Specifications

ManualsBrandsSecurity Command ManualsHome building and DecorR500

PlantScape

Server and Client Configuration Guide

plscpcg.book Page i Monday, May 28, 2001 10:11 AM

Summary of content (584 pages)

PAGE 1
plscpcg.
PAGE 2
plscpcg.book Page ii Monday, May 28, 2001 10:11 AM Document Release Issue Date TC-DSXX21 Release 400 0 June 2001 Notice This 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.
PAGE 3
plscpcg.book Page iii Monday, May 28, 2001 10:11 AM Europe Contact: Honeywell PACE TAC Phone: +32-2-728-2657 Facsimile: +32-2-728-2278 Mail: Honeywell PACE TAC Avenue du Bourget, 1 B-1140 Brussels, Belgium Australia, New Zealand, and Fiji 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 Pacific 5 Thomas Holt Drive North Ryde, NSW, 2113, Australia Email GTAC@honeywell.com.
PAGE 4
plscpcg.
PAGE 5
plscpcg.book Page v Monday, May 28, 2001 10:11 AM Contents 1 About This Guide Before Reading This Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2 Prerequisite Skills . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2 How to Use This Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3 2 Configuration Overview Configuration Environment and Tools . . Quick Builder . . . . . . . . . . . .
PAGE 6
plscpcg.book Page vi Monday, May 28, 2001 10:11 AM Contents Copying Project Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55 Backing Up Project Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56 5 Configuring Stations and Printers About Station . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . About Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
PAGE 7
plscpcg.book Page vii Monday, May 28, 2001 10:11 AM Contents 7 Configuring Controllers About Controllers and Channels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98 Connecting Controllers to the Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98 Monitoring Communications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99 Communications Redundancy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100 Defining Channels . . . . .
PAGE 8
plscpcg.book Page viii Monday, May 28, 2001 10:11 AM Contents Control Level . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Reverse Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Configuring Alarms for Points . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . About Alarms and Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Alarm Properties for Status Points . . .
PAGE 9
plscpcg.book Page ix Monday, May 28, 2001 10:11 AM Contents Configuring Pager Details . . . . . Nominating Alarms to be Paged Enabling Pagers . . . . . . . . . . . . Alarm Message Content. . . . . . . 10 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
PAGE 10
plscpcg.book Page x Monday, May 28, 2001 10:11 AM Contents 12 Template Displays and Container Points Engineering Guidelines for Container Points . . . . . . . . . . . . . . . . . . . . . . 237 13 Configuring Reports Report Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Pre-formatted . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Additional Custom Reports . . . . . . . . . . . . . . . . . . . . . . . .
PAGE 11
plscpcg.book Page xi Monday, May 28, 2001 10:11 AM Contents Using Server Database and Operating System File Values . . . . . . . . . . . . . 275 Formatting the Report Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 276 Free Format Variables Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 277 A (Acquired Field Value) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 278 B (Start of Report Body) . . . . . . . . . . . . . . . .
PAGE 12
plscpcg.book Page xii Monday, May 28, 2001 10:11 AM Contents Changing the Default Transfer Period . . . . . . . . . . Failover of a Redundant Server System . . . . . . . . . . . . . . Manually Failing Over a Redundant Server System. . . . . . What To Do If the Servers Lose Synchronization . . . . . . . If the Primary Server Fails . . . . . . . . . . . . . . . . . . . If the Backup Server Fails . . . . . . . . . . . . . . . . . . . If There Is a Communications Failure . . . . . . . . . .
PAGE 13
plscpcg.book Page xiii Monday, May 28, 2001 10:11 AM Contents Operator Keyboard Support . . . . . . . . . . . Internationalization . . . . . . . . . . . . . . . . . . Configuration for Distributed Server Architecture . Configuring Servers to Share Data . . . . . . . Configuring “This Server” . . . . . . . . . . . . . Configuring the Remote Servers. . . . . . . . . Distributed Server Tuning . . . . . . . . . . . . . 16 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
PAGE 14
plscpcg.book Page xiv Monday, May 28, 2001 10:11 AM Contents Tape Drives for Archiving . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 384 Extended Event Archiving System Configuration . . . . . . . . . . . . . . . . . . . . . . . . 385 20 Using PlantScape Data in Other Applications PlantScape ODBC Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . About the PlantScape ODBC Driver . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
PAGE 15
plscpcg.book Page xv Monday, May 28, 2001 10:11 AM Contents Formula Arrays . . . . . . . . . . . . . . . GetHistVal_Date . . . . . . . . . . . . . . GetHistVal_Offset . . . . . . . . . . . . . GetHistValArray_Date . . . . . . . . . . GetHistValArray_Offset . . . . . . . . . GetPointVal . . . . . . . . . . . . . . . . . GetPointValArray . . . . . . . . . . . . . NAPI_rGetdat_int . . . . . . . . . . . . . NAPI_rGetdat_float . . . . . . . . . . . . NAPI_rGetdat_double . . . . . . . . . . NAPI_rGetdat_long .
PAGE 16
plscpcg.book Page xvi Monday, May 28, 2001 10:11 AM Contents station . . . . . . . . . . . . . . . . . . . . PlantScape Control Panel . . . . . . Controller Configuration Commands . . . config . . . . . . . . . . . . . . . . . . . . tdc_cl. . . . . . . . . . . . . . . . . . . . . Diagnostic Commands . . . . . . . . . . . . . dcheck. . . . . . . . . . . . . . . . . . . . display . . . . . . . . . . . . . . . . . . . . lisscn . . . . . . . . . . . . . . . . . . . . . listag . . . . . . . . . . . . . . . . .
PAGE 17
plscpcg.book Page xvii Monday, May 28, 2001 10:11 AM Contents Monitoring System Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 536 Displaying Lists of Points by Controller . . . . . . . . . . . . . . . . . . . . . . . . . .
PAGE 18
plscpcg.
PAGE 19
plscpcg.book Page 1 Monday, May 28, 2001 10:11 AM 1 About This Guide This Guide is intended primarily for engineers and system administrators who are responsible for configuring and supporting Release 400 of the PlantScape server software.
PAGE 20
plscpcg.book Page 2 Monday, May 28, 2001 10:11 AM 1 – About This Guide Before Reading This Guide Before using this Guide to configure your PlantScape server, you need to: • Understand basic PlantScape concepts such as “channel,” “controller,” “point,” and “Station,” as explained in the Overview Guide. • Install the PlantScape and third party software as described in the Installation Guide.
PAGE 21
plscpcg.book Page 3 Monday, May 28, 2001 10:11 AM How to Use This Guide How to Use This Guide “Configuration Overview” on page 5 introduces you to the main configuration tasks and tools, and shows you where they are described in this Guide. The “Configuration Tutorial” on page 13 gives you hands-on experience in performing basic server configuration tasks, and is particularly intended for those who are new to PlantScape. It shows you how to start Quick Builder and introduces its key features.
PAGE 22
plscpcg.
PAGE 23
plscpcg.book Page 5 Monday, May 28, 2001 10:11 AM 2 Configuration Overview This chapter introduces the configuration tasks and tools for the PlantScape server. To configure PlantScape means to customize the PlantScape server database for your plant. It involves defining communication connections, and the data acquisition and control that you want to implement at your site.
PAGE 24
plscpcg.book Page 6 Monday, May 28, 2001 10:11 AM 2 – Configuration Overview Configuration Environment and Tools A typical PlantScape configuration environment features the following components: • A server running the Windows 2000 operating system. • One or more operator Stations running the Windows 2000 or Windows NT operating system, and printers connected to the server. (In most basic systems, the Station software and the server software run on the same computer.
PAGE 25
plscpcg.book Page 7 Monday, May 28, 2001 10:11 AM Configuration Environment and Tools Tools Used in Earlier Products Quick Builder is a replacement for the following tools that were used in older releases of the product: • hdwbld • pntbld • bckbld The procedures in this Guide assume that Quick Builder is the configuration tool for points and hardware, and that pntbld, hdwbld, and bckbld are only used for specific diagnostic purposes.
PAGE 26
plscpcg.book Page 8 Monday, May 28, 2001 10:11 AM 2 – Configuration Overview PlantScape Server Utilities Utilities that run on the server are available to assist you in configuration and administration tasks. Utilities that apply to specific controllers, such as communications testing utilities, are described in the controller references. General utilities are described in “Command Reference” on page 483, and referred to throughout this guide.
PAGE 27
plscpcg.book Page 9 Monday, May 28, 2001 10:11 AM Server Scripting Server Scripting You can extend the functionality of PlantScape by creating server scripts. As you configure your system, you may want to create server scripts for: • Servers • Point servers • Points • Reports The type of script you want to create determines the tool you use. For example, if you want to create a script that runs at specified times, you use Station to create the script.
PAGE 28
plscpcg.book Page 10 Monday, May 28, 2001 10:11 AM 2 – Configuration Overview Configuration Procedures The table below shows the procedures for configuring the PlantScape server in their recommended sequence. The table also shows: • Which procedures are part of a basic PlantScape server installation, but are not mandatory (“Optional Procedure”). • Which procedures relate to licensable options (“PlantScape Option”). • Where to find the information you need to plan and complete the procedures.
PAGE 29
plscpcg.book Page 11 Monday, May 28, 2001 10:11 AM Configuration Procedures Procedure Tool For Details, See... Implement a control strategy for points on Honeywell Control Processors and define points on other controllers. If required, create server scripts. Control Builder and/or Quick Builder For points on PlantScape Control Processors, refer to the PlantScape Process Software documentation.
PAGE 30
plscpcg.book Page 12 Monday, May 28, 2001 10:11 AM 2 – Configuration Overview Procedure Tool For Details, See... Configure operating groups and trend sets (optional procedure) Station “Configuring Group and Trend Displays” on page 225. Configure pre-formatted reports and create server scripts to run on completion of reports (optional procedure) Station “Configuring Reports” on page 239. Configure Point Control Schedules (PlantScape option) Station “Configuring Schedules” on page 357.
PAGE 31
plscpcg.book Page 13 Monday, May 28, 2001 10:11 AM 3 Configuration Tutorial This tutorial walks you through typical, though simple, configuration steps. It does not provide detailed explanations of the configuration tools and tasks. It is only intended to familiarize you with the tools and utilities used to configure the PlantScape server, so that you can get your system up and running as quickly as possible. The tools and tasks are described in detail in subsequent chapters of this Guide.
PAGE 32
plscpcg.book Page 14 Monday, May 28, 2001 10:11 AM 3 – Configuration Tutorial LAN Connection Serial Connection Server Station 1770-KF2 Data Highway Plus Allen-Bradley PLC-5 Operator Station Figure 3.
PAGE 33
plscpcg.book Page 15 Monday, May 28, 2001 10:11 AM Starting Quick Builder and Creating a Project File Starting Quick Builder and Creating a Project File The first step in configuring the server database is to start Quick Builder and create a project file to store your configuration data. To start Quick Builder: 1 Click the Start button and select Programs ⇒ PlantScape Server ⇒ Quick Builder.
PAGE 34
plscpcg.book Page 16 Monday, May 28, 2001 10:11 AM 3 – Configuration Tutorial Figure 3.3 Create New Project Dialog Box 3 In the File name field, type: tutorial.qdb 4 5 6 Tip 16 Click Save. This displays the Enable Components dialog box. Select PlantScape as the server type. Enable the components you want to include in the project. You can limit the components in a project to improve Quick Builder’s performance.
PAGE 35
plscpcg.book Page 17 Monday, May 28, 2001 10:11 AM Starting Quick Builder and Creating a Project File Figure 3.4 Enable Components Dialog Box 7 Click OK to close the Enable Components dialog box. In a few moments, this creates the new project file and re-displays the Quick Builder window with the name of the new project file displayed in the title bar.
PAGE 36
plscpcg.book Page 18 Monday, May 28, 2001 10:11 AM 3 – Configuration Tutorial Figure 3.
PAGE 37
plscpcg.book Page 19 Monday, May 28, 2001 10:11 AM Defining a Station Defining a Station Stations are your “window” into the server databases. They are your means for accessing and controlling plant and process data.
PAGE 38
plscpcg.book Page 20 Monday, May 28, 2001 10:11 AM 3 – Configuration Tutorial 3 4 5 b) In the list of Station types, select Static Station. c) In the Number of items to Add field, leave the default selection of 1. Click OK to add the Station to the item list. Select the Station item in the item list, and complete the fields in the Main tab as follows: a) In the Station Name field, type: SrvStation b) In the Description field, type: Server Station Leave the default settings in the remaining fields.
PAGE 39
plscpcg.book Page 21 Monday, May 28, 2001 10:11 AM Defining a Station Creating and Defining a LAN Rotary Station Item To create and define a LAN Rotary Station for your project: 1 In the Quick Builder menu bar, go to the Edit menu and select Add Item(s). This displays the Add Item(s) dialog box. Figure 3.8 Adding a Station 2 3 4 Use a) b) c) d) the Add Item(s) dialog box as follows: From the Add Items drop-down list, select Station. In the list of Station types, select Rotary Station.
PAGE 40
plscpcg.book Page 22 Monday, May 28, 2001 10:11 AM 3 – Configuration Tutorial Figure 3.
PAGE 41
plscpcg.book Page 23 Monday, May 28, 2001 10:11 AM Defining a Channel and a Controller Defining a Channel and a Controller This topic only applies to sites that are using controllers other than PlantScape Control Processors. If you are using only PlantScape Control Processors, you do not need to define channels and controllers.
PAGE 42
plscpcg.book Page 24 Monday, May 28, 2001 10:11 AM 3 – Configuration Tutorial Figure 3.10 Using the Add Item(s) Dialog Box to Add a Channel 3 4 24 R400 Click OK. Select the channel item in the item list and complete the fields on the Main tab as follows: a) In the Description field, type via COM1 through KF2 to DH+ You can ignore the remaining fields on this page for the purposes of this tutorial.
PAGE 43
plscpcg.book Page 25 Monday, May 28, 2001 10:11 AM Defining a Channel and a Controller Figure 3.11 Main Tab for the Channel 5 Click the Port tab to display the Port tab and check that the fields are completed.
PAGE 44
plscpcg.book Page 26 Monday, May 28, 2001 10:11 AM 3 – Configuration Tutorial Figure 3.12 Port Tab for the Channel Defining an Allen-Bradley PLC To define an Allen-Bradley PLC you need to create and define a controller item for your project. To define a controller: 1 From the Edit menu, select Add Item(s). This displays the Add Item(s) dialog box.
PAGE 45
plscpcg.book Page 27 Monday, May 28, 2001 10:11 AM Defining a Channel and a Controller Figure 3.13 Using Add Dialog Box to Add a Controller 2 3 4 Use the Add Item(s) dialog box as follows: a) From the Add Items list, select Controller. b) From the list of controller types, select AllenBradley. c) In the Number of items to Add field, leave the default selection of 1. d) In the Use Name field, type ABR-PLC5-1. e) In the Start field for defining the variable name, type 1. Click OK.
PAGE 46
plscpcg.book Page 28 Monday, May 28, 2001 10:11 AM 3 – Configuration Tutorial Figure 3.
PAGE 47
plscpcg.book Page 29 Monday, May 28, 2001 10:11 AM Defining a Status and an Analog Point Defining a Status and an Analog Point In PlantScape, any sensors connected to the PLC are mapped into points for viewing and control. We will now define: 1 A status point to control a pump 2 An analog point to monitor the level of a tank Defining a Status Point to Control a Pump To define a status point to control a pump: 1 From the Edit menu in Quick Builder, select Add Item(s).
PAGE 48
plscpcg.book Page 30 Monday, May 28, 2001 10:11 AM 3 – Configuration Tutorial 4 Select the point item in the item list, and complete the fields on the Main tab as follows: a) In the Description field, type Pump Status. b) From the PV Scan Period drop-down list, select 5 seconds. c) From the Number of States drop-down list, select 2. d) In the State 0 field, type OFF. e) In the State 1 field, type ON. Figure 3.16 Status Point Main Tab 5 6 30 R400 Select the ...
PAGE 49
plscpcg.book Page 31 Monday, May 28, 2001 10:11 AM Defining a Status and an Analog Point c) In the Location field, type the following PLC-5 memory location I:001/10 Figure 3.17 Address Builder Dialog Box 7 8 9 Click OK to close the Address Builder dialog box and add the address to the PV Source Address field on the Main tab. Use the mouse to highlight all the contents of the PV Source Address field and press + to copy the address.
PAGE 50
plscpcg.book Page 32 Monday, May 28, 2001 10:11 AM 3 – Configuration Tutorial Figure 3.18 Status Point Control Tab Defining an Analog Point to Monitor the Level of a Tank To define an analog point to monitor the level of a tank: 1 From the Edit menu in Quick Builder, select Add Item(s). 2 Use the fields in the Add dialog box as follows: a) From the Add Items drop-down list, select Point. b) From the list of point types, select Analog. c) In the Number field, leave the default selection of 1.
PAGE 51
plscpcg.book Page 33 Monday, May 28, 2001 10:11 AM Defining a Status and an Analog Point Figure 3.19 Using Add Dialog Box to Add an Analog Point 3 4 Click OK. Select the point item in the item list. Click Main and complete the fields on the Main tab as follows. a) In the Description field, type Input Tank Level. b) From the PV Scan Period drop-down list, select 5 seconds. c) In the 100% Range Value field, type 1000. d) In the 0% Range Value field, type 0.
PAGE 52
plscpcg.book Page 34 Monday, May 28, 2001 10:11 AM 3 – Configuration Tutorial Figure 3.20 Analog Point Main Property 5 6 34 R400 Click the ... button next to the PV Source Address field. Complete the fields in the Address Builder dialog box as follows: a) From the Address Type list select Controller. b) In the Controller Name field, select ABR-PLC5-1. c) In the Location field, type N7:1 as the PLC-5 integer address.
PAGE 53
plscpcg.book Page 35 Monday, May 28, 2001 10:11 AM Defining a Status and an Analog Point Figure 3.21 Address Builder Dialog Box 7 Click OK to close the Address Builder dialog box.
PAGE 54
plscpcg.book Page 36 Monday, May 28, 2001 10:11 AM 3 – Configuration Tutorial Downloading the Database With the Stations, channels, controllers, and points defined, you are ready to download these definitions to the PlantScape server database. To download the Quick Builder configuration data to the server database: 1 From the Tools pull-down menu in Quick Builder, select Download. This displays the Download dialog box. Figure 3.
PAGE 55
plscpcg.book Page 37 Monday, May 28, 2001 10:11 AM Saving the File and Exiting Quick Builder Saving the File and Exiting Quick Builder After creating and downloading the project information, you can exit Quick Builder. To exit Quick Builder: 1 From the File menu, select Save. Information about the project’s setup, including the current views and reports is saved to the project file tutorial.qdb. 2 From the File menu, select Exit.
PAGE 56
plscpcg.book Page 38 Monday, May 28, 2001 10:11 AM 3 – Configuration Tutorial Starting the Stations With the PlantScape server database configured and loaded, you can now start a Station. Starting Station on the Server To start Station on the server computer, click the Start button and select Programs ⇒ PlantScape Server ⇒ Station. The Station window is displayed with a “Connecting” message in the message zone (see the top left-hand corner of Station window, below the tool bar).
PAGE 57
plscpcg.book Page 39 Monday, May 28, 2001 10:11 AM Starting the Stations Figure 3.23 Station Setup 3 4 5 6 On the Connection tab in the Server field, enter the server name. Select Rotary Station as the Station type. Click Advanced and view the default settings. Click Save to save these settings in the default.stn file. If you want to save the settings to another file, click Save As and specify a filename. If the Station cannot connect to the server, refer to “Troubleshooting Advice” on page 531.
PAGE 58
plscpcg.book Page 40 Monday, May 28, 2001 10:11 AM 3 – Configuration Tutorial Configuring a Trend Set and a Group Display This topic shows you how to configure two different types of simple standard displays.
PAGE 59
plscpcg.book Page 41 Monday, May 28, 2001 10:11 AM Configuring a Trend Set and a Group Display Figure 3.24 Trend Set Summary Display 2 3 4 Click the number or title of an unassigned trend set. This calls up the trend configuration display. Give the trend a title by entering a description in the Title field. Leave the Trend Type at the default setting, Multiplot. In the Samples field, enter a number for the number of samples to be displayed (for example, 300).
PAGE 60
plscpcg.book Page 42 Monday, May 28, 2001 10:11 AM 3 – Configuration Tutorial Figure 3.25 Trend Set Configuration Display 5 6 7 8 9 10 Click the Sample Interval field and select an interval from the list. (for example, 5 seconds) In the first Point ID field, enter PUMPSTS (the point ID of the status point you created in 3.4.1 “Defining a Status Point to Control a Pump”). You can enter the point ID using the Point Browser. Click the Point Browser button to call up the Point Browser.
PAGE 61
plscpcg.book Page 43 Monday, May 28, 2001 10:11 AM Configuring a Trend Set and a Group Display Figure 3.26 Multiplot Trend Set Details Display Configuring Multirange Trend Set Details If you click the Type combobox at the top of the Multiplot Trend Set display, you can select from a range of other types of trend set displays. For the purposes of the next exercise, select Multirange.
PAGE 62
plscpcg.book Page 44 Monday, May 28, 2001 10:11 AM 3 – Configuration Tutorial Figure 3.27 Multirange Trend Set Display You use the Multirange Trend Set Details display to enter the trend ranges to be displayed for each point. Note that the trend ranges are only used for displaying this trend and do not affect the actual range of the point. Configuring an Operating Group You can configure an operating group comprising the two points you have configured in this tutorial.
PAGE 63
plscpcg.book Page 45 Monday, May 28, 2001 10:11 AM Configuring a Trend Set and a Group Display Figure 3.28 System Configuration – Groups Display 2 3 4 Click the first unassigned Title field. This opens the Group Configuration display. Type a title for the group in the Title field. Enter TANKLEVEL as the first point ID, and PUMPSTS as the second point ID and select PV as the parameter for each.
PAGE 64
plscpcg.book Page 46 Monday, May 28, 2001 10:11 AM 3 – Configuration Tutorial Figure 3.29 Group Configuration Display 5 46 R400 Click View Group from the bottom right of the display to call up the Group Detail display for that operating group. The following figure shows how the display would look if your server were connected and operational.
PAGE 65
plscpcg.book Page 47 Monday, May 28, 2001 10:11 AM Configuring a Trend Set and a Group Display Figure 3.
PAGE 66
plscpcg.book Page 48 Monday, May 28, 2001 10:11 AM 3 – Configuration Tutorial Configuring an Alarm Duration Report This section of the tutorial shows you how to configure a simple report that generates information on the duration of alarms at given points. You can only configure a report if you are have a security level of SUPV or higher. To configure an Alarm Duration report: 1 Select Configure ⇒ Reports from the Station menu to call up the Reports display. Figure 3.
PAGE 67
plscpcg.book Page 49 Monday, May 28, 2001 10:11 AM Configuring an Alarm Duration Report Figure 3.32 Report/Archive Definition Display 4 5 6 7 8 Enter TankAlm as the report name. Enter Tank Alarm Duration Report as the report title. To allow operators to request this report at any time, select the Enable reporting on request checkbox. If you want the report to run periodically, select the Enable periodic reporting checkbox and specify the intervals at which the report is to be run. Click the Contents tab.
PAGE 68
plscpcg.book Page 50 Monday, May 28, 2001 10:11 AM 3 – Configuration Tutorial Figure 3.33 Report/Archive Content Display 9 10 11 50 R400 Enter PUMPSTS in the Point ID(s) field to use the status point you defined earlier in this tutorial. From the Event type combobox select All to specify that all alarms are to be included in the report. If your server is fully operational you can click the Request button on the display to generate and display the report.
PAGE 69
plscpcg.book Page 51 Monday, May 28, 2001 10:11 AM What Next? What Next? With the Stations started, you can now explore your PlantScape system, or else move on to the configuration procedures described in the next part of this Guide. For more detailed information on how operators use Station displays, you might want to refer to the Operators Guide. If you want to create a custom graphic display for the points you have defined in this tutorial, refer to the tutorial chapter in the Display Building Guide.
PAGE 70
plscpcg.
PAGE 71
plscpcg.book Page 53 Monday, May 28, 2001 10:11 AM 4 Using Quick Builder Quick Builder is a tool that you can use to define and manage configuration data for Stations, printers, and controllers (other than the PlantScape Control Processors), as well as the channels for, and points on, those controllers. This chapter contains a brief overview of Quick Builder and some operating considerations.
PAGE 72
plscpcg.book Page 54 Monday, May 28, 2001 10:11 AM 4 – Using Quick Builder Quick Builder Overview You use Quick Builder to: • Create an “item” for each Station, printer, and controller, as well as the channel used by each controller, and each point on the controller • Define the relevant details of each item by completing the fields in a series of property tabs. Quick Builder stores configuration data in a project, which constitutes an “offline database.
PAGE 73
plscpcg.book Page 55 Monday, May 28, 2001 10:11 AM Quick Builder Overview Menus Toolbar Filter Selector Item Types Property Page Status Line Figure 4.1 Typical Quick Builder Window Starting Quick Builder To start Quick Builder, on any computer where Quick Builder is installed, • Click the Start button and choose Programs ⇒ PlantScape Server ⇒ Quick Builder. Copying Project Files You need to create a separate Quick Builder project file for each PlantScape server.
PAGE 74
plscpcg.book Page 56 Monday, May 28, 2001 10:11 AM 4 – Using Quick Builder Backing Up Project Files As with any other important site data, you should back up your Quick Builder project files regularly. You can do this by using Windows Explorer to copy the .qdb file to an appropriate device or folder.
PAGE 75
plscpcg.book Page 57 Monday, May 28, 2001 10:11 AM 5 Configuring Stations and Printers This chapter describes how to configure Stations and printers.
PAGE 76
plscpcg.book Page 58 Monday, May 28, 2001 10:11 AM 5 – Configuring Stations and Printers About Station Station is PlantScape’s user interface. You use Station to monitor and control your system. Station displays are used to notify operators of alarm conditions.
PAGE 77
plscpcg.book Page 59 Monday, May 28, 2001 10:11 AM About Station Type Description Rotary Provides an “as required” link to a Station. This is the recommended connection type for staff who do not use Station full-time. Rotary connections are advantageous from a licensing point of view because your license only specifies the number of simultaneously connected Stations.
PAGE 78
plscpcg.book Page 60 Monday, May 28, 2001 10:11 AM 5 – Configuring Stations and Printers Associated Stations You can configure a Station so that the current page is “sent” for display to one of two other Stations when a special function key is used at the original Station. The Station to which the display is sent is known as an “Associated Station.” You also have to configure the function key that sends the display.
PAGE 79
plscpcg.book Page 61 Monday, May 28, 2001 10:11 AM About Station Customizing the Appearance and Behavior of Station You can customize initialization parameters of Station by editing the station.ini file. Use a text editor to open the file in %systemRoot%, for example, C:\winnt\station.ini. For details on what you can customize see “Station.ini” on page 83.
PAGE 80
plscpcg.book Page 62 Monday, May 28, 2001 10:11 AM 5 – Configuring Stations and Printers Printers Printers that are intended for printing reports or alarms and events are defined with Quick Builder. When you have defined your printers in Quick Builder, you assign printers to specific tasks using the Station Configuration display. For more information see “Printer Assignment” on page 81.
PAGE 81
plscpcg.book Page 63 Monday, May 28, 2001 10:11 AM Setting Up Station Setting Up Station This section describes how to start and configure Station. Starting Station To start Station: 1 Click the Start button. 2 Select Programs ⇒ PlantScape Server ⇒ Station. To use a setup file other than default.stn: 1 Select Station ⇒ Connect. The Connect dialog box opens. 2 Select the required .stn file from the Recent Connections tab or the Other Connections tab. 3 Click Connect.
PAGE 82
plscpcg.book Page 64 Monday, May 28, 2001 10:11 AM 5 – Configuring Stations and Printers Figure 5.1 Connection Properties Dialog Box 2 3 Note The Connection Properties menu item might be disabled on Stations that have had the startup command line modified for security reasons. Use the tabs and fields in the Connection Properties dialog box to review or modify the settings, as described in “Connection Properties Dialog Box” on page 69.
PAGE 83
plscpcg.book Page 65 Monday, May 28, 2001 10:11 AM Setting Up Station 7 8 9 10 11 Select the required action from the Action list. For a list of actions and required information see “Command Actions” on page 74. Specify any other required information for the action you have selected. The new menu item is added to the Station menubar. Click and drag the new menu item to the required position on any of the menus. Click Save As and specify a filename to save your settings.
PAGE 84
plscpcg.book Page 66 Monday, May 28, 2001 10:11 AM 5 – Configuring Stations and Printers To configure function keys for a Station: 1 In the Connection Properties dialog box, click the Toolbar tab. 2 In the Definition field, specify the file you want to customize. 3 Click Customize, the Customize Toolbars dialog box opens. 4 In the Categories list, select Station Shortcut Keys. 5 Click New Command, the Command Properties dialog box opens. 6 Enter the keyboard shortcut.
PAGE 85
plscpcg.book Page 67 Monday, May 28, 2001 10:11 AM Using Station for Configuration Using Station for Configuration You use displays in Station to complete other configuration tasks that are not covered in Station setup or station.ini. You also use Station to configure server wide settings. Configuring Timeout To specify idle timeout and select timeout: 1 From the System Configuration Menu display, click Server Wide Settings. This calls up the Server Wide Settings display.
PAGE 86
plscpcg.book Page 68 Monday, May 28, 2001 10:11 AM 5 – Configuring Stations and Printers Configuring Alarms To specify alarm settings for all Stations in your system: 1 From the System Configuration Menu display, click Server Wide Settings. 2 Specify the required alarm settings as described in “Station Alarm Settings” on page 79. To define Station-specific alarm settings: 1 On the Station Summary display, click the number or title of the Station you want to configure.
PAGE 87
plscpcg.book Page 69 Monday, May 28, 2001 10:11 AM Connection Properties Dialog Box Connection Properties Dialog Box You use the Connection Properties dialog box to customize some of the Station settings. The dialog box contains a series of tabs relating to the Station settings you can customize. The settings are described in the sub-topics below.
PAGE 88
plscpcg.book Page 70 Monday, May 28, 2001 10:11 AM 5 – Configuring Stations and Printers Displays Tab Use the Displays tab to define the paths and the order Stations uses to search for displays. Button Description Page Background Color Specifies the color of the background visible when you change displays. Search for displays in Lists the paths and the order Station uses to look for displays. Add Adds a search path. Remove Deletes the selected search path from the list.
PAGE 89
plscpcg.book Page 71 Monday, May 28, 2001 10:11 AM Connection Properties Dialog Box Property Description Show shortcut keys in ToolTips Specifies if shortcut keys are included in the ToolTip Show keyboard shortcuts Specifies if keyboard shortcuts are shown with the menu items. Applicable only if a shortcut is assigned to a menu item. Show icons Specifies if icons are shown with the menu item. Applicable only if an icon is assigned to a menu item.
PAGE 90
plscpcg.book Page 72 Monday, May 28, 2001 10:11 AM 5 – Configuring Stations and Printers 72 Property Description Remove Removes the selected Web page or file and cannot be viewed in SafeBrowse. SafeBrowse home page Enables you to specify the URL of the default home page. SafeBrowse search page Enables you to specify the URL of the default search page.
PAGE 91
plscpcg.book Page 73 Monday, May 28, 2001 10:11 AM Toolbars Dialog Box Toolbars Dialog Box You access the Toolbars dialog box from the Toolbar tab, in the Connection Properties dialog box.
PAGE 92
plscpcg.book Page 74 Monday, May 28, 2001 10:11 AM 5 – Configuring Stations and Printers Command Properties Dialog Box The Command Properties dialog box is used to set the properties of a command you add to the toolbar, menubar or keyboard shortcut. Property Description Icon The icon currently assigned to the command. Change Icon Enables you to specify an icon for a toolbar button. Name The name of the menu item, toolbar button or keyboard shortcut.
PAGE 93
plscpcg.book Page 75 Monday, May 28, 2001 10:11 AM Toolbars Dialog Box Action Required Value HMIWeb Command HMIWeb command. Select the command from the list. The HMIWeb commands are commands that apply to the display element that has focus in a HMIWeb display, or to the data source to which it is bound. Note that some of these commands are only supported by certain types of display element/data source. When a HMIWeb command is invoked, it is sent to the display element for processing.
PAGE 94
plscpcg.
PAGE 95
plscpcg.
PAGE 96
plscpcg.
PAGE 97
plscpcg.book Page 79 Monday, May 28, 2001 10:11 AM Server Wide Settings Station Alarm Settings Use Station Alarms on the Server Wide Settings display to specify settings for alarms: Property Description Audible active time The duration of audible alarms. For example, if you specify 10 seconds, the alarms sound for 10 seconds each, unless the operator silences the alarm by acknowledging it before the 10 seconds has passed.
PAGE 98
plscpcg.book Page 80 Monday, May 28, 2001 10:11 AM 5 – Configuring Stations and Printers Station Configuration Display You use the Station Configuration Display to define Station-specific settings. General Tab The following sections describe settings you define on the General Tab of the Station Configuration display. Associated Stations Use the Associated Stations controls to specify: Property Description First Station Specifies the number or name of the first associated Station.
PAGE 99
plscpcg.book Page 81 Monday, May 28, 2001 10:11 AM Station Configuration Display Start Up/Idle Timeout Action Use the Start up/idle Timeout Action controls to specify: Property Description Start up page Specifies the page display called up: • Each time a rotary Station connects to the server. • When a station Station initially connects to the server.
PAGE 100
plscpcg.book Page 82 Monday, May 28, 2001 10:11 AM 5 – Configuring Stations and Printers Area Assignment Tab If your system is divided into areas, use the controls on the Area Assignment tab to assign this Station to the areas where access is required. 82 Property Description Assigned Indicates if the Station is assigned to an area Restrictions Specifies any restrictions to the level of access the Station has to the area, for example, view only access. Area The areas defined in the system.
PAGE 101
plscpcg.book Page 83 Monday, May 28, 2001 10:11 AM Station.ini Station.ini You can add or change the following parameters in station.ini to customize the Station: AllowRightMouseClickBrowserMenus=n Controls whether the right mouse button menu is available in a SafeBrowse window. Valid values for n are: 0 Right mouse button menu is disabled. 1 Right mouse button menu is enabled. ArrowKeysForNavigation=n Allows the use of arrow keys to navigate around a display.
PAGE 102
plscpcg.book Page 84 Monday, May 28, 2001 10:11 AM 5 – Configuring Stations and Printers DisableEchoSafeBrowseMessage=n Disables the display of download messages in the message zone when SafeBrowse is being used. Valid values for n are: 0 Enables the display of download messages. 1 Disables the display of download messages. DisableMaximizeButton=n Allows or prevents users from maximizing the Station window. Valid values for n are: 0 Users can maximize the Station window.
PAGE 103
plscpcg.book Page 85 Monday, May 28, 2001 10:11 AM Station.ini FixedWindowSize=n Allows or prevents users from resizing the Station window. Valid values for n are: 0 Users can resize the Station window. 1 Users cannot resize the Station window. This setting also ensures that a full page is automatically shown at every zoom level. FlashWindowOnAlarm=n Causes the Station taskbar icon to flash when an alarm is raised.
PAGE 104
plscpcg.book Page 86 Monday, May 28, 2001 10:11 AM 5 – Configuring Stations and Printers KeepAliveTimeout The time interval at which Station sends a messages to the server and waits for a reply. If the Server has not communicated with Station before the next KeepAliveTimeout period, Station starts the failover process. You cannot change this without coding changes to the server, see “Server Redundancy Fast Failover Configuration” on page 330.
PAGE 105
plscpcg.book Page 87 Monday, May 28, 2001 10:11 AM Station.ini Tip If you are using a dual monitor and want to run Station and Display Builder side-by-side, change the resolution of Station by editing station.ini and change the resolution of Display Builder by adding a registry entry using regedit. SocketNoLinger=n Specifies whether Station issues a setsocketoption() NOLINGER when connecting to the server. This is used for non-Winsock compliant layers, for example, Novell LanWorkPlace V5.0.
PAGE 106
plscpcg.book Page 88 Monday, May 28, 2001 10:11 AM 5 – Configuring Stations and Printers WindowsObjects=n Controls whether Station uses the Motif style for controls such as scroll bars instead of the Microsoft Windows style. Valid values for n are: 88 0 Station uses the Motif style. 1 Station uses the Microsoft Windows style.
PAGE 107
plscpcg.book Page 89 Monday, May 28, 2001 10:11 AM Keyboard Service Program Keyboard Service Program The Keyboard Service program is a standard program that can be used for function keys. The parameter settings for Task LRN 1 are shown in the following table. Parameter 1 Parameter 2 Action 1 N/A Initiates the fast update as defined from Quick Builder or from Station Setup. 101 through 120 N/A The action is defined when a display is built in Display Builder. Table 5.
PAGE 108
plscpcg.
PAGE 109
plscpcg.book Page 91 Monday, May 28, 2001 10:11 AM 6 Dividing the System into Areas This chapter describes areas and how to implement areas in your system.
PAGE 110
plscpcg.book Page 92 Monday, May 28, 2001 10:11 AM 6 – Dividing the System into Areas Areas The PlantScape database can be partitioned into areas to control access to a particular section of the plant or process. These areas might match actual physical areas or sections of a site or building. Only Stations or operator IDs configured to have access to a given area are able to monitor (or control) points, alarms and custom displays for that area. The PlantScape database contains a system area.
PAGE 111
plscpcg.book Page 93 Monday, May 28, 2001 10:11 AM Areas To configure areas: 1 From the System Configuration Menu display, click Areas. 2 Click the Enable checkbox. 3 For Area 1: Area Code The 2-character code that identifies the system area. Enable Alarms Indicates whether or not alarms are generated for system items. Should usually be enabled. 4 For areas numbered 2 and above: Area Code A unique 2-character code that identifies the area. Description An optional description of the area.
PAGE 112
plscpcg.book Page 94 Monday, May 28, 2001 10:11 AM 6 – Dividing the System into Areas • • Tip A method of giving an operator additional access at specified times. For example, after hours monitoring from a central location A quick way of assigning areas to operators If you make any changes to area profiles, these changes are not available to the operator until the next time the operator logs on.
PAGE 113
plscpcg.book Page 95 Monday, May 28, 2001 10:11 AM Areas 3 4 5 Note Click an empty row in the summary. The Area Time Periods configuration display opens. Under Definition, enter: – The name you want to give the area time period. – A description of the time period. – The area code that must be assigned to an operator before they can view or change this area time period. The area code must be configured. Select the days and enter the start time and stop time for the segments you need.
PAGE 114
plscpcg.book Page 96 Monday, May 28, 2001 10:11 AM 6 – Dividing the System into Areas 4 Note The lower half of the screen provides for 16 Area List / Area Time Period pairs. Specify the pairs that you require for this profile. The first profile in the summary is a system-defined profile that consists of the All Areas / All Hours pair only. An operator with this area profile has access to all areas at any time. This profile is supplied with the name Full Access.
PAGE 115
plscpcg.book Page 97 Monday, May 28, 2001 10:11 AM 7 Configuring Controllers This chapter describes how you configure controllers in your system. It provides introductory information on controllers and channels, and shows you how to: • Define a channel with Quick Builder • Define a controller with Quick Builder • Test the communications • Monitor the status of system communications Note The information in this chapter applies to configuring controllers other than PlantScape Control Processors.
PAGE 116
plscpcg.book Page 98 Monday, May 28, 2001 10:11 AM 7 – Configuring Controllers About Controllers and Channels In PlantScape, the term “controller” is the generic term for devices such as loop controllers, and so on, which are used to monitor and control one or more processes and items of field equipment. In a PlantScape system, controllers are connected to the server so that the server can co-ordinate the monitoring and supervising of all your plant processes.
PAGE 117
plscpcg.book Page 99 Monday, May 28, 2001 10:11 AM About Controllers and Channels Monitoring Communications Before you start defining controllers and channels, it is useful to understand a number of concepts that are used in PlantScape to flag communications failures and help you to monitor the state of your system. After the connections between the server and the controllers have been physically set up, defined, and enabled, the server starts to record channel and controller communications statistics.
PAGE 118
plscpcg.book Page 100 Monday, May 28, 2001 10:11 AM 7 – Configuring Controllers For some types of controllers, it is necessary to disable and then re-enable the channel or controller in order to re-establish communications after the problem has been rectified. For details of these procedures, see “Enabling and Disabling Channels and Controllers” on page 109.
PAGE 119
plscpcg.book Page 101 Monday, May 28, 2001 10:11 AM Defining Channels Defining Channels To define channels with Quick Builder: 1 Create a channel item for each channel in your system. Note 2 When you create a channel item, you need to select a controller type; for example, Allen-Bradley, LCS620, Network Node, and so on. Select the channel item(s) in the item list and complete the relevant fields on each tab. The information you need to specify depends on the type of channel.
PAGE 120
plscpcg.book Page 102 Monday, May 28, 2001 10:11 AM 7 – Configuring Controllers Configure the port for the channel as if the Stallion EasyConnection port were a standard Windows serial port. Example To use the port configured as “COM8”, you would enter the following settings under the Port tab for your channel: Port Type Serial Serial Port Name COM8 Set the other communication parameters such as Baud Rate to the appropriate values for your device.
PAGE 121
plscpcg.book Page 103 Monday, May 28, 2001 10:11 AM Defining Channels Software Flow Control (XON/XOFF) Software flow control uses special characters in the data stream to control the transmission and reception of data. These characters are called “XON” and “XOFF”. Because they interfere with the data flow, these characters should not appear in the normal data transmitted in the data stream. XON/XOFF flow control is therefore normally used only to transmit ASCII characters.
PAGE 122
plscpcg.book Page 104 Monday, May 28, 2001 10:11 AM 7 – Configuring Controllers The following timing diagram shows how this works with a radio system. RTS DTE Originated (Server) RTS is dropped in order to allow the radio system to key transmission in the other direction so that the Controller may respond to the Server. CTS DCE Originated (Radio Modem) DATA DTE Originated Figure 7.
PAGE 123
plscpcg.book Page 105 Monday, May 28, 2001 10:11 AM Defining Channels Pin Number Data Line Description 3 RXD Receive serial data 4 RTS Request to Send 5 CTS Clear to Send 6 DSR Device (DCE) ready 7 GND or COM Signal common (ground) 8 DCD or RLSD Carrier Detect 20 DTR Server (DTE) ready 22 RI Ring Indication Table 7.1 Stallion RS-232 Pin Assignments (Continued) RS-422 Requirements There are no special settings required in Quick Builder for a RS-422 setup.
PAGE 124
plscpcg.book Page 106 Monday, May 28, 2001 10:11 AM 7 – Configuring Controllers 4-wire configuration To use the Stallion EasyConnection board with a 4-wire RS-485 configuration, do not select Echo (Required for Stallion RS-485 ports) on the serial port tab for the channel properties in Quick Builder. Stallion Board Lines 15 17 19 25 3 18 RS-485 4-wire device Tx Tx Rx Rx +ve - ve +ve -ve To other RS-485 devices Figure 7.
PAGE 125
plscpcg.book Page 107 Monday, May 28, 2001 10:11 AM Defining Controllers Defining Controllers You define controllers with Quick Builder: 1 Create a controller item for each controller in your system. Note that when you create a controller item, you need to specify the controller type; for example, an Allen-Bradley, a Series 9000, and so on. 2 Select one (or more) of the controller items in the item list and then complete the relevant fields on each tab.
PAGE 126
plscpcg.book Page 108 Monday, May 28, 2001 10:11 AM 7 – Configuring Controllers Testing Communications It is important to resolve any connection problems before starting to define points. After downloading the channel and controller definitions from Quick Builder to the server database, you can test the communications between the server and the controllers by running the special test utilities that come with PlantScape.
PAGE 127
plscpcg.book Page 109 Monday, May 28, 2001 10:11 AM Enabling and Disabling Channels and Controllers Enabling and Disabling Channels and Controllers After you have downloaded the channels and controllers to the server, you need to “enable” them so that the system can send and receive data. To enable or disable channels and controllers, you need to be using Station with a security level of SUPV or higher. Security levels are described in “About Security Levels” on page 212.
PAGE 128
plscpcg.book Page 110 Monday, May 28, 2001 10:11 AM 7 – Configuring Controllers If you have defined redundant communications links (as described in “Communications Redundancy” on page 100), the System Status–Controllers display works like the display for a single link, except that there are two lines of information for each controller: one for link A, and one for link B.
PAGE 129
plscpcg.book Page 111 Monday, May 28, 2001 10:11 AM Monitoring the Status of Communications in Your System Monitoring the Status of Communications in Your System You can monitor your PlantScape system communications by checking on the status and error statistics of each channel and each controller in your system. Channel Status and Error Statistics To view status and error statistics information: 1 Call up the System Status–Channels display as described in “Enabling a Channel” on page 109.
PAGE 130
plscpcg.book Page 112 Monday, May 28, 2001 10:11 AM 7 – Configuring Controllers Viewing Channel and Controller Configuration Information You can call up System Configuration displays to view information about the channels and controllers that have been defined and enabled for your system.
PAGE 131
plscpcg.book Page 113 Monday, May 28, 2001 10:11 AM Viewing Channel and Controller Configuration Information For each controller in your system, the System Configuration–Controllers display shows: • Whether or not the controller is enabled • The channel number • The Hiway identifier (only applicable to TDC 3000 Data Hiway controllers) • The controller ID This information is also available on the System Status–Controllers display, and you can enable or disable controllers on both displays.
PAGE 132
plscpcg.
PAGE 133
plscpcg.book Page 115 Monday, May 28, 2001 10:11 AM 8 Configuring Points The information in this chapter applies to configuring points on controllers other than PlantScape Control Processors. For information on points on PlantScape Control Processors, refer to the PlantScape Process Control Building Guide. This chapter provides an overview of the different types of points you can configure and how they can be used.
PAGE 134
plscpcg.book Page 116 Monday, May 28, 2001 10:11 AM 8 – Configuring Points About Points The PlantScape server uses “points” to store information about a field value or device, for example, the state of a pump, a temperature sensor, the process variable of a control loop, and so on. PlantScape records each significant change in the values for a point as an event, which operators can see on the Event Summary display.
PAGE 135
plscpcg.book Page 117 Monday, May 28, 2001 10:11 AM About Points 3 Station to configure the history collection for PlantScape Control Processor point, as described in “Viewing History Collection Configuration” on page 169 of this chapter. Points on Other Types of Controllers For points on other types of controllers (for example, Allen-Bradley, TDC 3000 Data Hiway, Series 9000 and so on): 1 Use Quick Builder to create each point item and define its properties.
PAGE 136
plscpcg.book Page 118 Monday, May 28, 2001 10:11 AM 8 – Configuring Points Point Types PlantScape provides the following standard point types, which have fixed data structures: Type Description Status Represents digital inputs or outputs. For example, the on and off states of a pump or light. Analog Represents continuous values. For example, pressures in a boiler or temperatures in a blast furnace. Accumulator Represents total values.
PAGE 137
plscpcg.book Page 119 Monday, May 28, 2001 10:11 AM Point Servers Point Servers A point server is a software component that interfaces between a PlantScape Server and devices and channels that are represented in PlantScape as flexible points. This section discusses configuration issues in PlantScape that apply to any point server. For information about a particular point server, see the documentation supplied with the field devices represented within it.
PAGE 138
plscpcg.book Page 120 Monday, May 28, 2001 10:11 AM 8 – Configuring Points Main Properties This section describes the main properties of PlantScape points. Some properties are common to all point types, and some are specific. The main properties that are common to all point types are: Property See… Point ID: “Point ID” on page 121. Description: “Description” on page 122. Area Code: “Area Code” on page 122.
PAGE 139
plscpcg.book Page 121 Monday, May 28, 2001 10:11 AM Main Properties Property See… Scanning Enabled: See “Building Points Off-Scan” on page 181. The main properties specific to Accumulator Points are: Property See… Engineering Units: “Engineering Units” on page 132. Range High Value: “Range High Value” on page 133. Rollover Value: “Rollover Value” on page 132. Scale Factor: “Scale Factor” on page 133. Meter Factor: “Meter Factor” on page 133.
PAGE 140
plscpcg.book Page 122 Monday, May 28, 2001 10:11 AM 8 – Configuring Points If the PlantScape Distributed Server Architecture option is installed, the point ID of any point that will be accessed from another server must be unique across all servers. Description Use the Description to provide more detailed identifying information about the point; for example, “Number 3 blast furnace”.
PAGE 141
plscpcg.book Page 123 Monday, May 28, 2001 10:11 AM Main Properties Status Point Parameters A status point can access three types of field values: • Process Variable (PV) • Output (OP) • Mode (MD) Figure 8.1, “Status Point Representing a Pump” on page 123 shows the relationship between a field value and a status point. Server (Station Display) Controller Plant Equipment DEVCTL OP MD Digital Input Digital Output PV OP MD Pump Figure 8.
PAGE 142
plscpcg.book Page 124 Monday, May 28, 2001 10:11 AM 8 – Configuring Points Number of States Status point PVs are used to represent the current “state” of the field device or process. For example, you could define four distinct states for a valve: TRAVEL, CLOSED, OPEN, and FAIL. The PV for a status point in PlantScape can be used to represent up to eight discrete states.
PAGE 143
plscpcg.book Page 125 Monday, May 28, 2001 10:11 AM Main Properties Status Point Output (OP) OP is the opposite of PV, that is, OP represents values that can be changed by an operator or by another component of the system when performing supervisory control. The OP of a point can only be changed by an operator if the mode of that point has been set to “manual.” (For details of point modes, see “Status Point Mode (MD)” on page 125.
PAGE 144
plscpcg.book Page 126 Monday, May 28, 2001 10:11 AM 8 – Configuring Points Analog Point Parameters An analog point can represent the following different types of field values: • Process Variable (PV) • Output (OP) • Mode (MD) • Setpoint (SP) • Up to four auxiliary values (A1, A2, A3, A4) Analog points represent continuous values such as pressures or temperatures. Figure 8.4, “Analog Point Used to Represent a Temperature” on page 126 shows the relationship between a field value and an analog point.
PAGE 145
plscpcg.book Page 127 Monday, May 28, 2001 10:11 AM Main Properties Engineering Units In defining the PV of an analog point, you need to specify the engineering units used in representing the PV value; for example, degrees Kelvin, ohms, megalitres/minute, and so on. Range High Value and Range Low Value You also need to specify the highest and the lowest valid values of the range for this point.
PAGE 146
plscpcg.book Page 128 Monday, May 28, 2001 10:11 AM 8 – Configuring Points Figure 8.5 How Drift Deadbands Work Clamp Point When defining an analog point you can indicate whether you want the PV to be clamped to 0% if it less than the PV clamp low limit, and 100% if it is greater than the PV clamp high limit (for information about setting clamp limits, refer to“PV Clamp Values for Analog Points” on page 189).
PAGE 147
plscpcg.book Page 129 Monday, May 28, 2001 10:11 AM Main Properties PV PV Low Clamp Limit Raw Input Value 0% Raw Input Value 0% Low Clamp Limit PV PV High Clamp Limit 100% Raw Input Value High Clamp Limit 100% Raw Input Value Figure 8.6 Effects of PV Clamping Analog Output (OP) The output (or “OP”) can be used to read and write an analog value. It can only be changed by an operator if the mode is set to MANUAL (see “Analog Mode (MD)” on page 130).
PAGE 148
plscpcg.book Page 130 Monday, May 28, 2001 10:11 AM 8 – Configuring Points SP SP 500.0 500.0 PV 550.0 OP 25.0 PV 550.0 OP 25.0 Field Controller Server Figure 8.7 Analog Point Analog Mode (MD) The mode (or “MD”) is used to determine whether or not an operator is permitted to control the output value. The two most common modes are: “manual” and “automatic.” For more details about control modes, see “Control Modes” on page 153.
PAGE 149
plscpcg.book Page 131 Monday, May 28, 2001 10:11 AM Main Properties Accumulator Point Counter Flow Meter Field AZGALLONS Controller Server Figure 8.8 Accumulator Point An accumulator point can access a single counter input value. Accumulator Point Process Variable (PV) The PV for an accumulator point is used to read a value from a counter that continues to increment until it reaches its rollover value, at which time it resets.
PAGE 150
plscpcg.book Page 132 Monday, May 28, 2001 10:11 AM 8 – Configuring Points Now suppose that the value of the field counter changes to 4050. We then have: AZGALLONS 4050 4050 Figure 8.10 Counter Increases by 50 If the counter increases by another 50, it will roll over: AZGALLONS 0004 4100 Figure 8.
PAGE 151
plscpcg.book Page 133 Monday, May 28, 2001 10:11 AM Main Properties Note that, regardless of this “physical” rollover value, the accumulator point PV continues to increase indefinitely until it reaches its maximum value or until it is reset by an operator. Range High Value You also need to specify the value that represents the highest available range for this point. This is only used to scale the height of the PV indicator.
PAGE 152
plscpcg.book Page 134 Monday, May 28, 2001 10:11 AM 8 – Configuring Points Not all parameters need to be configured for a point. In many cases, the only parameter of a point that needs to be configured is the PV which shows the current value of a given location within a controller. The following table summarizes these parameters.
PAGE 153
plscpcg.book Page 135 Monday, May 28, 2001 10:11 AM Description Status Description The description of the point. 37 ✔ ✔ ✔ EULO 0% range 16 ✔ ✔ EUHI 100% range 17 ✔ ✔ AlarmLimit1 The value at which alarm 1 is tripped. 18 ✔ ✔ AlarmLimit2 The value at which alarm 2 is tripped. 19 ✔ ✔ AlarmLimit3 The value at which alarm 3 is tripped. 20 ✔ ✔ AlarmLimit4 The value at which alarm 4 is tripped. 21 ✔ ✔ AlarmLimit5 The value at which alarm 5 is tripped.
PAGE 154
plscpcg.book Page 136 Monday, May 28, 2001 10:11 AM The type of alarm 8, for example, PVHI 25 ✔ ✔ RollOver Accumulator input rollover value, for example, a 12 bit counter rolls over at 4095. 26 ✔ MeterFactor The accumulator meter factor. Normally 1.0, is adjusted after meter proving. 27 ✔ ScaleFactor The accumulator scale factor, for example, 1 pulse.count = 5.678 liters. 28 ✔ RawPV The value of the accumulator raw input (the counter it is reading).
PAGE 155
plscpcg.book Page 137 Monday, May 28, 2001 10:11 AM Description Status H8HE History Extended 8 hour 48 ✔ ✔ ✔ H24HE History Extended 24 hour 49 ✔ ✔ ✔ OnScan 0=off,1=on 56 ✔ ✔ ✔ Alarm Value If the point is not in alarm, the Alarm Value parameter has a value of 0. Otherwise the value is equal to the alarm type as defined in the alarm limit. For example, if the point is in the PV LO state the Alarm Value parameter is 6.
PAGE 156
plscpcg.book Page 138 Monday, May 28, 2001 10:11 AM Description ID Status State0Descriptor The text that describes PV state 0, for example, Travel. 68 ✔ State1Descriptor The text that describes PV state 1, for example, Open. 69 ✔ State2Descriptor The text that describes PV state 2, for example, Closed. 70 ✔ State3Descriptor The text that describes PV state 3, for example, Invalid. 71 ✔ State4Descriptor The text that describes PV state 4, for example, Stopped.
PAGE 157
plscpcg.book Page 139 Monday, May 28, 2001 10:11 AM Description Status UnackAlarmExists The point has alarmed and the alarm has not been acknowledged. 89 ✔ ✔ ✔ Alarm1Priority The alarm priority of alarm 1, for example, Urgent. 92 ✔ ✔ Alarm2Priority The alarm priority of alarm 2, for example, Urgent. 93 ✔ ✔ Alarm3Priority The alarm priority of alarm 3, for example, Urgent. 94 ✔ ✔ Alarm4Priority The alarm priority of alarm 4, for example, Urgent.
PAGE 158
plscpcg.book Page 140 Monday, May 28, 2001 10:11 AM Description ID Status State7AlarmPriority The alarm priority of state 7, for example, Urgent. 99 ✔ AlarmPriority The alarm priority of unreasonable alarm. 100 ✔ ✔ AlarmSubPriority The alarm subpriority of unreasonable alarm. 100 ✔ ✔ ControlFailAlarmPriority The alarm priority at which a control failure is alarmed.
PAGE 159
plscpcg.book Page 141 Monday, May 28, 2001 10:11 AM Description Status State6AlarmSubPriority The alarm subpriority of state 6. (0-15) 108 ✔ State7AlarmSubPriority The alarm subpriority of state 7. (0-15) 109 ✔ AssociatedDisplay When the associated display key is pressed, this display is called up. 110 ✔ ✔ ✔ AlarmMessageIndex A point can be configured to generate a message. This is the message number. 114 ✔ ✔ ✔ REALARM If set (=1), the point in alarm transitions between alarm states.
PAGE 160
plscpcg.book Page 142 Monday, May 28, 2001 10:11 AM Description ID Status State5AlarmEnabled State 5 is an alarm state. 125 ✔ State6AlarmEnabled State 6 is an alarm state. 126 ✔ State7AlarmEnabled State 7 is an alarm state. 127 ✔ NumberOfInputStates Number of Status PV states (2, 4, or 8) 129 ✔ NumberOfOutputState Number of Status OP states (2 or 4) 130 ✔ NormalMode The normal mode of the point, for example, Auto.
PAGE 161
plscpcg.book Page 143 Monday, May 28, 2001 10:11 AM Description Status PVAlgoExists If set (=1), a PV algorithm has been built on the point. 301 ✔ ✔ ✔ ActionAlgoExists If set (=1), an Action algorith has been built on the point. 302 ✔ ✔ ✔ PointInAlarm The point is in alarm (0=no alarm, 1=in alarm) 303 ✔ ✔ ✔ InRateOfChangeAlarm If set (=1), a Rate of Change alarm exists. 304 ✔ ✔ InDeviationLowAlarm If set (=1), a Deviation Low alarm exists.
PAGE 162
plscpcg.book Page 144 Monday, May 28, 2001 10:11 AM A3AssociatedParameter If non zero, the A3 value is store to this parameter. 322 ✔ A4AssociatedParameter If non zero, the A4 value is store to this parameter. 323 ✔ State0InAlarm If set (=1), a State 0 alarm exists. 304 ✔ State1InAlarm If set (=1), a State 1 alarm exists. 305 ✔ State2InAlarm If set (=1), a State 2 alarm exists. 306 ✔ State3InAlarm If set (=1), a State 3 alarm exists.
PAGE 163
plscpcg.book Page 145 Monday, May 28, 2001 10:11 AM Main Properties PlantScape uses “control confirmation” scans to ensure that controls are actually performed by a controller. If a point parameter has a source and a destination address, a parameter is scanned immediately after the value is changed. An alarm is generated if the scanned value does not match the controlled value. Source and destination addresses generally refer to locations within real controllers.
PAGE 164
plscpcg.book Page 146 Monday, May 28, 2001 10:11 AM 8 – Configuring Points • • • • The rate of change of the value. If a value only changes once an hour, it is inefficient to scan that value every five seconds. The rate at which history needs to be collected for the point (in the case of the PV parameter). A point requiring one minute snapshots to be recorded would have a scan period of no greater than 60 seconds.
PAGE 165
plscpcg.book Page 147 Monday, May 28, 2001 10:11 AM Main Properties Scan Point Special A Scan Point Special is a forced scan of point parameters. Whenever scanning of a point is disabled and then re-enabled (for example using the Point Detail display), a Scan Point Special is performed. Application programs and free format reports can request a Scan Point Special demand scan of a point. See “Configuring Reports” on page 239 and the Application Development Guide for more information.
PAGE 166
plscpcg.book Page 148 Monday, May 28, 2001 10:11 AM 8 – Configuring Points Every time points are configured, the server re-builds the scan packets in order to re-optimize scanning. For example, the server will ensure that: • If there are multiple references to an address at the same scan rate, there will be only one entry in the scan packet. • If there are multiple references to an address at different scan rates, a single entry will be made at the fastest rate.
PAGE 167
plscpcg.book Page 149 Monday, May 28, 2001 10:11 AM Control Properties Control Properties Control properties enable authorized operators to intervene or to override the automatic control that is being carried out by controllers. For example, you might have a point that is to be used to monitor a pump so that operators can see whether the pump is on or off.
PAGE 168
plscpcg.book Page 150 Monday, May 28, 2001 10:11 AM 8 – Configuring Points Target Input State Associations Target input state associations are the PV input states that correspond to the output states you wish to use in controlling this point. See the Quick Builder online help for an explanation of descriptor values and their use. Pulse Width Pulsing is an action that can be performed by the server: if the server switches an output ON, a pulse width later the server can switch the output OFF.
PAGE 169
plscpcg.book Page 151 Monday, May 28, 2001 10:11 AM Control Properties Control Properties for Analog Points Property See… Source Address and Destination Address See “Source and Destination Addresses” on page 144. Scan Period See “Point Scanning” on page 145. Setpoint (SP) See “Analog Setpoint (SP)” on page 130. Output (OP) See “Analog Output (OP)” on page 129. Mode (MD) See “Control Modes” on page 153. Reverse Output See “Reverse Output” on page 154.
PAGE 170
plscpcg.book Page 152 Monday, May 28, 2001 10:11 AM 8 – Configuring Points This check is performed every 10 seconds (from when the control is performed) until good control has been achieved or the control timeout period has elapsed (whichever happens first). 100% + Deadband - Deadband SP PV T If T> control timeout then generate PV Fail alarm 0% Time Figure 8.
PAGE 171
plscpcg.book Page 153 Monday, May 28, 2001 10:11 AM Control Properties Control Modes The current control mode of a point determines whether or not an operator is permitted to control the OP or SP of the point. The available control modes are: manual, automatic, cascade, and computer. Cascade and computer are only available with specific controllers. Most PlantScape device interfaces support just single bit modes (that is, values of 0 and 1, displayed by default as MAN and AUTO).
PAGE 172
plscpcg.book Page 154 Monday, May 28, 2001 10:11 AM 8 – Configuring Points Control Level The control level provides an additional form of security on individual points. For each point, you can specify a control level between 0 and 255. At Stations using operator-based security, operators can only control a point if they are defined with a control level equal to or higher than its control level. (See “Configuring Security and Access” on page 209 for information about operator-based security.
PAGE 173
plscpcg.book Page 155 Monday, May 28, 2001 10:11 AM Configuring Alarms for Points Configuring Alarms for Points Alarms are primarily used to notify operators of conditions that might call for intervention or supervisory control. For information on how alarms work with respect to points on PlantScape Control Processors, refer to the Process Control Building Guide. This topic describes how alarms for status, analog, and accumulator points work, and how to define alarms.
PAGE 174
plscpcg.book Page 156 Monday, May 28, 2001 10:11 AM 8 – Configuring Points Alarm Properties for Status Points Property See… Enable (State Alarms) “State Alarms for Status Points” on page 156. Priority and Sub Priority “Defining Events, Alarms, and Alarm Priorities” on page 162. External Change Alarms “External Change Alarms for Status Points” on page 157. Control Fail Alarm “Control Fail Alarms for Status Points” on page 157. Alarm Message Index “Specifying an Alarm Message Index” on page 165.
PAGE 175
plscpcg.book Page 157 Monday, May 28, 2001 10:11 AM Configuring Alarms for Points Alarms on Transition for Status Points You can also configure alarms to be generated if the PV of a point changes from one alarm state to another. For example, if you define both CLOSED and FAILED as alarm states for a valve, the server generates an alarm when the valve fails, and generates an additional alarm when the valve closes as a result of the failure.
PAGE 176
plscpcg.book Page 158 Monday, May 28, 2001 10:11 AM 8 – Configuring Points You might use this feature, for example, if the controller on which this point is built cannot continue normal functioning until the alarm state is acknowledged. For further details, see the Quick Builder online help. Alarm Properties for Analog Points Property See… Alarm Type “PV Limit Alarms for Analog Points” on page 158. Priority and Sub Priority “Defining Events, Alarms, and Alarm Priorities” on page 162.
PAGE 177
plscpcg.book Page 159 Monday, May 28, 2001 10:11 AM Configuring Alarms for Points PV Low A PV Low alarm is generated when the PV falls below the specified limit. PV Low Low A PV Low Low alarm is generated when the PV falls below the specified limit, which must be less than the PV Low limit. Deviation High and Deviation Low A Deviation Low alarm is generated when the PV drops below the SP by the value: • For a positive range, for example, 0 to 100, this will be a negative number.
PAGE 178
plscpcg.book Page 160 Monday, May 28, 2001 10:11 AM 8 – Configuring Points Transmitter High A Transmitter High alarm is similar to the PV High alarm. It can be used to indicate a failed transmitter signal. For each alarm, you can also specify the alarm priority, sub-priority and the specific limit. Alarm priorities and sub-priorities are described in “Defining Events, Alarms, and Alarm Priorities” on page 162. Alarm limits are described below.
PAGE 179
plscpcg.book Page 161 Monday, May 28, 2001 10:11 AM Configuring Alarms for Points Alarm Deadband for Analog Points On the Alarm property sheet for an analog point you can specify an alarm deadband so that an analog value (moving in and out of the alarm limit) will not generate unwanted alarms. To define a deadband, select a percentage value from the Alarm Deadband list.
PAGE 180
plscpcg.book Page 162 Monday, May 28, 2001 10:11 AM 8 – Configuring Points Accumulator Point Alarm Types For each accumulator point you can define up to four alarms for indicating when the PV has gone beyond certain limits. You can choose from three alarm types for an accumulator point when defining an alarm to indicate when the PV has gone beyond certain limits: Property Description Rate Of Change The rate of change of the PV, in engineering units per second, exceeds the limit.
PAGE 181
plscpcg.book Page 163 Monday, May 28, 2001 10:11 AM Configuring Alarms for Points The priority determines whether the server treats a change as an event or an alarm: Property Description Journal The change is written to the event file, where it can be accessed for alarm and event reports, or event displays on a Station. Journal priority alarms do not appear in the Alarm Summary.
PAGE 182
plscpcg.book Page 164 Monday, May 28, 2001 10:11 AM 8 – Configuring Points Configuring the Precedence of Alarms in the Alarm Line The sub-priority defined for each alarm determines which alarm takes precedence appears in the alarm line of a Station display.
PAGE 183
plscpcg.
PAGE 184
plscpcg.book Page 166 Monday, May 28, 2001 10:11 AM 8 – Configuring Points If you need to temporarily disable alarming when a status point changes to a nominated state, you can use the Status Change Alarm Group Inhibit algorithm (#79) or the Status Change Alarm Area Inhibit algorithm (#80). The configuration of algorithms is described in “Configuring Algorithms” on page 193. You can also disable all alarms across the system (see “Point Alarm Enabling/Disabling” on page 187).
PAGE 185
plscpcg.book Page 167 Monday, May 28, 2001 10:11 AM History Collection and Archiving History Collection and Archiving PlantScape can be configured to store the values of points at predetermined intervals to create a history of process values. This process is known as history collection and archiving. This historical information can then be called up on a Station Trend display so that operators can monitor the trends in the processes represented by those points.
PAGE 186
plscpcg.book Page 168 Monday, May 28, 2001 10:11 AM 8 – Configuring Points • • • 1-hour averages of the 1-minute snapshots 8-hour averages of the 1-minute snapshots 24-hour averages of the 1-minute snapshots The averages are calculated using the 1-minute base interval. That is, for 6-minute averages are calculated on six 1-minute values. If you change the 1-minute base interval the averages are still calculated from the base interval.
PAGE 187
plscpcg.book Page 169 Monday, May 28, 2001 10:11 AM History Collection and Archiving History Types Extended History Fast History Intervals Default Retention Period Duration Number of Samples 1-hour snapshot 7 days 170 8-hour snapshot 3 months 281 24-hour snapshot 1 year 368 1 - 30-second snapshot 1 hour 3670 - 122 Table 8.
PAGE 188
plscpcg.book Page 170 Monday, May 28, 2001 10:11 AM 8 – Configuring Points You can also use these displays to add points and parameters for history collection. Note Because you do not use Quick Builder to configure CDA points (points on PlantScape Control Processors), you use the History Collection displays to configure history collection for these points by entering the point IDs and parameters of the points whose history you want to collect.
PAGE 189
plscpcg.book Page 171 Monday, May 28, 2001 10:11 AM History Collection and Archiving In the String field, enter the starting folders for your history archive folder trees. The first folder path in the string is the default archive folder. Enter any additional folders after the default folder, separating them with semi-colons. The changes take effect next time you start the server.
PAGE 190
plscpcg.book Page 172 Monday, May 28, 2001 10:11 AM 8 – Configuring Points Where Is… DD The day that the archive was made (for example, 03 for the 3rd day of the month, and so on). HH The hour that the archive was made (for example, 13 for 1 pm). RRR The number of the history archive report that was used to create the archive.
PAGE 191
plscpcg.book Page 173 Monday, May 28, 2001 10:11 AM History Collection and Archiving To configure history archives: 1 From the System Configuration Menu display, click History Archiving. 2 Using the checkboxes under History Types to Archive, select the history types you want to archive. (See “Types of History Collection” on page 167 for a detailed description of history types.) 3 Enter the minimum free disk space that must be available for this archiving job to run.
PAGE 192
plscpcg.book Page 174 Monday, May 28, 2001 10:11 AM 8 – Configuring Points 8 Under Disk Limit, enter the minimum free disk space that must be available for this archiving job to run. This prevents all of the free disk space on the server from being used for history archive files. (If the disk becomes full, system performance will be severely degraded.) The Disk Free limit is a system wide limit used by all history archive reports.
PAGE 193
plscpcg.
PAGE 194
plscpcg.book Page 176 Monday, May 28, 2001 10:11 AM 8 – Configuring Points By assigning points to a trend set, you enable users to view trend information for the data collected from those points by calling up a Trend Set display. For examples of Operating Group and Trend Set displays, refer to “Configuring Group and Trend Displays” on page 225. You can configure up to 16000 operating groups and up to 3000 trend sets.
PAGE 195
plscpcg.book Page 177 Monday, May 28, 2001 10:11 AM Configuring Station Displays for Points For example, the following figure shows a Group Detail display for an operating group consisting of two analog points and six status points. The analog points in this display all use the standard faceplate for analog points and the status points all use the standard faceplate for status points. Figure 8.
PAGE 196
plscpcg.book Page 178 Monday, May 28, 2001 10:11 AM 8 – Configuring Points Changing Point Configuration via Station Displays After a point definition has been stored in the server database, you can use the Point Detail display on Station to view configuration details for the point. You can also use a Point Detail display to change point configuration information, but you must be using Station at a security level of SUPV or higher.
PAGE 197
plscpcg.book Page 179 Monday, May 28, 2001 10:11 AM Advanced Point Configuration Advanced Point Configuration The configuration tasks described in this topic relate to functions that are not essential to implement for the successful running of your system, but rather allow you to take advantage of some advanced features of PlantScape point configuration.
PAGE 198
plscpcg.book Page 180 Monday, May 28, 2001 10:11 AM 8 – Configuring Points When a source address is configured for a database type address, an equivalent destination address is automatically defined. Destination addresses cannot be explicitly configured for database addresses. Note You could configure a point on a PlantScape Control Processor as a source address for a database point. However, this is inefficient and might significantly degrade system performance.
PAGE 199
plscpcg.book Page 181 Monday, May 28, 2001 10:11 AM Advanced Point Configuration Using Auxiliary Parameters to Track Controller Alarm Limits If you set the auxiliary parameter name to match the name of an internal point parameter, then the internal parameter’s value will track the value in the controller. If the internal parameter is changed, the value will also be written to the auxiliary parameter’s destination address.
PAGE 200
plscpcg.book Page 182 Monday, May 28, 2001 10:11 AM 8 – Configuring Points • Scaled formats, which converts and scales a field value before loading it into the parameter. With a scaled format, parameters that use this format are automatically scaled. To create a user-defined data format: 1 On the SystemConfigurationMenu display clickUser-defined DataFormats. 2 Click the Unscaled or Scaled tab, as appropriate. 3 Click an empty data format row. 4 Enter the name for the data format.
PAGE 201
plscpcg.book Page 183 Monday, May 28, 2001 10:11 AM Advanced Point Configuration Property Description Type The type of conversion, which can be either: • Linear. A conversion ratio defined by Node 1 and Node 2. Note that the nodes only define the conversion ratio, not the minimum/maximum values. Real Value Node2 Node1 Instrument Value • Piecewise Linear. Approximates a conversion curve that can have up to seven nodes.
PAGE 202
plscpcg.book Page 184 Monday, May 28, 2001 10:11 AM 8 – Configuring Points To define a format for this: 1 Define an unscaled data format. 2 In the Field Value section select INT2 from Data type, and set the Start bit to 0 and Width to 16. 3 Select Signed value. (Do not select Swap words or Swap bytes.) 4 Enter NaN in Minimum and Maximum. 5 In the Conversion section select Linear. Set the node values as follows.
PAGE 203
plscpcg.book Page 185 Monday, May 28, 2001 10:11 AM Advanced Point Configuration Real Value 100 55.5 33.3 5 25 100 Instrument Value 2 3 4 5 6 7 Define an unscaled data format. In the Field Value section select REAL4 from Data type. Select Swap bytes. (Do not select Swap words.) Enter NaN in Minimum and Maximum. In the Conversion section select Piecewise linear curve. Set the Node values as follows. Node Field value Converted value 1 0 0 2 5 33.3 3 25 55.
PAGE 204
plscpcg.
PAGE 205
plscpcg.book Page 187 Monday, May 28, 2001 10:11 AM Advanced Point Configuration Point Alarm Enabling/Disabling When you are configuring a point, you can disable its alarms in Quick Builder. (see “Configuring Alarms for Points” on page 155). Server-Wide Alarms You can temporarily disable all alarms for your system by deselecting the Alarms enabled server-wide checkbox on the Alarm Processing tab under Alarm & Point Processing. By default, Alarms enabled server-wide is selected.
PAGE 206
plscpcg.book Page 188 Monday, May 28, 2001 10:11 AM 8 – Configuring Points When external alarm notification is enabled, the specified point parameter is controlled to: 1, when an alarm occurs 0, when an alarm is acknowledged or returns to normal You cannot specify active times or re-alarm times for external alarm notifications, as you can for Stations audible alarms. To enable or disable external alarm notification for any of the four priority choices, select or clear the appropriate checkbox.
PAGE 207
plscpcg.book Page 189 Monday, May 28, 2001 10:11 AM Advanced Point Configuration To customize status line indicator colors: 1 On the System Configuration Menu display, click Alarm and Point Processing. 2 On the Alarm & Point Processing display click the Alarm Colors tab. 3 Under Status Line Indicator Colors select the appropriate color for each indicator you want to change. To customize the color of points off-scan: 1 On the System Configuration Menu display, click Alarm and Point Processing.
PAGE 208
plscpcg.book Page 190 Monday, May 28, 2001 10:11 AM 8 – Configuring Points When a point is deleted from the server, the internal number for that point is freed, and is available to be allocated to another point. If you need to know which internal point numbers are currently in use, you can use the listag utility to list the points currently configured in the database. For details of running the listag utility, refer to “Command Reference” on page 483.
PAGE 209
plscpcg.book Page 191 Monday, May 28, 2001 10:11 AM Advanced Point Configuration Property Description Channel Shows the channel number and name. Status Shows the channel service status (for example, OK for “in service”, DISABLED for “out of service”). Ovld Indicates an overload if the channel is unable to process all its requests or the channel cannot do the work it was requested to do in the time specified.
PAGE 210
plscpcg.book Page 192 Monday, May 28, 2001 10:11 AM 8 – Configuring Points Property Description Cycles Behind Indicates that the length of time since the last scan is greater than the scan period. Cycles behind is only valid while the current cycle is behind. When the next cycle starts, this entry will be reset to zero. Requests Lost This column displays the number of requests lost.
PAGE 211
plscpcg.book Page 193 Monday, May 28, 2001 10:11 AM Configuring Algorithms Configuring Algorithms Algorithms perform additional point processing or initiate actions when point values change. Note • • • You cannot configure algorithms for flexible points and container points (see “Template Displays and Container Points” on page 237). For information about constraints on configuring algorithms for a distributed server architecture, see “Working with Algorithms” on page 348.
PAGE 212
plscpcg.book Page 194 Monday, May 28, 2001 10:11 AM 8 – Configuring Points • • • • • • • Run Hours (Algo#7) General Logic (Algo#10) Composite Alarm Processing (Algo#12) Integration (Algo#15) Cyclic Task Request (Algo#16) Piecewise Linearization (Algo#22) Maximum/Minimum (Algo#64) Action Algorithms Action algorithms initiate some action when the PV of the point to which they are attached changes. Action algorithms are processed whenever the PV of a point changes.
PAGE 213
plscpcg.book Page 195 Monday, May 28, 2001 10:11 AM Configuring Algorithms Algorithms #16 and #69 are also documented in the Application Development Guide. Defining Algorithms To define an algorithm for a point: 1 Select the point item in the Quick Builder item list. 2 In the PV Algo box or the Action Algo box, select the type of algorithm you need to configure. 3 Select the PV Algo tab or the Action Algo tab and complete the fields.
PAGE 214
plscpcg.book Page 196 Monday, May 28, 2001 10:11 AM 8 – Configuring Points Finding Free Algorithm Blocks Algorithm blocks are used to store the algorithm configuration as well as working values required by the algorithm. Algorithm blocks are part of the database. Details of the number of blocks available can be found in the installation guide.
PAGE 215
plscpcg.book Page 197 Monday, May 28, 2001 10:11 AM 9 Configuring Alarm Paging The Alarm Pager licensable option is a background task that monitors Station alarms to determine which new alarms meet the criteria for paging out and sends the messages to the appropriate pagers. Paging starts when messages are placed on the queue. First the system checks which connection method is being used: either direct connection to a paging system, or connection by modem to a paging service provider.
PAGE 216
plscpcg.
PAGE 217
plscpcg.book Page 199 Monday, May 28, 2001 10:11 AM Configuring Alarm Paging Configuring Alarm Paging You can configure a number of characteristics of the Alarm Paging system. For example, you can: • Select the connection method, either to a paging system or by modem to a paging service provider. • Enter information regarding modem or paging system connections and set a password. • Configure communications settings. • View the alarm paging status. • Enable or disable the pager service.
PAGE 218
plscpcg.book Page 200 Monday, May 28, 2001 10:11 AM 9 – Configuring Alarm Paging Alarm Paging Settings This section gives a brief description of the settings on the Communication tab of the Alarm Paging display. Modem Connection and Dialing Settings Used for entering or changing modem or paging system connection and dialing settings. For details, see “Setting Up Alarm Paging Communications” on page 202. Service Provider Communication Settings Used for entering or changing communication settings.
PAGE 219
plscpcg.book Page 201 Monday, May 28, 2001 10:11 AM Configuring Alarm Paging The number of messages shown in each queue is the number of alarms that are to be paged out, not the number of individual messages sent to individual pagers. For example, there might be ten messages on the queue display but these ten messages might be paged to twenty or more pagers. Main Queue: The number is incremented when the server issues an alarm that is configured for paging.
PAGE 220
plscpcg.book Page 202 Monday, May 28, 2001 10:11 AM 9 – Configuring Alarm Paging Setting Up Alarm Paging Communications The Alarm Paging system communicates with the modem or paging system through a serial port. It is important that you do not use this serial port for any purpose other than for paging alarms. The Alarm Paging system automatically sets the communication settings between the serial port and the modem.
PAGE 221
plscpcg.book Page 203 Monday, May 28, 2001 10:11 AM Configuring Alarm Paging 6 7 Click Set Password to set an Alarm Paging password (if required). The password is usually supplied by the service provider. For example, for PET protocol the password usually has the format “PG1xxxxxx”, where xxxxxx is the password supplied by the service provider. (If the provider does not supply a password, you might still need to set the Alarm Paging password to PG1. Check with your provider for details.
PAGE 222
plscpcg.book Page 204 Monday, May 28, 2001 10:11 AM 9 – Configuring Alarm Paging Property Description Initialization Command The command string needed to set the modem to the settings as required by the provider.
PAGE 223
plscpcg.book Page 205 Monday, May 28, 2001 10:11 AM Configuring Alarm Paging Property Description Phone Ringing The response which the modem issues if it detects that the line is ringing on the other end. The default is RINGING. Change to RING for modems in List A and List B*. Connection Detected The response issued by the modem if it detects that the connection with the provider’s modem at the other end is successful. The default is CONNECT.
PAGE 224
plscpcg.book Page 206 Monday, May 28, 2001 10:11 AM 9 – Configuring Alarm Paging If you are using Short Message Service on a mobile phone, then the pager ID is the mobile phone number. Note 3 Do not enter the phone number of the Pager Service Provider on this display. The service provider’s number is entered when configuring the Alarm Paging modem. See “Setting Up Alarm Paging Communications” on page 202. If unacknowledged alarms to this pager are escalated, select the pager that receives them.
PAGE 225
plscpcg.book Page 207 Monday, May 28, 2001 10:11 AM Configuring Alarm Paging Nominating Alarms to be Paged There are two ways to nominate the alarms that will be sent to each pager. One way is to individually specify every point that is to have its alarms paged. The other way is to nominate the alarms by areas assigned to operators. Nominating Individual Point Alarms You use the Specific Alarms tab on the Alarm Paging display to specify the point points that are to have alarms paged out.
PAGE 226
plscpcg.book Page 208 Monday, May 28, 2001 10:11 AM 9 – Configuring Alarm Paging For example, a Station operator named Norm Smith might have areas A1, A2, and A3 assigned to him. Only alarms from areas A1, A2, and A3 are sent to any pager configured with Norm Smith’s Operator ID. For information on setting up an operator’s profile, see “Configuring Operator-Based Security” on page 216. To nominate alarms by areas: 1 Click the Pagers tab on the Alarm Paging display. 2 Enter the Pager Name and Pager ID.
PAGE 227
plscpcg.book Page 209 Monday, May 28, 2001 10:11 AM 10 Configuring Security and Access This chapter shows you how to configure security for your PlantScape system. It describes: • The two main types of security you can use • How you configure each type of security • How to use areas to limit access and distribute alarms accordingly Note This chapter does not describe how you secure the operating system. For information on securing Microsoft Windows, see the administration guide.
PAGE 228
plscpcg.book Page 210 Monday, May 28, 2001 10:11 AM 10 – Configuring Security and Access About Security The security required for your PlantScape system can be divided as follows: • Windows operating system security • Station security When you install the PlantScape software, three Windows accounts are set up. These accounts are required to give users access to the Windows operating system.
PAGE 229
plscpcg.book Page 211 Monday, May 28, 2001 10:11 AM Understanding Station Security Understanding Station Security When you define a Station, you also define the security method that will control access to functions at that Station.
PAGE 230
plscpcg.book Page 212 Monday, May 28, 2001 10:11 AM 10 – Configuring Security and Access • Areas are assigned to the operator, irrespective of which Station they are currently logged on to. Operator-Based Security and Point Control You can specify a control level for a point when it is configured in the server database. (Control levels for points are described in “Control Properties” on page 149.
PAGE 231
plscpcg.book Page 213 Monday, May 28, 2001 10:11 AM Understanding Station Security If you have configured a Station to use Operator-Based security: • The Station prompts you to sign on, and you cannot access any Station functions until you have successfully signed on. If you have not configured a Station to use Operator-Based security: • The Station starts at a security level of OPER, but you need to enter a password if you want to access a higher level of security.
PAGE 232
plscpcg.book Page 214 Monday, May 28, 2001 10:11 AM 10 – Configuring Security and Access Configuring Station-Based Security If you have opted for the Station-Based security method, it is recommended that you change the default passwords (one each for ENGR, SUPV, and MNGR) that were installed as part of the PlantScape installation process. Under Station-based security, only levels SUPV, ENGR, and MNGR require passwords because: • LVL1 and LVL2 are not available.
PAGE 233
plscpcg.book Page 215 Monday, May 28, 2001 10:11 AM Configuring Station-Based Security Using Passwords in Station-Based Station Security To access functions that are associated with security levels higher than OPER: 1 Start up Station if it is not already running. 2 Type psw in the command zone and press (or click the Security Level displayed in the Status Line). The Station Logon dialog box opens. 3 Enter the password for the desired security level and click OK.
PAGE 234
plscpcg.book Page 216 Monday, May 28, 2001 10:11 AM 10 – Configuring Security and Access Configuring Operator-Based Security If you wish to use Operator-Based security, you need to: 1 Specify Operator-Based security for each Station that is to use this security method. 2 Define each operator who needs to access these Stations. Enabling Operator-Based Security You specify Operator-Based security for a Station when you define the Station connection in Quick Builder.
PAGE 235
plscpcg.book Page 217 Monday, May 28, 2001 10:11 AM Configuring Operator-Based Security To add an operator to the system: 1 Click an unassigned operator ID position in the Operator ID column. This opens the Operator Configuration display. 2 For the operator you want to add, type the appropriate information into the text fields. Make certain you type a unique operator ID of no more than four alphanumeric characters for the operator.
PAGE 236
plscpcg.book Page 218 Monday, May 28, 2001 10:11 AM 10 – Configuring Security and Access Property Description Area Assignment Tab Opens the Area Assignment display for that operator. Use the Area Assignment display to view or define the areas that the operator can access. For more information, see “Using Areas to Control Access to the System” on page 222.
PAGE 237
plscpcg.book Page 219 Monday, May 28, 2001 10:11 AM Configuring Operator-Based Security Property Description Password Expiry Period Operator passwords will expire after this number of days, and a new password will be required. Password Validation Period PlantScape does not allow operators to reuse any of their 10 most recently used passwords unless the password was changed at least as many days ago as specified in this field.
PAGE 238
plscpcg.book Page 220 Monday, May 28, 2001 10:11 AM 10 – Configuring Security and Access Locking Stations in Full Screen and Disabling Menus You can restrict access to non-Station software on an operator Station by implementing one or more of the following security measures: • Lock the Station window in full screen so that users cannot resize the window or access operating system functions and non-Station applications. • Disable the Exit menu choice so users cannot close down this Station.
PAGE 239
plscpcg.book Page 221 Monday, May 28, 2001 10:11 AM Locking Stations in Full Screen and Disabling Menus There are a number of other command line options, such as specifying the name of the setup file that you want Station to start up with (see “Starting Station” on page 63.) For details of other command line options, refer to “station” on page 504 in “Command Reference” on page 483. To change a Station’s command line: 1 Right-click the Start button. 2 Select Open All Users.
PAGE 240
plscpcg.book Page 222 Monday, May 28, 2001 10:11 AM 10 – Configuring Security and Access Using Areas to Control Access to the System When you assign areas, you control the level of access to an area by setting the security level. Area security levels are used in conjunction with the existing operator-based or Station-based security.
PAGE 241
plscpcg.book Page 223 Monday, May 28, 2001 10:11 AM Using Areas to Control Access to the System 2 3 Tip Click Operator Area Assignment. This opens the Operator Area Assignment tab for individual operators. For each operator, you can select an area profile from the list (see “Area Profiles” on page 93) or you can select the areas the operator needs to access and the level of access for each area.
PAGE 242
plscpcg.book Page 224 Monday, May 28, 2001 10:11 AM 10 – Configuring Security and Access Changing the Names of Security Levels You can change the default names (OPER, MNGR, and so on) that are used to identify each security level, and which are displayed in Station’s Status Line. The default name for security levels are PlantScape acronyms that can be changed via the System Acronym Configuration display. To change the security level acronyms: 1 From the Station menu select Configure ⇒ Acronyms ⇒ System.
PAGE 243
plscpcg.book Page 225 Monday, May 28, 2001 10:11 AM 11 Configuring Group and Trend Displays This chapter describes how you configure two types of standard displays that can be used for grouping information and showing trends: • Group displays • Trend displays These displays require only minimal configuration and provide a convenient way for operators and other users to view information about a group of related points on a single display.
PAGE 244
plscpcg.book Page 226 Monday, May 28, 2001 10:11 AM 11 – Configuring Group and Trend Displays Configuring Groups You can only configure groups after you have configured points for your site. To configure groups, you need to be using Station with a security level of SUPV (or higher). Security levels and the procedures for changing security levels are described in “Configuring Security and Access” on page 209.
PAGE 245
plscpcg.book Page 227 Monday, May 28, 2001 10:11 AM Configuring Groups Figure 11.1 Group Detail Display Creating Groups To create new groups (or display information about existing groups), click Groups on the System Configuration Menu display. This calls up the Group Configuration Summary display. The Group Configuration Summary display is used to list groups configured for your site. From this display you can access the details of any group already in the system.
PAGE 246
plscpcg.book Page 228 Monday, May 28, 2001 10:11 AM 11 – Configuring Group and Trend Displays 5 From the drop-down list of parameters, select the parameter that you want shown in the group trend and group numeric history for each point. This parameter should be PV for standard points, or the equivalent for flexible points. Note 6 Selecting a parameter other than PV (or equivalent) does not change the parameter shown on the faceplates in the group displays.
PAGE 247
plscpcg.book Page 229 Monday, May 28, 2001 10:11 AM Configuring Groups The following standard methods can be used to call up a group display: • Go to the Group Summary display click the name of a specific group to call up. When the Group Configuration display for a specific group is displayed, click the View Group link to view the group. • Click the Group icon on the Station toolbar and type a group number in the Station command zone and press . • Press to call up a group by number.
PAGE 248
plscpcg.book Page 230 Monday, May 28, 2001 10:11 AM 11 – Configuring Group and Trend Displays Configuring Trend Set Displays Trend set displays are standard Station displays that provide a way of viewing historical data for points. Trend set displays complement other types of displays that can be used to view historical data such as point detail trends, group trends, and custom display trends.
PAGE 249
plscpcg.
PAGE 250
plscpcg.book Page 232 Monday, May 28, 2001 10:11 AM 11 – Configuring Group and Trend Displays About the Configuration of Trend Sets Trend sets are easy to configure. You only need to enter the point IDs and specify the type of history details you want to view. You use a Trend Set Definition display to create a new trend set, but trend sets can be modified directly from a Trend Set display.
PAGE 251
plscpcg.book Page 233 Monday, May 28, 2001 10:11 AM Configuring Trend Set Displays 12 13 14 If a history offset is required, under History enter the time in HH:MM format and the date in DD-MMM-YY format in the History offset fields. Otherwise, you can leave this field blank. Click View Trend to call up the Trend Set display in which you can change details interactively for this trend set. In the Trend Set display, use the % /EU box (see Figure 11.
PAGE 252
plscpcg.book Page 234 Monday, May 28, 2001 10:11 AM 11 – Configuring Group and Trend Displays You • • • can also change information in the following fields: Point IDs Parameter of a point History Offset You can use the % /EU box to toggle between displaying the trend in % (percentage terms) or EU (engineering units). If you are using EU, enter the high and low range values (in engineering units) in the fields above and below the toggle box. High Range Toggle Box Low Range Figure 11.
PAGE 253
plscpcg.book Page 235 Monday, May 28, 2001 10:11 AM Configuring Trend Set Displays Calling Up Trend Set Displays In addition to the standard methods available to call up trend sets, it is also possible to configure other methods to call them up. The following custom methods can be configured: • A user-defined Station function key • A push-button object on a custom display For details on configuring user-defined function keys, see “Customizing Toolbars, Menus and Function Keys” on page 64.
PAGE 254
plscpcg.
PAGE 255
plscpcg.book Page 237 Monday, May 28, 2001 10:11 AM 12 Template Displays and Container Points A template display is a custom display that is used to represent a unit of equipment containing several points of one or more fixed types. A template display is functionally equivalent to the supplied Point Detail displays for status, analog, and accumulator points. To use a template display, you first define a container point for the unit of equipment.
PAGE 256
plscpcg.
PAGE 257
plscpcg.book Page 239 Monday, May 28, 2001 10:11 AM 13 Configuring Reports PlantScape reports provide a simple and flexible way to extract information from the server database. This chapter begins with an introduction to the various types of reports used in PlantScape. It then describes how you call up a summary on reports and how you configure the reports (“Configuring a New Report” on page 243).
PAGE 258
plscpcg.book Page 240 Monday, May 28, 2001 10:11 AM 13 – Configuring Reports Report Types Pre-formatted You can choose from the following types of pre-formatted reports for retrieving information from the PlantScape server database. Alarm and Event Alarm and event details from the event file. This report enables you to analyze alarms and events that occurred during a specified time span on specific points. Excludes remote points. See “Alarm and Event Reports” on page 248.
PAGE 259
plscpcg.book Page 241 Monday, May 28, 2001 10:11 AM Report Types Sequence of Events Some types of controllers, such as the TDC 3000 PIU, have the capability to time-stamp events to millisecond resolution. When this capability is used, the server stores the high resolution event information in the server “sequence of events” file. The Sequence of Events Report is based on data extracted from this server file. Excludes remote points. See “Sequence of Events Reports” on page 257.
PAGE 260
plscpcg.book Page 242 Monday, May 28, 2001 10:11 AM 13 – Configuring Reports Configuring Reports The starting point for configuring a report is to call up the Reports display on a Station. Either: • On the System menu bar, choose Configure ⇒ Reports, or • Press to call up the System Menu display and click System Configuration. From the Configuration Menu display, click Reports in the Navigation Panel. The Reports display shows the reports that are configured for your site.
PAGE 261
plscpcg.book Page 243 Monday, May 28, 2001 10:11 AM Configuring Reports You can also configure reports to be requested: • By selecting a button on a custom display. See the Display Building Guide for details. • By pressing a function key. See “Customizing Toolbars, Menus and Function Keys” on page 64 for details. • As a result of a process event. For more details, see the description of the Status Change Report Request algorithm in “Configuring Algorithms” on page 193.
PAGE 262
plscpcg.book Page 244 Monday, May 28, 2001 10:11 AM 13 – Configuring Reports Name The name to be used when the report is requested by name. For example, you might want to use a more specific description such as “Shift1” for the report name. You can use a maximum of 10 characters. The name must be unique to this report and must not contain any spaces. Title The report title to be shown on the report output and the summary display. The title can be up to 70 characters.
PAGE 263
plscpcg.book Page 245 Monday, May 28, 2001 10:11 AM Configuring Reports Select a file type for the output file. If you select a file type, the report will not be printed. Periodic Reporting Enable Periodic Reporting Select this check box if you want the report to be run automatically at specified intervals. If the report is requested by Algo 70 and you want the report printed, you need to select this check box. Destination Choose a printer for the periodic reports from the Destination list.
PAGE 264
plscpcg.book Page 246 Monday, May 28, 2001 10:11 AM 13 – Configuring Reports Each time the report runs, it overwrites this output file using current data. Operators can use the “pr” command to view and print an existing report through Station (for details, see the Operators Guide). Anyone who has access to Windows can view and print the file through Microsoft Internet Explorer.
PAGE 265
plscpcg.book Page 247 Monday, May 28, 2001 10:11 AM Configuring Reports Specific Time Period To define a fixed time period for the report: • Enter the start and end dates in the format DD-MMM-YY. For example, 02-Feb-97 for 2nd February 1997. (You can also use the numerical equivalent for a month. The system will automatically change your entry into a three-letter month abbreviation.) To specify the current date, leave the field blank. • Enter the start and end times in the format HH:MM.
PAGE 266
plscpcg.book Page 248 Monday, May 28, 2001 10:11 AM 13 – Configuring Reports Alarm and Event Reports Every alarm or event that occurs is saved in the event file. The number of events that can be stored is determined by database sizing (refer to the installation guide for information on system sizing). As this file becomes full, the oldest event is discarded whenever a new event is added. (For more details about alarms and events, see “Configuring Alarms for Points” on page 155.
PAGE 267
plscpcg.book Page 249 Monday, May 28, 2001 10:11 AM Alarm and Event Reports 4 5 Event location Use the Event Location list to specify whether the online event file is to be searched, or whether events should be retrieved from an event archive previously restored to the playback area. Area Enter an area code in the Area field if you only want to include alarms and events in a specific area. Point ID(s) Enter a specific point ID or use wildcard characters to search for a number of points.
PAGE 268
plscpcg.book Page 250 Monday, May 28, 2001 10:11 AM 13 – Configuring Reports Alarm Duration Reports Alarm Duration reports show the duration of alarms that occurred during a particular time period: To configure an Alarm Duration report: 1 Click the Definition tab (see “Configuring a New Report” on page 243), select Alarm Duration from the Type selection list, and enter the report definition details. 2 Click the Content tab. 3 Specify the types of alarms and events you want included in the report.
PAGE 269
plscpcg.book Page 251 Monday, May 28, 2001 10:11 AM Alarm Duration Reports Subpriority You can specify the subpriority of the alarms you want included in the report. For information about alarm subpriorities, see “Defining Events, Alarms, and Alarm Priorities” on page 162. 4 Event Location Select the location of the events to be searched for the report. The options are Online, to search the online event file Playback, to search an event archive that has been restored to the playback area.
PAGE 270
plscpcg.book Page 252 Monday, May 28, 2001 10:11 AM 13 – Configuring Reports Cross Reference Reports The Cross Reference Report can be used to find where points have been referenced in the server database.
PAGE 271
plscpcg.book Page 253 Monday, May 28, 2001 10:11 AM Cross Reference Reports Viewing Cross Reference Errors Any inconsistencies found in the database are recorded in the following file when the report is run. An error log is also generated at the end of the actual report file (rptxxx.
PAGE 272
plscpcg.book Page 254 Monday, May 28, 2001 10:11 AM 13 – Configuring Reports Downtime Analysis Reports The Downtime Analysis Report can include delays that are still outstanding as well as those that have been resolved. The report output can also be sorted by downtime category and reason codes. To configure a Downtime Analysis report: 1 Click the Definition tab (see “Configuring a New Report” on page 243), select Downtime Duration from the Type selection list, and enter the report definition details.
PAGE 273
plscpcg.book Page 255 Monday, May 28, 2001 10:11 AM History Archive History Archive History Archive reports save point history to archives. They do not generate any printed output. History archives can also be configured using the History Archiving display. For details, see “Configuring History Archiving” on page 170.
PAGE 274
plscpcg.book Page 256 Monday, May 28, 2001 10:11 AM 13 – Configuring Reports Point Attribute Reports Reports can be made of points with various attributes. To configure a Point Attribute report: 1 Click the Definition tab (see “Configuring a New Report” on page 243), select Point Attribute from the Type selection list, and enter the report definition details. 2 Click the Content tab.
PAGE 275
plscpcg.book Page 257 Monday, May 28, 2001 10:11 AM Sequence of Events Reports Sequence of Events Reports Some types of controllers, such as the TDC 3000 PIU, have the capability to time-stamp events to millisecond resolution. When this capability is used, the server stores the high resolution event information in the server “sequence of events” file. You can configure the Sequence of Events report to list events from this server file for selected points during a selected time span.
PAGE 276
plscpcg.book Page 258 Monday, May 28, 2001 10:11 AM 13 – Configuring Reports Batch Reports Batch reports are used to collect history for a set of points and events for an area for the duration of a production run. A batch report can collect: • One type of history sample (such as 5-second samples or 1-hour averages) for up to 50 points • Events for one area Notes • Each point included in a batch report must be configured to collect the type of history required by the report.
PAGE 277
plscpcg.book Page 259 Monday, May 28, 2001 10:11 AM Batch Reports Property/Button Description Batch identifier A user-defined property (such as a batch) that forms part of the report filenames each time the report is run. 20 characters maximum. (Because it forms part of a filename, it must not contain characters such as *, ?, \, | and /.) “Batch Report Filenames” on page 261 describes how report filenames are generated.
PAGE 278
plscpcg.book Page 260 Monday, May 28, 2001 10:11 AM 13 – Configuring Reports Property/Button Description Status Shows the current status of the report, which can be: • Ready - the report is not running. • Working - the report is running. • Finishing - a complete batch report is being generated. • Error - the report has stopped because of an error. Start time The time/date when the report started. End time The time/date when the report competed.
PAGE 279
plscpcg.book Page 261 Monday, May 28, 2001 10:11 AM Batch Reports Creating a Points List You use the Application Point List to define the set of points used in a batch report. Note that every point on the list must be configured to collect the type of history required by the report. For example, if the report requires 1-hour averages, each point must configured to collect Standard history, which includes 1-hour averages.
PAGE 280
plscpcg.book Page 262 Monday, May 28, 2001 10:11 AM 13 – Configuring Reports Part Description nnn The report number, as shown in the Reports display. BatchId The Batch identifier specified for the report. LotId The Lot identifier specified for the report. SeqNo The report’s sequence number, which contains three digits with leading zeros. (Corresponds to the Last/Current sequence num on the Definition tab for the report.
PAGE 281
plscpcg.book Page 263 Monday, May 28, 2001 10:11 AM Batch Reports Starting and Stopping a Batch Report You use LRN 178 to start and stop the collection of data for a batch report. You can invoke LRN 178 in a number of ways, for example by requesting it via pushbutton to a custom display, or by invoking it in a script or via action algorithm 71 (Queued Task Request). This LRN uses the following parameters. Parameter 1 The number of the batch report for which you want to start/stop collecting data.
PAGE 282
plscpcg.book Page 264 Monday, May 28, 2001 10:11 AM 13 – Configuring Reports ODBC Data Exchange Reports The ODBC Data Exchange option enables you to configure the two-way exchange of data between the server database and an ODBC-compliant third-party database, using standard Structured Query Language (SQL) commands. This feature is available if your server license includes ODBC Data Exchange.
PAGE 283
plscpcg.book Page 265 Monday, May 28, 2001 10:11 AM Microsoft Excel Reports Microsoft Excel Reports With Microsoft Excel Reports you can: • Get values from point parameters • Perform calculations on those points • Retrieve historical data to determine summations, maximums, minimums, and standard deviations • Retrieve alarms and events • Generate graphs and tables • Store new values or calculations in the server database, provided you installed Microsoft Excel Data Exchange with the “write” option enabled.
PAGE 284
plscpcg.book Page 266 Monday, May 28, 2001 10:11 AM 13 – Configuring Reports Creating Custom Reports with Excel To create a Microsoft Excel report you need to: • Create a report definition file to define the data that the report will contain. • Configure the report on Station to specify when and how your report will be run. Creating the Report Definition File A report definition file is an Microsoft Excel File that is set up to access and process data from the server database.
PAGE 285
plscpcg.book Page 267 Monday, May 28, 2001 10:11 AM Creating Custom Reports with Excel Refer to “Using PlantScape Data in Other Applications” on page 391 for details of the data you can access via Microsoft Excel Data Exchange or the ODBC Driver and how to access it. Note Do not create a report that will require users to respond to a prompt. Microsoft Excel is not visible when the report is run. If the report requires a response it will either hang or fail.
PAGE 286
plscpcg.book Page 268 Monday, May 28, 2001 10:11 AM 13 – Configuring Reports Configuring the Report Details Microsoft Excel reports, like other PlantScape reports, need to be configured on Station. This is done on the Microsoft Excel Report Configuration display. To configure an Microsoft Excel report: 1 Click the Definition tab (see “Configuring a New Report” on page 243) and enter the report definition details. 2 Select Microsoft Excel from the Type selection list. 3 Click the Content tab.
PAGE 287
plscpcg.book Page 269 Monday, May 28, 2001 10:11 AM Creating Custom Reports with Excel 6 7 8 9 – Point parameter: pv Click Add, then Next to display the next step. Fill in the fields as follows: – history type: Fast History Snapshots – number of values: 20 – offset: 1 – Arrange data: vertically – for all other fields accept the default. Click Finish to display the result. To include the date-time at the which the report is run, select an empty cell and type Now().
PAGE 288
plscpcg.book Page 270 Monday, May 28, 2001 10:11 AM 13 – Configuring Reports Configuring Free Format Reports This section provides overview information about the Free Format Report. It shows how you use Station to configure a custom report and describes the components of a Report Definition file. For detailed information about the structure of a Report Definition file and the variables used, refer to “Free Format Report Reference” on page 272.
PAGE 289
plscpcg.book Page 271 Monday, May 28, 2001 10:11 AM Configuring Free Format Reports Saving Report Definition Files Report definition files can be given any name, and should be saved in the following path: server\user Configuring the Report Details After creating the definition for the Free Format Report, you need to configure it via the Reports display on a Station just like any other PlantScape report.
PAGE 290
plscpcg.book Page 272 Monday, May 28, 2001 10:11 AM 13 – Configuring Reports Free Format Report Reference This section gives details about the structure and contents of a Free Format Report.
PAGE 291
plscpcg.book Page 273 Monday, May 28, 2001 10:11 AM Free Format Report Reference A variable is one item of information (such as a temperature) stored in a point parameter. A variable can contain: • Point values (including historical data) • Values from server database files and regular operating system files • Calculated values You can include up to 999 variables in a definition file. Of these variables, a maximum of 400 can be character variables (ASCII).
PAGE 292
plscpcg.book Page 274 Monday, May 28, 2001 10:11 AM 13 – Configuring Reports Using Point Values The most common values used in custom reports are point values. Reading a Point Parameter from the Server Database Three report definition file entries are provided for reading and writing points values: F = Fetch from point Reads a specified point parameter into a Free Format variable. The format to be used when the variable is printed in the report can be specified.
PAGE 293
plscpcg.book Page 275 Monday, May 28, 2001 10:11 AM Free Format Report Reference C = Calculated Variable Used to specify the print format to be used for the Definition Free Format variable that is the result of the calculation. P = Perform Calculation Used to specify the expression for a calculation on several Free Format variables. Addition, subtraction, multiplication, division and exponentiation operations can be performed.
PAGE 294
plscpcg.book Page 276 Monday, May 28, 2001 10:11 AM 13 – Configuring Reports R = Read from file Provided to read a value from a server database file or operating system file into a Free Format report variable. To read from an operating system file the file must first be defined with the entry, M, Operating system file definition. W = Write to file Provided to write a value from a Free Format report variable into a server database file.
PAGE 295
plscpcg.book Page 277 Monday, May 28, 2001 10:11 AM Free Format Variables Reference Free Format Variables Reference This section contains details about each of the Free Format Report Definition file entries.
PAGE 296
plscpcg.book Page 278 Monday, May 28, 2001 10:11 AM 13 – Configuring Reports A (Acquired Field Value) Purpose Scans a point parameter value before storing it in a Free Format variable. Otherwise this entry is identical to the F (Fetch from point) entry. Format A Index Point_ID Parameter Print_Format Description Index Number (1-999) identifying report variable to store value acquired from field. Point_ID Point name Parameter As described for entry type F. History parameters are not enabled.
PAGE 297
plscpcg.book Page 279 Monday, May 28, 2001 10:11 AM Free Format Variables Reference B (Start of Report Body) Format B Description This entry is the last in the variable definition section. Lines that follow this entry specify report layout, including: headings, outlines and spacing. Areas to contain variable information are identified by single quotation marks enclosing the index number of the Free Format variable.
PAGE 298
plscpcg.book Page 280 Monday, May 28, 2001 10:11 AM 13 – Configuring Reports $Cnnn where: nnn Is the index number (501-599) of a user defined sequential file previously defined using the M entry An X-Y plot of two arrays of values can be output in the body of the report using the following command, starting in column 1. $XY Xindex Yindex Num Xmin Xmax Ymin Ymax where: Xindex The first element in array for x axis variable.
PAGE 299
plscpcg.book Page 281 Monday, May 28, 2001 10:11 AM Free Format Variables Reference C (Calculated Variable Definition) Purpose Specifies the print format for the Free Format variable containing the result of a calculation. This entry is always used together with the P (Perform calculation) entry and may come before or after it. Format C Index Print_Format Description Index Number (1-999) identifying report variable to store result of calculation. Print_Format As described for entry type F.
PAGE 300
plscpcg.book Page 282 Monday, May 28, 2001 10:11 AM 13 – Configuring Reports D (History Standard Deviation) Purpose Used to calculate the standard deviation of history values of a point and to store the standard deviation in a Free Format variable. Format D Index Point_ID Parameter Print_Format [History Type(Offset) Repeat] Description Index The number (1-999) identifying report variable to store standard deviation. Point_ID Point name of the analog point. Parameter As described for entry type F.
PAGE 301
plscpcg.book Page 283 Monday, May 28, 2001 10:11 AM Free Format Variables Reference F (Fetch From Point) Purpose Reads a point parameter value and stores it in a Free Format variable. Multiple point history values can be read into successive free format variables. Format F Index Point_ID Parameter Print_Format [History Type (Offset) Repeat] Description Index The number (1-999) identifying the start of the report variable in which to store the history value fetched.
PAGE 302
plscpcg.book Page 284 Monday, May 28, 2001 10:11 AM 13 – Configuring Reports Parameter ANA STA EULO 0% Range x x EUHI 100% Range x x ACC (For a list of standard point parameters, see “Summary of Point Parameters and Addresses” on page 133.) Print_Format “FORTRAN” style format descriptors: In Integer Zn Short integer in hexadecimal notation Fn.m Floating point En.
PAGE 303
plscpcg.book Page 285 Monday, May 28, 2001 10:11 AM Free Format Variables Reference H8H History Standard 8 hour average H24H History Standard 24 hour average H5SF History Fast snapshot H1HE History Extended 1 hour snapshot H8HE History Extended 8 hour snapshot H24HE History Extended 24 hour snapshot [Offset] This is the offset within the history file. It locates the required value in the history file.
PAGE 304
plscpcg.book Page 286 Monday, May 28, 2001 10:11 AM 13 – Configuring Reports The 10th most recent value will be index no 2. The 11th most recent value will be index no 3. The 12th most recent value will be index no 4. Example 2: F 6 FIC123 PV D6 H6M(10) 3 In this example, the date of the history values retrieved in Example 1 will be obtained. They will be stored in indexes 6, 7 and 8. The format of the date will be DD-MMM. Example 3: F 5 FIC123 PV F8.
PAGE 305
plscpcg.book Page 287 Monday, May 28, 2001 10:11 AM Free Format Variables Reference G (Give to Point) Purpose Stores the value in a Free Format variable in a point parameter. A control will be performed for point parameters with destination addresses. Format G Index Point_ID Parameter Description Index The variable containing the value to be stored; this variable must have previously been initialized. Point_ID and Parameter As described for entry type F. History parameters are not supported.
PAGE 306
plscpcg.book Page 288 Monday, May 28, 2001 10:11 AM 13 – Configuring Reports L (History Maximum and Minimum) Purpose The maximum and minimum history values of a point are stored in two successive free format variables. Format L Index Point_ID Parameter Print_Format [History Type(Offset)Repeat] Description Index The number (1-999) identifying the report variable to store the total. Point_ID The point name of the analog point. Parameter As described for entry type F.
PAGE 307
plscpcg.book Page 289 Monday, May 28, 2001 10:11 AM Free Format Variables Reference M (Operating System File Definition) Purpose Defines the details about an operating system file to be accessed by the R (Read from file) or W (Write to file) entries. Format M Type No Rec_sz Path Description Type SEQ for sequential file and REL for relative file. Should always be SEQ for Windows 2000. No Internal file number (501-599) used for file identification within the Free-Format report.
PAGE 308
plscpcg.book Page 290 Monday, May 28, 2001 10:11 AM 13 – Configuring Reports P (Perform Calculation) Purpose Specifies a calculation to be performed. The result of the calculation is stored in a free format variable. This entry is always used together with the C (Calculated Variable Definition) entry and may come before or after it. Format P Index Expression Description Index The number (1-999) identifying report variable to store result of calculation.
PAGE 309
plscpcg.book Page 291 Monday, May 28, 2001 10:11 AM Free Format Variables Reference R (Read From File) Purpose Used to read a value from either an operating system file or a server database file. If the value is to be read from an operating system file the M entry should be used to define the details about the file. Format R Index No Rec_No Offset Print_Format Type [Read] Description Index Number (1-999) identifying variable to store value read from file.
PAGE 310
plscpcg.book Page 292 Monday, May 28, 2001 10:11 AM 13 – Configuring Reports In Integer Zn Short integer in hexadecimal notation Fn.m Floating point En.m Floating point in exponential form An ASCII D Date (DD-MMM-YY) integer date is in minutes T Time (HH:MM:SS) real data is in seconds where: n Is the width of the field and m is the number of decimal places. Examples Example 1: R 26 00031 $25 00001 F8.2 RL The value stored in Index number 25 will be used as the record number.
PAGE 311
plscpcg.book Page 293 Monday, May 28, 2001 10:11 AM Free Format Variables Reference File numbered 502 is sequential. If record 3 contains 0001 (hex) and 8001 (hex) in its fifth and sixth word, then the value of Index number 11 will be 98,305. Note No, Rec_No, and Offset can all be indirect by using the “$” operator (for example, Rec_No = $123 means use the value of index number 123). See Also: Entries M and W.
PAGE 312
plscpcg.book Page 294 Monday, May 28, 2001 10:11 AM 13 – Configuring Reports T (Totalize History) Purpose Totals the history values for a point and stores the total in a free format variable. Format T Index Point_ID Parameter Print_Format [History Type (Offset)Repeat] Description Index Number (1-999) identifying report variable to store total. Point_ID Point name of the analog point. Parameter As described for entry type F. Print_Format As described for entry type F.
PAGE 313
plscpcg.book Page 295 Monday, May 28, 2001 10:11 AM Free Format Variables Reference W (Write to File) Purpose Used to write a value from a free format variable to either an operating system file or a server database file. If an operating system file is to be accessed, then the details about the file should be specified with the M entry. Format W Index No Rec_No Offset Type [Write] Description Index Number (1 - 999) identifying the database variable storing the value to be written.
PAGE 314
plscpcg.book Page 296 Monday, May 28, 2001 10:11 AM 13 – Configuring Reports An ASCII D Date (DD-MMM-YY) integer date is in minutes T Time (HH:MM:SS) real data is in seconds Where: n is the width of the field and m is the number of decimal places. See Also: Entries M and R.
PAGE 315
plscpcg.book Page 297 Monday, May 28, 2001 10:11 AM Free Format Variables Reference X (Demand Point Processing) Purpose Scans a point parameter value and forces processing of the point regardless of whether or not the point value has changed. This entry is used to force any algorithms attached to the point to be executed. Otherwise this entry is identical to the F (Fetch from point) entry.
PAGE 316
plscpcg.book Page 298 Monday, May 28, 2001 10:11 AM 13 – Configuring Reports Free Format Report Example This section shows an example of a report definition file and the resulting report output. Report Definition File * *This is an example free format report *Get the Point ID F 1 01IT1LEVEL NAME A10 * *Get the last 10 history values and store at *index 20.. F 20 01IT1LEVEL PV F8.3 H1M(1) 10 *Get the maximum and minimum of these values and store at 50,51 respectively L 50 01IT1LEVEL PV F8.
PAGE 317
plscpcg.
PAGE 318
plscpcg.book Page 300 Monday, May 28, 2001 10:11 AM 13 – Configuring Reports 75.00 + ! ! ! 60.00 + ! * * ! ! ! 45.00 + ! ! * ! ! 30.00 + ! * * ! ! ! 15.00 + * ! ! ! * * ! .00 + +---------+---------+---------+---------+---------+ .00 2.00 4.00 6.00 8.00 10.
PAGE 319
plscpcg.book Page 301 Monday, May 28, 2001 10:11 AM 14 Configuring and Monitoring a Redundant Server System PlantScape supports both dual networks and redundant servers, in any combination. For example, you can configure: • Station connections to redundant servers over dual networks • Redundant connections between redundant servers (recommended) The following figure shows a sample network architecture drawing for a fully redundant system.
PAGE 320
plscpcg.book Page 302 Monday, May 28, 2001 10:11 AM 14 – Configuring and Monitoring a Redundant Server System In this example, the system consists of: • Dual networks X (link 0) and Y (link 1) • Redundant servers, with base name hsserv and identifiers a and b. These servers are redundantly connected, which means that each has a NIC card for each network.
PAGE 321
plscpcg.
PAGE 322
plscpcg.book Page 304 Monday, May 28, 2001 10:11 AM 14 – Configuring and Monitoring a Redundant Server System However, the naming (or at least alias) scheme given to these nodes is important for servers (for example: hsserva, hsservb, hsserva0, hsserva1, hsservb0, hsservb1).
PAGE 323
plscpcg.book Page 305 Monday, May 28, 2001 10:11 AM Server Redundancy Configuration Procedures Server Redundancy Configuration Procedures The following procedures assume that you have completed a redundancy installation as described in the Installation Guide. Prerequisites for Configuring Server Redundancy At this point you should have installed Windows and the PlantScape Server software as described in the installation guide.
PAGE 324
plscpcg.book Page 306 Monday, May 28, 2001 10:11 AM 14 – Configuring and Monitoring a Redundant Server System Completing the TCP/IP Configuration of the Servers This section describes how to complete the configuration of your primary and backup servers and how to test your configuration. It assumes that your primary server is called hsserva and your backup server is called hsservb.
PAGE 325
plscpcg.book Page 307 Monday, May 28, 2001 10:11 AM Completing the TCP/IP Configuration of the Servers The hosts file is: %SystemRoot%\system32\drivers\etc\hosts For example: c:\winnt\system32\drivers\etc\hosts 2 Add the following lines to the hosts file: # TCP/IP address for primary 200.0.0.1 hsserva hsserva0 # TCP/IP address for backup 200.0.0.2 hsservb hsservb0 Remember to use the base server name and TCP/IP addresses that are applicable to your site.
PAGE 326
plscpcg.book Page 308 Monday, May 28, 2001 10:11 AM 14 – Configuring and Monitoring a Redundant Server System Dual Network Configuration In a dual network configuration the servers are connected on two networks and have two network cards as illustrated in the following figure. hsserva Primary Server hsservb Backup Server First Network Second Network Figure 14.
PAGE 327
plscpcg.book Page 309 Monday, May 28, 2001 10:11 AM Completing the TCP/IP Configuration of the Servers 200.0.0.2 hsservb hsservb0 # Second TCP/IP link of the primary 200.0.1.1 hsserva1 # Second TCP/IP link of the backup 200.0.1.2 hsservb1 Remember to use the base server name and TCP/IP addresses that are applicable to your site. For example, if your primary server is called hsserva and has TCP/IP addresses of 200.10.10.1 and 200.10.11.
PAGE 328
plscpcg.book Page 310 Monday, May 28, 2001 10:11 AM 14 – Configuring and Monitoring a Redundant Server System 3 310 R400 If any requests time out, or if the incorrect TCP/IP address is pinged, go back and re-examine your TCP/IP configuration. Refer to the Installation Guides for PlantScape and Windows for more information, if necessary.
PAGE 329
plscpcg.book Page 311 Monday, May 28, 2001 10:11 AM Defining the Redundant Connections Defining the Redundant Connections Details about the connection between the two servers in a redundant server system are defined using entries in a hardware definition file.
PAGE 330
plscpcg.book Page 312 Monday, May 28, 2001 10:11 AM 14 – Configuring and Monitoring a Redundant Server System To Serial Field Devices hsservb hsserva Primary Server Serial Data Lines Terminal Server Serial Data Lines Backup Server Terminal Server Network Figure 14.4 Software Arbitration When software arbitration is used, terminal servers provide the data link between the servers and the serial field devices.
PAGE 331
plscpcg.book Page 313 Monday, May 28, 2001 10:11 AM Defining the Redundant Connections Hardware Definition File Entries for Software Arbitration You define software arbitration as follows in a hardware definition file: DEL PSW00 ADD PSW00 NETWORK_PSW RECOVER=recover_option Where: recover_option Is ABORT or REBOOT. ABORT means that when a failover occurs, PlantScape Server is stopped and restarted on the failed server.
PAGE 332
plscpcg.book Page 314 Monday, May 28, 2001 10:11 AM 14 – Configuring and Monitoring a Redundant Server System Dual Network Data Link Definition The dual network data link configuration is illustrated in Figure 14.3, “Dual Network Configuration” on page 308.
PAGE 333
plscpcg.book Page 315 Monday, May 28, 2001 10:11 AM Synchronizing Date and Time on the Servers Synchronizing Date and Time on the Servers The date and time on the primary and backup servers need to be synchronized to ensure that all dates and/or times associated with events in the database are consistent between servers. In a redundant server system, the primary server is used as the time source and the backup server is configured to synchronize with the primary server.
PAGE 334
plscpcg.book Page 316 Monday, May 28, 2001 10:11 AM 14 – Configuring and Monitoring a Redundant Server System If you change the time on the primary server (or the primary server is down for some period of time) and you want the backup server to synchronize immediately, you need to stop and restart the Time Service on the backup server as follows: 1 In the Windows Control Panel ⇒ Administrative Tools, open Services. 2 Stop and start the Time service.
PAGE 335
plscpcg.book Page 317 Monday, May 28, 2001 10:11 AM Configuring Stations for Server Redundancy Configuring Stations for Server Redundancy Stations need to connect to whichever server is running as the primary server. However, for local and network-connected Stations to always connect to the server running as primary requires special Station configuration. How this is done for single and dual networks is described in the following sections.
PAGE 336
plscpcg.book Page 318 Monday, May 28, 2001 10:11 AM 14 – Configuring and Monitoring a Redundant Server System If Station is unable to connect to the backup server via the first network Station attempts to reconnect to the primary server via the second network. If Station is unable to connect to the primary server via the second network Station attempts to connect to the backup server via the second network.
PAGE 337
plscpcg.book Page 319 Monday, May 28, 2001 10:11 AM Configuring Stations for Server Redundancy Configuring Stations for Microsoft Internet Explorer Many Station displays use Microsoft Internet Explorer. On a redundant network, Internet Explorer must be able to resolve the server names to a hostname or IP addresses. The configuration steps are: On all computers running Station other than the servers: 1 Open the hosts file in %SystemRoot%\system32\drivers\etc.
PAGE 338
plscpcg.book Page 320 Monday, May 28, 2001 10:11 AM 14 – Configuring and Monitoring a Redundant Server System Synchronizing the Server Databases At this point the PlantScape Server redundancy configuration is complete. The primary and backup servers can now be put into redundant mode. Synchronization is the process of copying over the PlantScape Server database from the primary server to the backup server.
PAGE 339
plscpcg.book Page 321 Monday, May 28, 2001 10:11 AM Monitoring Redundant Servers Monitoring Redundant Servers Once the servers are running in redundant mode, you can use a number of methods to monitor the status of your system.
PAGE 340
plscpcg.book Page 322 Monday, May 28, 2001 10:11 AM 14 – Configuring and Monitoring a Redundant Server System Property Description Tracing mask The Tracing Mask value is used for diagnostic purposes. Do not change this value unless advised to do so by Honeywell support staff. Using Points to Monitor Redundant Servers A point definition file, called redun.pnt and located in \server\user is supplied to define points to monitor the redundant server queue.
PAGE 341
plscpcg.book Page 323 Monday, May 28, 2001 10:11 AM Monitoring Redundant Servers Figure 14.5 Trend Display for Monitoring Redundant Server System For more information on configuring and using trend sets, refer to “Configuring Trend Set Displays” on page 230 in this Guide, and to the Operators Guide.
PAGE 342
plscpcg.book Page 324 Monday, May 28, 2001 10:11 AM 14 – Configuring and Monitoring a Redundant Server System Synchronizing Other Files PlantScape database information is automatically transferred from the primary server to the backup server. Any configuration changes to the database (such as changes to points and displays) are also transferred.
PAGE 343
plscpcg.book Page 325 Monday, May 28, 2001 10:11 AM Synchronizing Other Files During synchronization the file transfer program attempts to transfer files from the indicated directories on the primary server to the backup server. The time and date that the file transfer program ran is recorded. During periodic transfers the file transfer program attempts to transfer any files from the indicated directories that have changed since the last time the program ran.
PAGE 344
plscpcg.
PAGE 345
plscpcg.book Page 327 Monday, May 28, 2001 10:11 AM Manually Failing Over a Redundant Server System Manually Failing Over a Redundant Server System There might be times when you want the backup server to run as the primary for a while. For instance, you may want to upgrade your primary server in some way (for example, upgrade memory, upgrade the hard disk or install a Windows Service Pack). PlantScape supports manual (operator-controlled) failover from the primary server to the backup server.
PAGE 346
plscpcg.book Page 328 Monday, May 28, 2001 10:11 AM 14 – Configuring and Monitoring a Redundant Server System What To Do If the Servers Lose Synchronization Because PlantScape is a high availability system, it is very important to recognize quickly if the servers lose synchronization (that is, stop running in redundant mode).
PAGE 347
plscpcg.book Page 329 Monday, May 28, 2001 10:11 AM What To Do If the Servers Lose Synchronization If the Backup Server Fails If the backup server fails, your PlantScape system runs normally, but it will not be running in redundant mode. You should: 1 Determine the cause of the problem on the backup server and rectify it. 2 Reconfigure or re-verify (depending on the cause of the problem) the redundancy configuration on the backup server.
PAGE 348
plscpcg.book Page 330 Monday, May 28, 2001 10:11 AM 14 – Configuring and Monitoring a Redundant Server System Server Redundancy Fast Failover Configuration Normally Station reconnect time is approximately 30 seconds. It is possible to tune server and Station redundancy timeout parameters to achieve approximately 10 second Station reconnect time (also known as fast failover).
PAGE 349
plscpcg.book Page 331 Monday, May 28, 2001 10:11 AM Server Redundancy Fast Failover Configuration 4 5 For example: ADD PSW00 NETWORK_PSW RECOVER=ABORT IDLE=5 READ=10 From the command prompt, run the command hdwbld redun.hdw to make the changes effective. Use Start/Stop PlantScape Server to set the Server state to System Running. Time Until Server Disconnects Station Set the time that the server waits for data from a Station before disconnecting it.
PAGE 350
plscpcg.book Page 332 Monday, May 28, 2001 10:11 AM 14 – Configuring and Monitoring a Redundant Server System Time Until Stations Fail Over to Backup Network The time until a Station fails over to the backup network depends on: • The KeepAliveTimeout and DisConnectTimeout settings in the station.ini file. • The TcpMaxConnectRetransmissions setting in the registry. Note If you adjust the timeout settings, you must also adjust the time until the server disconnects Station.
PAGE 351
plscpcg.book Page 333 Monday, May 28, 2001 10:11 AM Server Redundancy Fast Failover Configuration Making IP Address Resolution Faster One way to achieve faster failover without necessarily increasing network traffic is to define IP addresses in the hosts files of all computers on the network: 1 On all Station PCs, ensure that there is an entry in the hosts file (%SystemRoot%\system32\drivers\etc\hosts) for both server computers.
PAGE 352
plscpcg.
PAGE 353
plscpcg.book Page 335 Monday, May 28, 2001 10:11 AM 15 Configuring Distributed Server Architecture The Distributed Server Architecture option enables multiple PlantScape servers to share point data, alarms, messages, and history without the need for duplicate configuration on any server. This chapter discusses the architecture and functions of a distributed server system and the configuration procedures that are required.
PAGE 354
plscpcg.book Page 336 Monday, May 28, 2001 10:11 AM 15 – Configuring Distributed Server Architecture Overview The Distributed Server Architecture option enables you to integrate multiple PlantScape servers into a single operational system, with little engineering effort. It is effective for geographically distributed systems, for logically separate PlantScape systems located in different parts of a plant, and for combinations of the two.
PAGE 355
plscpcg.book Page 337 Monday, May 28, 2001 10:11 AM Overview Plant-Wide Network Plant A Plant B Plant C Figure 15.2 Plant-Wide Distributed System The requirements for implementing a distributed server architecture for PlantScape are: • Areas must be enabled. • Area codes must be unique across all servers (see “Alarms” on page 343). • All points assigned to an area must be defined on the server where the area is local. • Point IDs must be unique across all servers (see “Point IDs” on page 339).
PAGE 356
plscpcg.book Page 338 Monday, May 28, 2001 10:11 AM 15 – Configuring Distributed Server Architecture Data Access Distributed Server Architecture provides global access to point parameter data on all servers in the system. Each server provides automatic dynamic caching of remote data for all of its clients, so that clients access their local Server for all data. Clients do not access remote Servers directly.
PAGE 357
plscpcg.book Page 339 Monday, May 28, 2001 10:11 AM Data Access Areas An area must be configured on every server that accesses it. The configurations must specify the same area code and server alias, and the code for each area must be unique across all servers. All points assigned to an area must be defined on the server specified in the area’s definition. Any point that is accessed from more than one server must be assigned to an area. By default, the server subscribes to alarms for all areas.
PAGE 358
plscpcg.book Page 340 Monday, May 28, 2001 10:11 AM 15 – Configuring Distributed Server Architecture In a distributed architecture system, the internal numbering of points and the ordering of points cannot be assumed. The internal point number for a cache point is usually different from the internal point number on the local server, and cache points are created in the order that points are accessed.
PAGE 359
plscpcg.book Page 341 Monday, May 28, 2001 10:11 AM Distributed Server Displays Distributed Server Displays Operators interact with local and remote data on displays in the same way. From an operator’s perspective, the only difference between a local and a remote point is that a remote point is assigned to an area configured with the alias of a remote server (see “Defining and Enabling Areas” on page 92).
PAGE 360
plscpcg.book Page 342 Monday, May 28, 2001 10:11 AM 15 – Configuring Distributed Server Architecture The “in-alarm” and acknowledgment status of remote Points is indicated on custom displays in the same way as local Points. Associated Displays Each Station displays the Associated Display defined on its local server. To ensure that the appropriate Associated Display is displayed for remote points, the numbers and contents of Associated Displays should be the consistent across all servers.
PAGE 361
plscpcg.book Page 343 Monday, May 28, 2001 10:11 AM Notifications Notifications Notifications include process alarms, system alarms, messages and journalled events. With the Distributed Server Architecture option, alarms and messages are distributed as needed by the processes running on each server in the system. Alarms On each server, you enable alarms from remote servers by configuring the areas for which you want to display alarms and then enabling alarms for those areas.
PAGE 362
plscpcg.book Page 344 Monday, May 28, 2001 10:11 AM 15 – Configuring Distributed Server Architecture Alarms for a Remote Area If you disable alarms for a remote area, the effect is to unsubscribe your local server from the alarms. The remote server continues to generate alarms, and other servers that subscribe to it continue to receive them. Alarm and Message Acknowledgement Policy By default, alarm acknowledgements are distributed to all servers.
PAGE 363
plscpcg.book Page 345 Monday, May 28, 2001 10:11 AM Notifications Journalled Operator Changes Operator changes to a remote point are journalled on both the local server and the data owner.
PAGE 364
plscpcg.book Page 346 Monday, May 28, 2001 10:11 AM 15 – Configuring Distributed Server Architecture History, Trends, and Downtime Analysis Extended Event Archiving With two exceptions, events for a point are recorded only on the server where the point is defined. The exceptions are Acknowledgement events and Point Value Change events, which are recorded both on the server where they occurred and on the data owner.
PAGE 365
plscpcg.book Page 347 Monday, May 28, 2001 10:11 AM Security Security If you are using Station-based security, you assign both local and remote areas to the Stations on their local servers. You cannot use a remote server to assign any areas to Stations. (For information about Station-based security, see “Assigning Areas to Stations” on page 222.) If you are using operator-based security, you configure the operators on all servers where they need to log on.
PAGE 366
plscpcg.book Page 348 Monday, May 28, 2001 10:11 AM 15 – Configuring Distributed Server Architecture Working with a Distributed Server Architecture For normal operation, a distributed server system works the same as a single server system. From an operator’s perspective, the only difference between a local and a remote point is that a remote point is assigned to an area configured with the alias of a remote server (see “Defining and Enabling Areas” on page 92).
PAGE 367
plscpcg.book Page 349 Monday, May 28, 2001 10:11 AM Working with a Distributed Server Architecture Accessing history data for remote points in real time might impact the overall performance of a low bandwidth network, such as a WAN. For example, history data trend displays is requested and returned in real time. Multicasting For any server in the distributed architecture, you can choose multicasting to remote servers that are connected over a network that supports it.
PAGE 368
plscpcg.book Page 350 Monday, May 28, 2001 10:11 AM 15 – Configuring Distributed Server Architecture Operator Keyboard Support Specialized operator keyboard functions, such as AUTO/MANUAL and raise/lower, are supported in the same way for local and remote points. The fast raise/lower step is specified in the system wide station configuration for the server that the Station is connected to (see “Configuring Alarms” on page 68). This step applies to local and remote points.
PAGE 369
plscpcg.book Page 351 Monday, May 28, 2001 10:11 AM Configuration for Distributed Server Architecture Configuration for Distributed Server Architecture The Distributed Server Architecture option is enabled on each server by configuring the network names of the servers to be accessed (see “Configuring Servers to Share Data” on page 352).
PAGE 370
plscpcg.book Page 352 Monday, May 28, 2001 10:11 AM 15 – Configuring Distributed Server Architecture Configuring Servers to Share Data On each server that will access or be accessed by other servers in the system, you need to configure some parameters and define the other servers. Configuring “This Server” The local server is shown as This Server at the top of the Distributed Servers summary.
PAGE 371
plscpcg.book Page 353 Monday, May 28, 2001 10:11 AM Configuration for Distributed Server Architecture Property Description Distributed Server Alarm Priorities The priority and subpriority of alarms for the functioning of Distributed Server itself.
PAGE 372
plscpcg.book Page 354 Monday, May 28, 2001 10:11 AM 15 – Configuring Distributed Server Architecture Distributed Server Tuning The Tuning tab contains Cache and Communications Settings for the remote server. These settings should only be changed by experienced technical personnel in consultation with your local Technical Assistance Center. To set tuning settings: 1 On the System Configuration Menu display, click Distributed Servers. The Distributed Servers Configuration Summary opens.
PAGE 373
plscpcg.book Page 355 Monday, May 28, 2001 10:11 AM Configuration for Distributed Server Architecture The maximum tuning settings for each remote server are set by the global cache age time. The cache flush time is calculated first. The cache flush time is then used to calculate the cache age time. The cache age time is then used to calculate the maximum subscription time. These calculations are as follows: Tuning Setting Minimum Value Maximum Value Cache Flush Time 10000ms.
PAGE 374
plscpcg.
PAGE 375
plscpcg.
PAGE 376
plscpcg.book Page 358 Monday, May 28, 2001 10:11 AM 16 – Configuring Schedules About the Schedules Option The Schedules option enables the control of points to be scheduled on both a one-off and periodic basis. For example, a pump could be scheduled to be switched on at 4 pm and off at 6 pm each day. Schedules are configured using Station displays.
PAGE 377
plscpcg.book Page 359 Monday, May 28, 2001 10:11 AM Configuring Holiday and Shift Details Configuring Holiday and Shift Details Holiday and shift information is used in the scheduling of point control. Shift information can also be used in: • Periodic Reports (see “How Reports Are Used” on page 242 for details) • Algorithms (see “Configuring Algorithms” on page 193 for details) You use Station displays to configure holidays and shifts.
PAGE 378
plscpcg.book Page 360 Monday, May 28, 2001 10:11 AM 16 – Configuring Schedules Configuring Point Control Schedules To configure schedules, you need to be using a security level of SUPV or higher. You configure schedules from the Point Control Schedule display. To call up the Point Control Schedule display: • Select Configure ⇒ Schedules ⇒ Point Control Schedules on the System menu bar • On the System Configuration Menu display, click Point Control Schedules. This opens the Point Control Schedule display.
PAGE 379
plscpcg.book Page 361 Monday, May 28, 2001 10:11 AM Configuring Point Control Schedules For status points: • The target value for an OP parameter can be set to 0 or 1 for single-bit output points and 0-3 for dual-bit output points. • The MD parameter can be set to any value between 0 to 15 (where 0 is manual, 1 is auto, and so on). For more information about status point parameters, see “Status Point Parameters” on page 123. For flexible points, any writable numeric parameter can be controlled.
PAGE 380
plscpcg.book Page 362 Monday, May 28, 2001 10:11 AM 16 – Configuring Schedules Considerations When Adding a Schedule The Scheduler runs once per minute to check if any scheduled controls should be performed. Controls are performed sequentially. Therefore, if a large number of schedules are configured for the same time, the last control requests might be delayed by several tens of seconds. However, these requests will always be performed before performing controls scheduled at a later time.
PAGE 381
plscpcg.book Page 363 Monday, May 28, 2001 10:11 AM Configuring Point Control Schedules Deleting a Schedule Use the Point Control Schedule display to delete a new schedule as follows: 1 Specify the schedule you want to delete by clicking it in the display. 2 When the schedule you want to delete is displayed in the Schedule Maintenance fields, press Delete.
PAGE 382
plscpcg.
PAGE 383
plscpcg.book Page 365 Monday, May 28, 2001 10:11 AM 17 Configuring Recipes This chapter describes how you configure recipes. A “recipe” is a set of pre-configured values that can be loaded into one or more sets of point parameters. A set of point parameters generally controls a “unit”, which is a set of equipment used to produce the recipe. A recipe can be loaded into any units that share similar sets of points. Recipes can consist of up to 30 ingredients.
PAGE 384
plscpcg.book Page 366 Monday, May 28, 2001 10:11 AM 17 – Configuring Recipes About Recipe Configuration The total number of recipes that can be configured depends on the size of your database. For details of database sizing, see the Installation Guide. For • • • • For • • • • • • • • each recipe, the following attributes can be configured: Recipe title Scale factor for recipe ingredients (This can be specified by an operator.
PAGE 385
plscpcg.book Page 367 Monday, May 28, 2001 10:11 AM Configuring Points for Recipes Configuring Points for Recipes If a point will be in a recipe, the first two characters of the point ID must be the unit descriptor. The unit descriptor is a 2-character identifier (for example 01, L7). You need to configure a point for every combination of unit descriptor and ingredient that you want to use.
PAGE 386
plscpcg.book Page 368 Monday, May 28, 2001 10:11 AM 17 – Configuring Recipes Configuring Recipes To configure a recipe: 1 Select Configure ⇒ Applications ⇒ Recipes from the System menu bar. This calls up the Recipe Summary display. 2 To work with an existing recipe, click its number or title. This calls up the Recipe Detail display. 3 To create a new recipe, click an unassigned row. When the blank Recipe Detail display opens, enter the appropriate information. (See “Defining a Recipe” on page 368.
PAGE 387
plscpcg.book Page 369 Monday, May 28, 2001 10:11 AM Configuring Recipes Description A fuller description of the recipe than can be displayed in the title. Scale The scale factor for the recipe. Ingredients in a recipe can be scaled to less than 100% so that a partial recipe quantity can be produced. When the recipe is loaded, all ingredients with Scaled set to “Yes” are scaled by the percentage specified in this field. This percentage can be changed by anyone using the OPER security level or higher.
PAGE 388
plscpcg.book Page 370 Monday, May 28, 2001 10:11 AM 17 – Configuring Recipes Scaled Enter “Yes” if the working value should be scaled by the Scale percentage. Otherwise enter “No.” Begin/Continue/End Comboboxes If the recipe consists of 30 ingredients or less, set the combobox above the list of ingredients to BEGIN and the combobox at the bottom of the display to END. See Chaining Recipes for details on using the Continue option.
PAGE 389
plscpcg.book Page 371 Monday, May 28, 2001 10:11 AM Configuring Custom Reports Configuring Custom Reports You can set up free format custom reports to show the results of completed processes. The following sections describe how you set up custom reports to run automatically, and how you configure a free format report for recipes.
PAGE 390
plscpcg.
PAGE 391
plscpcg.book Page 373 Monday, May 28, 2001 10:11 AM Configuring Custom Reports Word Offset Field Description Data Type 1357 Ingredient 1 minimum value (repeated for the 30 ingredients i.e word 1359 for ingredient 2) RL 1417 Ingredient 1 maximum value (repeated for the 30 ingredients i.e word 1419 for ingredient 2) RL 1477 Ingredient 1 working value (repeated for the 30 ingredients i.e. word 1479 for ingredient 2) RL 1537 Ingredient 1 parameter (repeated for the 30 ingredients i.
PAGE 392
plscpcg.
PAGE 393
plscpcg.book Page 375 Monday, May 28, 2001 10:11 AM 18 Configuring Downtime Analysis This chapter describes how you configure the Downtime Analysis option to record and analyze plant downtime. Discrete values from controllers can be configured to be delay states. Each delay state can be configured to have an associated category and reason code. These codes are then displayed on the Downtime Summary display on Station when delays occur.
PAGE 394
plscpcg.book Page 376 Monday, May 28, 2001 10:11 AM 18 – Configuring Downtime Analysis About Downtime Analysis When an item of plant equipment goes into “delay,” an entry is made in a file in the server database called the delay file. Each delay entry includes: • A description of the item of equipment • The start time and date of the delay • A downtime category code • A downtime reason code Operators are alerted to delays by the yellow flashing Delay field in Status Line.
PAGE 395
plscpcg.book Page 377 Monday, May 28, 2001 10:11 AM Configuring the Recording of Downtime Configuring the Recording of Downtime To configure downtime analysis, you need to: 1 Configure status points to read values from controllers that indicate delay conditions of plant equipment. 2 Configure reason codes for delays. (Reason codes are used to provide a short description of the cause of the delay.) 3 Configure reason categories for delays. (Reason categories are used to help classify delays.
PAGE 396
plscpcg.book Page 378 Monday, May 28, 2001 10:11 AM 18 – Configuring Downtime Analysis You can configure up to 1024 reason codes by specifying a different description for each reason code you want to use. The description you enter for each reason code is displayed on the Downtime summary for a delay point that uses that reason code. Note, however, that operators can enter a new reason code for a delay in the Downtime Summary.
PAGE 397
plscpcg.book Page 379 Monday, May 28, 2001 10:11 AM Configuring the Recording of Downtime Figure 18.
PAGE 398
plscpcg.book Page 380 Monday, May 28, 2001 10:11 AM 18 – Configuring Downtime Analysis Configuring Downtime Summation Downtime can be totalled by area, category, and delay point status at specified intervals. The totalled delay information is stored in the PV of dummy analog points. To define a dummy analog point for downtime summation, you define the point in Quick Builder: • Leaving the source and destination addresses for PV, SP, OP, and MD blank • Using a particular naming convention.
PAGE 399
plscpcg.book Page 381 Monday, May 28, 2001 10:11 AM Configuring the Downtime Analysis Report Configuring the Downtime Analysis Report The Downtime Analysis Report can include delays that are still outstanding as well as those that have been resolved. The report output can also be sorted by downtime category and reason codes. Details on creating a Downtime Report can be found under “Configuring a New Report” on page 243 and in “Downtime Analysis Reports” on page 254.
PAGE 400
plscpcg.
PAGE 401
plscpcg.book Page 383 Monday, May 28, 2001 10:11 AM 19 Configuring Extended Event Archiving Every event, such as a point status change or an operator action, is stored in an event file. The online event file is only capable of storing a certain number of events. You can archive these events to disk and tape, where they can be stored for future retrieval.
PAGE 402
plscpcg.book Page 384 Monday, May 28, 2001 10:11 AM 19 – Configuring Extended Event Archiving About Extended Event Archiving You use the Extended Event Archiving and Reporting System to enable extended event collection and recall. When extended events collection is enabled, PlantScape periodically copies the events from the event file and places them into the Online Extended Event file for queries and reporting.
PAGE 403
plscpcg.book Page 385 Monday, May 28, 2001 10:11 AM Extended Event Archiving System Configuration Extended Event Archiving System Configuration To configure Extended Event Archiving: 1 On the System Configuration Menu display click Extended Event Archiving. This calls up the Extended Event Archiving Configuration display.
PAGE 404
plscpcg.book Page 386 Monday, May 28, 2001 10:11 AM 19 – Configuring Extended Event Archiving Property Extended Event Throttle Value Description The maximum number of events that can be copied into the online extended event file over the duration of a cycle period. When the number of events generated per cycle period is greater than the throttle value, typically in peak traffic periods, the system goes into the overload state.
PAGE 405
plscpcg.book Page 387 Monday, May 28, 2001 10:11 AM Extended Event Archiving System Configuration Property Description Next Record Number In Online Extended Event File This specifies the record number in the online extended event file where the next event collected from the system will be placed. Current Push Record The current push record indicates the record number in the system file of the most recent event that has occurred.
PAGE 406
plscpcg.book Page 388 Monday, May 28, 2001 10:11 AM 19 – Configuring Extended Event Archiving Property Maximum Tolerable Time Delay Between Collections (minutes) Description Used when the archiving system is enabled after being disabled for some period of time.
PAGE 407
plscpcg.book Page 389 Monday, May 28, 2001 10:11 AM Extended Event Archiving System Configuration The following table provides a description of each extended event archiving status. Status Description OK The extended event archiving system is operating as required. Overload The system is receiving events at a faster rate than it is configured to copy them into the online extended event file.
PAGE 408
plscpcg.
PAGE 409
plscpcg.book Page 391 Monday, May 28, 2001 10:11 AM 20 Using PlantScape Data in Other Applications This chapter describe how PlantScape data can be used for purposes other than operator-related activities such as supervisory control and data acquisition. PlantScape provides the following methods for accessing server data: • The PlantScape ODBC Driver option is designed for retrieving PlantScape data via ODBC-compliant applications such as Crystal Reports, Microsoft Access, or Microsoft Excel.
PAGE 410
plscpcg.book Page 392 Monday, May 28, 2001 10:11 AM 20 – Using PlantScape Data in Other Applications PlantScape ODBC Support ODBC is a standard set of function calls for accessing data in a database. These calls enable you to perform Structured Query Language (SQL) queries on the database.
PAGE 411
plscpcg.book Page 393 Monday, May 28, 2001 10:11 AM About the PlantScape ODBC Driver About the PlantScape ODBC Driver The PlantScape ODBC driver enables you to access PlantScape Server data (such as history, event, access, and point data) directly from any application that provides ODBC support; for example, Microsoft Access, Microsoft Excel, or Crystal Reports. The PlantScape ODBC driver has two parts: the ODBC Server and the ODBC Client.
PAGE 412
plscpcg.book Page 394 Monday, May 28, 2001 10:11 AM 20 – Using PlantScape Data in Other Applications Configuring the PlantScape ODBC Driver The following procedures assume that you have already completed the installation of the PlantScape server software as described in the Installation Guide. Specifically, the procedures assume that: • You have installed the PlantScape ODBC Client software on the client computer (that is, the computer that will be used to query the PlantScape Server database).
PAGE 413
plscpcg.book Page 395 Monday, May 28, 2001 10:11 AM Configuring the PlantScape ODBC Driver 6 7 8 Note • • Use the Data Source Name and Description fields to enter a data source name and description. It is advisable to name the data source after the PlantScape server that you will be querying. For example, if your PlantScape server is called hsserv, enter hsserv as the data source name, and enter Data source for PlantScape database on hsserv as the description. Click OK to close the Setup dialog box.
PAGE 414
plscpcg.book Page 396 Monday, May 28, 2001 10:11 AM 20 – Using PlantScape Data in Other Applications Note 8 Click OK to close the ODBC Data Source Administrator dialog box. • File data sources, which enable access over the network, cannot be built for the PlantScape ODBC driver via the ODBC Administrator. If you require a file data source: a) Build a system data source.
PAGE 415
plscpcg.book Page 397 Monday, May 28, 2001 10:11 AM Configuring the PlantScape ODBC Driver Note In this field… Enter… Server Name The name of the computer on which the PlantScape Server software is running. If you are running a redundant system, enter only the base part of the server name. For example, if your two servers are called hsserva and hsservb enter only hsserv as the server name. The ODBC driver will connect automatically to the computer currently running as primary.
PAGE 416
plscpcg.book Page 398 Monday, May 28, 2001 10:11 AM 20 – Using PlantScape Data in Other Applications Normally when you query the PlantScape database you are prompted to connect to the database via the Connection Details dialog box. It might sometimes be useful for the client application to connect to the database without the user having to log in (for example, if you have set up a periodic reporting facility).
PAGE 417
plscpcg.book Page 399 Monday, May 28, 2001 10:11 AM Configuring the PlantScape ODBC Driver Point Tables You • • • • • can query the following PlantScape point tables with the ODBC driver: AccumulatorPoint AnalogPoint StatusPoint FlexiblePoint ControlModulePoint (for accessing points on the Honeywell Control Processor) The point fields (which are visible as columns in each of the point tables) are shown in the following graphic. Figure 20.
PAGE 418
plscpcg.book Page 400 Monday, May 28, 2001 10:11 AM 20 – Using PlantScape Data in Other Applications A table opened in this way displays every point field for every point of that type in the PlantScape server database. This might be more information than is needed. To select particular data out of the table, you need to build a query. A query can be used to reduce the number of columns (point fields) or rows (points) which are retrieved from the database.
PAGE 419
plscpcg.book Page 401 Monday, May 28, 2001 10:11 AM Configuring the PlantScape ODBC Driver To access a flexible point parameter, you set ParameterXXX to equal the parameter you need. PlantScape then sets the QualityXXX, TypeXXX, and TextValueXXX parameters to the corresponding values. For example, if you set Parameter001, then Quality001, Type001, TextValue001 and NumericValue001 will contain values corresponding to this parameter for every point.
PAGE 420
plscpcg.book Page 402 Monday, May 28, 2001 10:11 AM 20 – Using PlantScape Data in Other Applications FROM ControlModulePoint WHERE Parameter001 = ‘PIDA.SP’ The result set is shown below. Figure 20.5 Result for Example Query for Control Module Point The Quality field indicates the point parameter status when the data was retrieved. It can take the following values: UNIM The parameter has not been implemented for the point. UNSPECIFIED No parameter has been specified in the parameter field.
PAGE 421
plscpcg.book Page 403 Monday, May 28, 2001 10:11 AM Configuring the PlantScape ODBC Driver The relationship between the Type field and the TextValue and NumericValue fields is as follows: • If the parameter type is TEXT, then the value is shown in the TextValue field. • If the parameter type is NUMBER, the value is shown in the NumericValue field. • If the parameter type is ENUM, the value is shown in both the TextValue and the NumericValue field.
PAGE 422
plscpcg.book Page 404 Monday, May 28, 2001 10:11 AM 20 – Using PlantScape Data in Other Applications Event Tables All PlantScape events displayed in the Event Summary can be viewed through the Event table (Figure 20.6, “Event Table Data” on page 404). Like the point tables, the Event table can be opened and viewed directly from most client applications. Figure 20.
PAGE 423
plscpcg.book Page 405 Monday, May 28, 2001 10:11 AM Configuring the PlantScape ODBC Driver WHERE (PointID=’sinewave’) Note • If no value is specified for LogTimeStamp, then, by default, only events generated within the last 24 hour period are returned. History Tables Nine history tables from the PlantScape database are visible via the ODBC driver.
PAGE 424
plscpcg.book Page 406 Monday, May 28, 2001 10:11 AM 20 – Using PlantScape Data in Other Applications For example, Parameter001 = ‘TankLevel.pv’. This sets Value001 to be the value of the TankLevel’s PV, and Quality001 to be the quality of the corresponding history value. The quality indicates the state of the point at the time the sample was taken. Possible qualities are: GOOD There are no errors. BAD The point was not scanning at time sample taken.
PAGE 425
plscpcg.book Page 407 Monday, May 28, 2001 10:11 AM Configuring the PlantScape ODBC Driver The equivalent SQL query is: SELECT "TimeStamp" ,"Value001", Quality001 FROM "History1MinSnapshot" WHERE ( ( ("Parameter001" = ’TankLevel.pv’ ) AND ("TimeStamp" > {ts ’1997-07-25 10:00:00’} ) ) AND ("TimeStamp" < {ts ’1997-07-25 16:00:00’} ) ) Case-Sensitive Searches By default all queries made by the PlantScape ODBC driver are case insensitive.
PAGE 426
plscpcg.book Page 408 Monday, May 28, 2001 10:11 AM 20 – Using PlantScape Data in Other Applications Login and Password Rejected When Connecting to the Data Source Connecting to the data source requires a PlantScape login and password. PlantScape is supplied with the default login mngr, password mngr1. For information about adding new operator logins, see “Defining an Operator” on page 216.
PAGE 427
plscpcg.book Page 409 Monday, May 28, 2001 10:11 AM Configuring the PlantScape ODBC Driver Figure 20.10 Link Dialog Box 3 4 5 6 From the Files of Type combobox, select ODBC Databases. This displays the Select Data Source dialog box. Select PlantScape Data Source, or the data source you configured with the PlantScape ODBC driver and click OK. This displays the Connection Details dialog box.
PAGE 428
plscpcg.book Page 410 Monday, May 28, 2001 10:11 AM 20 – Using PlantScape Data in Other Applications 7 A number of dialog boxes titled Select Unique Identifier appear. Click OK in each dialog box without selecting any items. Note These dialog boxes refer to a feature that is not supported by the PlantScape server. Changing anything in any of these boxes can lead to unpredictable results. You have now created links to all the tables in the database.
PAGE 429
plscpcg.book Page 411 Monday, May 28, 2001 10:11 AM Configuring the PlantScape ODBC Driver 4 5 6 7 8 9 • Add • • • The LRN number to 0 an analog point and set: The PointID to sinewave The PV Scan Period to 2 seconds The PV Source address to the controller just built, with a location of 114. Select the Alarm tab and set: • The PV High with urgent priority and limit 90 • The PV Low with urgent priority and limit 10 Select the History tab and assign the PV to fast history.
PAGE 430
plscpcg.book Page 412 Monday, May 28, 2001 10:11 AM 20 – Using PlantScape Data in Other Applications 7 8 In the third column select PVValue. In the fourth column select OnScan. In the Criteria row, type: =1 9 (to select all the points which are currently scanning) Unmark the check-box to prevent this column from being displayed. Select View ⇒ Datasheet to send the query to your PlantScape database. You should see a table like the one below. Figure 20.
PAGE 431
plscpcg.book Page 413 Monday, May 28, 2001 10:11 AM Configuring the PlantScape ODBC Driver Building a History Query The format for history queries is slightly different from other queries because the names of points are system-configurable. To build a query which retrieves the 5-second snapshot values of your sinewave point over a 10 minute period: 1 Select the Queries tab. 2 Click New, select Design View and click OK to display the Show Table dialog box.
PAGE 432
plscpcg.book Page 414 Monday, May 28, 2001 10:11 AM 20 – Using PlantScape Data in Other Applications To configure Microsoft SQL Server you use the DTS Wizard and includes the following steps: • Configuring the data source in SQL Server • Configure the destination SQL Server database • Selecting the tables you want to link to • Select when data is copied To configure Microsoft SQL Server: 1 Select Start ⇒ Programs ⇒ Microsoft SQL Server 7.0 ⇒ Import and Export Data. The DTS Wizard starts.
PAGE 433
plscpcg.book Page 415 Monday, May 28, 2001 10:11 AM About PlantScape ODBC Data Exchange About PlantScape ODBC Data Exchange The ODBC Data Exchange option enables you to configure the two-way exchange of data between the PlantScape server database and an ODBC-compliant local or network third-party database, using standard Structured Query Language (SQL) commands. When you configure the PlantScape ODBC Data Exchange option, the PlantScape server acts as a client application.
PAGE 434
plscpcg.book Page 416 Monday, May 28, 2001 10:11 AM 20 – Using PlantScape Data in Other Applications Server Database ODBC Data Exchange ODBC Drivers Client Components Server Components Data Access Software Access SQL Server Oracle Figure 20.
PAGE 435
plscpcg.book Page 417 Monday, May 28, 2001 10:11 AM Configuring ODBC Data Exchange Reports Configuring ODBC Data Exchange Reports The following procedures assume that you have already completed the PlantScape ODBC Data Exchange installation as described in the installation guide.
PAGE 436
plscpcg.book Page 418 Monday, May 28, 2001 10:11 AM 20 – Using PlantScape Data in Other Applications b) Click Next and follow the prompts to complete the SQL Server configuration. Notes If you intend to use multiple databases, you need to set up a data source for each database.
PAGE 437
plscpcg.book Page 419 Monday, May 28, 2001 10:11 AM Configuring ODBC Data Exchange Reports Specifying the SQL Database Login Details Data Source Name Enter the name of the data source for the database to which the report is to connect. This name should match the Data Source Name entered when you configured the ODBC System Data Source (see “Configuring the ODBC Data Source” on page 417). User Name Enter the user login name that has permission to access the required database. This field is optional.
PAGE 438
plscpcg.
PAGE 439
plscpcg.book Page 421 Monday, May 28, 2001 10:11 AM Configuring ODBC Data Exchange Reports Selecting an Alarm Priority in the Event of a Failed SQL Report If the SQL report fails, an alarm is generated with a message describing the type of error. Configure the priority of this alarm by selecting an alarm type from the Alarm priority on error list. Specifying How Bad Values Are Handled You can configure how bad or Not a Number (NaN) numeric and string values are stored in the ODBC database.
PAGE 440
plscpcg.book Page 422 Monday, May 28, 2001 10:11 AM 20 – Using PlantScape Data in Other Applications Adding Comments to the Reference File You can add comments to the Input Reference file to aid readability. Comments are enclosed in /*...*/ and may be nested. There must not be any comments between the end-of-command marker (“;”) and an embedded reference.
PAGE 441
plscpcg.book Page 423 Monday, May 28, 2001 10:11 AM Configuring ODBC Data Exchange Reports The following table shows the types of embedded reference which can be used to access or write data to an PlantScape server.
PAGE 442
plscpcg.book Page 424 Monday, May 28, 2001 10:11 AM 20 – Using PlantScape Data in Other Applications Checking Commands SQLCHK Utility The Input Reference file can be checked for PlantScape server database reference syntax errors by using a command-line utility, SQLCHK. Each command is read and if there is an embedded PlantScape server database reference before the end-of-command marker (“;”) it is resolved and data substituted.
PAGE 443
plscpcg.book Page 425 Monday, May 28, 2001 10:11 AM Configuring ODBC Data Exchange Reports Point Reference Type Format "@ POINTREF POINTNAME pointname PARAMETER parameter [Numeric] @" Description This reference type is used to access point parameters in the PlantScape server application database. pointname Point ID (tag name) parameter Source/destination of data. Control Module point parameters may be used here in the format .. For example, PIDA.PV.
PAGE 444
plscpcg.book Page 426 Monday, May 28, 2001 10:11 AM 20 – Using PlantScape Data in Other Applications Parameter 4 H24HE Description 24 hour extended history Notes 1 2 3 4 5 Example All SQL keywords may be abbreviated to the first 2 letters Each line must be no more than 80 characters long Data can only be uploaded to the PV of a point if the option “Enable PV Data Upload” is enabled. Data can only be uploaded to the history parameters of a point if the option “Enable History Data Upload” is enabled.
PAGE 445
plscpcg.book Page 427 Monday, May 28, 2001 10:11 AM Configuring ODBC Data Exchange Reports History Reference Type Report Format "@ HISTORYREF POINTNAME pointname TYPE histype DATE data TIME time OFFSET offset [ITEMS numitems] [PARAMETER paramname] @" Description This reference type is used to access point history data on the PlantScape server. You cannot use this reference type to upload history values. Individual history parameters can be uploaded using the Pointref reference type.
PAGE 446
plscpcg.book Page 428 Monday, May 28, 2001 10:11 AM 20 – Using PlantScape Data in Other Applications Parameter Any valid parameter name, including control module point parameters can be used. For a complete list of point parameters see Table 8.1, “Summary of Point Parameter Types,” on page 134. Notes • • Example All SQL keywords may be abbreviated to the first 2 letters. Specify either the date and time, or an offset, but not both.
PAGE 447
plscpcg.book Page 429 Monday, May 28, 2001 10:11 AM Configuring ODBC Data Exchange Reports Table Reference Type Report Format “@ TABLEREF TABLENUM table RECORDNUM record WORDNUM word NUMRECORDS numrecords datatype @” Description This reference type is used to access file data in the PlantScape server database.
PAGE 448
plscpcg.book Page 430 Monday, May 28, 2001 10:11 AM 20 – Using PlantScape Data in Other Applications Data Type Keyword Data Type Description Data Item Following Keyword JULDATE Date in Julian format [Optional number of items] TIME Time in seconds since midnight [Optional number of items] DATETIME Date and time in the format [Optional number of items] DD-MMM_YY HH:MM Table 20.3 Notes 1 2 3 4 5 6 Example All SQL keywords may be abbreviated to the first two letters.
PAGE 449
plscpcg.book Page 431 Monday, May 28, 2001 10:11 AM Configuring ODBC Data Exchange Reports The following example will extract a floating point number, a 2-byte integer and 3 strings 10 characters long from record 5 of the file 256 starting at word 1, and store this data in the SQL database.
PAGE 450
plscpcg.book Page 432 Monday, May 28, 2001 10:11 AM 20 – Using PlantScape Data in Other Applications SQL Report Example The following example is written for Microsoft SQL Server. Some of the SQL syntax is specific to Microsoft SQL Server, for example, getdate().
PAGE 451
plscpcg.
PAGE 452
plscpcg.
PAGE 453
plscpcg.book Page 435 Monday, May 28, 2001 10:11 AM Configuring ODBC Data Exchange Reports smallfloat = 0.
PAGE 454
plscpcg.book Page 436 Monday, May 28, 2001 10:11 AM 20 – Using PlantScape Data in Other Applications PlantScape OPC Support PlantScape provides both an OPC Client and an OPC Server. The OPC Server makes PlantScape Server point data available for use in other applications. The OPC Client is used to collect data from other OPC servers to put into PlantScape server point values. The PlantScape OPC Server and Client can be used together or with third-party OPC Servers and Clients.
PAGE 455
plscpcg.book Page 437 Monday, May 28, 2001 10:11 AM PlantScape OPC Support Using the PlantScape OPC Server Preparation See the PlantScape Installation Guide for details on how to configure the PlantScape server computer and an OPC Client computer for OPC connection, and for a description of the PlantScape OPC Server Connect package that must be installed on OPC Client computers.
PAGE 456
plscpcg.book Page 438 Monday, May 28, 2001 10:11 AM 20 – Using PlantScape Data in Other Applications PlantScape Data Addressing Point parameter data is available via the PlantScape OPC Server. An item created to reference data must use an address consistent with the following formats: Format for Simple Points (those other than Control Processor points) point.parameter [/enum] where point is the point ID.
PAGE 457
plscpcg.book Page 439 Monday, May 28, 2001 10:11 AM PlantScape OPC Support How Items Access Point Parameters of Type enum Some point parameters are enumerated—they can be represented by both an integer and a string. Examples are: status point states, modes, and Control Module Point enumeration parameters. Two methods of accessing enumerated parameters are supported: Parameter is written and/or read as text This requires the item to be built with the enum flag on. point.
PAGE 458
plscpcg.
PAGE 459
plscpcg.
PAGE 460
plscpcg.
PAGE 461
plscpcg.
PAGE 462
plscpcg.
PAGE 463
plscpcg.
PAGE 464
plscpcg.book Page 446 Monday, May 28, 2001 10:11 AM 20 – Using PlantScape Data in Other Applications OPC Server Param Name OPC Type OPC Access Enumerated? A2ExternalChangeAlarmEnable VT_BOOL A3ExternalChangeAlarmEnable VT_BOOL A4ExternalChangeAlarmEnable VT_BOOL ModeCheckingDisabled VT_BOOL A1AssociatedParameter VT_I4 read only yes A2AssociatedParameter VT_I4 read only yes A3AssociatedParameter VT_I4 read only yes A4AssociatedParameter VT_I4 read only yes Table 20.
PAGE 465
plscpcg.
PAGE 466
plscpcg.book Page 448 Monday, May 28, 2001 10:11 AM 20 – Using PlantScape Data in Other Applications OPC Server Param Name OPC Type InPVHighHighAlarm VT_BOOL OPC Access Enumerated? Table 20.6 Accumulator Point OPC Parameter Names and Details (Continued) Control Processor Point Parameters Below are the Control Processor point parameters which apply to all points. The point-specific parameters can be referred to as specified in “Format for Control Processor Points” on page 438.
PAGE 467
plscpcg.
PAGE 468
plscpcg.book Page 450 Monday, May 28, 2001 10:11 AM 20 – Using PlantScape Data in Other Applications Anyone with full access to the OPCRead file will have read access to the OPC Server. Anyone with full access to the OPCWrite file will have write access to the OPC Server. In order to allow a particular account to have read access, but deny write access to the OPC Server, the account must be given full access to the OPCRead file and have no access to the OPCWrite file.
PAGE 469
plscpcg.book Page 451 Monday, May 28, 2001 10:11 AM PlantScape OPC Support Function HRESULT Item HRESULT Condition. S_FALSE 0xE00483FD (for all items) Host backup. S_FALSE 0xE00483FC (for all items) Host not running (but not backup). S_FALSE 0xE0048222 Point not active. S_FALSE 0xE0048223 Parameter error S_FALSE 0xE0048224 Control inhibited S_FALSE 0xE0048227 RTU disabled. S_FALSE 0xE0048228 Channel disabled. S_FALSE 0xE0048229 Illegal mode for control.
PAGE 470
plscpcg.book Page 452 Monday, May 28, 2001 10:11 AM 20 – Using PlantScape Data in Other Applications PlantScape Application Programming Interface and Network API If necessary, a site can develop its own custom applications to use in conjunction with PlantScape data. • For applications that run on the PlantScape server, PlantScape provides an Application Programming Interface (API). • For applications that run on another computer, PlantScape provides a Network API option.
PAGE 471
plscpcg.book Page 453 Monday, May 28, 2001 10:11 AM PlantScape Application Programming Interface and Network API Custom Server Application System Server API Server Network Network API Remote Machine Custom Network Application Figure 20.
PAGE 472
plscpcg.book Page 454 Monday, May 28, 2001 10:11 AM 20 – Using PlantScape Data in Other Applications Using Microsoft Excel Data Exchange Using the Microsoft Excel Data Exchange option, you can capture real time point value and history information from PlantScape and display the data in an Excel spreadsheet. Data can be retrieved from PlantScape by using either the Microsoft Excel Data Exchange Wizard, or through cell formulas.
PAGE 473
plscpcg.book Page 455 Monday, May 28, 2001 10:11 AM Using Microsoft Excel Data Exchange b) c) Enter the desired point ID into the Point ID field, for example, 01T1LEVEL. Select the point parameter from the Point Parameter list (or type the parameter name into the field), for example, PV. You can add or remove point parameters as required. Note 3 4 The Point Parameter drop-down list displays all parameters, regardless of point type. You must select a parameter valid for your chosen point type.
PAGE 474
plscpcg.book Page 456 Monday, May 28, 2001 10:11 AM 20 – Using PlantScape Data in Other Applications To display a sequence of historical values: 1 Select Tools ⇒ Microsoft Excel Data Exchange ⇒ Wizard to start the wizard. 2 Select Get history values from server(s). 3 You can specify the target point parameters you want retrieved. 4 Specify the desired historical values to be retrieved for the selected points. Note Ensure that your selection matches the history collection for the points on the server.
PAGE 475
plscpcg.book Page 457 Monday, May 28, 2001 10:11 AM Using Microsoft Excel Data Exchange Caution Do not use the Function Wizard for any PUT functions, as this may write undesired values to the server. See the Caution in “Microsoft Excel Data Exchange Functions” on page 461 for more details. To select a function: a) From the Function Category list, click User Defined. b) Select a function from the Function Name list. c) Enter any required details for the function.
PAGE 476
plscpcg.book Page 458 Monday, May 28, 2001 10:11 AM 20 – Using PlantScape Data in Other Applications • • 3 4 5 6 7 8 9 10 If it is not there, then continue with the following steps. If it is there, then you need go no further, as Microsoft Excel Data Exchange has been successfully installed for the current account. Go to the Tools menu and select Add-Ins. Click Browse. Navigate to the Microsoft Excel Data Exchange folder (in this case C:\CLIENT\XLDATAEX). Select MEDE.XLA Click OK.
PAGE 477
plscpcg.book Page 459 Monday, May 28, 2001 10:11 AM Using Microsoft Excel Data Exchange Using PlantScape Parameters with Microsoft Excel Data Exchange Functions The following Microsoft Excel Data Exchange functions take the parameter argument as a string (for example, "PV", "SP"): GetPointVal GetPointValArray(actually a list eg "PV,MD,OP") GetHistVal_Offset GetHistValArray_Offset(actually a list e.g. "PV,MD,OP") GetHistVal_Date GetHistValArray_Date(actually a list e.g.
PAGE 478
plscpcg.
PAGE 479
plscpcg.book Page 461 Monday, May 28, 2001 10:11 AM Microsoft Excel Data Exchange Functions Microsoft Excel Data Exchange Functions The Microsoft Excel Data Exchange functions and parameters are listed on the following pages. Caution 1 2 Functions that are prefixed by NAPI_ should only be used by advanced or experienced users who are familiar with the Network API. Do not use the Microsoft Function Wizard to write NAPI routines into cells.
PAGE 480
plscpcg.book Page 462 Monday, May 28, 2001 10:11 AM 20 – Using PlantScape Data in Other Applications To edit a formula array: 1 Select all the cells which form the formula array. 2 Click the formula in the formula entry line near the top of the window. 3 Edit the formula as necessary. 4 Press ++ to place the formula back into the formula array cells. To change the number of cells in a formula array: 1 Follow Steps 1 and 2 of the editing instructions.
PAGE 481
plscpcg.book Page 463 Monday, May 28, 2001 10:11 AM Microsoft Excel Data Exchange Functions GetHistVal_Date For a single point parameter, retrieves multiple consecutive history values by date and time. GetHistVal_Date inserts each history sample into an individual cell in your Microsoft Excel worksheet. Before using the function, you must highlight the cells that will contain history values (that is, you must highlight the number of rows and columns necessary for displaying the data).
PAGE 482
plscpcg.book Page 464 Monday, May 28, 2001 10:11 AM 20 – Using PlantScape Data in Other Applications GetHistVal_Offset For a single point parameter, retrieves multiple consecutive history values by offset. GetHistVal_Date inserts each history sample into an individual cell in your Microsoft Excel worksheet. Before using the function, you must highlight the number of cells that will contain history values (that is, you must highlight the number of rows and columns necessary for displaying the data).
PAGE 483
plscpcg.book Page 465 Monday, May 28, 2001 10:11 AM Microsoft Excel Data Exchange Functions GetHistValArray_Date For multiple point parameters, retrieves multiple consecutive history values by date and time. Before using the function, you must highlight the number of cells that will contain history values (that is, you must highlight the number of rows and columns necessary for displaying the data).
PAGE 484
plscpcg.
PAGE 485
plscpcg.book Page 467 Monday, May 28, 2001 10:11 AM Microsoft Excel Data Exchange Functions GetHistValArray_Offset For multiple point parameters, retrieves multiple consecutive history values by offset. Before using the function, you must highlight the number of cells that will contain history values (that is, you must highlight the number of rows and columns necessary for displaying the data).
PAGE 486
plscpcg.book Page 468 Monday, May 28, 2001 10:11 AM 20 – Using PlantScape Data in Other Applications GetPointVal Retrieves a single point parameter value from the server. Server Name of the PlantScape server from which data is retrieved. PointID Name of the point on the PlantScape server from which data is retrieved. PointParameter The point parameter of interest, for example, “PV”. Refer to Table 8.1, “Summary of Point Parameter Types,” on page 134 for a list of parameter types.
PAGE 487
plscpcg.book Page 469 Monday, May 28, 2001 10:11 AM Microsoft Excel Data Exchange Functions GetPointValArray Retrieves the value of multiple point parameters from the server. Before using the function, you must highlight the number of cells that will contain history values (that is, you must highlight the number of rows and columns necessary for displaying the data). Can display data horizontally or vertically. NumPoints Number of points.
PAGE 488
plscpcg.book Page 470 Monday, May 28, 2001 10:11 AM 20 – Using PlantScape Data in Other Applications NAPI_rGetdat_int Retrieves a single field from a user file in the following formats: double double precision (8 bytes) I.E.E.E. floating point float single precision (4 byte) I.E.E.E. floating point int two bytes signed integer long four bytes signed integer str character string Server Name of the PlantScape server from which data is retrieved. File PlantScape database file number.
PAGE 489
plscpcg.book Page 471 Monday, May 28, 2001 10:11 AM Microsoft Excel Data Exchange Functions NAPI_rGetdat_str Retrieves a single field from a user file in string format Server Name of the PlantScape server from which data is retrieved. File PlantScape database file number. User files start from file 251 so that user file 1 is file 251, user file 2 is file 252 and so on. Record The record number in the user file. Word The word number in the record.
PAGE 490
plscpcg.book Page 472 Monday, May 28, 2001 10:11 AM 20 – Using PlantScape Data in Other Applications NAPI_rGethstpar_date Retrieves history parameter value for a single point by date and time. Server Name of the PlantScape server from which data is retrieved. HistoryType History type of the point to retrieve. For example, 6 for 5 second fast history.
PAGE 491
plscpcg.book Page 473 Monday, May 28, 2001 10:11 AM Microsoft Excel Data Exchange Functions NAPI_rGethstpar_ofst Retrieves history parameter value for a single point by offset. Server Name of the PlantScape server from which data is retrieved. HistoryType History type of the point to retrieve. For example, 6 for 5 second fast history.
PAGE 492
plscpcg.book Page 474 Monday, May 28, 2001 10:11 AM 20 – Using PlantScape Data in Other Applications NAPI_rGetPnt_Num Retrieves the point number for a point. Example Server Name of the PlantScape server from which data is retrieved. PointID Name of the point on the PlantScape server from which data is retrieved.
PAGE 493
plscpcg.book Page 475 Monday, May 28, 2001 10:11 AM Microsoft Excel Data Exchange Functions NAPI_rGetPnt_Status Retrieves a point status information. Example Server Name of the PlantScape server from which data is retrieved. PointID Name of the point on the PlantScape server from which data is retrieved.
PAGE 494
plscpcg.book Page 476 Monday, May 28, 2001 10:11 AM 20 – Using PlantScape Data in Other Applications NAPI_rGetVal_Ascii Retrieves a string parameter of a point. Server Name of the PlantScape server from which data is retrieved. PointNumber Point number of the point. See “NAPI_rGetPnt_Num” on page 474 for details of how to obtain the point number for a point ID. PointParameter The point parameter of interest, for example, DESC. Refer to Table 8.
PAGE 495
plscpcg.book Page 477 Monday, May 28, 2001 10:11 AM Microsoft Excel Data Exchange Functions NAPI_rGetVal_History Retrieves the value of the PV history type of a point. Server Name of the PlantScape server from which data is retrieved. PointNumber Point number of the point. See “NAPI_rGetPnt_Num” on page 474 for details of how to obtain the point number for a point ID. PointParameter The point parameter of interest, for example, PV. Refer to Table 8.
PAGE 496
plscpcg.book Page 478 Monday, May 28, 2001 10:11 AM 20 – Using PlantScape Data in Other Applications NAPI_rGetVal_Number Retrieves a numeric parameter of a point. Server Name of the PlantScape server from which data is retrieved. PointNumber Point number of the point. See “NAPI_rGetPnt_Num” on page 474 for details of how to obtain the point number for a point ID. PointParameter The point parameter of interest, for example, PV. Refer to Table 8.
PAGE 497
plscpcg.book Page 479 Monday, May 28, 2001 10:11 AM Microsoft Excel Data Exchange Functions NAPI_rPutdat_int Writes a single value to a field in a user file in the following formats: double double precision (8 bytes) I.E.E.E. floating point float single precision (4 byte) I.E.E.E. floating point int two bytes signed integer long four bytes signed integer str character string Server Name of the PlantScape server to which the value is written. File PlantScape database file number.
PAGE 498
plscpcg.book Page 480 Monday, May 28, 2001 10:11 AM 20 – Using PlantScape Data in Other Applications Example To store an integer value of 42 into user table 1, record 1, word 15 for server HSSERVA.
PAGE 499
plscpcg.book Page 481 Monday, May 28, 2001 10:11 AM Microsoft Excel Data Exchange Functions NAPI_rPutdat_float See “NAPI_rPutdat_double” on page 481 NAPI_rPutdat_double See “NAPI_rPutdat_double” on page 481 NAPI_rPutdat_long See “NAPI_rPutdat_double” on page 481 NAPI_rPutdat_str Writes a string to a field in a user file: Server Name of the PlantScape server to which the value is written. File PlantScape database file number.
PAGE 500
plscpcg.book Page 482 Monday, May 28, 2001 10:11 AM 20 – Using PlantScape Data in Other Applications NAPI_rPutVal_Number Set a numeric parameter of a point. Server Name of the PlantScape server from which data is retrieved. PointNumber Point number of the point. See “NAPI_rGetPnt_Num” on page 474 for details of how to obtain the point number for a point ID. PointParameter The point parameter of interest, for example, PV. Refer to Table 8.
PAGE 501
plscpcg.book Page 483 Monday, May 28, 2001 10:11 AM 21 Command Reference This chapter describes the commands and utilities used to configure PlantScape. They are grouped as follows: • Installation/Migration Commands • Configuration Commands • Controller Configuration Commands • Diagnostic Commands • Administration Commands • Database Initialization Commands • Application Development Commands To run a command/utility, see Running PlantScape Commands/Utilities.
PAGE 502
plscpcg.book Page 484 Monday, May 28, 2001 10:11 AM 21 – Command Reference Running PlantScape Commands/Utilities To use the commands and utilities described in this chapter you need to log on to the PlantScape server using a Honeywell Administrator account. (User accounts are described in the Administration Guide.) To run a command/utility: 1 Select Start ⇒ Programs ⇒ Accessories ⇒ Command Prompt to open a Command Prompt window.
PAGE 503
plscpcg.
PAGE 504
plscpcg.book Page 486 Monday, May 28, 2001 10:11 AM 21 – Command Reference setup Description setup is primarily used to install the PlantScape server software and client software (Station, Display Builder, Quick Builder).
PAGE 505
plscpcg.book Page 487 Monday, May 28, 2001 10:11 AM Installation/Migration Commands sysbld Description sysbld is used to adjust the number of configurable database items within the maximum number of items permitted by your license.
PAGE 506
plscpcg.book Page 488 Monday, May 28, 2001 10:11 AM 21 – Command Reference Part Description mode One of the following: -initialise Initializes the database, and deletes all configuration and process data. -preserve Preserves data in the database. See “Disk Space Considerations” on page 488. options -default Builds the database using default sizes. -diag Prints diagnostic messages. -full Resizes all database items. -y Answers yes to all questions.
PAGE 507
plscpcg.book Page 489 Monday, May 28, 2001 10:11 AM Installation/Migration Commands utbconv Description utbconv is provided to migrate point and parameter reference numbers embedded in user files from an old release of PlantScape to the current release. (When you upgrade to the current release, all parameter and point numbers except those in user files are automatically translated (if necessary) by the PlantScape installation process.
PAGE 508
plscpcg.book Page 490 Monday, May 28, 2001 10:11 AM 21 – Command Reference Part Description file_num The number of the file where the point or parameter number is located. record_num The records to be converted, either all or a specific record number. word_list The words to be converted, which can include: • Specific words, for example: 5 or 5, 9. • Range A range of words, for example: 5-9. Notes • Comments can be inserted by placing a # at the start of the line.
PAGE 509
plscpcg.book Page 491 Monday, May 28, 2001 10:11 AM Installation/Migration Commands 2 Enter 1 The system responds with: Enter DEVICE/FILE name 3 Enter user_file.
PAGE 510
plscpcg.book Page 492 Monday, May 28, 2001 10:11 AM 21 – Command Reference pointmig Description pointmig is used to migrate point definition files from SCAN 3000 databases. Syntax pointmig release_number input_PDF Part Description release_number The release of SCAN 3000 under which the point definition file (PDF) was created. For example, 500 for Release 500 of SCAN 3000. input_PDF Is the path name of the file to be converted. Notes • pointmig can also be run in conjunction with pntbld.
PAGE 511
plscpcg.book Page 493 Monday, May 28, 2001 10:11 AM Configuration Commands Configuration Commands The following commands and utilities can be used for a range of configuration purposes.
PAGE 512
plscpcg.book Page 494 Monday, May 28, 2001 10:11 AM 21 – Command Reference alglst Description alglst lists the free algorithm blocks in the database. Syntax alglst To run alglst: 1 Enter alglst. The system responds with: Enter first algo block number 2 Enter the lower limit of the range of algorithm block numbers in your system (usually 1). The system responds with: Enter the last algo block number 3 Enter the upper limit of the range of block numbers.
PAGE 513
plscpcg.book Page 495 Monday, May 28, 2001 10:11 AM Configuration Commands bckbld Description bckbld is used to create a point definition file that reflects the current point configuration details in the server database. It is used, for example, when you have made changes to point configuration data via Station, rather than via Quick Builder or pntbld. After creating a point definition file, you can upload it into a Quick Builder project. For details, see the Quick Builder help.
PAGE 514
plscpcg.book Page 496 Monday, May 28, 2001 10:11 AM 21 – Command Reference Notes • To run bckbld, the database must be loaded, but the server software can be running or not running. • Quick Builder cannot upload a file created with the -ns option because it has history, trend, and group point build lines at the bottom of the file. Quick Builder requires all point build lines related to a point to be grouped together. If you want to upload the file, do not specify an option, or specify the -gp option.
PAGE 515
plscpcg.book Page 497 Monday, May 28, 2001 10:11 AM Configuration Commands dspbld Description dspbld starts Display Builder and opens a display or exports a display (system or custom). For details, see the Display Building Guide.
PAGE 516
plscpcg.book Page 498 Monday, May 28, 2001 10:11 AM 21 – Command Reference hdwbckbld Description hdwbckbld is used to create a hardware definition file that reflects the current hardware configuration details in the server database. It is used, for example, when you have made changes to hardware and hardware connections via Station, rather than via Quick Builder or hdwbld. After creating a hardware definition file, you can upload it into a Quick Builder project. For details, see the Quick Builder help.
PAGE 517
plscpcg.book Page 499 Monday, May 28, 2001 10:11 AM Configuration Commands hdwbld Description hdwbld defines hardware and hardware connections in your system. For most configuration tasks, the preferred engineering tool is Quick Builder, which generates the hdwbld input file and runs the utility. For details about hdwbld, refer to the Hardware and Point Build Reference. Notes • To run hdwbld, the database must be loaded, but the server software can be running or not running.
PAGE 518
plscpcg.book Page 500 Monday, May 28, 2001 10:11 AM 21 – Command Reference paswrd Description paswrd is used to change the passwords for Station security levels if you use Station-based security. For details, see “Configuring Station-Based Security” on page 214. Notes • To run paswrd, the database must be loaded, but the server software can be running or not running.
PAGE 519
plscpcg.book Page 501 Monday, May 28, 2001 10:11 AM Configuration Commands pntbld Description pntbld is used to define points for the system. Notes • You should use Quick Builder in preference to pntbld to define points. • For details of creating or updating point definition files and running pntbld, see the Hardware and Point Build Reference. • To run pntbld, the database must be loaded, but the server software can be running or not running.
PAGE 520
plscpcg.book Page 502 Monday, May 28, 2001 10:11 AM 21 – Command Reference qckbld Description qckbld starts Quick Builder and, if specified, opens a project. Syntax qckbld [filename] Part Description filename The project file that is opened. Notes • The folder in which Quick Builder is located must be specified. If you want to run the utility from the Command prompt, you must first change to the Quick Builder folder before running the command.
PAGE 521
plscpcg.book Page 503 Monday, May 28, 2001 10:11 AM Configuration Commands rtusum Description rtusum lists all points assigned to a particular controller. Control information for each point is also displayed. Syntax rtusum controller_number [-v] Part Description controller_number The number of the controller. -v Shows the bit, width, format and imgsiz. Notes • To run rtusum, the database must be loaded, but the server software can be running or not running.
PAGE 522
plscpcg.book Page 504 Monday, May 28, 2001 10:11 AM 21 – Command Reference station Description station starts Station. Syntax station [setupfile] [-s[f][x][s][c]][-z[1|2|3]] [-t tracefile] Part Description setupfile The default Station setup file. If no file is specified, default.stn is used. -sf Disables window resizing so that Station can only operate in full screen mode. -sx Disables the Exit menu item. -ss Disables the Setup menu item. -sc Disables the Connect menu item.
PAGE 523
plscpcg.book Page 505 Monday, May 28, 2001 10:11 AM Configuration Commands PlantScape Control Panel PlantScape Control Panel is used to update the server registry settings for: • The path for displays (so that the server can get data from displays into the run-time database) • The default path for history archives • The font used in reports To run the PlantScape Control Panel: 1 From the Start menu, select Programs ⇒ PlantScape Server ⇒ PlantScape Server Control Panel.
PAGE 524
plscpcg.book Page 506 Monday, May 28, 2001 10:11 AM 21 – Command Reference Controller Configuration Commands The following commands and utilities can be used for various controller configuration purposes: • config • tdc_cl For information about controller-specific utilities, including test utilities, see the associated Controller Reference. These references are available from Quick Builder’s Help menu.
PAGE 525
plscpcg.book Page 507 Monday, May 28, 2001 10:11 AM Controller Configuration Commands config Description config is used with TDC and UDC controllers. It enables the server’s configuration image for controllers and channels to be saved and restored to files.
PAGE 526
plscpcg.book Page 508 Monday, May 28, 2001 10:11 AM 21 – Command Reference tdc_cl Description tdc_cl is used to compile CL programs ready for loading into an MC/AMC. (TDC 3000 Multifunction & Advanced Multifunction Controllers (MC/AMCs) can be programmed using CL to execute user-defined control strategies or custom functions.) Syntax tdc_cl file [-d][-x] Part 508 Description file The name of the CL source file (with a .cl extension). -d Compiles source lines beginning with %DEBUG.
PAGE 527
plscpcg.book Page 509 Monday, May 28, 2001 10:11 AM Diagnostic Commands Diagnostic Commands The • • • • • • following commands and utilities can be used for server diagnostics: dcheck display lisscn listag tail trace For controller diagnostics, see to the associated Controller Reference. These references are available from Quick Builder’s Help menu.
PAGE 528
plscpcg.book Page 510 Monday, May 28, 2001 10:11 AM 21 – Command Reference dcheck Description dcheck is a database index integrity checker. You may need to use this utility if you experience problems with Event Archiving files after a power failure or some other unexpected event which prevents data from being logged properly.
PAGE 529
plscpcg.book Page 511 Monday, May 28, 2001 10:11 AM Diagnostic Commands display display is used to display text for server error codes. Syntax display error_code Part Description error_code The number of the server error code for which you want more information. If the error code is hexadecimal, prefix it with 0x. Notes • To run this command, the database must be loaded, but the server software does not need to be running. Example This example displays the description for hexadecimal error code 0106.
PAGE 530
plscpcg.book Page 512 Monday, May 28, 2001 10:11 AM 21 – Command Reference lisscn Description lisscn lists the following configuration details: • The scan packets in each scan interval (or period) • The number of scan packets per interval • The scan packets per interval per second Syntax lisscn [options] Part Description -ALL Lists all scan packets (default). -OUT file_name The file to which the results are written. The default is to display the output on the screen.
PAGE 531
plscpcg.book Page 513 Monday, May 28, 2001 10:11 AM Diagnostic Commands listag Description listag lists the points currently configured in the database. Syntax listag [options] Part Description -OUT file_name The file to which the results are written. The default is to display the output on the screen. -ALL Lists all point types (default). -FM n Specifies the first point number in the list. -ND n Specifies the width of the point description column. The default is 30 characters.
PAGE 532
plscpcg.book Page 514 Monday, May 28, 2001 10:11 AM 21 – Command Reference tail Description tail displays the last few lines of the server log file. Syntax tail [-f] file Part Description -f Runs tail indefinitely. When you use the -f option: • Any new lines are appended to the file. • You can stop the utility by pressing +. file The name of the server log file, for example, \server\data\log.txt. Notes • The most recent messages are stored in a file whose default name is log.txt.
PAGE 533
plscpcg.book Page 515 Monday, May 28, 2001 10:11 AM Diagnostic Commands trace Description trace is used to record communications activity for Stations and channels. Syntax trace [lrn1 [-Llrn2] [-Mmem_size]] Part Description lrn1 First LRN that is traced. lrn2 Second LRN that is traced. mem_size The amount of tract is captured, in Kb (default 30Kb). Notes • To start a trace, the database must be loaded and the server must be running. • To stop a trace, enter trace 0.
PAGE 534
plscpcg.
PAGE 535
plscpcg.book Page 517 Monday, May 28, 2001 10:11 AM Administration Commands hscserver /start Description hscserver /start starts PlantScape. For more information, see the Administration and Startup Guide.
PAGE 536
plscpcg.book Page 518 Monday, May 28, 2001 10:11 AM 21 – Command Reference hscserver /stop Description hscserver /stop stops PlantScape. For more information, see the Administration and Startup Guide.
PAGE 537
plscpcg.book Page 519 Monday, May 28, 2001 10:11 AM Administration Commands dspclr Description dspclr: • Removes displays from the Display Summary • Clears specified displays Syntax dspclr [first_display] [first_display] [-y] Part Description first_display The number of the first display that is removed. first_display The number of the last display that is removed. -y Removes the displays without requesting confirmation. Notes • dspclr only applies to numbered displays.
PAGE 538
plscpcg.book Page 520 Monday, May 28, 2001 10:11 AM 21 – Command Reference hisint Description hisint deletes all history and event data from the server database. Syntax hisint [options] Part Description -SILENT Executes without prompting. -PRESERVE Preserves the file’s contents. database Restores history/events from the specified database. -Rnnn PlantScape’s release number. Required if you are restoring history/events. -DIAG Displays diagnostic messages.
PAGE 539
plscpcg.book Page 521 Monday, May 28, 2001 10:11 AM Administration Commands usrlrn Description usrlrn displays logical resource numbers (LRNs) that are used or are available for server tasks. Syntax usrlrn [options] Part Description -a Displays all LRNs. -h Displays usage. -p Displays process IDs as well as LRNs. -u Displays all used LRNs. Notes • To find out which LRNs are available for a new application, enter usrlrn.
PAGE 540
plscpcg.book Page 522 Monday, May 28, 2001 10:11 AM 21 – Command Reference tagflb Description tagflb rebuilds the files that PlantScape uses to store database locations for points. These files are the data file, tagfl.dat, and the index file, tagfl.idx, and are located in \server\data\. (Sometimes the files are jointly called the tag file.) Syntax tagflb Notes • To run tagflb, ensure that: – You have copied tagfl.dat and tagfl.
PAGE 541
plscpcg.book Page 523 Monday, May 28, 2001 10:11 AM Database Initialization Commands Database Initialization Commands These commands and utilities are used to initialize the database: • pntdel • almint Caution Do not run these commands/utilities unless you are absolutely sure that you want to remove the information from your PlantScape database. For other database initialization commands, see the technical notes that come with PlantScape.
PAGE 542
plscpcg.book Page 524 Monday, May 28, 2001 10:11 AM 21 – Command Reference pntdel Description pntdel deletes all channel, controller, and point configuration from the server database. Caution If you delete the configuration data, it cannot be recovered without rebuilding the data from scratch. History data will also be lost.
PAGE 543
plscpcg.book Page 525 Monday, May 28, 2001 10:11 AM Database Initialization Commands almint Description almint initializes the Alarm Summary queue. Caution Running almint will delete the contents of the alarm summary queue from the PlantScape database. It does not, however, remove the alarms from the event file. Syntax almint [-point] [-nopoint] [-force] Part Description -point Clears the alarm state of all points. -nopoint Does not clear the alarm state of points.
PAGE 544
plscpcg.book Page 526 Monday, May 28, 2001 10:11 AM 21 – Command Reference Application Development Commands The following commands and utilities are primarily used for application development purposes.
PAGE 545
plscpcg.book Page 527 Monday, May 28, 2001 10:11 AM Application Development Commands fildmp Description fildmp is used for dumping, restoring, or comparing the contents of server logical files with standard text files. See “utbconv” on page 489 for an example of the use of fildmp for backing up user files. For more details about fildmp, see the Application Development Guide.
PAGE 546
plscpcg.book Page 528 Monday, May 28, 2001 10:11 AM 21 – Command Reference fileio Description fileio is an interactive utility that is used for modifying the contents of individual fields in a logical file. For more details about fileio, see the Application Development Guide.
PAGE 547
plscpcg.book Page 529 Monday, May 28, 2001 10:11 AM Application Development Commands taglog Description taglog lists information associated with the specified points in the server database. It is used to find out if a point exists and to determine its internal point number. For more details about taglog, see the Application Development Guide.
PAGE 548
plscpcg.
PAGE 549
plscpcg.book Page 531 Monday, May 28, 2001 10:11 AM 22 Troubleshooting Advice This chapter contains advice on handling common errors and problems that you might encounter while carrying out configuration and system administration procedures.
PAGE 550
plscpcg.book Page 532 Monday, May 28, 2001 10:11 AM 22 – Troubleshooting Advice Troubleshooting Station Connections and Station Displays Use the following suggestions to help with Station connection and Station display problems.
PAGE 551
plscpcg.book Page 533 Monday, May 28, 2001 10:11 AM Troubleshooting Station Connections and Station Displays When Station Cannot Find Display Files If Station connects successfully but cannot call up a display, it generally responds with the message: The display file xxx was not found. To resolve this problem you need to: • Check the registry entry for the path for Station displays.
PAGE 552
plscpcg.book Page 534 Monday, May 28, 2001 10:11 AM 22 – Troubleshooting Advice Scanning and Communications Problems If you need to contact Honeywell Technical Support for assistance with a problem, the support engineer might ask you for certain information to help diagnose the problem. This section describes how to gather useful information for troubleshooting by Honeywell.
PAGE 553
plscpcg.book Page 535 Monday, May 28, 2001 10:11 AM Scanning and Communications Problems Finding Out Which Processes Are Running Use Microsoft Windows Task Manager to check which processes are currently running. Gathering Information Using the Diagnostic Capture Tool The Diagnostic Capture Tool allows you to easily save your log file, trace information and other diagnostic information in a single zip file. You can send this file to technical assistance for help with diagnosing problems in your system.
PAGE 554
plscpcg.book Page 536 Monday, May 28, 2001 10:11 AM 22 – Troubleshooting Advice Miscellaneous Tips The following procedures might be useful for troubleshooting or configuration tasks. Monitoring System Status To help determine when your system might need attention, you can monitor your system status from time to time, by following the instructions in “Monitoring the Status of Communications in Your System” on page 111.
PAGE 555
plscpcg.book Page 1 Monday, May 28, 2001 10:11 AM Glossary accumulator point A point type used to represent counters. Information contained in the accumulator point can include: the raw value, a process value, a rollover value, a scale factor, and a meter factor. acronym A text string used on a display to represent a state or a value in a form that is convenient for operators.
PAGE 556
plscpcg.book Page 2 Monday, May 28, 2001 10:11 AM Glossary alarm priority One of four levels of severity specified for the alarm. The alarm priorities from least to most severe are: • Journal • Low • High • Urgent algorithm See point algorithm. analog point A point type that is used to represent continuous values that are either real or integer. Continuous values in a process could be: pressure, flow, fill levels, or temperature.
PAGE 557
plscpcg.book Page 3 Monday, May 28, 2001 10:11 AM Glossary client software An umbrella term covering PlantScape, Quick Builder, Station, and Display Builder software. channel The communications port used by the server to connect to as controller. Channels are defined using the Quick Builder tool. CIM Communications Interface Module collection A collection is a set of named values or display objects that are used in scripts.
PAGE 558
plscpcg.book Page 4 Monday, May 28, 2001 10:11 AM Glossary database point Any point that has one or more parameters with database addresses. DCD Data Carry Detect. DCS Digital Control System. DDE Dynamic Data Exchange. default The value that an application automatically selects if the user does not explicitly select another value. deleted item In Quick Builder, an item that has been flagged for deletion from the server database and appears in the Recycle Bin grouping.
PAGE 559
plscpcg.book Page 5 Monday, May 28, 2001 10:11 AM Glossary Distributed Server Architecture An option that enables multiple PlantScape servers to share point data, alarms, and history without the need for duplicate configuration on any server. This is the preferred method for transferring data between servers in large systems. DNS Domain Name System. DSR Data Signal Ready. DTE Data Terminal Equipment. DTR Data Terminal Ready. dual-bit status point A status point that reads two bits.
PAGE 560
plscpcg.book Page 6 Monday, May 28, 2001 10:11 AM Glossary export In relation to Station displays, the process of registering a display with the server so that it can be called up in Station. In relation to Quick Builder, the process of converting the configuration data in a project file into text files for use with other applications. Extended Event Archiving Every event, such as point status change or an operator action, is stored in an event journal.
PAGE 561
plscpcg.book Page 7 Monday, May 28, 2001 10:11 AM Glossary history gate A status point parameter that is used to control the collection of history for an analog or status point. The history is only collected if the gate state value of the nominated parameter is in the nominated state. host server In a distributed server architecture, the server on which a remote point’s definition is stored and from which alarms for the point originate. HTTP Hypertext Transfer Protocol.
PAGE 562
plscpcg.book Page 8 Monday, May 28, 2001 10:11 AM Glossary item list In Quick Builder, a listing of the items defined in the project file that displays in every Project View. The item list can be used to find an item and then display its properties. item number Item numbers are used in the server database to identify items. In Quick Builder, the number is assigned to an item internally.
PAGE 563
plscpcg.book Page 9 Monday, May 28, 2001 10:11 AM Glossary ODBC See Open Database Connectivity. ODBC driver A driver that processes ODBC (Open Database Connectivity) calls, queries the database, and returns the results. See also Open Database Connectivity. OP PlantScape abbreviation for output. Open Database Connectivity A standard set of function calls for accessing data in a database. These calls include the facility to make SQL (Structured Query Language) queries on the database.
PAGE 564
plscpcg.book Page 10 Monday, May 28, 2001 10:11 AM Glossary The main point parameters are process variable (PV), output (OP), set point (SP), and mode (MD). PlantScape can store and manage multiple values in the one point. You can therefore use a single point to monitor and control a complete loop.
PAGE 565
plscpcg.book Page 11 Monday, May 28, 2001 10:11 AM Glossary There are two types of point algorithms, PV (processed every time the point parameter is scanned) and Action (processed only when a point parameter value changes). Point Detail display A display that shows the current point information. Each point has a Point Detail display. Process software An umbrella term for Control Builder and other process software. process variable An actual value in a process: a temperature, flow, pressure, and so on.
PAGE 566
plscpcg.book Page 12 Monday, May 28, 2001 10:11 AM Glossary PV period An amount of time specified for the scanning of the point process value (PV) parameter. The PV period determines the frequency with which the scan will be performed by the server. The server groups point addresses into scan packets by PV period and controller. Quick Builder Quick Builder is a graphical tool that is used to define the hardware items and some point types in a PlantScape system.
PAGE 567
plscpcg.book Page 13 Monday, May 28, 2001 10:11 AM Glossary RTU See controller. S9000 Series 9000 controller. SafeBrowse object A SafeBrowse object is a Web browser specifically designed for use with Station. SafeBrowse includes appropriate security features that prevent users from displaying unauthorized Web pages or other documents in Station. scan The technique used to read data from a controller. Scans are conducted for point parameters with source addresses (for example, PV, SP, OP, MD, An).
PAGE 568
plscpcg.book Page 14 Monday, May 28, 2001 10:11 AM Glossary Server software An umbrella term used to refer to the database software and server utilities installed on the PlantScape server computer. server Station A computer running both the PlantScape database (server) software and the Station software. setpoint The desired value of a process variable. Setpoint is a point parameter, whose value may be entered by the operator. The setpoint can be changed any number of times during a single process.
PAGE 569
plscpcg.book Page 15 Monday, May 28, 2001 10:11 AM Glossary • 1-hour averages • 8-hour averages • 24-hour averages Station The main operator interface to PlantScape. Station can run on either a remote computer through a serial or LAN link, or the server computer. When Station is running on the server computer, it is often referred to as a server Station. When it is running on a machine other than the server, it is often referred to as an operator Station.
PAGE 570
plscpcg.book Page 16 Monday, May 28, 2001 10:11 AM Glossary timer A timer is a programming mechanism for running scripts at regular intervals in Station. Trend Set A set of point parameter historical data, usually shown as a graph on a standard Station display. Trend sets can be defined using Quick Builder or a Station display. UDC Universal Digital Controller.
PAGE 571
plscpcg.
PAGE 572
plscpcg.
PAGE 573
plscpcg.
PAGE 574
plscpcg.
PAGE 575
plscpcg.
PAGE 576
plscpcg.
PAGE 577
plscpcg.
PAGE 578
plscpcg.
PAGE 579
plscpcg.
PAGE 580
plscpcg.
PAGE 581
plscpcg.
PAGE 582
plscpcg.
PAGE 583
plscpcg.
PAGE 584
plscpcg.