Draw Honeywell

PlantScape

Display Building Guide

plntdspb.book Page i Monday, May 28, 2001 8:57 AM

ii

Notice

Hone

Other

SuppUnited

Document Release Issue Date

TC-DCXX31 R400 0 June 2001

plntdspb.book Page ii Monday, May 28, 2001 8:57 AMThis document contains Honeywell proprietary information. Information contained herein is to be used solely for the purpose submitted, and no part of this document or its contents shall be reproduced, published, or disclosed to a third party without the express permission of Honeywell Limited Australia.

While this information is presented in good faith and believed to be accurate, Honeywell disclaims the implied warranties of merchantability and fitness for a purpose and makes no express warranties except as may be stated in its written agreement with and for its customer.

In no event is Honeywell liable to anyone for any direct, special, or consequential damages. The information and specifications in this document are subject to change without notice.

Copyright 2001 Honeywell Limited Australia

ywell TrademarksPlantScape, SafeBrowse, TotalPlant and TDC 3000 are U.S. registered trademarks of Honeywell, Inc.

TrademarksMicrosoft, and SQL Server are either registered trademarks or trademarks of Microsoft Corporation in the United States and/or other countries.

Trademarks that appear in this document are used only to the benefit of the trademark owner, with no intention of trademark infringement.

ort and Other Contacts States and Canada

Contact: Honeywell IAC Solution Support Center

Phone: 1-800 822-7673. In Arizona: (602) 313-5558Calls are answered by dispatcher between 7:00 am and 5:00 pm Mountain Standard Time. Emergency calls outside normal working hours are received by an answering service and returned within one hour.

Facsimile: (602) 313-5476

Europe

Austra

Elsew

World

Train

Mail: Honeywell IAC TAC, MS1S116404 N. Black Canyon HighwayPhoenix, AZ 85023

Contact: Honeywell PACE TAC

Phone: +32-2-728-2657

Facsimile: +32-2-728-2278

plntdspb.book Page iii Monday, May 28, 2001 8:57 AMiii

lia, New Zealand, and Fiji

hereCall your nearest Honeywell office.

Wide WebHoneywell Industrial Automation and Control:

http://www.iac.honeywell.com

Honeywell TotalPlant Support Online:

http://support.totalplant.honeywell.com

ing ClassesHoneywell holds technical training classes on PlantScape. These classes are taught by experts in the field of process control systems. For more information about these classes, contact your Honeywell representative.

Mail: Honeywell PACE TACAvenue du Bourget, 1B-1140 Brussels, Belgium

Contact: Honeywell Global TAC Pacific

Phone: 1300-36-4822 (within Australia)+61-2-9353-7255 (outside Australia)

Facsimile: +61-2-9353-8804

Mail: Honeywell Global TAC Pacific5 Thomas Holt DriveNorth Ryde, NSW, 2113, Australia

Email [email protected]

iv

Related DocumentationFor a complete list of publications and documents for PlantScape, see the PlantScape Overview.

plntdspb.book Page iv Monday, May 28, 2001 8:57 AM

Contents

1 About This GuideBefore Reading This Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2How To Use This Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3

2

plntdspb.book Page v Monday, May 28, 2001 8:57 AMPlantScape Display Building Guide v

Getting StartedStarting Display Builder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6Using the Toolbars . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

Standard Toolbar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7Toolbox Toolbar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9View Toolbar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11Arrange Toolbar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12Format Toolbar. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

Basic Drawing Techniques . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16Setting the Defaults. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16Creating a Display Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17Selecting Display Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17Locking Display Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18Aligning Display Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19Distributing Display Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19Flipping Display Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19Moving A Display Object To The Front Or Back . . . . . . . . . . . . . . . . . . . 20Grouping Display Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20Resizing Display Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20Duplicating Display Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20Deleting Display Objects. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21Editing Display Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21Rotating Display Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21Moving Display Objects with the Arrow Keys. . . . . . . . . . . . . . . . . . . . . . 22Selecting Colors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22Undoing the Previous Action. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23

Using the Properties Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24Linking Display Objects to the Database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26Using Shapes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27

Shape Sequences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27Dynamic Shapes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29Using the Shape Gallery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30Registering Shape Folders . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31Using the Supplied Shape Library . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31

Using SafeBrowse. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32URL Formats. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32Linking to Displays from HTML Pages . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

Contents

vi

Inserting Graphics Created by Other Applications . . . . . . . . . . . . . . . . . . . . . . . . 34Pasting Text from Another Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35Setting the Displays Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36Working With Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38

Creating a New Display or Shape . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38Saving a New Display or Shape. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38Opening a File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40

3

plntdspb.book Page vi Monday, May 28, 2001 8:57 AM R400

Distributing And Validating Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41Checking the Validity of Point IDs in Remotely-built Files . . . . . . . . . . . . . 41Distributing Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41Exporting Numbered Displays. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42

Defining Display Object PropertiesAnimation Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44Appearance Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47Custom XY Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48Data Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49

Defining a Link To a Point . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49Defining a Link to a Database File. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50Using Local Display Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53

Details Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54ActiveX Document Object. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54Alarm Line Object. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55Alphanumeric Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56Chart Object. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58Checkbox Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59Combobox Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60Indicator Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61Pushbutton Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62SafeBrowse Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64Scrollbar Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64Text Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69

Font Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70General Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71Options Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73

Selecting the Type of Chart . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74Repeats Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75XY Plot Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78Understanding Acronyms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79

Selecting Default Acronyms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80Using Custom Acronyms. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80

Contents

4 Defining Display and Shape File PropertiesGeneral Tab for a Display . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86

Restricting Page Callup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87Keys Tab for a Display . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88Callup Task Tab for a Display . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89Periodic Task Tab for a Display. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90Help Tab for a Display . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92

5

plntdspb.book Page vii Monday, May 28, 2001 8:57 AMPlantScape Display Building Guide vii

Assigning a HTML Help Topic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92Assigning a Document . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93

General Tab for a Shape File. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95

Writing ScriptsUnderstanding the Station Automation Object Model . . . . . . . . . . . . . . . . . . . . . 98Understanding Scripts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101

Using General Scripts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102Referencing Objects, Properties and Methods. . . . . . . . . . . . . . . . . . . . . . 102Using the Dictionary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104Writing Scripts for Shapes and Shapelinks . . . . . . . . . . . . . . . . . . . . . . . . 104Event Handling in Groups and Shapes. . . . . . . . . . . . . . . . . . . . . . . . . . . 105Using Timers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105

Using the Script Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106Writing Scripts for Displays and Shape files . . . . . . . . . . . . . . . . . . . . . . . 106Writing Scripts for Station . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107Debugging Scripts. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108

Understanding the Possibilities of Automation . . . . . . . . . . . . . . . . . . . . . . . . . . 110Object Model Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112

Application Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113AppWindow Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117Dictionary Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119Display Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121Objects Collection. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129Page Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131

Methods. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133Add Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134AddListItem Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135BeginCriticalSection Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136Blue Method. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137CancelChange Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138CancelClick Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139CancelDoubleClick Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140CancelNavigate Method. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141CancelOperatorCommand Method. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142

Contents

viii

Clear Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143CreateTimer Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144DPToLPX and DPToLPY Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146EndCriticalSection Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147ExecuteOperatorCommand Method. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148GetResponse Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149GoBack Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150

plntdspb.book Page viii Monday, May 28, 2001 8:57 AM R400

GoForward Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151GoHome Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152GoSearch Method. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153Green Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154InvokeMenu Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155Item Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156KillTimer Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157LPToDPX and LPToDPY Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158MakeColor Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159OpenHelp Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160Quit Method. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161Red Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162Redraw Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163Refresh Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164Remove Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165RemoveListItem Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166RequestServerLRN Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167SelectText Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168SetFocus Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169Shell Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170Sleep Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171Stop Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172Update Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173UserObjectNotify Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174

Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175OnAlarm Event. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176OnAppStartup Event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177OnBeginNavigate Event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178OnChange Event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179OnClick Event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181OnConnect Event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182OnDisconnect Event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183OnDoubleClick Event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184OnDownloadBegin Event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185OnDownloadComplete Event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186OnFocus Event. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187

Contents

OnLoad Event. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188OnMenu Event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189OnMouseEnter Event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190OnMouseLeave Event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191OnMouseMove Event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192OnNavigateComplete Event. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193OnOperatorChange Event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194

6

plntdspb.book Page ix Monday, May 28, 2001 8:57 AMPlantScape Display Building Guide ix

OnOperatorCommand Event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195OnPageComplete Event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 196OnPageLoad Event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197OnPeriodicUpdate Event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198OnQuit Event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199OnRightClick Event. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200OnTimer Event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201OnUnload Event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202OnUpdate Event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203OnUserObjectNotify Event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204

Understanding Coordinates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205Understanding Mouse Coordinates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205Converting Between Logical and Display Coordinates . . . . . . . . . . . . . . . 205

Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 206Animation Using a Shape Sequence. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 206Color Animation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207Adding Tool Tips . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 208Controlling Station from Another Application . . . . . . . . . . . . . . . . . . . . . . 209Controlling Another Application from Station . . . . . . . . . . . . . . . . . . . . . . 209Using Custom Dialog Boxes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210Using the Document Property . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 216

Guidelines for Creating User-friendly DisplaysGeneral Standards . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 218

Title Bar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219Alphanumeric Data Fields and Labels . . . . . . . . . . . . . . . . . . . . . . . . . . . 220Pushbuttons and Hyperlinks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221Comboboxes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222Checkboxes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222Group Headings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223Icons . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 224Faceplates and LEDs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 225

Further Reading . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 226

Contents

x

7 TutorialSetting up the Drawing Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 228Drawing the Objects. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229

Saving the Display . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 238

8 Reference InformationKeyboard Shortcuts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 240

GlossIndex

plntdspb.book Page x Monday, May 28, 2001 8:57 AM R400

Using the Shortcut Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241Point Detail Displays . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 242Exporting System Displays . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 245Using Display Builders Command-Line Parameters . . . . . . . . . . . . . . . . . . . . . . 246Using DisplayInfo. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 247Creating Shapes for Early Versions of Old Products . . . . . . . . . . . . . . . . . . . . . . 248

Drawing Shape Sequences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 248Creating a New Numbered Shape . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 249

ary

1 About This GuideThis Guide describes how to use Display Builder to create custom displays for your PlantScape system.

This Guide: Introduces you to the basic concepts behind Display Builder Describes how to create displays and link them to points in the server

database

plntdspb.book Page 1 Monday, May 28, 2001 8:57 AMPlantScape Display Building Guide 1

Describes how to write scriptsmini programsthat increase the functionality of your displays

Provides guidelines for creating user-friendly displays

Note This version of Display Builder creates displays with a proprietary DSP format. If you want to create Web-based displays, see the HMIWeb Display Building Guide.

1 About This Guide

2

Before Reading This GuideThis Guide assumes that you are familiar with the PlantScape server database, so that when creating custom displays, you can link display objects to appropriate points within that database.

You should also be familiar with the standard displays that come with Station, and understand their capabilities and limitations.

plntdspb.book Page 2 Monday, May 28, 2001 8:57 AMR400

Pre-Requisite SkillsThis Guide assumes that you have some knowledge of Microsoft Windows, and understand phrases such as double-clicking and dragging.

How To Use This Guide

How To Use This GuideThis guide is structured as follows: Getting Started introduces you to Display Builder, and describes how to use

the drawing tools. Defining Display Object Properties describes how to configure the

characteristics of display objects, including linking them to the database. Defining Display and Shape File Properties describes how to specify the


characteristics of display and shape files. Writing Scripts describes how to add extra functionality to displays with

scripts. Guidelines for Creating User-friendly Displays provides guidelines and tips. Tutorial provides step-by-step instructions that show you how to create a

simple display. Reference Information covers miscellaneous topics, such as keyboard

shortcuts and migrating displays from older products.

1 About This Guide

4


2 Getting StartedCustom displays work in the same way as the standard displays supplied with PlantScape. However, custom displays allow you to present information in a more sophisticated and user-friendly manner. As a consequence, custom displays make it easier for operators to visualize complex processes, and reduce the probability of operator errors.


2 Getting Started

6

Starting Display BuilderTo start Display Builder from the Start menu if you are on the server, select Start Programs PlantScape Server Display Builder.

To start Display Builder from the Start menu on any other computer, select Start Programs PlantScape Client Software Display Builder.

When Display Builder starts, you see what at first appears to be a standard


drawing application, with several toolbars and a blank drawing. At its simplest level, this is true because you draw display objects, such as rectangles and pushbuttons, in much the same way as you do in a standard drawing application.

The big difference, however, is that you can animate display objects in a number of ways. For example, you can link an alphanumeric display object to a point in the server database, so that it displays the points value. You can also make a display interactive by adding controls such as pushbuttons and checkboxes.

Figure 2.1 Layout of Display Builder

Using the Toolbars

Using the ToolbarsThe toolbars provide speedy access to many of Display Builders functions.

To display (or hide) a toolbar:1 Select View Toolbars to see the list of toolbars.

Stan


Tip A tick opposite a toolbar indicates that it is already visible.2 Select the toolbar you want to display (or hide).3 If appropriate, drag the toolbar to a convenient location. For example if you

have a large screen, it is a good idea to reserve one part of the screen for the display you are creating and another part for the toolbarsthat way, they never obscure your work. (If you drag a toolbar to the edge of the Display Builder window, they will dock to the edge, and effectively become part of it.)

dard ToolbarThe Standard toolbar includes basic Windows-related buttons such as Open and Save.

Figure 2.2 Toolbars Menu

Figure 2.3 Standard Toolbar

2 Getting Started

8

Button Description

Display/Shape. Creates a new display or shape. Click the arrow to the right to display the list:

Display. Creates a new display.

Shape Sequence. Creates a new shape sequence. See Using Shapes on page 27.


Dynamic Shape. Creates a new dynamic shape. See Using Shapes on page 27.

Open. Opens an existing display.

Save. Saves the display.

Print. Prints the display.

Cut. Removes the selected object(s) from the display (and copies them to the clipboard).

Copy. Copies the selected object(s) to the clipboard.

Paste. Pastes the clipboards contents into the display.

Duplicate. Makes duplicates of the selected object(s).

Find. Finds an object by its name (as shown in the Name property of the Properties window).

Undo. Undoes the previous action.

Help. Displays the Help for Display Builder.

Using the Toolbars

Toolbox ToolbarThe Toolbox toolbar contains two types of buttons: Editing Buttons, which you use to edit existing objects. Object Creation Buttons, which you use to create display objects. For

example, if you want to draw a rectangle, you click Rectangle.

Editin

Obje


g Buttons

ct Creation Buttons

Figure 2.4 Toolbox Toolbar

Button Description

Pointer. Selects, moves and resizes display objects.

Zoomer. Zooms in and of your display. To zoom in on a part of your display, first click Zoomer and then click the area of interest. You can zoom in further by clicking repeatedly.

To zoom out, hold down and click.

Rotator. Rotates the selected rotatable object (Windows NT only). See Rotating Display Objects on page 21.

Button Description

Text. Creates text, such as the displays title.

Line. Creates a straight line.

Freehand Line. Creates a freehand line which follows the path you trace with the cursor.

2 Getting Started

10

Rectangle. Creates a rectangle or square.

Rounded Rectangle. Creates a rectangle or square with rounded corners.

Oval. Creates an oval or circle.

Button Description


Polyline. Creates a multi-segment line (which are similar to polygons, but with one open side).

To create a polyline, you click to mark each apex, except for the last. You mark the last apex by double-clicking.

Polygon. Creates a polygon.

To create a polygon, you click to mark each apex, except for the last. You mark the last apex by double-clicking, which then closes the polygon.

Arc. Creates an arc (a quarter of an oval or circle).

Wedge. Creates a segment (quarter) of an oval or a circle.

Video. Creates a window for viewing video information.

(To display a video in Station, the computer requires a Microsoft Media (MCI) compliant video overlay card. If there is no video card, the video object appears as a colored rectangle.)

For information on setting up video overlay devices, see the Installation Guide.

SafeBrowse. Creates a window for viewing a SafeBrowse object. (A SafeBrowse object is a Web browser specifically designed for use with Station. See Using SafeBrowse on page 32.)

ActiveX Document. Creates a window for viewing an ActiveX document. (This is any ActiveX-compliant document, such as a Microsoft Excel spreadsheet or a Microsoft Word document.)

Alphanumeric. Used to display database values in many different formats.

Pushbutton. Creates a pushbutton that users can click in an interactive display. When clicked the specified command is performed.

Using the Toolbars

View

Checkbox. Creates a checkbox so that users can select or deselect an option in an interactive display.

Combobox. Creates a combobox so that users can select from a list of options in an interactive display.

Chart. Creates a chart (graph) that shows changes in values over time.

Button Description


ToolbarThe View toolbar includes a range of editing buttons.

Scrollbar. Creates a scrollbar that users can operate in an interactive display. See Understanding Scrollbars on page 65.

Indicator. Creates a gauge that indicates relative values. (Similar in principal to a cars fuel gauge.)

Alarm Line. Used to display alarm messages, delay or event conditions.

Figure 2.5 View Toolbar

Button Description

Rulers. Shows/hides the rulers. The rulers make it easier to arrange display objects in a neat and consistent manner. See Setting the Displays Options on page 36.

Grid. Shows/hides the grid. The grid makes it easier to arrange display objects in a neat and consistent manner. See Setting the Displays Options on page 36.

Snap-to-Grid. Turns the snap-to-grid function on/off. When snap-to-grid is active, objects automatically align to the grid when you create, move or resize them.

2 Getting Started

12

Arra

Properties Window. Opens/closes the Properties window. You use the Properties Window to edit the characteristics of the selected object(s). See Using the Properties Window on page 24.

Script Window. Opens/closes the Script window. You use the Script Window to write scriptsa script is a mini-program that performs a specific task. See Using the Script Window on page 106.

Scripts enable you to increase the sophistication of your displays, and

Button Description


nge ToolbarThe Arrange toolbar contains buttons for aligning and grouping display objects.

can vary widely in functionality and complexity. Anyone with minimal programming skills can write simple scripts. Scripts are described in detail in Writing Scripts on page 97.

Shape Gallery. Opens/closes the Shape Gallery. The Shape Gallery makes it easy to preview and add pre-built shapes to your displays. See Using the Shape Gallery on page 30.

Figure 2.6 Arrange Toolbar

Button Description

Bring To Front. Moves the selected object(s) to the front so that it is not obscured by overlapping objects.

Send To Back. Moves the selected object(s) to the back where it is obscured by overlapping objects.

See Moving A Display Object To The Front Or Back on page 20.

Group. Groups the selected objects so that they become one object. If necessary, you can nest grouped objects to create even more complex display objects.

Ungroup. Splits a grouped object into its component objects.

See Grouping Display Objects on page 20.

Using the Toolbars

Align Left. Moves the selected objects horizontally so that they are all aligned to the left.

Align Center. Moves the selected objects horizontally so that their centers are aligned.

Align Right. Moves the selected objects horizontally so that they are all aligned to the right.

Align to Page Center. Moves the selected objects so that they are

Button Description


centered on an imaginary line that runs vertically through the center of the display.

See Aligning Display Objects on page 19.

Align Top. Moves the selected objects vertically so that they are all aligned at the top edge.

Align Middle. Moves the selected objects vertically so their centers are aligned.

Align Bottom. Moves the selected objects vertically so that they are all aligned at the bottom edge.

Align to Page Middle. Moves the selected objects horizontally so that they are centered on an imaginary line that runs horizontally through the center of the display.

See Aligning Display Objects on page 19.

Even Horizontal Spacing. Moves the selected objects (except the outer two) horizontally so that they are spaced evenly. For example, if you select three objects, the inner one will move left or right so that is centered between the two outer ones.

Even Vertical Spacing. Moves the selected objects (except the top and bottom ones) vertically so that they are spaced evenly. For example, if you select three objects, the inner one will move up or down so that is centered between the top and bottom ones.

See Distributing Display Objects on page 19.

Flip Horizontal. Flips the selected objects horizontally (as in a mirror image).

Flip Vertical. Flips the selected objects vertically.

Rotate Left. Rotates the selected objects 90 degrees clockwise.(Only available on Windows NT.)

Rotate Right. Rotates the selected objects 90 degrees anti-clockwise. (Only available on Windows NT.)

See Flipping Display Objects on page 19.

2 Getting Started

14

Format ToolbarThe Format toolbar contains buttons for controlling the appearance of display

Lock Objects Toggle. Locks/unlocks an object. Locking an object protects it from being accidently moved or resized. See Locking Display Objects on page 18.

Button Description


objects.

You can use Format buttons in two ways: If you click a button while one or more objects are selected, it only affects

the appearance of selected object(s). If you click a button while no object is selected, you change the displays

default value (standard value), which is then used whenever you create new objects in that display. See Setting the Defaults on page 16.

Figure 2.7 Format Toolbar

Button Description

Font. Sets the font of text. Note that you should only use fonts that are loaded on every Station computer.

Font Size. Sets the size of text.

Bold, Italic and Underline. Change the texts appearance.

Using the Toolbars

Justify Left, Justify Center and Justify Right. Align lines of text within a paragraph.

Line Color. Sets the line color of objects. When you click the button, a

Button Description


palette opens from which you select the color. See Selecting Colors on page 22.

Fill Color. Sets the fill color of objects. When you click the button, a palette opens from which you select the color. See Selecting Colors on page 22.

Line Style. Sets the line thickness.

Arrows. Sets the line-end style, such as arrows.

Effects. Sets the 3D effects of objects.

2 Getting Started

16

Basic Drawing TechniquesThis section describes basic drawing techniques. Note that techniques are similar to those used in other Windows-based drawing and paint programs.

Tip You can access many commands using keyboard shortcutssee Keyboard Shortcuts on page 240. You can also access many commands from the shortcut menusee Using the Shortcut Menu on page 241.

Setti


ng the DefaultsWhen drawing objects, you generally want most of them to have similar characteristics, such as color, line thickness and font. The easiest way of ensuring such uniformity is to set the default values, which Display Builder then uses when you draw each new object.

Most toolbar buttons show their default settings. For example, if the default text size has been set to 12 points, 12 appears in Font Size.

For example, to set the default colors to red line and yellow fill:1 Make sure no object is selected. (If an object is selected, click a blank part

of the display, or select Edit Deselect All.)2 Click Line Color to open the color palette.

3 Click the red box.

Tip The box sets the color to the displays background color, and the box sets the color to transparent.

Figure 2.8 The Color Palette

Basic Drawing Techniques

4 Click Fill Color to open the color palette again.5 Click the yellow box.

Note A display object that is linked to the database can only use sixteen colors, these being: white, gray, black, red, green, cyan, blue, magenta and yellow and their low-intensity equivalents. If you select a non-standard color, the nearest standard color will be used.

Creating a Display Object

Sele


To create a display object:1 Click the appropriate button on Toolbox toolbar.2 Drag the cursor diagonally over the display, and release the mouse button

when the dotted outline rectangle is the correct size and shape.

Tip To create a square/round display object, hold down while dragging.

cting Display ObjectsWhen you select an object, a set of eight selection handles appears around the objects boundary. Having selected an object you manipulate it as required.

Figure 2.9 A Selected Display Object

To select: Do this:

One object Click it.

Several objects Hold down and click each object.

Several objects, which are generally close together

Drag the mouse cursor diagonally across the objects. This selects any object that falls entirely within the selection rectangle which appears while dragging.

2 Getting Started

18

Dese

Lock

One object from a stack of objects

Hold down and click repeatedly until the object you want is selected. Each time you click, the next object in the stack (starting from the top) is selected.

Do not click too quicklyif you do, your action will be interpreted as a double-click.

All objects Select Edit Select All.

All objects linked to the Select Edit Select Dynamic.

To select: Do this:


lecting Display Objects

ing Display ObjectsLocking objects in place prevents them from being accidently moved or modified with the mouse. (You can still move and resize locked objects by editing their size and position properties in the Properties window.)

To lock an object:1 Select the object.2 Click Lock Objects. Note how the selection handles turn grey to indicate

that the object is locked.

database (dynamic objects)

All objects not linked to the database (static objects)

Select Edit Select Static.

No object Click a blank part of the display, or select Edit Deselect All.

To deselect: Do this:

All objects Click a blank part of the display. (If an object, such as a background bitmap, covers the entire display, select Edit Deselect All.)

One or more objects from a group of selected objects

Hold down and click each object you want to deselect.


Alig

Dist

Flipp

Figure 2.10 The Selection Handles of a Locked Object


Note To unlock a locked object, select it and then click Lock Objects a second time.

ning Display ObjectsTo align two or more display objects:1 Select the display objects you want to align.2 Click the appropriate Align button on the Arrange toolbar. For example, if

you want the left sides of the objects to be in line, click Align Left.See Arrange Toolbar on page 12 for a description of each of the Arrange buttons.

ributing Display ObjectsTo distribute three or more display objects:1 Select the display objects you want to distribute.2 Click Even Horizontal Spacing or Even Vertical Spacing on the Arrange

toolbar.

ing Display ObjectsTo flip one or more display objects:1 Select the display objects you want to flip.2 Click the appropriate Flip button on the Arrange toolbar. For example, if

you want to create a mirror-image, click Flip Horizontal.

Tip If you want to flip the objects on their sides, click Rotate Left or Rotate Right (only available on Windows NT).

2 Getting Started

20

Moving A Display Object To The Front Or BackWhen display objects overlap, you may need to change the order in which they are stacked on top of each other, so that one object doesnt obscure another.

To move display object(s) to the front or back of the stack:1 Select the display objects you want move.2 Click Bring to Front or Send to Back on the Arrange toolbar.

Grou

Resi

Dup


ping Display ObjectsYou can create a complex display object by creating a number of simple objects, arranging them in an appropriate manner and then grouping them. If appropriate, you can nest grouped objects to create even more complex display objects.

To group two or more display objects:1 Select the display objects you want group.2 Click Group on the Arrange toolbar.

To ungroup a grouped object, select it and then click Ungroup.

zing Display ObjectsTo resize one or more display objects:1 Select the object(s). Their selection handles appear.2 Drag one of the selection handles as required. The objects are resized as

you drag.

Tip If you want to retain the object proportions, hold down and drag a corner handle.

licating Display ObjectsTo make duplicate copies of one or more display objects:1 Select the display object(s) you want to duplicate.2 Select Edit Duplicate. A copy of the selected object(s) appears near the

centre of the display.


Deleting Display ObjectsTo delete one or more display objects:1 Select the display object(s) you want to delete.2 Select Edit Delete. (Alternatively, press .)

Editing Display Objects

Rota


You edit display objects by selecting them and then making the appropriate changes in the Properties window.

For example, to change the font of one or more alphanumerics to 12 point, bold:1 Select the alphanumeric(s).2 If necessary, open the Properties window by clicking Properties Window

on the View toolbar.3 Click the Font tab.4 Select 12 from the Size property.5 Select Bold from the Font style property.

For more information about the Properties window, see Using the Properties Window on page 24.

ting Display ObjectsIf you use Windows NT on both the computer used to create displays, and on every computer that runs Station, you can rotate the following types of display objects. You can also rotate a group if all objects in the group are rotatable.

Note: You cannot rotate a shapelink if the associated shape contains any dynamic

objects. (Shapelinks are described in Using Shapes on page 27.)

Arc Metafile Rectangle JPEG

Bitmap Oval Rounded Rectangle TGA

Freehand Line Polygon Text

Line Polyline Wedge

2 Getting Started

22

If someone views a display containing rotated objects on a Station which is not running on Windows NT, the objects will revert to their non-rotated state.

To rotate an object:1 Click Rotator on the Toolbox toolbar.2 Click the object you want to rotate.

Four rotation handles appear, as well as a rotation markerthis indicates the point about which the object rotates.

Mov

Sele


3 If you want to rotate the object about a specific point, drag the rotation marker to that pointthe point can even be outside the object.

4 Drag one of the rotation handles clockwise or anticlockwise. As you drag the handle, the object rotates about the rotation marker.

ing Display Objects with the Arrow KeysIf you want to move an object a small distancea technique called nudging you may find it easier to use the arrow keys than to use the mouse. Each time you press an arrow key, the selected object(s) move a few pixels in the direction of the arrow. If you hold down an arrow key, the selected object(s) move slowly in the direction of the arrow.

cting ColorsTo select the line or fill color for the selected objects:1 Click Line Color or Fill Color, as appropriate to open the color palette.2 Click the appropriate color in the palette.3 Alternatively, if you want to:

Select a custom color, see Selecting a Custom Color on page 23. Remove the color, so that the line or fill becomes transparent, click the

box.

Figure 2.11 The Rotation Marker and Rotation Handles


Make the color the same as the displays background color, click the box.

Selecting a Custom ColorTo select a custom line or fill or line color for the selected objects:1 Click Line Color or Fill Color, as appropriate to open the color palette.2 Click Other to open the Color dialog box.

Und


3 Click the point in the color spectrum box that has the color you want.

Tip There are two other ways of selecting a color. Either, enter the HSV or RGB values in the appropriate fields, or drag the Color marker (the x in the color spectrum box) and the Saturation marker on the Saturation scrollbar.4 Click Add to Custom Colors so that the color appears in the next available

Custom colors box.5 Click the custom color you have just created and then click OK.

oing the Previous ActionWhen creating a display, it is very easy to make mistakes. If you realize your mistake immediately after making it, select Edit Undo to undo your last action. (Alternatively, press +.)

Figure 2.12 The Color Dialog Box

2 Getting Started

24

Using the Properties WindowYou use the Properties window to view and edit the properties of the selected display objects. (The properties include physical characteristics, such as color and size, as well as database link details.)

You also use the Properties window to view and edit the displays propertiesthese appear when no display objects are selected.


The Properties window changes whenever you select another object. In the following figure, the left-hand example shows the window when you select an alphanumeric, whereas the right-hand example shows the window when you select a chart.

The Properties window is modeless, which means that the selected object(s) change as soon as you change a propertys value. (Unlike a standard dialog box, you do not have to click an OK button.)

Properties are grouped according to the tabs that run across the top of the window. The following examples show how the window changes as you click the tabs.

Figure 2.13 Selecting a Tab Changes the Properties Window

Using the Properties Window


The Properties window also changes if you: Select several display objects of the same type. Any properties whose values

are not identical are blanked or grayed out. For example, Name in the General tab will be blank because each object has a unique name.If you edit a property, you change all selected objectsfor example, if you change Fill Color to red, they will all turn red.

Select display objects of various types, such as a pushbutton and an alphanumeric. In this case, the window only displays tabs that are shared by all selected objects. For example, if you selected an alphanumeric and a pushbutton, you could change the properties on the Font tab because both objects contain text.

Deselect all objects. The Properties window then shows the displays properties, and its title changes to Display Properties.

For a description of each property, see: Defining Display Object Properties on page 43 Defining Display and Shape File Properties on page 85

Figure 2.14 Properties are Grouped According to Tab

2 Getting Started

26

Linking Display Objects to the DatabaseA major feature of Display Builder that distinguishes it from a standard drawing application is its ability to link display objects to the server database. Some types of display object, such as alphanumerics and indicators, are specifically designed for displaying database information.

You can link most types of display object to either a point parameter (such as the points value) or to a database file, whose contents are controlled by an


application. For more information about linking objects to the database, see Defining Display Object Properties on page 43.

Note A display can have up to 300 database links.

Using Shapes

Using ShapesA shape is a special display object that speeds up drawing tasks and makes your displays visually consistent. Shapes are stored in special files called shape files.

Having created a shape, it can be used as many times as necessary (including multiple times into the same display). To insert a shape into a display, you insert a shapelink that includes a link to the shape. The shapelink also controls the size and position of the shape in the display. (Because shapes are linked to displays,

Shap

Using


updating a shape files attributes, other than size, automatically updates all displays linked to that shape.)

There are two types of shapes: Shape Sequences and Dynamic Shapes.

e SequencesA shape sequence consists of a set of shapes that can be used as either a status indicator, or as a simple animation.

Note A shape sequence cannot contain any dynamic display objects, such as alphanumerics.

a Shape Sequence as a Status IndicatorThe following figure shows a shape sequence representing traffic light statuses.

When used in a display, the status of the associated point determines which of the three shapes appears in the display. For, example, when the status is 0 (Stop) the red hexagon appears; and when the status changes to 1, the hexagon disappears and amber triangle appears.

Figure 2.15 A Shape Sequence

Red Amber Green

2 Getting Started

28

Using

Creat

Display fileShapelink

Amber


a Shape Sequence for an AnimationA shape sequence can also be used in conjunction with a script to produce a simple animationin this case, each shape represents a separate frame in the animation. For an example of a simple animation, see Animation Using a Shape Sequence on page 206.

ing a Shape SequenceTo create a shape sequence:1 Select File New Shape Sequence to open a new display.2 Draw the shapes as required.

NotesThe following rules and restrictions apply to shape sequences: If a shape consists of more than one display object, it must be grouped. They cannot contain dynamic display objectsthat is, display objects that

are linked to the database, such as alphanumerics and comboboxes. If the shape sequence is to be used as a status indicator, you must create a

separate shape for each state.

Figure 2.16 Linking to a Shape Sequence

Shape file

Red Amber Green

Using Shapes

You must also arrange the shapes (left-to-right/top-to-bottom) in the appropriate order. In the case of a status indicator, the top-left shape corresponds to 0, the next shape corresponds to 1, and so on. In the case of an animation, the top-left shape represents the first frame, and so on.

Inserting a Shape Sequence into a DisplayTo insert a shape sequence into a display:1 Select Edit Insert Shapelink to open the Insert Shapelink dialog box.

Dyn

Crea


2 Select the required shape file from the list of files. (If you click at the top of the dialog box and then click at the bottom, the shapes in the selected file are displayed sequentially.)

Tip Alternatively, drag a shape from the Shape Gallery and drop it directly into the display. See Using the Shape Gallery on page 30.3 Move and resize the shapelink as required.4 Open the Properties window and click the Data tab.5 Enter the database link details. (If you are linking to a particular point

parameter, select Point/Parameter from Type of database link, and then enter the appropriate point and parameter details.)

6 Click the Animation tab and select Shape Sequence from Type of animation.

7 Enter the number of shapes you want to use in Number of shapes. (A shape file may contain more shapes than is required for a particular point/parameter. If, for example, there are only four states but the shape file contains eight shapes, type 4 to use the first four shapes.)

amic ShapesA dynamic shape can contain dynamic objects, such as alphanumerics, that are designed to be linked to the database.

For example, you could create a pump with an alphanumeric to display the flow rate. Each time you use this pump in a display, you assign the appropriate point/parameter to the alphanumeric.

Note A dynamic shape file can contain only one shape.

ting a Dynamic ShapeTo create a dynamic shape:1 Select File New Dynamic Shape to open a new display.2 Draw the shape.

2 Getting Started

30

Tip Remember to group all objects.

Linking to a Dynamic ShapeTo add to a dynamic shape to a display:1 Select Edit Insert Shapelink to open the Insert Shapelink dialog box.2 Select the required shape file from the list of files. (If you click at the top

of the dialog box and then click at the bottom, the shapes in the selected file are displayed sequentially.)

Usin


Tip Alternatively, drag a shape from the Shape Gallery and drop it directly into the display. See Using the Shape Gallery on page 30.3 Move and resize the shapelink as required.4 Open the Properties window and click the Data tab.5 Specify the appropriate point and parameter details for each object. (Every

object in the dynamic shape is listed.)

g the Shape GalleryThe Shape Gallery makes it easy to preview and add pre-built shapes to your displays. To open the Shape Gallery, click Shape Gallery in the View toolbar.

Note You can only open the Shape Gallery if at least one display is open.

To preview a set of shapes:1 Select the appropriate folder in the left-hand pane. A one-line summary of

each shape appears in the right-hand pane.

Figure 2.17 The Shape Gallery

Using Shapes

2 If you want to preview each shape, click .3 In you want to preview individual shapes in a shape sequence (No of

shapes is 2 or more), double-click it. (Alternatively, select the shape and click .)

To insert a shape into a display:1 Drag it from the list and drop it into the display.

Reg

Usin


istering Shape FoldersIf your displays include shapes that are not in the same folder as the displays, you must register those folders in the Shapelink Search Paths window. (If you dont do this, Display Builder will replace any shapes with place-markers the next time you open a display.)

To register the folders:1 Select View Shapelink Search Paths to open the Shapelink Search

Paths window.2 Click to add a blank line to the list.3 Either type the folders full path, or click and browse for the folder.4 If necessary, use and to rearrange the order of folders in the list.

(Display Builder searches through the folders in the order listed.)

g the Supplied Shape LibraryDisplay Builder is supplied with a library of pre-built shapes that you can include in your displays. These shapes are stored in \ShapeLib, and are organized into sub-folders according to subject. (The \examples folder contains some example displays built using the shape library.)

2 Getting Started

32

Using SafeBrowseA SafeBrowse object is a Web browser specifically designed for use with Station.

SafeBrowse includes appropriate security features that prevent users from calling up unauthorized Web pages or other documents in Station. For details about restricting access, see the Configuration Guide.

URL

Exam


FormatsThe general format for the URL (Uniform Resource Locator) of a SafeBrowse object is:

Protocol://ResourceName

ple The URL for a HTML file called procedure.htm, either:

file://c:\procs\procedure.htmor

c:\procs\procedure.htm

The URL for a Web address:

http://www.ourwebsite.com

The URL for a Word file called sp.doc:

file://c:\procs\sp.doc

Part Description

Protocol The protocol, which can be either http, ftp, gopher, or file.

The default protocol is file. If the protocol is not specified, Station assumes that the URL refers to a file, either on the Station computer or on the network.

ResourceName The resource address or identifier, such as a file or Web address. If the extension is not specified, Station assumes that it is a display file.

Using SafeBrowse

Linking to Displays from HTML PagesIf you create full-page HTML files for Station users, you can include hypertext links to displaysthe specified display is called up when a user clicks a link. (A HTML file is displayed in full-page mode when a user calls it up from the Command Zone.)

The protocol for inserting a link to a display is http://station/. For example, to add a link to a display called pumps.dsp:

Pump Summary


Note You cannot call up a display if the HTML page is displayed within a SafeBrowse object.

2 Getting Started

34

Inserting Graphics Created by Other ApplicationsInserting suitable graphics, such as digitized photographs or schematic drawings, can enhance your displays.

Note Inserting graphicsespecially large onesmay affect Stations performance when the display is called up by an operator.

Display Builder supports the following graphic formats:


Windows Bitmap (*.bmp) JPEG (*.jpg) Targa (*.tga) Metafile (*.wmf) Enhanced Metafile (*.emf)

To insert a graphic:1 Select Edit Insert Picture to open the Insert Picture dialog box.2 Select the graphic file you want to insert. If necessary, browse for the file,

restrict the list to the appropriate file type and preview the graphic in the right-hand box.

3 Move, resize and group the graphic, like any other display object.

Tip You can also paste a graphic from the clipboard. To do this, create your graphic in a suitable application, copy it to the clipboard and then paste it into your display.

Pasting Text from Another Application

Pasting Text from Another ApplicationYou can paste text into your displays from other applications. For example, if you want to include a large block of text in your display, you may find it easier to compose it in a text editor or word processor.

Note The characteristics of pasted text vary according to the application in which it was written. For example, if you select several paragraphs from Microsoft Word, they are pasted into your display as a metafile (a type of


graphic) which retains the original layout. However, if you select several paragraphs from Windows Notepad, each paragraph is pasted into your display as a separate text object, without word wrapping.

To paste text into a display:1 Start Display Builder and open the display in which you want to paste the

text.2 Start the text editor or word processor and write the text.3 Select the text.4 Use the applications Copy function to copy the text to the clipboard.5 Select Display Builder, so that it is the active application.6 Select Edit Paste.7 Move, resize and group the text, like any other display object.

2 Getting Started

36

Setting the Displays OptionsA display has a number of options that make display creation easier.

To set a displays options:1 Select View Options to open the Options dialog box.


2 Set the options as required.

Figure 2.18 The Options Dialog Box

Option Description

Grid settings Specifies the spacing, style and color or grid lines.

The spacing is based on the displays logical coordinates, which range from 0, 0 (top, left) to 7999, 4399 (bottom, right). The default spacing is 100 units.

For more information about logical coordinates, see Understanding Coordinates on page 205.

Page background color Sets the displays background color in Display Builder. Note that this does not affect the display when viewed in Station.

Show rulers Shows/hides the rulers. Note that you can change this by clicking Rulers on the View toolbar.

Show grid Shows/hides the grid. Note that you can change this setting by clicking Grid on the View toolbar.

Setting the Displays Options

Align objects to grid When selected objects automatically align to grid lines when you create, move or resize them. Note that you can change this setting by clicking Snap-to-Grid on the View toolbar.

Option Description


2 Getting Started

38

Working With FilesIn Display Builder, you create, save and open files in a similar manner to any other Windows-based application. This section, however, covers details that are specific to Display Builder files.

Display Builder uses a .dsp extension for displays and shape files.

Crea

Defin

Savi


ting a New Display or ShapeTo create a new display or shape, select File New and then the appropriate type of file. A blank display appears.

Note You cannot change the files type after creating it. For example, you cannot change a shape sequence into a dynamic shape.

ing the Displays PropertiesYou must define the files properties, such as its title and type. For details, see Defining Display and Shape File Properties on page 85.

ng a New Display or ShapeWhen you save a display or shape for the first time, you specify:

Item Description

File name The displays name or number. See Named Versus Numbered Displays on page 39.

Save as type The displays format. (By default, Display Builder uses the current format.)

You only need to select an earlier format if you are creating a display for an earlier version PlantScape, or for an earlier product. See Saving Displays in Earlier Formats on page 39.

Working With Files

Named Versus Numbered DisplaysAn advantage of a named display is that users call up it up by entering the displays filename (without the extension) in Stations Command Zone. It is easier for users to remember an intuitive name like overview than a number such as 309.

Note If you want to assign a display to a function key (so that users can call it to call up by pressing the key), its name must not be longer than 20 characters.

Savin


In general, making a display numbered or named is simply a matter of choice. However, the display must be numbered if: You want Station to automatically call up the display when a user logs on. You want to configure the and keys so that they

call up the next/previous pages. Both the page for which you configure the keys and the pages you call up must be numbered pages.

You want the display listed in the Display Summary. You want to call up the display from a toolbar button. An Algorithm (algo) references the display. The point cross-reference report references the display.

Page numbering for custom displays starts at 301. (Numbers 1 to 300 are reserved for the system displays that are supplied with PlantScape.) The maximum page number depends on system sizing, and available disk space. For more information see the Installation Guide.

g Displays in Earlier FormatsIf you are creating a display for an earlier release of PlantScape, or for an earlier product, such as SCAN 3000 or XSM, you must select the appropriate format from Save as type when saving the display for the first time.

Note When saving a display in an earlier format, only features supported by that format will be saved.

Save as type: Product release:

Release 320.2 PlantScape R320, EBI R110

Release 320 PlantScape R210/R300, EBI R100

Release 310 PlantScape R200/R130

Release 300 PlantScape R110, SCAN 3000 R620 (ActiveX edition), XFi R620 (ActiveX edition), XSM R630

Release 230 XSM R610

2 Getting Started

40

Opening a FileTo open an existing Display Builder file, select File Open and use the Open dialog box to select the file you want to open.

Work

Release 220 SCAN 3000 R620, XFi R620, XSM R550

Release 110 SCAN 3000 R530 (Unix), XFi R530, XSM R515

Save as type: Product release:


Note If you open a file saved in an earlier file format, Display Builder automatically opens it in the current format. Having made the required changes, you must therefore select the original format when saving it if you want to retain the earlier file format.

ing with Several FilesIf required, you can have up to ten files open simultaneouslya useful feature when copying and pasting objects between displays and shape files.

Distributing And Validating Files

Distributing And Validating FilesHaving created your displays and shape files, you must perform the appropriate distribution and validation tasks.

Checking the Validity of Point IDs in Remotely-built FilesIf you are working remotelythat is, you are creating displays and shape files on

Dist


a computer other a serveryou must check that the point IDs specified in the file are valid.

One way of doing this is to copy the file to the appropriate server folder, open the file using Display Builder on the server or network, and immediately save it. The server generates an error message if there is any invalid point ID.

Another way is to use Display Builders command-line parameters. See Using Display Builders Command-Line Parameters on page 246.

ributing FilesThere are two storage techniques for displays and shape files: Centralized, where all files are stored centrally on the server, and accessed

by Stations as required Distributed, where each Station has its own copies on a local folder. (This

storage technique reduces communication traffic and callup delays because Stations do not have to download display files before displaying them.)

To distribute files if you use centralized storage:1 Copy the display and shape files to the appropriate display folder on the

server.2 If you have any numbered displays, export them. See Exporting Numbered

Displays on page 42.

To distribute files if you use distributed storage:1 Copy the display files to the appropriate server folder. (Shape files do not

need to be on the server.)2 If you have any numbered displays, export them. See Exporting Numbered

Displays on page 42.3 Copy the display and shape files to the appropriate display folder on each

Station computer that needs those files.

2 Getting Started

42

Exporting Numbered DisplaysYou must export numbered displays so that the server can establish a link between the page number and the filename.

If, when saving a numbered display in Display Builder, you save it to the appropriate display folder on the server, the display is generally exported as part of the saving process. A warning message appears if the display was not exported. (Exporting is not possible if, for example, the server is down.)


To export a remotely-built display:1 Copy the display file to the appropriate folder on the server.2 Open the file using Display Builder on the server or network, and

immediately save it. The display is then exported as you save it.

If you only want to export system displays, see Exporting System Displays on page 245.

3 Defining Display Object PropertiesThis chapter describes display object properties, which you access through the Properties window (described in Using the Properties Window on page 24).

Tip If the Properties window is not open, click Properties Window in the View toolbar.

For details about this tab: Go to:


Animation page 44

Appearance page 47

Custom X-Y page 48

Data page 49

Details page 54

Font page 70

General page 71

Options page 73

Repeats page 75

X-Y Plot page 78

3 Defining Display Object Properties

44

Animation TabThe animation tab controls the correspondence between the objects color and the value or status of the associated point.


Figure 3.1 Animation Tab

Animation Tab

Property Description

Type of animation The type of animation used for the object:

Color breakpoints. The color changes as the value changes. You can specify up to nine colors and the percentage range for which each color applies. (For example, you could make an object turn red when the value is between 90 and 100


percent of its range.)

Level fill. When the value is low, the color applies to only the bottom part of the object; as the value rises, the color rises to fill more of the object.

Shape sequence. Only applicable to a shapelink. Specifies the number of shapes in the shape sequence you want to use. See Inserting a Shape Sequence into a Display on page 29.

Note that the Details properties change in accordance with the selected type of animation.

Details These properties change in accordance with the option selected in Type of animation.

Type of breakpoint specifies how the color changes:

Continuous. (Only applicable to analog values.) The color changes as the value changes. You can specify up to nine colors and the percentage range for which each color applies. (For example, you could make an object turn red when the value is between 90 and 100 percent of its range.)

Discrete. The color changes as the state changes. You define a separate color for each state. Select Inverse if you want to animate the fill color rather than the line colorthis produces a reverse video effect, which makes text stand out providing you have selected an appropriate color scheme.

Indicate alarm state with color Station overrides the current color with the system-defined colors during alarm or off scan states. (The system-defined colors are specified in System Defined Colors on page 46.)

Not applicable if you select the Shape sequence option.


46

System Defined Colors

Point state System defined color

In alarm and unacknowledged Red and blinking

In alarm and acknowledged Red

Returned to normal but alarm not acknowledged Normal color, but blinking

Point off scan (scanning disabled) White


Appearance Tab

Appearance TabThe Appearance tab controls the objects overall appearance, such as its fill color and line thickness.


Figure 3.2 Appearance Tab


Colors These properties control the objects line and fill colors.

Lines These properties control the line characteristics, such as dashed lines and arrows at line ends.


48

Custom XY TabThe Custom X-Y tab is only applicable to chart objects and only appears when you select Custom X-Y Plot from Chart type on the Options tab.


Figure 3.3 Custom XY Tab

Item Description

Plot colors The colors used for the plot(s). The chart can display up to two plots.

Fill colors Select Fill between plots if you want to color the area between the plots. (This option highlights differences between the values of the two plots.)

Data Tab

Data TabThe Data tab specifies the objects link to the database. The Type of database link property specifies the type of link: Point/Parameter. The object is linked to a point parameter. See

Defining a Link To a Point on page 49. Database file. The object is linked to a file in the server database,

whose contents are controlled by another application. See Defining a Link

Defi


to a Database File on page 50. None. The object has no link to the database. See Using Local Display

Objects on page 53.

ning a Link To a PointWhen defining a link to a point, you specify the point and the appropriate parameter. (Each point has a number of parameters associated with it, such as field values and configuration details. For details about points and their parameters, see the Configuration Guide.)

Figure 3.4 Data TabLinking to a Point


50

Defin


Point The ID of the point to which the object is linked.

If you are working remotelynot on a servertype the points ID. (When the display is finalized, you should check that the IDs are validsee Checking the Validity of Point IDs in Remotely-built Files on page 41.)

If you are creating the display on a server, you can


ing a Link to a Database FileFor details about database (user) files, see the Application Development Guide.

normally select the ID from the list. (However, in a multi-server system, the server you are working on may not know of the existence of every point in the system.)

Parameter The point parameter to which the object is linked.

If you select a history parameter, such as H24H, History offset controls which history value is used. (0, the default, represents the latest history value, 1 represents the second-to-last value, and so on.)

Data entry allowed Allows users to edit the objects value. (See Understanding the Value Property on page 126.)

If you select Data entry allowed, Security Level appears, from which you select the appropriate level. (Only users with the specified level, or higher, can enter data.)

Data Tab


Figure 3.5 Data TabLinking to a Database File


File The number of the file to which the object is linked. Select the indexing option from the list opposite:

No indexing.

Indexed by file offset. Adds Stations current file offset to the file number. The offset can be set by scrollbars, by the host and by the and keys.


52

Record The number of the record within the file. Select the indexing option from the list opposite:

No indexing.

Indexed by record offset. Adds Stations current record offset to the record number. The offset can be set by scrollbars, by the server and by the and keys.



Indexed by field offset. Adds Stations current field offset to the word number. The offset can be set by scrollbars, by the server and by the and keys.

Indexed by Station no. Each Station uses separate records in the user file. The effect is to view the User file as a series of logical files, one for each Station. Set the record and word numbers as normal; for example, if you want the link to refer to the second record for each Station, set Record to 2.

Word The word number within the file. Select the indexing option from the list opposite:

No indexing.

Indexed by field offset. Adds Stations current field offset to the word number. The offset can be set by scrollbars, by the server and by the and keys.

Format The data format.

If you select String, you must specify the length of the string.

If you select Bits, you must specify the starting bit and the number of bits within the word.

Read from oldest record of circular file

Applicable if it is a circular file and you want to read the oldest record first.

Data entry allowed

Security level

Applicable only to a text object. Allows users to edit currently displayed text.

If you select Data entry allowed, you must also select a Security level. (Only users with the selected level, or higher, can enter data.)

Data Tab

Using Local Display ObjectsInstead of linking a display object to the database, you can use it as an input or output for a script. Such display objects are known as local objects because they are not linked to the database.

For example, you could configure a scrollbar as a user-input control for a scriptsee Using a Scrollbar to Set a Value on page 66.

You make a display object local by setting the Type of database link property to none.



54

Details TabThe Details tab contains properties that are specific to each type of object.

Activ

For details about this type of object: Go to:

ActiveX Document page 54

Alarm Line page 55


eX Document Object

Alphanumeric page 56

Chart page 58

Checkbox page 59

Combobox page 60

Indicator page 61

Pushbutton page 62

SafeBrowse page 64

Scrollbar page 64

Text page 69

Figure 3.6 Details Tab for a ActiveX Object

Details Tab

Alarm Line Object


File Name The URL (Uniform Resource Locator) of the document that you want to display. If necessary, find the document by clicking Browse.


Figure 3.7 Details Tab for an Alarm Line


Type The type of message the object displays, such as alarm or event.

Alarm priorities displayed Only messages with the specified priorities are displayed.


56

Alphanumeric Object


Figure 3.8 Details Tab for an Alphanumeric Object


Display as

Details

These properties specify how the point parameter information is displayed. See Alphanumeric Display Options on page 57.

Number of characters displayed

Word wrap

The maximum number of characters that can be displayed.

Selecting Word wrap allows the value (normally text) to appear over several lines, where it is longer than the objects width.

Local edit Indicates that when a user edits the objects value, the edited value is stored locally, rather than being sent to the server. Also, pressing inserts carriage returns, instead of sending the contents to the server.

In practice, this option is only used for the message object on the message pad system display.

Details Tab

Alphanumeric Display Options

Display As option Description

Numeric Displays the value as a number. If you deselect Floating decimal point, you must type the number of decimals you want to display in Number of decimals.

State Descriptor Applicable to a status point. Displays the state descriptor corresponding to the points status.


Text Applicable if the value is a text string.

Acronym Displays an acronym, which is based on the points (integer) value.

If you want to learn about acronyms, see Understanding Acronyms on page 79.

To select a set of acronyms from:

The default acronym file, see Selecting Default Acronyms on pag

Documents

Draw Honeywell