citectscada process analyst
TRANSCRIPT
-
8/12/2019 CitectSCADA Process Analyst
1/329
Process Analyst User Guide
Citect Pty. Limited
3 Fitzsimons Lane
Pymble NSW 2073Australia
Telephone: 61 2 9496 7300
Fax: 61 2 9496 7399
-
8/12/2019 CitectSCADA Process Analyst
2/329
DISCLAIMER
Citect Corporation makes no representations or warranties with respect to this manual and, to the maximum extent permitted by law, expressly limits
its liability for breach of any warranty that may be implied to the replacement of this manual with another. Further, Citect Corporation reserves the right
to revise this publication at any time without incurring an obligation to notify any person of the revision.
COPYRIGHT
Copyright 2004 Citect Corporation. All rights reserved.
TRADEMARKS
Citect Pty. Limited has made every effort to supply trademark information about company names, products and services mentioned in this manual.
Trademarks shown below were derived from various sources.
Citect, CitectHMI, and CitectSCADA are registered trademarks of Citect Corporation.
IBM, IBM PC and IBM PC AT are registered trademarks of International Business Machines Corporation.
MS-DOS, Windows, Windows 95, Windows NT, Windows 98, Windows 2000, Windows for Workgroups, LAN Manager, Microsoft Windows XP, Excel
and MSMAIL are trademarks of Microsoft Corporation.
DigiBoard, PC/Xi and Com/Xi are trademarks of DigiBoard.
Novell, Netware and Netware Lite are registered trademarks of Novell Inc.
dBASE is a trademark of Borland Inc.
GENERAL NOTICE
Some product names used in this manual are used for identification purposes only and may be trademarks of their respective companies.
October 2004 edition for CitectSCADA Version 6.0
Manual Revision Version 6.0.
Printed in Australia.
-
8/12/2019 CitectSCADA Process Analyst
3/329
Contents
About this Guide
Part I Process Analyst for Operators
Chapter 1 The Process Analyst: An Overview
Chapter 2 Using the Main Toolbar
Chapter 3 Understanding Process Analyst PensPens: An Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Data Compaction. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Data Quality. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Date/Time (Horizontal) Axis. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Vertical (Value) Axis . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Gridlines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Pen Layout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Pen Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
Analog pens. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
Digital pens . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
Alarm pens . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
Chapter 4 Interacting with the Process AnalystPen Selection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
Locking/Unlocking Pens . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
Scrolling the Chart . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Scaling the Chart . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21Using the Navigation Toolbar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Specifying a start time and end time . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
About time spans . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
Span Lock . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
Navigating time . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
Synchronize to Now. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
Toggle Autoscrolling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
Zoom In/Zoom Out . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
-
8/12/2019 CitectSCADA Process Analyst
4/329
Contentsiv
Undo Last Zoom . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
Toggle Box Zoom . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
Edit Span. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
Edit Vertical Scale . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
Reset to Default Span . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
Using Cursors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
Using Cursor Labels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
Using the Right-click Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
Understanding Mouse Pointers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
Adding and Deleting Pens . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
Adding Pens . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
Deleting Pens . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
Viewing Pen Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
Chapter 5 Using the Object ViewObject View Basics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
Using Object View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
Chapter 6 Printing and ExportingAbout Process Analyst Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
Configuring Process Analyst Report Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
Setting up report legends . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
Setting up report options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45Exporting Pen Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
Copying data to the Clipboard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
Copying data to file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
Chapter 7 Configuring the Process AnalystUsing the Process Analyst Properties Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . 49
Main page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
Toolbars. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
Object View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
Configuring Chart-wide Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
Configuring general properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
Configuring server paths . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53Configuring Chart Panes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
Configuring Pens . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
Configuring pen appearance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
Configuring pen gridlines. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
Configuring pen axes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
Configuring pen quality . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
Configuring the pen data connection. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
Configuring cursor labels. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
-
8/12/2019 CitectSCADA Process Analyst
5/329
Contents v
Configuring Cursors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
Configuring Defaults . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
Configuring Toolbars . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
Adding or removing toolbar commands. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
Changing the order of toolbar commands . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
Configuring the Object View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
Object View properties page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
Working with Views . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
Saving a view . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
Loading a view. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
Chapter 8 Operator Command ReferenceView Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
Zoom Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
Navigation Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
Export Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
Interface Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
General Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
Part II Process Analyst for Users
Chapter 9 Integration with CitectSCADAConfiguring the Process Analyst Control from Graphics Builder . . . . . . . . . . . . . . . 77
Tag association . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77
Security and Permissions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77
Administration privilege . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
Command privilege . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
Write privilege . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79
Multi-language Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79
Understanding the Process Analyst resources . . . . . . . . . . . . . . . . . . . . . . . 79
Using CitectSCADA to switch the Process Analyst language . . . . . . . . . . . . 80
Manually switching languages. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80
Specifying languages for the Web Client. . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
Creating your own Process Analyst resource.dll. . . . . . . . . . . . . . . . . . . . . . 81
Persistence . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87Saving while using the Citect Graphics Builder. . . . . . . . . . . . . . . . . . . . . . . 87
Using the Save View toolbar button . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87
Using the SaveToFile automation method . . . . . . . . . . . . . . . . . . . . . . . . . . 87
Saving between Citect page transitions (Run-time) . . . . . . . . . . . . . . . . . . . 87
Resetting back to the default state . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88
Backing up Projects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88
-
8/12/2019 CitectSCADA Process Analyst
6/329
Contentsvi
Chapter 10 Configuring Process Analyst Design Time PropertiesAdding New Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
Editing Existing Custom Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90
Creating or Editing Object View Columns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91
Process Analyst View Synchronization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92
Chapter 11 Using the Process Analyst Command SystemCommand System Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95
Custom Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95
CommandExecuted. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95
UpdateCommand . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95Icons . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
Chapter 12 Automation ModelExecution Results . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97
Interfaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99
Enumerations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99
IProcessAnalyst Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99
IProcessAnalyst.BlockUpdates [Method]. . . . . . . . . . . . . . . . . . . . . . . . . . . 100
IProcessAnalyst.UnBlockUpdates [Method] . . . . . . . . . . . . . . . . . . . . . . . . 101
IProcessAnalyst.CopyToClipboard [Method]. . . . . . . . . . . . . . . . . . . . . . . . 102
IProcessAnalyst.CopyToFile [Method] . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103IProcessAnalyst.FreezeEvent [Method] . . . . . . . . . . . . . . . . . . . . . . . . . . . 104
IProcessAnalyst.LoadFromFile [Method]. . . . . . . . . . . . . . . . . . . . . . . . . . . 105
IProcessAnalyst.PrintAll [Method] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106
IProcessAnalyst.SaveToFile [Method]. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107
IProcessAnalyst.ShowProperties [Method] . . . . . . . . . . . . . . . . . . . . . . . . . 108
IProcessAnalyst.SubscribeForPropertyChange [Method] . . . . . . . . . . . . . . 108
IProcessAnalyst.SynchroniseToNow [Method] . . . . . . . . . . . . . . . . . . . . . . 110
IProcessAnalyst.UnsubscribePropertyChange [Method]. . . . . . . . . . . . . . . 110
IProcessAnalyst.AdminPrivilegeLevel [Property] [Get] . . . . . . . . . . . . . . . . 111
IProcessAnalyst.AutoScroll [Property][Get/Set]. . . . . . . . . . . . . . . . . . . . . . 112
IProcessAnalyst.BackgroundColor [Property][Get/Set] . . . . . . . . . . . . . . . . 113
IProcessAnalyst.CommandSystem [Property][Get]. . . . . . . . . . . . . . . . . . . 114IProcessAnalyst.ContextMenu [Property][Get/Set] . . . . . . . . . . . . . . . . . . . 115
IProcessAnalyst.Cursors [Property][Get]. . . . . . . . . . . . . . . . . . . . . . . . . . . 116
IProcessAnalyst.DataRequestRate [Property][Get/Set] . . . . . . . . . . . . . . . 117
IProcessAnalyst.DisplayRefreshRate [Property][Get/Set]. . . . . . . . . . . . . . 118
IProcessAnalyst.Language [Property] [Get/Set] . . . . . . . . . . . . . . . . . . . . . 119
IProcessAnalyst.LastSelectedPen [Property][Get] . . . . . . . . . . . . . . . . . . . 120
IProcessAnalyst.LockedPens [Property][Get/Set] . . . . . . . . . . . . . . . . . . . . 121
IProcessAnalyst.ObjectView [Property][Get] . . . . . . . . . . . . . . . . . . . . . . . . 122
-
8/12/2019 CitectSCADA Process Analyst
7/329
Contents vii
IProcessAnalyst.Number of Samples[Property][Get/Set] . . . . . . . . . . . . . . 123
IProcessAnalyst.Panes [Property][Get] . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124
IProcessAnalyst.PrimaryPath [Property][Get/Set] . . . . . . . . . . . . . . . . . . . . 125
IProcessAnalyst.SecondaryPath [Property][Get/Set] . . . . . . . . . . . . . . . . . 126
IProcessAnalyst.Toolbars [Property][Get] . . . . . . . . . . . . . . . . . . . . . . . . . . 127
IProcessAnalyst.WritePrivilegeLevel [Property][Get]. . . . . . . . . . . . . . . . . . 127
IProcessAnalyst.ZoomMode [Property][Get/Set]. . . . . . . . . . . . . . . . . . . . . 128
MouseDoubleClick [Event] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129
MouseClick [Event] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130
PenCreated [Event] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131
PenDeleted [Event] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131
PenRenamed [Event] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132
PenSelectionChanged [Event]. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132
HorizontalAxisChanged [Event]. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133
VerticalAxisChanged [Event]. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134
CursorMoved [Event]. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135
Error [Event] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135
PropertyChanged [Event] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136
OVItemAdded [Event] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137
OVItemRemoved [Event]. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138
OVItemSelected [Event] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139
OVItemChecked [Event] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139
OVColumnAdded [Event] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140
OVColumnRemoved [Event] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140
CommandExecuted [Event]. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141UpdateCommand [Event] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142
AlarmType [Enumeration] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143
AxisLabelType [Enumeration] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143
LineStyle [Enumeration] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145
HatchStyle [Enumeration] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145
PenNameMode [Enumeration] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146
PenType [Enumeration]. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146
PointType [Enumeration] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146
RequestMode [Enumeration]. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147
ToolbarButtonType [Enumeration]. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147
LineType [Enumeration] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148
ErrorNotifyCode [Enumeration] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148QualityType [Enumeration] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149
QualityCompactionType [Enumeration]. . . . . . . . . . . . . . . . . . . . . . . . . . . . 149
FileLocation [Enumeration] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150
IAnalogPen Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150
IAnalogPen.LineColor [Property][Get/Set]. . . . . . . . . . . . . . . . . . . . . . . . . . 150
IAnalogPen.LineInterpolation [Property][Get/Set] . . . . . . . . . . . . . . . . . . . . 151
IAnalogPen.LineWidth [Property][Get/Set] . . . . . . . . . . . . . . . . . . . . . . . . . 152
IDigitalPen Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153
-
8/12/2019 CitectSCADA Process Analyst
8/329
Contentsviii
IDigitalPen.FillColor [Property][Get/Set] . . . . . . . . . . . . . . . . . . . . . . . . . . . 153
IDigitalPen.LineColor [Property][Get/Set] . . . . . . . . . . . . . . . . . . . . . . . . . . 154
IDigitalPen.LineWidth [Property][Get/Set] . . . . . . . . . . . . . . . . . . . . . . . . . . 155
IDigitalPen.Fill [Property][Get/Set]. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156
IAlarmPen Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157
IAlarmPen.LineColor [Property][Get/Set]. . . . . . . . . . . . . . . . . . . . . . . . . . . 157
IAlarmPen.LineWidth [Property][Get/Set] . . . . . . . . . . . . . . . . . . . . . . . . . . 158
IAlarmPen.AlarmType [Property][Get/Set]. . . . . . . . . . . . . . . . . . . . . . . . . . 159
IAlarmPen.GetFillColor [Method]. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160
IAlarmPen.SetFillColor [Method] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161
IAlarmPen.GetHatchColor [Method] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162
IAlarmPen.SetHatchColor [Method] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163
IAlarmPen.GetHatchStyle [Method]. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164
IAlarmPen.SetHatchStyle [Method]. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165
ICursors Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165
ICursors.Create [Method] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166
ICursors.RemoveAll [Method] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167
ICursors.Item [Property][Get]. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167
ICursors._NewEnum [Property][Get]. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168
ICursors.Count [Property][Get] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169
ICursors.ItemByName [Property][Get]. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169
ITrendCursor Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170
ITrendCursor.GetValue [Method] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171
ITrendCursor.Delete [Method] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172
ITrendCursor.Color [Property][Get/Set]. . . . . . . . . . . . . . . . . . . . . . . . . . . . 173ITrendCursor.Width [Property][Get/Set] . . . . . . . . . . . . . . . . . . . . . . . . . . . 174
ITrendCursor.Position [Property][Get/Set]. . . . . . . . . . . . . . . . . . . . . . . . . . 174
ITrendCursor.Visible [Property][Get/Set]. . . . . . . . . . . . . . . . . . . . . . . . . . . 175
ITrendCursor.Collection [Property][Get] . . . . . . . . . . . . . . . . . . . . . . . . . . . 176
ITrendCursor.Name [Property][Get/Set] . . . . . . . . . . . . . . . . . . . . . . . . . . . 177
ITrendCursor.PenLabelVisible [Property][Get/Set] . . . . . . . . . . . . . . . . . . . 178
ITrendCursor.PenLabelWidth [Property][Get/Set] . . . . . . . . . . . . . . . . . . . . 179
ITrendCursor.PenLabelHeight [Property][Get/Set] . . . . . . . . . . . . . . . . . . . 180
ITrendCursor.PenLabelX [Property][Get/Set] . . . . . . . . . . . . . . . . . . . . . . . 181
ITrendCursor.PenLabelY [Property][Get/Set] . . . . . . . . . . . . . . . . . . . . . . . 182
ITrendCursor.LabelsLocked [Property][Get/Set] . . . . . . . . . . . . . . . . . . . . . 183
IPen Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183IPen.AddSample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185
IPen.Clear [Method]. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186
IPen.Delete [Method]. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187
IPen.GetDefaultSpan [Method] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187
IPen.GetHorizontalAxisTimeSpan [Method] . . . . . . . . . . . . . . . . . . . . . . . . 189
IPen.GetInformation [Method] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190
IPen.GetStatistic [Method]. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192
IPen.GetVerticalAxisSpan [Method] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193
-
8/12/2019 CitectSCADA Process Analyst
9/329
Contents ix
IPen.GoToNow [Method]. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194
IPen.HorizontalScrollBy [Method] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194
IPen.HorizontalZoom [Method] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195
IPen.PointsVisible [Property][Get/Set]. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 196
IPen.PutHorizontalAxisTimeSpan [Method] . . . . . . . . . . . . . . . . . . . . . . . . 197
IPen.PutVerticalAxisSpan [Method]. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198
IPen.RefreshData [Method]. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199
IPen.ResetToDefaultSpan [Method] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200
IPen.Select [Method] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201
IPen.SetDefaultSpan [Method] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201
IPen.SetQualityCompactionPointType [Method] . . . . . . . . . . . . . . . . . . . . . 202
IPen.SetQualityLineStyle [Method] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203
IPen.SetVerticalAxisLabelValue [Method] . . . . . . . . . . . . . . . . . . . . . . . . . . 204
IPen.VerticalScrollBy [Method] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205
IPen.VerticalZoom [Method] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 206
IPen.AxisBackgroundColor [Property][Get/Set]. . . . . . . . . . . . . . . . . . . . . . 207
IPen.BlockRepaint [Property][Get/Set] . . . . . . . . . . . . . . . . . . . . . . . . . . . . 208
IPen.Collection [Property][Get] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 209
IPen.DataPoint [Property][Get/Set] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 209
IPen.DataServer [Property][Get/Set] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210
IPen.Height [Property][Get/Set]. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 211
IPen.HorizontalAxisColor [Property][Get/Set] . . . . . . . . . . . . . . . . . . . . . . . 212
IPen.HorizontalAxisResize [Property][Get/Set] . . . . . . . . . . . . . . . . . . . . . . 213
IPen.HorizontalAxisScroll [Property][Get/Set] . . . . . . . . . . . . . . . . . . . . . . . 214
IPen.HorizontalAxisWidth [Property][Get/Set] . . . . . . . . . . . . . . . . . . . . . . . 215IPen.HorizontalGridlinesColor [Property][Get/Set] . . . . . . . . . . . . . . . . . . . 216
IPen.HorizontalGridlinesStyle [Property][Get/Set]. . . . . . . . . . . . . . . . . . . . 217
IPen.HorizontalGridlinesWidth [Property][Get/Set] . . . . . . . . . . . . . . . . . . . 218
IPen.HorizontalMinorGridlinesColor [Property][Get/Set] . . . . . . . . . . . . . . . 219
IPen.HorizontalMinorGridlinesStyle [Property][Get/Set] . . . . . . . . . . . . . . . 220
IPen.IsDeleted [Property][Get]. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220
IPen.IsSelected [Property][Get] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221
IPen.LocalTime [Property][Get/Set]. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222
IPen.Name [Property][Get/Set] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223
IPen.RequestMode [Property][Get/Set]. . . . . . . . . . . . . . . . . . . . . . . . . . . . 224
IPen.Stacked [Property][Get/Set] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 225
IPen.TrendCursorLabelFillColor [Property][Get/Set] . . . . . . . . . . . . . . . . . . 225IPen.TrendCursorLabelLineColor [Property][Get/Set]. . . . . . . . . . . . . . . . . 226
IPen.TrendCursorLabelTextColor [Property][Get/Set]. . . . . . . . . . . . . . . . . 227
IPen.VerticalAxisAutoscale [Property][Get/Set]. . . . . . . . . . . . . . . . . . . . . . 228
IPen.VerticalAxisColor [Property][Get/Set] . . . . . . . . . . . . . . . . . . . . . . . . . 229
IPen.VerticalAxisLabelType [Property][Get/Set] . . . . . . . . . . . . . . . . . . . . . 230
IPen.VerticalAxisResize [Property][Get/Set] . . . . . . . . . . . . . . . . . . . . . . . . 231
IPen.VerticalAxisScroll [Property][Get/Set] . . . . . . . . . . . . . . . . . . . . . . . . . 232
IPen.VerticalAxisWidth [Property][Get/Set] . . . . . . . . . . . . . . . . . . . . . . . . . 233
-
8/12/2019 CitectSCADA Process Analyst
10/329
Contentsx
IPen.VerticalGridlinesColor [Property][Get/Set]. . . . . . . . . . . . . . . . . . . . . . 234
IPen.VerticalGridlinesStyle [Property][Get/Set] . . . . . . . . . . . . . . . . . . . . . . 235
IPen.VerticalGridlinesWidth [Property][Get/Set] . . . . . . . . . . . . . . . . . . . . . 236
IPen.VerticalMinorGridlinesColor [Property][Get/Set] . . . . . . . . . . . . . . . . . 237
IPen.VerticalMinorGridlinesStyle [Property][Get/Set] . . . . . . . . . . . . . . . . . 237
IPen.Visible [Property][Get/Set]. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 238
IObjectView Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 239
IObjectView.Visible [Property][Get/Set]. . . . . . . . . . . . . . . . . . . . . . . . . . . . 240
IObjectView.Height [Property][Get/Set] . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241
IObjectView.BackgroundColor [Property][Get/Set] . . . . . . . . . . . . . . . . . . . 241
IObjectView.ForeColor [Property][Get/Set] . . . . . . . . . . . . . . . . . . . . . . . . . 242
IObjectView.Columns [Property][Get] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 243
IObjectView.Items [Property][Get] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 244
IObjectView.SelectedItem [Property][Get]. . . . . . . . . . . . . . . . . . . . . . . . . . 245
IObjectViewItems Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 245
IObjectViewItems.Count [Property][Get] . . . . . . . . . . . . . . . . . . . . . . . . . . . 246
IObjectViewItems.Item [Property][Get] . . . . . . . . . . . . . . . . . . . . . . . . . . . . 246
IObjectViewItems._NewEnum [Property][Get]. . . . . . . . . . . . . . . . . . . . . . . 247
IObjectViewItem Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 247
IObjectViewItem.GetField [Method]. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 248
IObjectViewItem.PutField [Method] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 249
IObjectViewItem.Expanded [Property][Get/Set] . . . . . . . . . . . . . . . . . . . . . 249
IObjectViewItem.Tag [Property][Get/Set] . . . . . . . . . . . . . . . . . . . . . . . . . . 250
IObjectViewItem.Items [Property][Get] . . . . . . . . . . . . . . . . . . . . . . . . . . . . 251
IObjectViewPenItem Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 252IObjectViewPenItem.BlockColor [Property][Get] . . . . . . . . . . . . . . . . . . . . . 252
IObjectViewPenItem.Checked [Property][Get/Set] . . . . . . . . . . . . . . . . . . . 253
IObjectViewPenItem.Selected [Property][Get]. . . . . . . . . . . . . . . . . . . . . . . 254
IObjectViewColumns Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 255
IObjectViewColumns.Add [Method]. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 255
IObjectViewColumns.Hide [Method] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 256
IObjectViewColumns.Remove [Method] . . . . . . . . . . . . . . . . . . . . . . . . . . . 257
IObjectViewColumns.Show [Method] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 258
IObjectViewColumns.Count [Property][Get] . . . . . . . . . . . . . . . . . . . . . . . . 258
IObjectViewColumns.Item [Property][Get]. . . . . . . . . . . . . . . . . . . . . . . . . . 259
IObjectViewColumns.ItemByName [Property][Get]. . . . . . . . . . . . . . . . . . . 260
IObjectViewColumns._NewEnum [Property][Get] . . . . . . . . . . . . . . . . . . . . 261IObjectViewColumn Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 261
IObjectViewColumn.Name [Property][Get] . . . . . . . . . . . . . . . . . . . . . . . . . 261
IObjectViewColumn.Text [Property][Get]. . . . . . . . . . . . . . . . . . . . . . . . . . . 262
IObjectViewColumn.Width [Property][Get/Set] . . . . . . . . . . . . . . . . . . . . . . 263
ICommandSystem Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 263
ICommandSystem.Count [Property][Get] . . . . . . . . . . . . . . . . . . . . . . . . . . 264
ICommandSystem.Item [Property][Get]. . . . . . . . . . . . . . . . . . . . . . . . . . . . 264
ICommandSystem._NewEnum [Property][Get]. . . . . . . . . . . . . . . . . . . . . . 265
-
8/12/2019 CitectSCADA Process Analyst
11/329
Contents xi
ICommandSystem.ItemById [Property][Get] . . . . . . . . . . . . . . . . . . . . . . . . 266
ICommandSystem.Create [Method] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 266
ICommandSystem.Execute [Method] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 268
ICommandSystem.Remove [Method] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 268
ICommand Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 269
ICommand.CommandId [Property][Get] . . . . . . . . . . . . . . . . . . . . . . . . . . . 269
ICommand.ButtonType [Property][Get] . . . . . . . . . . . . . . . . . . . . . . . . . . . . 270
ICommand.Enabled [Property][Get/Set] . . . . . . . . . . . . . . . . . . . . . . . . . . . 271
ICommand.Pressed [Property][Get/Set] . . . . . . . . . . . . . . . . . . . . . . . . . . . 272
ICommand.Tooltip [Property][Get]. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 273
ICommand.Privilege [Property][Get] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 273
IToolbars Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 274
IToolbars.Count [Property][Get]. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 275
IToolbars.Item [Property][Get] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 275
IToolbars._NewEnum [Property][Get] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 276
IToolbar Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 276
IToolbar.Visible [Property][Get/Set]. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 277
IToolbar.Buttons [Property][Get] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 277
IToolbarButtons Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 278
IToolbarButtons.Add [Method]. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 279
IToolbarButtons.Remove [Method] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 279
IToolbarButtons.RemoveAll [Method] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 280
IToolbarButtons.Count [Property][Get] . . . . . . . . . . . . . . . . . . . . . . . . . . . . 281
IToolbarButtons.Item [Property][Get]. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 281
IToolbarButtons._NewEnum [Property][Get] . . . . . . . . . . . . . . . . . . . . . . . . 282IToolbarButton Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 283
IToolbarButton.CommandId [Property][Get] . . . . . . . . . . . . . . . . . . . . . . . . 283
IPanes Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 283
IPanes.Create [Method]. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 284
IPanes.RemoveAll [Method] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 285
IPanes.Count [Property][Get] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 285
IPanes.Item [Property][Get]. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 286
IPanes._NewEnum [Property][Get] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 287
IPanes.ItemByName [Property][Get] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 287
IPane Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 288
IPane.Delete [Method]. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 288
IPane.Height [Property][Get/Set]. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 289IPane.Collection [Property][Get] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 290
IPane.Name [Property][Get/Set] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 291
IPane.BackgroundColor [Property][Get/Set] . . . . . . . . . . . . . . . . . . . . . . . . 292
IPane.FixedHeight [Property][Get/Set] . . . . . . . . . . . . . . . . . . . . . . . . . . . . 293
IPane.Pens [Property][Get] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 294
IPens Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 294
IPens.Create [Method]. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 295
IPens.RemoveAll [Method] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 296
-
8/12/2019 CitectSCADA Process Analyst
12/329
Contentsxii
IPens.Count [Property][Get] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 296
IPens.Item [Property][Get]. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 297
IPens._NewEnum [Property][Get] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 298
IPens.ItemByName [Property][Get] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 298
IPens.Pane[Property][Get]. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 299
Chapter 13 Cicode Programming ReferenceAutomation Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 301
Handling an Event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 301
Enumerating collections . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 302
Implementing a custom command. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 303
Implementing a custom column. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 306
Index 311
-
8/12/2019 CitectSCADA Process Analyst
13/329
About this Guide
The information presented here is intended for two types of user, Operators andUsers:
Operator- a person who uses the Process Analyst in a runtime environmentto monitor plant operations. An Operator might configure the properties ofvarious Process Analyst components during runtime to facilitate their work.An Operator is not expected to possess in-depth technical knowledge about
the Process Analyst components. For details about using the Process Analystas an Operator, see Process Analyst for Operators.
User- a person who uses the Process Analyst during design time to engineera view for an Operator. A User possesses in-depth technical knowledgeabout CitectSCADA and Cicode, and understands how these componentsinteract. For details about using the Process Analyst as a User, see ProcessAnalyst for Users.
-
8/12/2019 CitectSCADA Process Analyst
14/329
About this Guide2
-
8/12/2019 CitectSCADA Process Analyst
15/329
-
8/12/2019 CitectSCADA Process Analyst
16/329
-
8/12/2019 CitectSCADA Process Analyst
17/329
Chapter 1: The Process Analyst: An Overview
The Process Analyst control allows Operatorsto view trend and/or alarm tagdata (both real-time and historical) for comparison and analysis during run timethrough their existing CitectSCADA server architecture. Userscan configurecertain properties of the Process Analyst control during design time.
A typical Process Analyst view might look like the one shown here. Your ProcessAnalyst views will probably look different to this example.
The Process Analyst control interface typically consists of the following
components:
1 Main toolbar: Contains commands for performing general operations in theProcess Analyst, such as opening views, printing reports, and so on. You canconfigure this toolbarto contain different items.
2 Pens: A Process Analyst pen represents your trend and/or alarm data. TheProcess Analyst supports three types of pen: analog pen, digital pen, andalarm pen. Each pen has its own graphical representation. You can configuremost pen propertiesduring run time.
1
2
3
5
6
7 8
9
10
http://about%20this%20help.pdf/http://about%20this%20help.pdf/http://about%20this%20help.pdf/http://about%20this%20help.pdf/ -
8/12/2019 CitectSCADA Process Analyst
18/329
Chapter 1: The Process Analyst: An Overview6
3 Panes: Panes are used to group pens visually in the Process Analyst and arestacked vertically on the Process Analyst display. Every pen belongs to asingle pane. You can configure chart panes.
4 Chart background (not shown): The panes are drawn over the chartbackground. Depending on the layout of the pens, the background may bepartially visible. You can configure the chart background.
5 Date/time axis: Located at the top of a pane, the date/time (horizontal) axisdisplays the date or time (or both) of the data for the primary selected penwithin a pane. You can configure the axis.
6 Vertical axis: Analog pens have a vertical axis on the left-hand side of the
pane to indicate data values. You can configure this axis.7 Cursor: A cursor allows an Operator to determine value at a given point in
time by dragging the cursor line to the point required. You can configure thecursor.
8 Cursor labels: Display the value where the cursor intersects the trend valueline.
9 Navigation toolbar: Contains commands to allow an Operator to travelforward or backward through trends, as well as other navigation-relatedtasks. You can configure this toolbarto contain different items.
10 Object View: When displayed, the Object View appears under thenavigation toolbar and displays information about your Process Analyst
pens, such as name, color, scale, and so on. You can configure the ObjectView.
-
8/12/2019 CitectSCADA Process Analyst
19/329
Chapter 2: Using the Main Toolbar
The Process Analyst main toolbar is located above the top pane. The maintoolbar contains commands that allow you to perform general operations, suchas save and load Process Analyst views, print trend reports, add or remove pens,display or hide cursors and labels, and so on.
Toolbar commands can be customized; for details, see Configuring Toolbars.
The table below describes the items that are included on the main toolbar bydefault.
See Also Using the Navigation Toolbar
Item Description
Load View. Loads a saved view from file. For details, see Loading a view.
Save View. Saves a view to file. For details, see Saving a view.
Print. Displays the standard Windows Print dialog box for printing trend reports. For
details, see Printing and Exporting.
Copy to Clipboard. Copies visible pens to the Windows Clipboard. For details, see
Copying data to the Clipboard.
Export to File. Exports visible pens to an Excel-compatible file. For details, see Copyingdata to file.
Add Pen. Displays the Add New Pen(s) dialog box for adding a pen. For details, see
Adding Pens.
Remove Pen. Deletes the currently selected pen from the trend display. For details, see
Deleting Pens.
Lock/Unlock Pens. Toggles the locking of pens. For details, see Locking/Unlocking Pens.
Show/Hide Points. Toggles the display of points representing where sample data was
recorded in the archive. For details, see Pens: An Overview.
Show/Hide Cursors. Toggles the display of cursors. For details, see Using Cursors.
Show/Hide Cursor Labels. Toggles the display of cursor labels. For details, see UsingCursor Labels.
Toggle Object View. Toggles the display of the Object View. For details, see Using the
Object View.
Properties. Displays the Properties dialog box for configuring the Process Analyst control.
For details, see Configuring the Process Analyst.
Help. Displays the Process Analyst online Help.
-
8/12/2019 CitectSCADA Process Analyst
20/329
Chapter 2: Using the Main Toolbar8
Operator Command Reference
-
8/12/2019 CitectSCADA Process Analyst
21/329
Chapter 3: Understanding Process AnalystPens
The Process Analyst pens allow you to analyze and compare both real-time andhistorical data from trend and alarm servers.
See Also Pens: An OverviewPen Types
Pens: An Overview
Process Analyst pens are drawn against time. Each pen has its own colored line(and can contain other graphical elements). Sample markers (orpoints) aredrawn on the line to indicate where data was recorded in the archive. The styleof the line indicates the quality of the data; the style of the sample markerindicates the compaction of the sample.
Data Compaction Data compactionis the visual grouping of multiple data points into a single datapoint when the data in the archive is too dense to be displayed as individualdata points for the selected time span.
Data is compacted by grouping raw samples together to form a multiple sample.Sample compaction is indicated on the graph by using different sample markers.For example, in the illustration below, the two sample markers that appear assquares actually represent multiple raw samples. However, because the datapoints in this view are too dense to display as individual points, the multiplesamples appear as one data point.
The following illustration zooms in on the second multiple sample, and showsthat what appeared to be a single raw sample actually consists of several rawsamples:
-
8/12/2019 CitectSCADA Process Analyst
22/329
Chapter 3: Understanding Process Analyst Pens10
The Process Analyst uses the following default point styles for single andmultiple samples:
Interpolated samples
Normally samples are only single or multiple. But there is a specific situation inwhich an interpolated sample is used to correct a graph that only occurs with
event trends.The frequency of the data stored in an event trend can vary dramatically; forexample, where several samples are within one display period, followed by nosamples for a long time. A multiple sample will be drawn with a valuecalculated from the samples within the period. But the value after that periodwill be whatever the last sample in the period was. So an interpolated sample isadded at the start of the next display period to correct the graph.
See Also Interpolation
Request modes
Because the Process Analyst Control makes requests for a range of data using adisplay period, CitectSCADA needs to perform calculations on data if it
becomes too dense in order to calculate the value of a multiple sample. TheProcess Analyst provides the following options for this calculation:
Average- The value will be an average of all the individual samples withinthe multiple sample, as will the timestamp. This is the default calculationmethod.
Maximum: The value will be the maximum value out of all the individualsamples within the multiple sample. The timestamp will be that of theindividual sample that was the maximum. The timestamp will be theaverage of all the individual samples within the multiple sample.
Minimum: The value will be the minimum value out of all the individualsamples within the multiple sample. The timestamp will be that of theindividual sample that was the minimum. The timestamp will be theaverage of all the individual samples within the multiple sample.
Newest: The value will the latest arrived value out of all the individualsamples within the multiple sample. The timestamp will be that of theindividual sample that was the newest. The timestamp will be the average ofall the individual samples within the multiple sample.
Sample compaction Point type
Single Ellipse
Multiple Rectangle
Interpolated Triangle (see Interpolated samples).
-
8/12/2019 CitectSCADA Process Analyst
23/329
Chapter 3: Understanding Process Analyst Pens 11
Data Quality Process Analyst pens use the same quality system as CitectSCADA trend andalarm data. There are four data quality states:
Good- Samples were recorded in the trend archive as good.
NA- When Citect is unable to obtain a sample, an N/A sample will berecorded in the trend archive.
Gated/Disabled- For trends, when the driver determines a sample value isinvalid, a value of Gated is recorded in the trend archive. For alarms, thisdata quality state indicates that the alarm has been disabled.
The Process Analyst uses the following default line styles to indicate data
quality:
Consider the following examples:
The line style indicating the data quality is configurable during run time anddesign time; for details, see Configuring pen quality.
Date/Time (Horizontal)Axis
All Process Analyst pens have a date/time axis, located at the top of the pane.
Quality Line style
Good Solid
NA None
GatedDot
Data sample Description
This example shows several single samples. The third sample has a quality of N/A,
indicated by the break in the trend line.
Here the quality of the third sample is gated, indicated by the broken line connecting these
samples.
With multiple samples, the quality of the last sample in the group determineshow the line is drawn. Consider the following examples:
This example shows that the third sample is actually a multiple sample. The quality of the
third (multiple) sample and the next sample is N/A, again indicated by the break in the
trend line.
Here the quality of the third multiple sample is gated, again indicated by the broken line
connecting the samples.
-
8/12/2019 CitectSCADA Process Analyst
24/329
Chapter 3: Understanding Process Analyst Pens12
The date/time axis displays time using the current locale format specified inyour computer date/time settings. If the millisecond component is required, it isappended to the end in the format ms. Since the local time zone isdetermined from the current computer settings, these settings must beconfigured accurately.
The date/time axis can also display data using the universal time coordinate(UTC) format. You can switch between local or UTC time as you like (seeConfiguring pen axes). If the current time is 10.00p.m. UTC, in the Sydney(GMT+10) time-zone, local time will be 8.00p.m.
The date/time axis is divided into major and minor time intervals, which change
dynamically depending upon the time span. In the illustration above, the majorintervals are 1 minute apart, and the minor are 5 seconds apart.
Note the following:
When the axis time span is 1 minute or less, the format of the axis labelsincludes milliseconds and the date is removed.
When the axis time span is 1 week or above, the time is removed and onlythe date is displayed.
By default, the date/time axis displays a time span of 10 minutes; the majorintervals represent 5 minutes, and the minor intervals 30 seconds.
Daylight savings (local time)
The date/time axis can also accommodate daylight savings transitions. Forexample, when entering daylight savings, the axis will indicate the transition as11a.m., 12a.m., 1a.m., 3a.m., 4a.m., 5a.m., if this transition occurred at 2a.m.Likewise, in the out transition, when 1 hour is removed from daylight savingstime, the axis will display 11a.m., 12a.m., 1a.m., 2a.m., 2a.m., 3a.m., 4a.m., 5a.m.
Now indicator
The Now indicator is a small white circle on the date/time axis that indicates thecurrent computer time based on the computers time settings.
The position of the Now indicator is refreshed according to the value specified inthe Display Refresh Datetext box in the Process Analyst Control Propertiesdialog box.
Note: If you have used the CitectSCADA trend page feature, note the following:In CitectSCADA the right-hand side of the screen always represents Now (whenlooking at real-time data). In the Process Analyst control, Now is represented
-
8/12/2019 CitectSCADA Process Analyst
25/329
Chapter 3: Understanding Process Analyst Pens 13
only by the Now indicator, which may be located anywhere on the trend display,even off screen, since it is possible to scroll into the future, or back into the past.
You can scroll and scale the date/time time axis to interact with your ProcessAnalyst pens; for details, see Interacting with the Process Analyst. You can alsoconfigure the date/time axis to suit your preferences; for details, see Configuringpen axes.
Vertical (Value) Axis The vertical (value) axis is located at the left-hand edge of the pane.
Like the date/time axis, the value axis consists of major and minor intervals, butthey represent value intervals rather than date and time. The intervals are
calculated automatically by the Process Analyst.The value axis is shown only for analog pens; the axis displayed reflects thevalues for the primary selected pen.
By default the vertical axis will use the engineering scale from the tag of theselected pen. The vertical axis also supports autoscaling. When autoscaling isenabled, the vertical axis automatically adjusts its limits to accommodate newsamples as they are added to each individual pen.
In this example, there are two panes, each of which has a differently scaledvertical axis.
You can scroll and scale the vertical axis; for details, see Scrolling the ChartandScaling the Chart. You can also configure the appearance of the vertical axis; fordetails, see Configuring pen axes.
-
8/12/2019 CitectSCADA Process Analyst
26/329
Chapter 3: Understanding Process Analyst Pens14
Gridlines The Process Analyst pens use gridlines as a visual guide to help an Operatordetermine the value of trends. Major gridlines are solid lines; minor gridlines are
broken lines. Analog pens have vertical and horizontal gridlines; alarm anddigital pens only have vertical gridlines. The display of gridlines changesdynamically according to the selected time span.
You can configure vertical gridlines at run time for all pen types; you canconfigure horizontal gridlines for analog pens. For details, see Configuring pengridlines.
Pen Layout You can are display pens in the Process Analyst by stacking or overlaying.
In stackedmode, a user-specified amount of vertical real-estate is allocatedto the pen, and with this, stacked pens are laid out under each other on thepane, starting from the top of the pane under the date/time axis, like this:
Here, three pens (one analog and two digital) are stacked under each other.
Stacking applies to all types of pens.
In unstackedmode, pens are drawn on top of each other. The order in whichthe pens were added to the pane governs the drawing order: the last penadded is the topmost pen drawn. When a pen is selected, it is brought to thefront of any other pens displayed
Here, two analog pens are overlaid. You can also overlay digital and alarmpens.
You can have any mix of stacked and unstacked pens on a pane.
-
8/12/2019 CitectSCADA Process Analyst
27/329
Chapter 3: Understanding Process Analyst Pens 15
Pen Types
The Process Analyst control supports three types of pen: analog pens, digitalpens, and alarm pens. Analog and digital pens are associated with trend tags;alarm pens are associated with alarm tags.
Analog pens The Process Analyst control typically uses analog pens to represent nonbinarydata. Only analog pens have a value (vertical) axis, which the data is plottedagainst, as shown here:
Interpolation
Analog pens have two types of interpolation that allow you to specify how toconnect data samples on a trend line: straightand stepped:
Straight- a line is drawn directly between the points like this:
Stepped- the lines drawn always maintain the value of the previous sampleuntil a sample with a different value arrives, in which case a vertical line isdrawn:
-
8/12/2019 CitectSCADA Process Analyst
28/329
Chapter 3: Understanding Process Analyst Pens16
The Process Analyst allows analog pens to be configured at run time and designtime. For details, see Configuring Pens.
See Also Interpolated samples
Digital pens The Process Analyst control typically uses digital pens to represent binary data.Values on the pen are clamped to a range of 0 to 1. Any value equal to or greaterthan 0.5 is clamped to 1; all other values are clamped to 0. A fill color is used toindicate where the data is 1, as shown here:
By default, the layout of digital pens is stacked. For details, see Pen Layout.
The Process Analyst allows the appearance of digital pens to be configuredduring run time and design time. You can configure the trend line color, width,and fill color. For details, see Configuring pen appearance.
Alarm pens The Process Analyst uses alarm pens to graphically display the history of aCitectSCADA alarm over time. The Process Analyst supports seven differenttypes of alarm pens.
The alarms on/off transition state changes and acknowledgements are allrepresented graphically in the alarm pen display. To achieve this, the alarm pen
consists of three elements: the alarm state, on/off, and acknowledgement.The diagram below illustrates how an alarm pen displays the information of analarm tag:
1 The alarm is turned on in its initial state and is unacknowledged.2 The alarm changes to a different state, but is still unacknowledged.
3 The alarm is acknowledged.
4 The alarm is turned off.
Like other types of pen, alarm pens can represent variations in data qualityanddata compaction.
1
2
3
4
on/off
-
8/12/2019 CitectSCADA Process Analyst
29/329
Chapter 3: Understanding Process Analyst Pens 17
The Process Analyst allows alarm pens to be configured at run time and designtime. For details, see Configuring alarm pens.
On/off
When an alarm is off, the alarm pen will draw the line low. When the alarmtransitions to on, the line is drawn high.
Alarm states
When an alarm transitions to on, it enters a particular state. The states of analarm are dictated by the type of CitectSCADA alarm tag. The Process Analystsupports all CitectSCADA standard alarm types.
Note: For multi-digital alarms, the state descriptions are retrieved from theCitectSCADA alarm record.
The Process Analyst uses a different color, shading style, and description torepresent each alarm state; these properties are configurable. For details, seeConfiguring alarm pens.
Alarm acknowledgment
Process Analyst alarm pens can represent when alarms are acknowledged.
The Process Analyst indicates the period for which the alarm has been leftunacknowledged by drawing a line above the trend line. A newunacknowledged period begins whenever the alarm transitions to an onstate.
The unacknowledged period ends when an Operator acknowledges analarm. The Process Analyst identifies this by placing a sample marker toindicate the exact time the alarm was acknowledged, and by drawing an
unacknowledged line down to that sample marker, as shown here:
acknowledgements
unacknowledged periods
acknowledgementmarker
-
8/12/2019 CitectSCADA Process Analyst
30/329
Chapter 3: Understanding Process Analyst Pens18
Alarm types
The Process Analyst uses the following types of alarm pen:
For multiple samples in an alarm, the alarm state value is the last recorded valuein the group.
Alarm type Alarm pen representation
Digital
Analog
Advanced
Argyle Analog
Multi-digital
Timestamped
Timestamped analog
Timestamped digital
-
8/12/2019 CitectSCADA Process Analyst
31/329
Chapter 4: Interacting with the ProcessAnalyst
This section discusses how to interact with the Process Analyst.
See Also Pen SelectionLocking/Unlocking PensScrolling the ChartScaling the ChartUsing the Navigation ToolbarUsing CursorsUsing Cursor LabelsUsing the Right-click MenuUnderstanding Mouse PointersAdding and Deleting PensViewing Pen Details
Pen Selection
Each pane on the Process Analyst can have one selected pen. The axes that are
displayed on a pane are that of the selected pen. The last pen selected across allpanes is referred to as theprimaryselected pen.
You can select a Process Analyst pen in several ways:
By clicking on the pens graphical elements (i.e., the pen line).
If the pens are stacked, by clicking the background under the pen line.
By selecting the pen in the Object View.
The selection of a pen is indicated by a subtle halo effect surrounding the penline. In the example shown here, the top (green) pen is selected, indicated by thehalo surrounding the pen:
-
8/12/2019 CitectSCADA Process Analyst
32/329
Chapter 4: Interacting with the Process Analyst20
Note that the halo does not appear if there is only one pen on the pane. Selectinga pen on a pane also causes the same pen to be highlighted in the Object View.Selecting a pen causes that pen to be drawn in front of other pens on the pane.
Locking/Unlocking Pens
By default, the Process Analyst locks together the time span and position in time(horizontal axis) of all pens. However, you can unlock the pens, allowing thepens to be displayed across different positions in time and/or time spans.
For example, you could unlock pens to compare a previous months data for atag with the data for this month. You would do this by adding two pens to apane that represent the same tag, then unlocking the pens, and adjusting thetime positions for each pen as required.
To control pen locking and unlocking, you use the Lock/Unlock Pensbutton onthe main toolbar.
This option is also available on the right-click (context) menu.
Locking and unlocking has the following behavior:
When pens are locked, all time-related operations are applied to all pens.
When pens are unlocked, all time-related operations are applied to theprimary selected pen.
Synchronization applies to all pens regardless of their being locked orunlocked.
When transitioning from locked to unlocked, the time span and position in timeof all pens are synchronized to match that of the primary selected pen.
-
8/12/2019 CitectSCADA Process Analyst
33/329
Chapter 4: Interacting with the Process Analyst 21
Scrolling the Chart
The Process Analyst allows you to scroll through data in both the horizontal andvertical directions by dragging the mouse or spinning the mouse wheel.
To scroll by dragging:
1 Click and hold down the left mouse button on the pen (or background) thatyou want to scroll.
2 Drag the mouse in the direction you want to scroll:
Horizontal axis: drag right to move backward in time, drag left to moveforward.
Vertical axis: drag up to scroll down the axis, drag down to scroll up theaxis.
3 Release the left mouse button to complete the scrolling.
To scroll by using the mouse wheel:
1 Click the pen or background that you want to scroll.
2 Spin the mouse wheel in the direction you want to scroll:
Horizontal axis: spin up to move backward, spin down to moveforward.
Vertical axis: spin up to scroll up the axis, spin down to scroll down.
You can disable scrolling in the horizontal direction, the vertical direction, orboth by using the Property dialog box or the right-click (context) menu; seeConfiguring pen axesand Using the Right-click Menufor details.
The Process Analyst indicates whether scrolling is enabled or disabled bydisplaying a different-shaped mouse pointer; for details, see UnderstandingMouse Pointers.
Scaling the Chart
The Process Analyst allows you to change the scale of the data in both thehorizontal and vertical direction by dragging the mouse or spinning the mousewheel.
To scale the data by dragging:
1 Click and hold down the left mouse button on the axis that you want toscale.
2 Drag the mouse in the direction you want to scale:
Horizontal axis: drag left to expand the scale, drag right to shrink.
Vertical axis: drag up to expand the scale, drag down to shrink.
-
8/12/2019 CitectSCADA Process Analyst
34/329
Chapter 4: Interacting with the Process Analyst22
3 Release the left mouse button to complete the scaling.
To scale by using the mouse wheel:
1 Click the axis that you want to scale.
2 Spin the mouse wheel in the direction you want to scale:
Horizontal axis: spin up to shrink the axis, spin down to expand.
Vertical axis: spin up to expand the axis, spin down to shrink.
You can disable scrolling in the horizontal direction, the vertical direction, orboth by using the Property dialog box or the right-click (context) menu; seeConfiguring pen axesand Using the Right-click Menufor details.
The Process Analyst indicates whether scaling is enabled or disabled bydisplaying a different-shaped mouse pointer; for details, see UnderstandingMouse Pointers.
Using the Navigation Toolbar
Using the navigation toolbar you can:
Specify a start time and end time.
Select predefined time spans.
Lock time spans on the display.
Navigate backward or forward through your data.
Synchronize all pens to Now.
Toggle autoscrolling of the display.
Zoom in on or out of data.
Undo the last zoom operation.
Toggle between Zoom mode and normal mode.
Set nonstandard time spans.
Edit the vertical (value) scale.
Specifying a start timeand end time
You can specify a start time and an end time for the trend display by using thedate/time pickers. The start time picker is located on the left-hand side of thenavigation toolbar, the end time picker on the right.
-
8/12/2019 CitectSCADA Process Analyst
35/329
Chapter 4: Interacting with the Process Analyst 23
The date/time picker formats the date and time using the settings obtained fromyour computer for the currently logged in user. The date/time picker displaystime in 24-hour format (dd/mm/yyyyhhmm:ssnnn) where:
ddrepresents days
mmrepresents months
yyyyrepresents years
hhrepresents hours
mmrepresents minutes
ssrepresents seconds nnnrepresents milliseconds (added automatically to the time)
To change the date or time in the date/time picker:
1 Click the element of the date or time you want to change in the start timepicker or the end time picker.
2 Do either of the following:
Type in a time explicitly.
Press the Up arrow keyor Down arrow keyto increment or decrementthe value respectively.
Note: You can use the Left arrowand Right arrowkeys to move between
time elements.
Working with Daylight Savings
To indicate whether the time in the time picker control is Standard time orDaylight Savings time, the clock to the left of the control has a shaded segment ifthe time is in a Daylight Savings period. When in Standard time, the clock doesnot have a shaded segment.
For example, this icon appears when the time pickers value is within the localDaylight Savings period.
This icon appears when the time pickers value is within the local Standard timeperiod.
If the Daylight Savings transition involves duplicate hours, you can use the spincontrols (or Upand Downarrow keys) to select the hour you want.
Note: In order for the Process Analyst to be able to indicate that DaylightSavings is in effect, the Automatically adjust clock for daylight saving changes
-
8/12/2019 CitectSCADA Process Analyst
36/329
Chapter 4: Interacting with the Process Analyst24
option on the Date and Time Properties dialog box must be enabled, as indicatedbelow:
See Also Daylight savings (local time)
Shifting and fitting time units
You can manipulate the start time and end time by using special keyboardshortcuts. Using these shortcuts, you can do the following:
Shift by unit
Fit to unit
Shift by unit Shifting date or time by unit allows you to change the opposite date/time element to the one selected by the corresponding date or time component.For example, if you shift by unit the month time element in the start time, the
month time element in the end time increments by one month exactly, includingdays, minutes, and seconds. This also works for months that have different enddays.
To shift by unit:
1 Press and hold down the Shiftkey.
2 Click a date or time element in the date/time picker. The opposite timepicker changes by the base time amount of the selected time element.
-
8/12/2019 CitectSCADA Process Analyst
37/329
Chapter 4: Interacting with the Process Analyst 25
Fit to unit Fitting date or time to unit allows you to synchronize the selected timeelement to the zero position of that time element in the start time and end time.For example, an Operator clicks on the hhtime element of the Start picker, whichshows 19:30:05.123. After Ctrl+ click, the Start hour time element shows19:00:00.000, and the End time element shows 20:00:00.000. Now the time spanrepresents exactly one hour, synchronized on the hour.
To fit to unit:
1 Press and hold the Ctrlkey.
2 Click a date or time element in the date/time picker. Both the start time andend time element are synchronized to zero based on the date/time element
selected.
About time spans The time spanof the trend display is the difference between the start time and theend time. The start time appears on the left-hand side of the trend display, theend time on the right. The Span Picker (shown below) indicates the current span
being used; it also contains commonly used predefined time spans. Selecting atime span adjusts the start time, leaving the end time as-is.
See Also Span Lock
Span Lock When the time span is locked and the start time and/or end time picker changed,the current time span is maintained. If the time span is unlocked, the time spanis not maintained when any of the time pickers are changed.
By default, the span is locked. You can toggle span locking on or off by using theSpanLockbutton.
See Also About time spans
Navigating time The navigation controls allow an Operator to navigate backwards or forwardsthrough time. The amount of time moved depends upon the time currently
selected in the Span Picker. For example, if 10 minutes is selected in the SpanPicker and Back One Spanis clicked, the display moves back 10 minutes intothe pens history.
The following navigation controls are available:
Navigation control Description
Back One Span- moves back one time span.
-
8/12/2019 CitectSCADA Process Analyst
38/329
Chapter 4: Interacting with the Process Analyst26
Synchronize to Now The Synchronize to Now command synchronizes all pens such that the date/time reflects Now, which is positioned on the right-hand edge of the screen.Now is calculated using the current system time.
The Synchronize to Command is also available from the right-click (context)menu.
See Also Now indicator
Toggle Autoscrolling When Autoscroll is turned on, as time passes the position in time of all pensmoves by the same amount to keep pace; by default, the display is updatedevery second. The refresh rate of the display can be controlled by using theDisplay Refresh Rateproperty.
When Autoscroll is turned off, as time passes the position in time of all pens
remain fixed.
By default, Autoscroll is on. You can toggle Autoscrolling on or off by using theToggle Autoscrollingbutton.
Using the navigation controls, including the Time Span picker, causesAutoscrolling to be turned off
The Autoscroll command is also available from the right-click (context) menu.
Zoom In/Zoom Out Use the Zoom In 50% and Zoom Out 50% commands like this:
Note: The midpoint of each axis is maintained during these zoom operations.
Back Half a Span- moves back half a time span.
Forward Half a Span- moves forward half a time span.
Forward One Span- moves forward one time span.
Navigation control Description
Command Icon DescriptionZoom In 50% Zooms in on the displayed data, halving the span of both axes.
Zoom Out 50% Zooms out of the displayed data, doubling the span of both axes.
-
8/12/2019 CitectSCADA Process Analyst
39/329
Chapter 4: Interacting with the Process Analyst 27
Undo Last Zoom Undo Last Zoom allows you to undo the last zoom operation, returning thedisplay to the previous state.
Toggle Box Zoom The Toggle Box Zoombutton switches between Box Zoom mode and normalinteraction mode. In Box Zoom mode, you can define an area of the chart tozoom in on for more detail.
To use Box Zoom:
1 Select the pen to zoom in on.
2 Click ToggleBox Zoomon the navigation toolbar.
The cursor changes to a cross.
3 Click and drag the bounding box to enclose the part of the data you want tozoom in on, as shown below.
4 Release the mouse button. The display changes to a close-up of the selecteddata.
5 To exit Zoom mode, click the Toggle Box Zoombutton.
Depending on whether the pens are locked or unlocked, the Toggle Box Zoomcommands works differently:
For locked pens, the zoom is applied to all pens in the horizontal date/timeaxes. If an analog pen is being zoomed, the zoom is applied to the vertical(value) axis of all non-autoscaled analog pens in the pane in which the zoom
box was initiated.
-
8/12/2019 CitectSCADA Process Analyst
40/329
Chapter 4: Interacting with the Process Analyst28
For unlocked pens, the zoom is applied only to the selected pen in both thedate/time and vertical (value) axes. The value axis is only affected ifautoscale is off.
Note: Vertical zoom is only applied to analog pens, since it has no effect withalarm or digital pens.
Edit Span Click the Edit Spanbutton to display the Edit Span dialog box, which allowsyou to set non-standard time spans.
To edit a time span:
1 Click Edit Spanon the navigation toolbar. The Edit Span dialog boxappears.
The fields provided are: w= weeks, d= days, hr= hours, min= minutes, sec= seconds, and ms= milliseconds.
2 Enter a New span. Click the element of the time span that you want tochange, then either type in a new value, or use the Up arrowor Down arrowto specify a new value. You can use the Right arrowand the Left arrowkeyto move between the time elements.
3 Click OK. The new time span is applied.
Edit Vertical Scale The Process Analyst allows Operators to edit the vertical scale of a selectedanalog pen to display more appropriate values, if required. The vertical scale for
digital or alarm pens cannot be edited.To edit the vertical scale:
1 Click Edit Vertical Scaleon the navigation toolbar. The Edit Vertical Scaledialog box appears.
-
8/12/2019 CitectSCADA Process Analyst
41/329
Chapter 4: Interacting with the Process Analyst 29
2 Click the Limitsor Engineering Scaleoption. The Limits values displayedare the current values used by the vertical scale. The Engineering Scalevalues are obtained from the trend tag.
3 Enter a new Minimumvalue and Maximumvalue, and then click OK.
Reset to Default Span Use the Reset to Default Spanbutton to reset the time span to the default timespan of the primary selected pen. The default span can be configured by usingthe Property dialog box. For details, see Configuring pen axes.
See Also Configuring DefaultsPen Selection
Using Cursors
A cursor enables an Operator to determine the value of a pen at a given point intime by dragging the cursor to the specific point on the pen line. A cursor labelisused to display the value.
-
8/12/2019 CitectSCADA Process Analyst
42/329
Chapter 4: Interacting with the Process Analyst30
An Operator can define many of the properties of cursors and cursor labels. Fordetails, see Configuring Cursors.
In this example the cursor intersects three pens; the cursor labels (the yellow
rectangles) display the corresponding pen values.
To move a cursor, drag the cursor line left or right. As the cursor moves, thecursor labels move with the cursor and are updated continuously, reflecting theposition of the cursor.
Note: The cursor extends across all configured panes.
A line connects the cursor label to the associated pen line. The line has threemain states:
State Style Example
Intersection within pen data Line
Intersection before or after pen
data
Line with indicator
No intersection and no data Invisible l ine
-
8/12/2019 CitectSCADA Process Analyst
43/329
Chapter 4: Interacting with the Process Analyst 31
To show/hide a cursor:
Click Show/Hide Cursoron the main toolbar. You can display additionalcursors by using the Properties dialog box.
You can display as many cursors as you want. To add a cursor, right-click theroot item (Process Analyst View) in the property tree in the Properties dialog
box, and choose Add Cursor.
Using Cursor Labels
Each cursor has one cursor label for each pen displayed. The cursor labeldisplays the value of the pen at the point where the cursor intersects with thepen data.
To display cursor labels:
Click Show/Hide Cursor Labelson the main toolbar.
This table summarizes how to use cursor labels:
The cursor label displays the following information:
The fields are displayed in the cursor label using the order defined above usingthe format specified for the vertical axis. For example, if your vertical axis formatis km/h, the label reads km/h.
Task Description
Move a cursor label Cl ick the cursor label and drag the label to a new locat ion.Change the size of cursor labels Click the cursor label you want to resize. Place the mouse cursor on one
of the sizing boxes, and drag the label to the new size. If you drag the
corner of the label, the label text resizes to an optimal size for the label.
Lock or unlock the cursor labels Click the Lock/Unlock Cursor Labels. When on, this command causes
cursor labels to be frozen in the position.
Cursor field Applies to Description
Pen Name All Pen types Displays the non-unique Process Analyst pen name
Value/Quality All Pen types Displays the value of the pen at the point the cursor intersects with the
pen data
Date-Time Stamp All Pen types Displays the date/time stamp at the point the cursor intersects with thedate/time axis.
Alarm Sample
Comment
Alarms Comment bound to an alarm sample.
-
8/12/2019 CitectSCADA Process Analyst
44/329
Chapter 4: Interacting with the Process Analyst32
The label displays the following values when the quality of the data is not good:
The label value can also contain a directional indicator that functions as follows:
Alarm label value
The alarm label value has the following format:
state[acknowledgement]
where staterefers to the alarm state at the point of intersection (see Alarm pens)and acknowledgementrefers to the acknowledged state of the alarm at the point ofintersection; i.e., Acknowledged or Unacknowledged.
Using the Right-click Menu
Use the right-click (context) menu to quickly access frequently used commands.
This menu is context-sensitive, providing relevant commands for differentregions of the display. The right-click menu appears when you click any of thefollowing regions:
Horizontal axis
Vertical axis
Background
Pen
The Propertiescommand is always available on the right-click menu; thiscommand displays the Properties dialog box. For details, see Using the ProcessAnalyst Properties Dialog Box.
Cursor value Description
NA At the point of intersection the pen has no available data for display.
Gated At the point of intersection the pens data has been gated.
Disabled At the point of intersection the alarm tag of the pen was disabled.
Cursor value Description
-> The cursor is to the left of the first available sample for this pen.
-
8/12/2019 CitectSCADA Process Analyst
45/329
Chapter 4: Interacting with the Process Analyst 33
Understanding Mouse Pointers
When using the Process Analyst, the mouse pointer changes shape to indicatethe operations you can perform at that time.
Adding and Deleting Pens
Pens can be added to (or removed from) any pane. The Process Analyst allowsOperators to search the trend tags and alarm tags that are defined on their trendand alarm servers and add pens that represent these tags to the current trenddisplay.
Mouse pointer Region Description
Pen line The mouse pointer looks like this when the pointer is on a pen. Clicking the
mouse at this point selects the pen.
Pen line/pen
background
The mouse pointer looks like this when the mouse is over a pens
background and both horizontal and vertical scrolling are enabled. Clicking
and dragging at this point results in the free movement of the pen. Scrolling
the mouse wheel results in horizontal-only movement.
Horizontal
axis
The mouse pointer looks like this when the pointer is on the horizontal axis
and horizontal scaling is enabled. Clicking and dragging (or scrolling the
mouse wheel) will result in the axis being scaled.
Pen line/pen
background
The mouse pointer looks like this when the pointer is on the horizontal axis
and only horizontal scrolling is enabled. Clicking and dragging (or scrolling
the mouse wheel) will result in the axis being scrolled.
Vertical axis The mouse pointer looks like this when the pointer is on the vertical axis
and vertical scaling is enabled. Clicking and dragging (or scrolling the
mouse wheel) will result in the axis being scaled.
Vertical axis The mouse pointer looks like this when the pointer is on the vertical axis
and only vertical scrolling is enabled. Clicking and dragging (or scrolling the
mouse wheel) will result in the axis being scrolled.
Box Zoommode
The mouse pointer looks like this when Box Zoom mode is enabled. SeeToggle Box Zoom.
-
8/12/2019 CitectSCADA Process Analyst
46/329
Chapter 4: Interacting with the Process Analyst34
Adding Pens You use the Add New Pens dialog box to add a new pen to your trend display.To display the Add Pens dialog box, click Add Penson the main toolbar.
To add a new pen:
1 Select the Typeof server you want to search: Trendsor Alarms.
2 Type in a Filterto apply to the search (optional).
If you leave the Filtertext box blank, all tags of the selected server type willbe retrieved. If you leave the Filtertext box blank, all tags of the selectedserver type will be retrieved. The filter has basic wildcard and Booleansearch functionality. You can use the keywords AND, OR and NOT withwildcard