experion mx r600 display builiders guide

Experion MX Display Builder

Users Guide 6510020317 Rev 02

Experion MX Display Builder Users Guide

October, 2011

Confidentiality Statement

This manual is a product of Honeywell. It is intended for use only by Honeywell and customer personnel in connection with Honeywell products. It is strictly prohibited to copy this manual or any part thereof or to transfer this manual or any part thereof to any non-Honeywell person or entity, except customer personnel for use in connection with Honeywell products. Persons employed by a third-party service company shall not have access to this manual.

Notice

All information and specifications contained in this manual have been carefully researched and prepared according to the best efforts of Honeywell, and are believed to be true and correct as of the time of this printing. However, due to continued efforts in product improvement, we reserve the right to make changes at any time without notice.

Trademarks

All trademarks and registered trademarks are the properties of their respective holders.

Copyright

© 2011 Honeywell

All rights reserved. No part of this publication may be reproduced or translated, stored in a database or retrieval system, or transmitted in any form or by any means, electronic, mechanical, photocopying, recording, or otherwise, without the prior written permission of Honeywell.

P/N 6510020317 Rev 02 10/27/11 i

Contents

Introduction ............................................................................................................................................. vii Audience ............................................................................................................................................... vii About This Manual ............................................................................................................................... vii Related Reading ................................................................................................................................... viii Conventions ........................................................................................................................................... ix

1. Getting Started .................................................................................................................................. 1-1

1.1. Overview ................................................................................................................................... 1-1

1.2. Starting HMIWeb Display Builder ........................................................................................... 1-1 1.2.1. Page Layout................................................................................................................... 1-2

1.3. QCS HMI Components in RAE600 .......................................................................................... 1-3 1.3.1. QCS Displays ................................................................................................................ 1-3 1.3.2. QCS Popups .................................................................................................................. 1-3 1.3.3. QCS Shapes ................................................................................................................... 1-3 1.3.4. QCS Objects .................................................................................................................. 1-3 1.3.5. QCS Style Sheet ............................................................................................................ 1-4

2. Creating a Simple QCS Display ....................................................................................................... 2-1

3. QCS Shapes ........................................................................................................................................ 3-1

3.1. QcsTrend Shape ........................................................................................................................ 3-1

4. QCS Popups ....................................................................................................................................... 4-1

4.1. QcsPopupDropDownList .......................................................................................................... 4-1

5. QCS Services ...................................................................................................................................... 5-1

5.1. QcsSupport Library ................................................................................................................... 5-1 5.1.1. Reading Data from the QCS Server .............................................................................. 5-1

5.1.1.1. Reading QCS data periodically ................................................................................ 5-3 5.1.2. Writing Data to the QCS Server ................................................................................... 5-3

Experion MX Display Builder Users Guide Contents

10/27/11 P/N 6510020317 Rev 02 ii

5.1.3. LaunchLabViewPopup Method .................................................................................... 5-4 5.1.4. NumDigitsOfPrecisionCalc Method ............................................................................. 5-5

5.2. QcsPersistance .......................................................................................................................... 5-6 5.2.1. QcsPersistance object ................................................................................................... 5-6

5.2.1.1. Saving Persistent Data ............................................................................................. 5-6 5.2.1.2. Retrieving Persistence value .................................................................................... 5-7 5.2.1.3. Disposing the Persistence object .............................................................................. 5-7

5.3. QcsLocalization ........................................................................................................................ 5-8 5.3.1. Translating Text Strings ............................................................................................... 5-8

6. QCS Generic Controls ...................................................................................................................... 6-1

6.1. QcsTable ................................................................................................................................... 6-1

6.2. QcsListBox control ................................................................................................................... 6-4

6.3. QcsNumericUpDown ................................................................................................................ 6-7

6.4. QcsSlider ................................................................................................................................... 6-8

6.5. QcsPolarPlot ........................................................................................................................... 6-11 6.5.1.1. Example 1 .............................................................................................................. 6-11 6.5.1.2. Example 2 .............................................................................................................. 6-13

6.6. QcsTreeView control .............................................................................................................. 6-15

6.7. QcsCheckedListBox ............................................................................................................... 6-17

7. QCS Specific Objects ........................................................................................................................ 7-1

7.1. QcsTrend control ...................................................................................................................... 7-1

7.2. QcsMeasurementProfile control ............................................................................................... 7-3

7.3. QcsFixedPointProfile ................................................................................................................ 7-5

7.4. QcsSummaryTable .................................................................................................................... 7-7

7.5. QcsTMMSRoundnessProfile .................................................................................................... 7-8

7.6. QcsTMMSHistoryTrend ......................................................................................................... 7-10

8. Experion Objects ............................................................................................................................... 8-1

8.1. Alphanumeric Control .............................................................................................................. 8-1

8.2. Textbox Control ........................................................................................................................ 8-2

8.3. Checkbox Control ..................................................................................................................... 8-2

8.4. Pushbutton Control ................................................................................................................... 8-2

8.5. Combobox Control ................................................................................................................... 8-3

8.6. ArrayItems ................................................................................................................................ 8-5

9. Troubleshooting ................................................................................................................................ 9-1

9.1. Error Logging ........................................................................................................................... 9-1 9.1.1. Experion HMIWeb log ................................................................................................. 9-1 9.1.2. Windows Event Log ..................................................................................................... 9-2

Experion MX Display Builder Contents

P/N 6510020317 Rev 02 10/27/11 iii

9.1.3. ELMO Logging System ................................................................................................ 9-4 9.1.4. Debugging Runtime Script Errors ................................................................................ 9-6

10. Technical Reference Information .............................................................................................. 10-1

10.1. Style Sheets ....................................................................................................................... 10-1 10.1.1. Using a Style sheet ...................................................................................................... 10-1 10.1.2. Structure of a Style ...................................................................................................... 10-2 10.1.3. Qcs Controls and their Styles ...................................................................................... 10-3

10.2. QCS Shapes ....................................................................................................................... 10-6 10.2.1. Measurement Profile (layout 1) .................................................................................. 10-7 10.2.2. Measurement Profile (layout 2) .................................................................................. 10-8 10.2.3. MIS Profile .................................................................................................................. 10-8 10.2.4. High Resolution Measurement Profile ........................................................................ 10-9 10.2.5. Trend (layout 1) ........................................................................................................ 10-11 10.2.6. Trend (layout 2) ........................................................................................................ 10-11 10.2.7. Scanner Animation .................................................................................................... 10-12 10.2.8. Indicator .................................................................................................................... 10-14 10.2.9. ColorCoordinateSlider .............................................................................................. 10-15 10.2.10. QcsTMMSCrepeBladeMeasurement ........................................................................ 10-17 10.2.11. QcsTMMSHistoryTrend ........................................................................................... 10-18 10.2.12. QcsControlLine ......................................................................................................... 10-19 10.2.13. QcsFixedPoint ........................................................................................................... 10-20 10.2.14. QcsFixedPoint01 ....................................................................................................... 10-21 10.2.1. History Trend ............................................................................................................ 10-21

10.3. QCS Objects .................................................................................................................... 10-22 10.3.1. Measurement Profile ................................................................................................. 10-23 10.3.2. Color Grid ................................................................................................................. 10-28 10.3.3. ArrayChart ................................................................................................................ 10-34 10.3.4. Trend ......................................................................................................................... 10-37 10.3.5. Table.......................................................................................................................... 10-42 10.3.6. SummaryTable .......................................................................................................... 10-60 10.3.7. Listbox ...................................................................................................................... 10-61 10.3.8. Slider ......................................................................................................................... 10-63 10.3.9. NumericUpdown ....................................................................................................... 10-65 10.3.10. TMMSHistoryTrend ................................................................................................. 10-66 10.3.11. QcsTmmsRoundnessProfile ...................................................................................... 10-71 10.3.12. TreeView ................................................................................................................... 10-74 10.3.13. PolarPlot .................................................................................................................... 10-82 10.3.14. QcsCheckedListbox .................................................................................................. 10-87 10.3.15. Fixed Point Profile .................................................................................................... 10-89

10.4. QCS Non-Display Objects .............................................................................................. 10-98 10.4.1. Support Libraries ...................................................................................................... 10-98

10.4.1.1. QcsSupportLibrary shape ................................................................................... 10-98 10.4.2. QCS System ............................................................................................................ 10-104

Experion MX Display Builder Users Guide Contents

10/27/11 P/N 6510020317 Rev 02 iv

10.4.2.1. Data Access ...................................................................................................... 10-106 10.4.3. Translator class ....................................................................................................... 10-107 10.4.4. Persistence class ...................................................................................................... 10-108 10.4.5. Settings class ........................................................................................................... 10-109 10.4.6. Scripting Support class ........................................................................................... 10-111

List of Figures Figure 1-1 HMIWeb Display Builder Layout ......................................................................................... 1-2Figure 4-1 QcsPopDropDownList Popup ................................................................................................ 4-3Figure 5-1Production data setup .............................................................................................................. 5-4Figure 6-1QcsTable ................................................................................................................................. 6-4Figure 6-2 QcsListbox ............................................................................................................................. 6-7Figure 6-3 QcsNumericUpDown ............................................................................................................. 6-8Figure 6-4QcsSlider ............................................................................................................................... 6-10Figure 6-5 QcsPolarPlot ........................................................................................................................ 6-12Figure 6-6 QcsPolarPlot- Example 2 ..................................................................................................... 6-14Figure 6-7 QcsTreeView ....................................................................................................................... 6-17Figure 6-8 QcsCheckedListBox ............................................................................................................ 6-18Figure 7-1 QcsTrend ................................................................................................................................ 7-3Figure 7-2 QcsMeasurementProfile ......................................................................................................... 7-5Figure 7-3 QcsFixedPointProfile ............................................................................................................. 7-7Figure 7-4 QcsSummaryTable ................................................................................................................. 7-8Figure 7-5 QcsTMMSRoundnessProfile ............................................................................................... 7-10Figure 7-6 QcsTMMSHistoryTrend ...................................................................................................... 7-12Figure 10-1 Measurement Profile (Layout 1) ........................................................................................ 10-7Figure 10-2 Measurement Profile (Layout 2) ........................................................................................ 10-8Figure 10-3 High Resolution Profiles .................................................................................................. 10-10Figure 10-4Trend (Layout 1) ............................................................................................................... 10-11Figure 10-5 Trend (Layout 2) .............................................................................................................. 10-11Figure 10-6 Scanner Animation ........................................................................................................... 10-12Figure 10-7 Indicator ........................................................................................................................... 10-14Figure 10-8 Color Coordinate Slider ................................................................................................... 10-16Figure 10-9 TMMSCrepeBlade Measurement .................................................................................... 10-17Figure 10-10 TMMSHistory Trend ..................................................................................................... 10-18Figure 10-11 QcsFixedPoint ................................................................................................................ 10-20Figure 10-12 QcsFixedPoint01 ............................................................................................................ 10-21Figure 10-4 QCS History Trend .......................................................................................................... 10-22Figure 10-13 Measurement Profile ...................................................................................................... 10-23Figure 10-14ArrayChart ...................................................................................................................... 10-34Figure 10-15Trend ............................................................................................................................... 10-37Figure 10-16 Table .............................................................................................................................. 10-42Figure 10-17 Summary Table .............................................................................................................. 10-60

Experion MX Display Builder Contents

P/N 6510020317 Rev 02 10/27/11 v

Figure 10-18 Listbox ............................................................................................................................ 10-62Figure 10-19 Slider .............................................................................................................................. 10-63Figure 10-20 NumericUpdown ............................................................................................................ 10-65Figure 10-21 QCSTMMSHistoryTrend Control in Event info Mode ................................................. 10-67Figure 10-22 QCSTMMSRoundnessProfile ........................................................................................ 10-72Figure 10-23 TreeView Control ........................................................................................................... 10-74

P/N 6510020317 Rev 02 10/27/11 vii

Introduction

This guide explains how to create and modify QCS displays using the Experion HMIWeb Display Builder (HDB). With the R600 release of the QCS software, many of the standard QCS displays are ported from LabVIEW to HMIWeb, and users can now use the HDB to modify these QCS displays and create new displays.

This manual also describes how to use the QCS Shapes and Objects which are included with each QCS system.

Audience This manual is intended for use by Honeywell personnel and customers. It is assumed that the reader is familiar with the QCS system (using the RAE platform) and the Experion HMIWeb Display Builder. It is also assumed that the reader has some knowledge of VB scripting.

About This Manual This manual contains 10 chapters.

Chapter 1, Getting Started, provides an overview on how to use the HMI Web Display Builder to customize the existing QCS displays or create new displays which access QCS data.

Chapter 2, Creating a Simple QCS Display, provides instructions on creating a basic display which shows QCS data.

Experion MX Display Builder Users Guide Introduction

10/27/11 P/N: 6510020317 Rev 02 viii

Chapter 3, Using QCS Shapes, provides instructions on creating displays using QCS Shapes.

Chapter 4, Using QCS Popups provides instructions on creating displays using QCS Popups.

Chapter 5, Using the QCS Services, provides instructions on creating displays using the QCS HMI Services.

Chapter 6, Using QCS Generic Controls provides instructions on creating displays using QCS Generic Controls.

Chapter 7, Using QCS Specific Objects, provides instructions on creating displays using QCS Specific Objects.

Chapter 8, Using Experion Objects, provides instructions on creating displays using Experion objects which access QCS data.

Chapter 9, Troubleshooting, provides information on how solve run-time display problems

Chapter 10, Technical Reference Information, provides information on the properties, methods and events that are used for each QCS Shape and Object.

Related Reading The following documents contain related reading material.

Honeywell P/N Document Title / Description

EP-DSX166 Experion HMIWeb Display Building Guide 6510020334 Real-Time Application Environment (RAE) R600 for Experion PKS

R400.1 Release and Installation Notes Rev 02

Introduction Conventions

P/N 6510020317 Rev 02 10/27/11 ix

Conventions The following conventions are used in this manual:

i

NOTE: Text may appear in uppercase or lowercase except as specified in these conventions.

User Command Characters in this style indicate text that you type.

System Response Characters in this style indicate system prompts, responses, messages, or characters that appear on displays, keypads, or as menu selections.

Filename Characters in this style indicate filenames or directories that can vary; for example, filename.txt represents any text file document. In text, words shown in italics are manual titles or key terms.

Buttons and Menus

Characters in this style indicate literal button or menu names, or labels on user interface objects such as text fields or drop-down boxes.

lowercase Used in an error message. In a command line, words in lowercase indicate variable input.

Enter Enter means to add text using a keypad or keyboard.

Press Press means to press a key or a button.

[ENTER] or [RETURN]

[ENTER] is the key you press to enter characters or commands into the system, or to accept a default option. In a command line, square brackets are included; for example: SXDEF 1 [ENTER]

[CTRL] [CTRL] is the key you press simultaneously with another key. This key may be labeled differently on different systems; for example, [CONTROL], or [CTL].

[KEY-1]-KEY-2 Connected keys indicate that you must press the keys simultaneously; for example, [CTRL]-C.

Click Click means to position the mouse pointer on an item, then quickly press and release the mouse button.

Experion MX Display Builder Users Guide Introduction

10/27/11 P/N: 6510020317 Rev 02 x

Double-click Double-click means to position the mouse pointer on an item, and then click the item twice in rapid succession.

Drag X Drag X means to position the mouse pointer on an item, press the mouse button and hold it down, and while keeping the button down, move the mouse pointer.

Press X Press X means to position the mouse pointer on an item, then press the mouse button and hold it down.

i

The information icon appears beside a note box containing information that is important.

!

The caution icon appears beside a note box containing information that cautions you about potential equipment or material damage.

The warning icon appears beside a note box containing information that warns you about potential bodily harm or catastrophic equipment damage.

P/N 6510020317 Rev 02 10/27/11 1-1

1. Getting Started

1.1. Overview The HMIWeb Display Builder (HDB) is a specialized tool which allows users to create and modify displays which are viewed using the Experion Station.

This manual explains on how to use the HDB to customize the existing QCS displays or create new displays, which access the QCS data.

1.2. Starting HMIWeb Display Builder You can launch the HMIWeb Display Builder either on a Server or on an Operator Station.

To start HMIWeb Display Builder on a server:

• From the Start menu, choose:

Start > All Programs > Honeywell Experion PKS > Server > HMIWeb Display Builder.

To start HMIWeb Display Builder on an operator station:

• From the Start menu, choose:

Start > Programs > Experion PKSClient> Software > HMIWeb Display Builder.

Experion MX Display Builder Users Guide Getting Started

10/27/11 P/N: 6510020317 Rev 02 1-2

1.2.1. Page Layout Figure 1-1 Shows the typical layout for the HMIWeb display Builder application with the QCS Controls.

Figure 1-1 HMIWeb Display Builder Layout

i

NOTE: For more information on the HMIweb Display Builder Toolbars, Properties Window, and Shape Gallery, see the HMIWeb Display Building Guide p/n EP-DSX166

Getting Started QCS HMI Components in RAE600

P/N 6510020317 Rev 02 10/27/11 1-3

1.3. QCS HMI Components in RAE600

1.3.1. QCS Displays There are around 50 new HMIWeb-based QCS displays that are included in RAE R600. These standard QCS displays replace displays that were written in LabVIEW and VB. You can use the QCS displays as delivered with the system, or customize them using the HDB. The displays are installed on the QCS Server and on each Operator Station. The default folder location for the QCS displays is:

C:\Program Files\Honeywell\Experion PKS\RAE\Displays\

1.3.2. QCS Popups The RAE R600 software includes a large number of HMIWeb-based popups. QCS popups are windows which can be opened from the Station toolbar or from buttons and hyperlinks on HMIWeb displays. These popups can be customized using the HDB. The popup files are installed on all nodes and in the same folder as the QCS displays. By convention, all QCS popup files start with the prefix QCSPopup.

1.3.3. QCS Shapes There are around 20 QCS Shapes included in the RAE600 software. A shape is a reusable display template which is created and used by the HDB. Many of these QCS Shapes include the ability to access and display QCS data. You can customize the QCS shapes using the HDB. The default folder location for the QCS Shape files is:

C:\Program Files\Honeywell\Experion PKS\RAE\Displays\Shapes

1.3.4. QCS Objects The QCS Objects are similar to QCS Shapes. QCS Objects are reusable objects which can access and display QCS data. QCS Objects are written in C#, and cannot be modified using the HDB. QCS Objects provide greater flexibility than QCS Shapes but typically require more manual script coding. Many QCS Objects

Experion MX Display Builder Users Guide Getting Started

10/27/11 P/N: 6510020317 Rev 02 1-4

appear as small buttons on the HDB Toolbox Toolbar. Additional information on the QCS Objects can be found in section 6 and 7.

1.3.5. QCS Style Sheet Each HMIWeb display specifies one associated Style Sheet. A style sheet contains a set of styles that control the user visible properties of objects, such as color, line thickness, and font type.

Example: A button can be associated with a particular button style which might specify foreground and background colors, font type, font size, border style, etc.

All standard QCS displays, popup, shapes, and objects use a common style sheet called the QCSStyles.css. This file is created when the QCS software is installed and is saved in the following default location:

C:\ProgramData\Honeywell\Experion PKS\Client\Abstract\Styles

One advantage of using a single style sheet is that any changes are automatically applied to all displays which use that style sheet.

P/N 6510020317 Rev 02 10/27/11 2-1

2. Creating a Simple QCS Display

To create a simple QCS Display which has a measurement profile, perform the following steps.

Start the HMIWeb Display Builder application.

1. On the File menu, choose Open.

2. Navigate to the folder:

C:\Program Files\Honeywell\Experion PKS\RAE\Displays

3. Select QcsDisplayTemplate.htm file and click Open.

4. A new window with the QcsDisplayTemplate display is opened.

Experion MX Display Builder Users Guide Creating a Simple QCS Display

10/27/11 P/N: 6510020317 Rev 02 2-2

5. Click on the Insert Shape from File icon in HDB toolbar ( ).

6. Move the pointer to the display area and then click and drag the pointer diagonally to size a rectangular area and insert the shape.

The Insert Shape dialog box appears.

Creating a Simple QCS Display QCS HMI Components in RAE600

P/N 6510020317 Rev 02 10/27/11 2-3

7. Navigate to the folder:

\Program Files\Honeywell\Experion PKS\RAE\Displays\Shapes

8. Select the QcsMeasurementProfile.sha file.

9. Click Open.

10. The QcsMeasurementProfile shape is inserted in the display.

11. Save the display to the Abstract folder using a new display name:

\Program Data\Honeywell\Experion PKS\Client\Abstract

12. Open the Experion Station and click Request Page button from the toolbar or press F5.

13. Enter the name of your new display.

14. The display should open showing the QCS Measurement Profile shape.

The QCS Measurement Profile shape basically places an instance of the Mini Profile popup on your display. This shape can be used without any VB script code. Click on the shape’s Measurement Selection button to select a QCS profile.

i

NOTE: You should always save your display and close the HDB before shutting down RAE. If you shutdown RAE on your computer while the HDB is running, it can close the HDB application, and you may loose any unsaved displays.

Some important notes that apply to all QCS Displays:

• Folder Location: It is important that you use the correct folder to save your new display. This folder must be in Station’s display search path or Station will be unable to find the new display. The default RAE.stn connection properties file includes the Abstract folder in this search path; hence this is a good folder to use for test or site specific displays. If you are creating a large number of displays you may want to create your own folder for custom displays. This custom displays folder must be added to Station’s display search path. For more information on this see the Knowledge Builder topic on Station Connection Properties.

• Display Size: The recommend setting for the display size is 1425 x 880 pixels. This setting is used to provide a common look with the other QCS displays. In run-time, Station normally resizes displays as required while

Experion MX Display Builder Users Guide Creating a Simple QCS Display

10/27/11 P/N: 6510020317 Rev 02 2-4

maintaining this ratio (the ratio between height and width). Station also reduces the font sizes and line thicknesses to keep the display readable. By giving all QCS displays the same initial size, all displays tend to resize the same way, which provides a more common look.

• Style Sheets: Style sheets are discussed later in this manual. For now, let us note that each display can specify only one Style Sheet, and all QCS displays normally use the QCStyles Style Sheet. This style sheet is required for many of the QCS Shapes and Objects.

• QCS Support Library Shape: This QCS Shape provides many useful methods to access QCS data. This shape is not visible on the display in run-time but, is required for all QCS displays.

• QCS Display Template: This display template is a good starting point when creating a new QCS display. The display size is predefined, the QCS style sheet is specified, and QCS Support Library Shape is already added to the display in this template.

i

NOTE: Display developers should normally only use the HDB to modify display files. If the display files are modified with another program (such as notepad.exe) the display may not migrate properly in future releases of the HDB.

P/N 6510020317 Rev 02 10/27/11 3-1

3. QCS Shapes

The display created in chapter 2, demonstrated the use of the QCS Measurement Profile Shape. This chapter will show you how to use another QCS Shape, the QCS Trend Shape.

Section 10.2 provides additional information on all QCS shapes included with this release of Experion MX.

3.1. QcsTrend Shape This example shows you how to use the QcsTrend Shape.

Perform the following steps to add this shape to a new display.

1. Start the HMIWeb Display Builder application.

2. Open the QCSDisplayTemplate found in the folder:

\Program Files\Honeywell\Experion PKS\RAE\Displays

3. Click on the “Insert Shape from File” icon in HDB toolbar ( ).

a. Move the pointer to the display area and then click and drag the pointer to set the desired location and size of the shape.

b. When the Insert Shape dialog box appears. Navigate to:

\Program Files\Honeywell\Experion PKS\RAE\Displays\Shapes

And select the QcsTrend.sha file and click OK.

4. Save the display into the Abstract folder using a new display name.

Experion MX Display Builder Users Guide QCS Shapes

10/27/11 P/N: 6510020317 Rev 02 3-2

5. Open the Station application and navigate to the new display using the Request Page toolbar button or F5.

The QcsTrend Shape behaves just like the QCS mini-trend popup. The shape QcsTrend02 is similar to QcsTrend Shape, but provides a slightly different look.

P/N 6510020317 Rev 02 10/27/11 4-1

4. QCS Popups

This chapter shows you how to use QCS Popups from a display.

4.1. QcsPopupDropDownList This section shows you how to use a typical QCS Popup called the QcsPopupDropDownList. This example shows how to create a Boolean drop-down popup, which takes the input provided by the user, and sends the value to the parent display.


2. Open the QcsDisplayTemplate.

3. Place a pushbutton on the display area.

a. Right-click the pushbutton and then select Properties Page.

b. On the General tab set the name as btnBoolean, and select the style as BtnStyleBold.

4. Right-click on the Pushbutton control and then click Edit Script.

5. Copy and paste the following code in the General section.

'Global Variable

Dim popupCurrentValue

popupValueArray = array ("ON", "OFF")

'Callback function

Experion MX Display Builder Users Guide QCS Popups

10/27/11 P/N: 6510020317 Rev 02 4-2

Sub ChangeSelection(value)

btnBoolean.value = value

popupCurrentValue=value

End Sub

i

NOTE:

Global variable (popupCurrentValue) is used to send the current value to the popup. The global array (popupValueArray) is used to define the items in the drop-down list. The global popupValueHeader may be used to set the label just above the drop-down list.

6. Copy and paste the following code into the onpagecomplete event handler.

btnBoolean.value = "ON"

popupCurrentValue= btnBoolean.value

7. In the Object Selection drop-down list, select the btnBoolean object.

8. Copy and paste the following code into the onclick handler for this button:

OpenDialog "QcsPopupDropDownList", getref("ChangeSelection")

The OpenDialog method is defined in the QcsSupportLibrary.sha file and it is used to open the specified popup. The OpenDialog method requires two parameters as shown in the following table.

Parameter Name Description

dialogName Popup name to open callbackFunc Pointer to the callback

function.

The getref method is used to get a reference (a pointer) to the callback function.

9. Save the display to the abstract folder with a unique name.

10. Open Station and navigate to this display. Then click on the button.

The QcsPopupDropDownList Popup (dialog box) should appear as shown in the following figure.

QCS Popups QcsPopupDropDownList

P/N 6510020317 Rev 02 10/27/11 4-3

Figure 4-1 QcsPopDropDownList Popup

P/N 6510020317 Rev 02 10/27/11 5-1

5. QCS Services

This chapter explains the various QCS Services that are typically used to create QCS displays.

Click on any of the following QCS Services listed, for more information on what these services do, and how these services can be used.

• Using QcsSupport Library

• Using QcsPersistance

• Using QcsLocalization

• Using QCSSettings

5.1. QcsSupport Library This section explains how to use the QCS HMI Services.

5.1.1. Reading Data from the QCS Server The following example shows how to read data from the QCS Server using the methods provided by the Qcs Support Library.


2. Open the QcsDisplayTemplate file.

3. Place two alphanumeric objects on the display.

4. Right-click the first alphanumeric object and select Property Pages.

Experion MX Display Builder Users Guide QCS Services

10/27/11 P/N: 6510020317 Rev 02 5-2

5. Click Data tab.

6. Select None as the Type of database link for each alphanumeric. This will allow script code to control the data value of this object. Apply this same change to the second alphanumeric object.

7. Right-click on one alphanumeric and then click Edit Script.

8. Enter the following script code in the General section.

dim qcsSystem

9. Enter the following script code, in the OnPageComplete event handler.

Set qcsSystem = GetQcsSystem("")

This creates an instance of the QcsSystem object which is provided by the QCS Support Library. The empty string parameter is used to get a connection to the default QCS Server. The default QCS server is normally used unless this is a Multi-Production line configuration.

10. Enter the following in the OnPageComplete subroutine to read the line name and system number from the QCS Server.

Alpha001.value = qcsSystem.DataAccess.GetData("./system/line name")

Alpha002.value = qcsSystem.DataAccess.GetData("./system/system number")

11. Add the following line in the Page_OnUnload event handler to dispose of the QcsSystem Object (since it is not required after the display is closed).

DisposeObject(qcsSystem)

12. Save the display in the Abstract folder with a unique filename

13. Open the Experion Station and navigate to the new display.

QCS Services QcsSupport Library

P/N 6510020317 Rev 02 10/27/11 5-3

14. You should see the Line Name in Alpha001 and the System Number in Alpha002.

5.1.1.1. Reading QCS data periodically

If the QCS data needs to be read periodically while the display is open then you will need to add a timer to the display and read the data on each timeout event. This differs from DCS data which is automatically updated by Station.

1. To add a timer to your display, enter the following script code in the General section.

dim TimerID

Function TimerTimeout()

‘Place data read logic in this function

End function

2. Enter the following script code in the OnPageComplete event handler to create a timer which generates a timeout event every two seconds.

TimerID=window.setInterval ("TimerTimeout()", 2000)

3. When the timer is no longer required, you can stop the timer using the following method call.

Window.clearInterval(TimerID)

5.1.2. Writing Data to the QCS Server In the previous example in section 5.1.1we read a string and an integer from the default QCS Server. The example in this section shows you how to write data to the QCS server.

1. Add a button to the test display from the section 5.1.1.

2. Enter the following script code in the OnClick event handler for that button:

qcsSystem.DataAccess.setData "./system/dummy/double", 123.45

3. Save these display changes.

4. Navigate to the display in Station.


10/27/11 P/N: 6510020317 Rev 02 5-4

5. Open the RAE Browser and read the current value of /system/dummy/double.

6. Click the button and read the value again. The value in the Host DR should now be 123.45.

5.1.3. LaunchLabViewPopup Method You can open a LabVIEW popup from a HMIWeb-based display using the LaunchLabVIEWPopup method, which is provided by the QcsSupportLibrary.

1. Add a button to a display and set its button style to BtnStyleLink.

2. Enter the following script code in the pushbuttons OnClick event handler.

LaunchLabViewPopup ("Production data setup.vi")

3. Save the display to the Abstract folder.

4. Open the Experion Station and navigate to the display.

When you click the button (which appears as a hyperlink), the Production data setup.vi (popup) appears as shown in Figure 5-1. This is the style used for the Setup button on most standard QCS displays.

Figure 5-1 Production data setup

QCS Services QcsSupport Library

P/N 6510020317 Rev 02 10/27/11 5-5

5.1.4. NumDigitsOfPrecisionCalc Method The QcsSupportLibrary provides a method called NumDigitsOfPrecisionCalc. This method can be used to determine the number of decimal places that fits in the available space. This function considers the value to be displayed and the width of the alphanumeric as input. The width of the alphanumeric is provided in digits (which includes the decimal place).

For example, if the input value is 123.4567 and the number of digits available (based on the width of the alphanumeric and font size) was 7, then this function returns 3. This is the number of decimal places, which fit in an alphanumeric.

Following is an example of how to use this method.



3. Drag and drop an alphanumeric on your display.

4. Right-click the object and select Property pages.

5. Click the Data tab, set the Type of database link to None.

6. Right-click alphanumeric and then click Edit Script.

7. Enter the following declaration in the General section.

dim QcsScriptSupport

8. In the OnPageComplete event handler add the following line to create an instance of the QCS Scripting Support Object.

Set QcsScriptSupport = CreateObject("Qcs.ScriptingSupport")

In this same subroutine you can add the following:

Value = 123.4567

DecimalPlaces=QcsScriptSupport.NumDigitsOfPrecisionCalc(value, 7)

MsgBox (DecimalPlaces)

Alpha001.value = FormatNumber(value, DecimalPlaces)

9. Save the display in the Abstract folder


10/27/11 P/N: 6510020317 Rev 02 5-6

10. Open the Experion Station Window.

11. Call the display you have created in Station.

The MsgBox opens with a value of 3 (this is number of decimal places which fit in this case). When you close the message box the value in the alphanumeric is displayed as 123.457. The input value is rounded off to three decimal places.

5.2. QcsPersistance This section shows how to use the QcsPersistance object to write data into a persistent database. Data that is saved in this manner is retained even when there is a power failure and system restarts.

5.2.1. QcsPersistance object 1. Enter the following declaration in the General section of your display’s

script code.

dim qcsPersistence

2. Enter the following line in the OnPageComplete event handler to create an instance of the QcsPersistence object.

Set qcsPersistence = GetQcsPersistence()

5.2.1.1. Saving Persistent Data

The SetPersistence method is used to save data into non-volatile memory.

The call syntax is:

qcsPersistence.SetPersistence ProductLine, ClientID, MonitorID, DisplayID, ControlType, ControlID, UserID, ValueToSave

The following call saves the value 1234 into persistent memory under the following keys:

• ProductLine = PM1

• ClientID = PC2456

• MonitorID = 1

QCS Services QcsPersistance

P/N 6510020317 Rev 02 10/27/11 5-7

• DisplayID = Display1

• ControlType = 1

• ControlID = 1

• UserID = Oper

qcsPersistence.SetPersistence "PM1","PC2456","1","Display1","1","1","Oper", 1234

These keys may be used to define the scope of the persistent data. If the data is applied to all nodes, and on all users on this production line, then you could save the data as:

qcsPersistence.SetPersistence "PM1","1","1","1","1","1","1", 1234

If the present data only applies to one operator station but applies to all users, and all displays, then the following call might be used.

qcsPersistence.SetPersistence "PM1","OpStn12","1","1","1","1","1", 1234

5.2.1.2. Retrieving Persistence value

The GetPersistence method is used to retrieve data from non-volatile memory.

The call syntax is:

qcspersistence.GetPersistence(ProductLine, ClientID, MonitorID, DisplayID, ControlType, ControlID, UserID)

If a match is found for the seven input keys, then the last data saved under these keys is returned.

For example:

x = qcsPersistence.GetPersistence("PM1","PC2456","1","Display1","1","1","Oper")

5.2.1.3. Disposing the Persistence object

The Persistence object must be disposed when the display is closed.

Add the following line to the Page OnUnload event handler to dispose this object.

DisposeObject(qcsPersistence)


10/27/11 P/N: 6510020317 Rev 02 5-8

5.3. QcsLocalization This section explains how you can use the QcsLocalization services to translate short text strings to the selected local language.

5.3.1. Translating Text Strings To use the QCS Localization services you first need to create an instance of the QcsTranslator.

1. Enter the following line to the General section of your displays script code.

dim translator

2. Enter the following in the OnPageComplete event handler.

Set translator = GetQcsTranslator()

You can also add your own Language Change handler with the following call (which is normally added to OnPageComplete event handler)

translator.AddLanguageChangeHandler(getref("LanguageChanged"))

In this method call, LanguageChanged is the subroutine which is called whenever the user changes the selected QCS language on the local computer. This is normally done using the QCS setup and debug popup on the Station toolbar.

3. Enter the following function in the General section code of a test display, to see how this works.

Function LanguageChanged(Language)

txtAve.value = translator.Translate("Average")

txtSpread.value = translator.Translate("Spread")

End function

4. Now add two alphanumeric to your test display and name them txtAve, and txtSpread.

5. Right-click the alphanumeric and select Properties Page.

6. Click Data tab.

7. Select the Type of database link to None.

QCS Services QcsLocalization

P/N 6510020317 Rev 02 10/27/11 5-9

8. Call LanguageChanged from the OnPageComplete event to do the initial translation and assignment of your alphanumerics.

LanguageChanged("")

9. In the page OnUnload handler, enter the following line to dispose of the translator object as the page closes.

DisposeObject(translator)

10. Save the display with a unique name in the Abstract folder

11. Open the Station Window and navigate to the display.

The text “Average” and “Spread” should appear on the page. Open the QCS System Setup and Debug popup from the toolbar and change the language to Finnish. The text strings will be translated into Finnish.

P/N 6510020317 Rev 02 10/27/11 6-1

6. QCS Generic Controls

The QCS Generic Controls are QCS controls in the HDB Toolbar which do not access QCS data directly. These are generic controls which can be used with QCS or DCS data and are listed below:

• Table

• ListBox

• Numeric Up/Down

• Slider

• Polar Plot

• TreeView

• Checked ListBox

6.1. QcsTable The QcsTable control displays data in a tabular format. This control can display data such as numerical values, strings, buttons, checkboxes, status images, and combo boxes. The QcsTable can display data in editable or non-editable cells.

This example shows you how to use a QcsTable control to display simulated Reel production data report in a tabular format.



3. Click on the QcsTable icon ( ) in the Toolbar toolbox and place an instance of this object on the display.

Experion MX Display Builder Users Guide QCS Generic Controls

10/27/11 P/N: 6510020317 Rev 02 6-2

4. Right-click the QcsTable control, and then click Property Pages

5. Click on the General tab.

a. In the Name box, enter the name as QcsTable.

b. In the Style drop-down list, click the .QcsMisReportTableStyle style. Close the QcsTable Properties window.

c. Right-click the QcsTable control in the Object Explorer view and then click Edit Script.

6. Enter the following script code in the General section (note that the order of this sample code is important). Sub InitTableProperties

QcsTable.Editmode = false

QcsTable.ActiveSheet = 0

QcsTable.Borderstyle3D = true

QcsTable.ProtectSheet = true

QcsTable.SetHorizontalScrollBarVisible("AsNeeded")

QcsTable.SetVerticalScrollBarVisible("AsNeeded")

QcsTable.RowCount= 4

QcsTable.ColumnCount = 3

end sub

Sub InitTableRowAndColHeaderSettings

QcsTable.ColumnHeaderVisible = true

QcsTable.SetColumnHeaderHeight 30

QcsTable.RowHeaderVisible = true

QcsTable.SetRowHeaderAlignment "Left"

QcsTable.SetRowHeaderWidth 150

end sub

QCS Generic Controls QcsTable

P/N 6510020317 Rev 02 10/27/11 6-3

Sub UpdateRowAndColHeaderValues

Dim currentRow

Dim currentCol

Dim rowHeaderNames

Dim colHeaderNames

rowHeaderNames = Array("Production","Speed","Length","Sheet Width")

colHeaderNames = Array("Reel","Grade","Standard")

'Update Table's Row header Names

for currentRow = 0 to QcsTable.RowCount-1

call QcsTable.SetRowHeader(currentRow, rowHeaderNames(currentRow))

Next

'Update Table's column Header Names

for currentCol = 0 to QcsTable.ColumnCount-1

QCSTable.SetColumnWidth currentCol, 150)

QcsTable.SetColumnHeader currentCol, colHeaderNames(currentCol)

Next

end sub

Sub UpdateTableCellValues

Dim currentRow

Dim currentCol

Dim rowData1,rowData2,rowData3,rowData4

rowData1 = array("0.0065","0.0152","11112.9")

rowData2 = array("0","0","60")

rowData3 = array("0.1115","0.2620","11124")

rowData4 = array("4000","3999.97","9999.9")

rowHeaderNames = Array("Production","Speed","Length","Sheet Width")

colHeaderNames = Array("Reel","Grade","Standard")

for currentCol = 0 to QcsTable.ColumnCount-1

QcsTable.setCellValue 0,currentCol,rowData1(currentCol)




Next


10/27/11 P/N: 6510020317 Rev 02 6-4

end sub

7. Copy and paste following script code into the OnPageComplete event handler.

InitTableProperties()

InitTableRowAndColHeaderSettings()

UpdateRowAndColHeaderValues()

UpdateTableCellValues()

8. Save and Close the Script Editor dialog box.

9. Save and close the display file.

10. Save the display in the Abstract folder and then open the display in Station

The QcsTable should appear as shown in the Figure 6-1.

Figure 6-1 QcsTable

Note that the QcsTable control does not actually access data from the QCS server. All data shown in this table is assigned using script code

6.2. QcsListBox control This example shows how to use the QcsListBox object.


2. Open a QcsDisplayTemplate.

QCS Generic Controls QcsListBox control

P/N 6510020317 Rev 02 10/27/11 6-5

3. Click the icon on the HDB Toolbar toolbox.

4. Drag the pointer on the Display area to create a QcsListBox control with the desired size and location.

5. Right-click on this QcsListBox and then click Property Pages.

6. Click the General tab.

7. In the Name box, type the name as QcsListBox.

8. In the Style drop-down list, click the .QcsListBoxStyle style.

9. The QcsListBox control is created and displayed under Page in the Object Explorer.

10. Place three Textboxes on the display. Give them the object names and styles as shown in the table below.

Textboxes name Style

lblSelectCode TxtTitle lblSelectedCode TxtTitle txtSelectedCode TxtStyleDottedFontMedium

11. Arrange the QcsListBox and the three Textboxes as shown in the following figure.

12. Right-click the QcsListBox control and then click Edit Script.

13. Enter the following script code in the General section.


10/27/11 P/N: 6510020317 Rev 02 6-6

Sub InitListBoxProperties()

'Sets listbox border to Fixed 3d Style

QcsListbox.ListBorderStyle = 2

'Use single select mode

QcsListbox.SelectionMode = 1

'Show horizontal scrollbar if needed

QcsListbox.HorizontalScrollBar = true

end Sub

Sub UpdateListBoxContent()

Dim codeIDArray

Dim iterator

codeIDArray = array("Code01","Code02","Code03","Code04","Code05","Code06")

'Reset Contents of Listbox

QcsListbox.ResetContent()

'Updating QcsListbox with codeID strings available in codeIDArray

for iterator = 0 to Ubound(codeIDArray)

QcsListbox.AddString(codeIDArray(iterator))

next

End Sub

14. Add the following script code to the ListboxSelectionChanged event hander for the QcsListBix. if QcsListbox.SelectedIndex => 0 then

txtSelectedCode.value = QcsListbox.SelectedValue

End if

15. Add the following script code to the OnPageComplete event handler. InitListBoxProperties

UpdateListBoxContent

16. Save the display and open in Station.

17. Select any of the items in the QcsListBox, and the item should appear in the txtSelectedCode textbox.

The display should appear as shown in Figure 6-2

QCS Generic Controls QcsNumericUpDown

P/N 6510020317 Rev 02 10/27/11 6-7

Figure 6-2 QcsListbox

6.3. QcsNumericUpDown

The QcsNumericUpDown object allows the user to enter a value by either typing the value in the data entry field or by clicking the up and down buttons.

This example shows you how to create a QcsNumericUpDown control.



3. Click on the icon in the HDB Toolbar toolbox.

4. Place an instance of this control n the page.

5. Open the Property Pages on this control. Set the object name to QcsNumericUpDown and the style to QcsNumericUpDownStyle.

6. Create a Textbox control and set the name to txtNumericValue and the style to TxtStyleDottedFontMedium.

7. Arrange these two objects as shown below.

8. Add the following script code to the General section.


10/27/11 P/N: 6510020317 Rev 02 6-8

Sub InitNumericUPDownProperties()

QcsNumericUpDown.ReadOnly = false

QcsNumericUpDown.TextAlign = "RIGHT"

QcsNumericUpDown.UpDownAlign = "RIGHT"

end Sub

Sub UpdateNumericUPDownSettings()

QcsNumericUpDown.Maximum = 9999

QcsNumericUpDown.Minimum = 1000

QcsNumericUpDown.StepIncrement = 2

QcsNumericUpDown.CurrentValue = 2000

End Sub

9. Add the following script code to the ValueChanged event handler for the QcsNumericUpDown control.

txtNumericValue.value = QcsNumericUpDown.CurrentValue

10. Add the following script code to the OnPageComplete event handler.

InitNumericUPDownProperties

UpdateNumericUPDownSettings

11. Save the display and open in Station.

12. Enter a numeric value in the QcsNumericUpDown control or click on the Up and Down buttons to change the value. Note that you cannot enter a value which is less than the specified minimum or greater than the specified maximum.

The QcsNumericUpDown object should appear as shown in Figure 6-3

Figure 6-3 QcsNumericUpDown

6.4. QcsSlider

This example shows you how to create a QCS display using the QcsSlider, to set a value by moving the slider.

QCS Generic Controls QcsSlider

P/N 6510020317 Rev 02 10/27/11 6-9



3. Click on the QcsSlide icon ( ) in the Toolbar toolbox.

a. Place an instance of this object on the display.

b. Right-click QcsSlider control you have created and then click Properties Pages.

4. Click on the General tab.

a. In the Name box, change the name to QcsSlider.

b. In the Style drop-down list, select the .QcsSliderStyle style.

5. Create a Text box control and set its name and style as shown below.

Textboxes name Style

txtSelectedValue .TxtStyleDottedFontMedium

Arrange the QcsSlider and textbox to appear as shown below.

6. Right-click on the QcsSlider control and then click Edit Script. Enter the following script code in the General section.

Sub InitSliderProperties()


10/27/11 P/N: 6510020317 Rev 02 6-10

QcsSlider.VerticalOrientation = true

QcsSlider.LimitLabelsVisible = true

QcsSlider.ScrollButtonsVisible = true

end Sub

Sub UpdateSliderSettings()

QcsSlider.Minimum = 0

QcsSlider.Maximum = 200

QcsSlider.LargeChange = (QcsSlider.Maximum - QcsSlider.Minimum)/2

QcsSlider.SmallChange = (QcsSlider.Maximum - QcsSlider.Minimum)/5

End Sub

7. Enter the following script code in the SliderValueChanged event handler of the QcsSlider object.

txtSelectedValue.value = QcsSlider.currentValue

8. Enter the following script code in the OnPageComplete event handler.

InitSliderProperties

UpdateSliderSettings

txtSelectedValue.value = QcsSlider.Minimum

QcsSlider.currentValue = QcsSlider.Minimum

9. Save the display and then open in Station.

The corresponding QcsSlider should appear as shown in Figure 6-4.

Figure 6-4QcsSlider

QCS Generic Controls QcsPolarPlot

P/N 6510020317 Rev 02 10/27/11 6-11

6.5. QcsPolarPlot

6.5.1.1. Example 1

This example shows you how to use a QcsPolarPlot control to display data.


a. Open the QcsDisplayTemplate.

b. Click on the QcsPloarPlot icon .

c. Drag the pointer on the Display area and position and size the control as desired.

2. Right-click the QcsPolarPlot control and then click Property Pages.


a. Set the object name to QcsPolarPlot.

b. In the Style drop-down list, click QcsPolarplotStyle.

c. Close the QcsPolarPlot Properties dialog box.

4. Right-click the QcsPolarPlot control and then click Edit Script. In the Object Selection dialog box, click Page.

a. Enter the following script code into the OnPageComplete event handler.

Dim angle(6) Dim tmpdata(6)

qcsPolarPlot.AddSeries "nowSeries", "polar", "Now", rgb(0,255,0) angle(0) = 0 angle(1) = 72 angle(2) = 144 angle(3) = 216 angle(4) = 288 angle(5) = 360 tmpangle = angle tmpdata(0) = 5 tmpdata(1) = 10 tmpdata(2) = 15


10/27/11 P/N: 6510020317 Rev 02 6-12

tmpdata(3) = 20 tmpdata(4) = 25 tmpdata(5) = 5 dataArray = tmpdata

qcsPolarPlot.ShowArrayData "nowSeries", tmpangle, dataArray

You must enter the script code in the sequence, as mentioned:

Dim angle(6), declares a local array with 6 elements.

Dim tmpdata(6) declares a local array with 6 elements.

The call to qcsPolarPlot.AddSeries adds a new graph to the QcsPolatPlot called the “nowSeries” and sets the pen color to green. The graph type is set to “polar” and the graph description is set to “Now”.

The call to qcsPolarPlot.ShowArrayData causes the control to show the graph (make is visible). Note that tmpAngle and dataArray are global variables.

5. Save and close the Script Editor Dialog box.

6. Save and close the Display.

7. Open the display in Station.

The corresponding QcsPolarPlot should appear as shown in Figure 6-5.

Figure 6-5 QcsPolarPlot

QCS Generic Controls QcsPolarPlot

P/N 6510020317 Rev 02 10/27/11 6-13

Note that the graph has 6 data points. Two of them, (0, 5) and (360, 5) are at the same location on the chart. This connects the start and end points of the graph.

6.5.1.2. Example 2

This example shows you how to use a QcsPolarPlot control to display two graphs.

1. Place an instance of the QcsPolarPlot control on the display.

2. Use the object’s Property Pages to set the name to QcsPolarPlot. Set the style to QcsPolarPlotStyle.

3. Add the following script code to the OnPageComplete event handler.

Dim angle(6) Dim tmpdata(6)

QcsPolarPlot.AddSeries "SeriesOne", "polar", "One", rgb(0,255,0) QcsPolarPlot.AddSeries "Seriestwo", "polar", "Two", rgb(255,0,0) angle(0) = 0 angle(1) = 72 angle(2) = 144 angle(3) = 216 angle(4) = 288 angle(5) = 360 tmpangle = angle tmpdata(0) = 5 tmpdata(1) = 10 tmpdata(2) = 15 tmpdata(3) = 20 tmpdata(4) = 25 tmpdata(5) = 5 dataArray = tmpdata

qcsPolarPlot.ShowArrayData "SeriesOne", tmpangle, dataArray angle(0) = 0 angle(1) = 72 angle(2) = 144 angle(3) = 216 angle(4) = 288 angle(5) = 360 tmpangle = angle tmpdata(0) = 7 tmpdata(1) = 12 tmpdata(2) = 18 tmpdata(3) = 24 tmpdata(4) = 27


10/27/11 P/N: 6510020317 Rev 02 6-14

tmpdata(5) = 7

dataArray = tmpdata

qcsPolarPlot.ShowArrayData "SeriesTwo", tmpangle, dataArray

4. Save the display and then open in Station. The QcsPolarPlor should appear as shown in Figure 6.6.

Figure 6-6 QcsPolarPlot- Example 2

You can change the style of the data points to a circle with the following call:

qcsPolarPlot.SetPointerStyle "SeriesOne", "circle", true

You can remove the data points and the axis with the following call:

qcsPolarPlot.SetPointerStyle "SeriesOne", "square", false

The following may be used to change the width of the graph lines:

qcsPolarPlot.SetSeriesWidth "SeriesOne", 2

See section 10.3.13 for additional information of the QcsPolarPlot control.

QCS Generic Controls QcsTreeView control

P/N 6510020317 Rev 02 10/27/11 6-15

6.6. QcsTreeView control This example shows you how to use the QcsTreeView control to display data in a hierarchy tree view.



b. Click on the QcsTreeView icon ( ) in the Toolbar toolbox.

c. Place an instance of this control on the display.

2. Right-click the QcsTreeView control and then click Property Pages.


a. Change the object name to QcsTreeView.

b. In the Style drop-down list, click QcsTreeViewStyle.

c. Close the QcsTreeView Properties dialog box.

4. Place six text boxes on the page. Give them the following names: txtNodeName, txtNodeKey, txtLevel, txtIndex, txtFullPath, and txtChildNodeCount.

5. Place two buttons on the page and give them the names btnExpandAll and btnCollapseAll.

6. Enter the following script code ion the OnPageComplete event handler.

dim RootNodeRef dim NodeRef 'Add a root node to the QcsTreeView control set RootNodeRef = QcsTreeView.AddRootNode("RootNodeName","RootNodeKey") 'Add a child node to the root node set NodeRef = rootNodeRef.AddChildNode("NodeName01","NodeKey01") 'Add three child nodes to this node NodeRef.AddChildNode "NodeName11","NodeKey11" NodeRef.AddChildNode "NodeName12","NodeKey12" NodeRef.AddChildNode "NodeName13","NodeKey13" 'Add a second child node to the root set NodeRef = rootNodeRef.AddChildNode("NodeName02","NodeKey02")


10/27/11 P/N: 6510020317 Rev 02 6-16

'Add two child nodes to this node NodeRef.AddChildNode "NodeName21","NodeKey21" NodeRef.AddChildNode "NodeName22","NodeKey22" NodeRef.ToolTipText = "Hi there" 'Add a third child node to the root set NodeRef = rootNodeRef.AddChildNode("NodeName03","NodeKey03") 'Add one child to this node NodeRef.AddChildNode "NodeName31","NodeKey31" 'Add a fourth node to the root set NodeRef = rootNodeRef.AddChildNode("NodeName04","NodeKey04") 'Expand all nodes in the treeview QcsTreeView.ExpandAll 'Get the number of nodes which can be visible txtMaxVisibleCount = QcsTreeView.VisibleCount() 'Select the Root Node QcsTreeView.SelectNodeWithKey "RootNodeKey"

7. Add the following script code to the AfterNodeSelect event handler of the QcsTreeView control.

dim selectedNodeRef

'Get reference of the selected Node set selectedNodeRef = qcsTreeView.SelectedNode 'Get Name of Selected Node txtName = selectedNodeRef.Name 'Get Key of Selected Node txtNodeKey = selectedNodeRef.Text 'Get Level of Selected Node txtLevel = selectedNodeRef.Level 'Get Index of Selected Node txtIndex = selectedNodeRef.Index 'Get FullPath string value of Selected Node txtFullPath = selectedNodeRef.FullPath

8. Add the following to the OnClick event handler for the btnExpandAll Button.

QcsTreeView.ExpandAll

QCS Generic Controls QcsCheckedListBox

P/N 6510020317 Rev 02 10/27/11 6-17

9. Add the following to the OnClick event handler for the btnCollapseAll Button.

QcsTreeView.CollapseAll

10. Save this display and then open in Station.

11. The display should appear as shown below:

Figure 6-7 QcsTreeView

See section 10.3.12 for additional information of the QcsTreeView control.

6.7. QcsCheckedListBox This example shows you how to use the QcsCheckedListBox control to select from a list of options.

1. Start the HMIWeb Display Builder and open the QcsDisplayTemplate.

a. Click on the QcsCheckedLsitBox icon ( ) in the Toolbar toolbox.

b. Place an instance of this control on the display.

2. Right-click on the QcsCheckedListBox control and then click Property Pages.


10/27/11 P/N: 6510020317 Rev 02 6-18

3. On the General tab set the object name to QcsCheckedListBox.

4. In the Style drop-down list, click the Background_StyleRect style.

5. Add a text box to the display and set its name to txtSelectedOptions.

6. Add a button to the display and set its name to btnGetOptions

7. Add the following script code to the page OnPageComplete event handler.

QcsCheckedListBox.AddString "Option 1" QcsCheckedListBox.AddString "Option 2" QcsCheckedListBox.AddString "Option 3" QcsCheckedListBox.AddString "Option 4" txtSelectedOptions = ""

8. Add the following script code to the OnClick event handler for the Get Options button.

Dim CheckedValues

CheckedValues = QcsCheckedListBox.CheckedValues

txtSelectedOptions = "" for i = 0 to ubound(CheckedValues) txtSelectedOptions = txtSelectedOptions & " " & CheckedValues(i) next

9. Save the display and view in Station.

10. This display should appear as shown below.

Figure 6-8 QcsCheckedListBox

P/N 6510020317 Rev 02 10/27/11 7-1

7. QCS Specific Objects

The QCS Specific Objects are used to access QCS data, and display this data on HMIWeb-based displays and popups. The QCS specific controls are listed below:

• Trend

• Measurement Profile

• Fixed Point Profile

• Summary Table

• TMMS Roundness Profile

• TMMS History Trend

7.1. QcsTrend control This example shows you how to use a QcsTrend object.

1. Start the HMIWeb Display Builder application and open the QcsDisplayTemplate.

2. Select the QcsTrend icon in the HDB toolbar ( ) and place an instance of this on the display.

3. Place a text box just above the QcsTrend control and set the name of this text box to txtTrendVar.

4. Right-click on the QcsTrend object and then click on Property Pages.

a. Change the object Name to QcsTrend.

Experion MX Display Builder Users Guide QCS Specific Objects

10/27/11 P/N: 6510020317 Rev 02 7-2

b. In the Style drop-down list, select QcsTrendStyle.

c. Close the QcsTrend Properties dialog box.


QcsTrend.TrendCount = 1

call QcsTrend.Connect()

call QcsTrend.ClearTrendGraph(0)

call QcsTrend.ShowCursor(0)

call QcsTrend.SetPeriod(5)

call QcsTrend.SetTrendVariables(0,"PM 1","trend buffer,1/")

call QcsTrend.SetScaleMode(0, 0, 0, 0, 0)

txtTrendVar.value = QcsTrend.Trend1

Note that:

QcsTrend.TrendCount = 1, specifies just one trend for this graph. The QcsTrend can display up to 4 trends.

QcsTrend.Connect () initializes the control.

QcsTrend.ClearTrendGraph(0), clears the graph, the 0 refers to the first of the four possible trends.

QcsTrend.ShowCursor(0), hides the cursor

QcsTrend.SetPeriod(5), sets the time range to 5 minutes.

QcsTrend.SetTrendVariables(0), “PM 1”, “trend buffer,1/”). The parameter “trend buffer,1/” refers to the record in the Trend buffer table in RTDR. The integer 1 specifies the first row in that table.

QcsTrend.SetScaleMode(0,0,0,0,0), sets the trend to Autoscale mode

txtTrendVar.value = QcsTrend.trend1, gets the trend description from the RTDR and places this in the user visible text box.. Similarly trend2, trend3 and trend4 can be used (when these trends are used).

QCS Specific Objects QcsMeasurementProfile control

P/N 6510020317 Rev 02 10/27/11 7-3

6. Save and close the Script Editor dialog box.

7. Save and close the Display.

8. Open the Display in Station.

The QcsTrend should appear as shown in the Figure 7-1. Note that the scanner must be scanning to collect new trend data.

Figure 7-1 QcsTrend

See section 10.3.4 for additional information on the QcsTrend object.

7.2. QcsMeasurementProfile control This example shows you how to use the QcsMeasurementProfile control to display a measurement profile.

1. Start the HMIWeb Display Builder application and open the QcsDisplayTemplate.

2. Click on the QcsMeasurementProfile control icon in the HDB Toolbar ( ) and place an instance of this on the display.

3. Right-click the QcsMeasurementProfile control and then click Property Pages.


a. Change the object name to QcsMeasurementProfile.

b. In the Style drop-down list, select QcsMeasProfilestyle.


10/27/11 P/N: 6510020317 Rev 02 7-4

c. Close the QcsMeasurementProfile Properties dialog box.

5. Place a text box on the display, and name it txtProfileVar.

6. Add the following code to the page OnPageComplete event handler.

QcsMeasurementProfile.ClearProfile (true)

QcsMeasurementProfile.updateMeasurementScaling 0, 0, 0, 0

QcsMeasurementProfile.UpdateMeasurementSelection "PM 1", "SCN1", "Upper Air Gap Temp", "UAG11NA", "Absolute"

txtProfileVar.value = "Upper Air Gap Temp"

Note that:

QcsMeasurementProfile.ClearProfile (true), clears the profile of any values prior to loading new data.

QcsMeasurementProfile.UpdateMeasurementScaling 0,0,0,0 sets this profile object to the Autoscale mode.

UpdateMeasurementSelection, Sets the desired profile. Parameter descriptions are as follows:

• PM 1 = Production Line identifier

• SCN1 = from id field of Frame table in RTDR

• Upper Air Gap Temp = from Description field of Measurement table in RTDR.

• UAG11NA = from the id field of the MeasurementArray table in RTDR.

• Absolute = Measurement Mode


8. Save and close the display.

9. Open the display you have created in the Station.

The QcsMeasurementProfile should appear as shown in the Figure 7-2

QCS Specific Objects QcsFixedPointProfile

P/N 6510020317 Rev 02 10/27/11 7-5

Figure 7-2 QcsMeasurementProfile

See section 10.3.1 for additional information on the QcsMeasurementProfile object.

7.3. QcsFixedPointProfile This example shows you how to use the QcsFixedPointProfile control to display a fixed point measurement profile.

1. Start the HMIWeb Display Builder application, and open the QcsDisplayTemplate.

a. Click the icon the QcsFixedPointProfile icon ( ) in the Toolbar toolbox.

b. Drag the pointer on the Display area to create QcsFixedPointProfile control with the desired size and location.

2. Right-click the QcsFixedPointProfile control and then click Properties Page.


a. Set the object name to QcsFixedPointProfile.

b. In the Style drop-down list, select QcsFixedPointProfileStyle.

c. Close the QcsFixedPointProfile Properties dialog box.

4. Place a Textbox control on the display and set its name to txtProfileVar.


10/27/11 P/N: 6510020317 Rev 02 7-6

5. Add the following script doe to the page OnPageComplete event handler.

QcsFixedPointProfile.ClearProfile (true)

QcsFixedPointProfile.updateMeasurementScaling 0, 0, 0, 0

QcsFixedPointProfile.UpdateMeasurementSelection "PM 1", "SCN1", "Upper Air Gap Temp", "UAG11NB", "Absolute"

txtProfileVar.value = "Upper Air Gap Temp"

Note that:

QcsFixedPointProfile.ClearProfile (true), clears the profile of any values prior to loading.

QcsFixedPointProfile.UpdateMeasurementScaling 0,0,0,0 sets the profile to AutoScale mode.

UpdateMeasurementSelection, sets the variable in the profile. Parameter descriptions are as follows:

• PM 1 = Production Line identifier

• SCN1 = from id field of Frame table in RTDR

• Upper Air Gap Temp = from Description field of Measurement table in RTDR.

• UAG11NB = from id field of Measurement bfr data table in RTDR.

• Absolute = Mode identifier



8. Open the display in Station.

The QcsFixedPointProfile should appear as shown in Figure 7-3

QCS Specific Objects QcsSummaryTable

P/N 6510020317 Rev 02 10/27/11 7-7

Figure 7-3 QcsFixedPointProfile

7.4. QcsSummaryTable This example shows you how to use QcsSummaryTable control to display the measurement summary data.


a. Click on the QcsSummaryTable icon ( ) in the Toolbar toolbox.

b. Place an instance of the control with the desired size and location.

2. Right-click the QcsSummaryTable control, and then click Properties Pages.

a. Click the General tab.

b. Set the object name to QcsSummaryTable.

c. Use the Style drop-down list to select the QcsSummaryTableStyle.

3. Add the following script code on the page OnPageComplete event handler.

4. Right-click the QcsSummaryTable control and then click Edit Script.

QcsSummaryTable.ProductionLine = GetProductionLine()

QcsSummaryTable.ActiveSet = 0


10/27/11 P/N: 6510020317 Rev 02 7-8

QcsSummaryTable.Connect()

Note that:

QcsSummaryTable.ProductionLine = GetProductionLine() get the local production line name.

QcsSummaryTable.ActiveSet = 0 set he active set to the first set (set 0).

QcsSummaryTable.Connect(), causes the object to get the data from the RTDR.



7. Open the display in the Station.

The QcsSummaryTable should appear as shown in Figure 7-4

Figure 7-4 QcsSummaryTable

7.5. QcsTMMSRoundnessProfile This example shows you how to use the QcsTMMSRoundnessProfile control to display a Machine Sentinel measurement profile.



QCS Specific Objects QcsTMMSRoundnessProfile

P/N 6510020317 Rev 02 10/27/11 7-9

b. Click on the ( ) icon in the Toolbar toolbox.

c. Drag the pointer on the Display area to create QcsTMMSRoundnessProfile with the desired location and size.

2. Right-click the QcsTMMSRoundnessProfile control, and then click Property Pages.


a. Set the Name to QcsTMMSRoundnessProfile.

b. In the Style drop-down list, select QcsRoundnessProfilestyle.

c. Close the QcsTMMSRoundnessProfile Properties dialog box.

4. Place a text box on the display area, and name it as lblMeasDesc.

5. Add the following code to the page OnPageComplete event handler.

'Setting roundness profile to Auto Scale

QcsTMMSRoundessProfile.scaleMode = 0

'Settings QcsTMMSRoundessProfile QcsTMMSRoundessProfile.IsAutoUpdated = true

'Update the RoundnessProfile Control with Measurement id call QcsTMMSRoundessProfile.UpdateMeasurementSelection(GetProductionLine(),"pm3","Dryend", "yankee press nip_TS", "yankee tacho")

lblMeasDesc.value = "PM3 DryEnd Yankee_Press_nip_TS Yankee_Tacho"



8. Open the display you have created in the Station.

The QcsTMMSRoundnessProfile should appear as shown in the Figure 7-5.


10/27/11 P/N: 6510020317 Rev 02 7-10

Figure 7-5 QcsTMMSRoundnessProfile

See section 10.3.11 for additional information on the QcsTmmsRoundnessProfile control.

7.6. QcsTMMSHistoryTrend This example shows you how to use the QcsTMMSHistoryTrend control.



b. Click on the ( ) icon in the Toolbar toolbox.

c. Drag the pointer on the Display area to create QcsTMMSHistoryTrend control icon with a desired shape and size.

2. Right-click the QcsTMMSHistoryTrend control and then click Property Pages.


QCS Specific Objects QcsTMMSHistoryTrend

P/N 6510020317 Rev 02 10/27/11 7-11

a. In the Name box, type QcsTMMSHistoryTrend.

b. In the Style drop-down list, click QcsHistoryTrendStyle.

c. Close the QcsTMMSHistoryTrend Properties dialog box.


'to make History Trend not show MachineSpeed trend for any provided machine sentinel Measurement

QcsTMMSHistoryTrend.ShowMachineSpeed = false

'Setting x-axis time range as 60 minutes

QcsTMMSHistoryTrend.Period = 60

'Set Machine sentinel measurement and its Keyvalue ids to History Trend

call QcsTMMSHistoryTrend.SetKeyValueSelection(GetProductionLine(),"pm3","Dryend", "yankee press nip_TS","Yankee tacho", "ppeak")

'Set Scale Mode of History trend as percentage of limits with 25 as percentage

call QcsTMMSHistoryTrend.SetKeyValueScaleMode(2,0,0, 25)

'set updated measurement’s string value to textbox control

lblMeasDesc.value = "PM3 DryEnd Yankee press nip_Ts Yankee tacho ppeak "



7. Open the display that you have created in the Station.

The QcsTMMSHistoryTrend should appear as shown in the Figure 7-6


10/27/11 P/N: 6510020317 Rev 02 7-12

Figure 7-6 QcsTMMSHistoryTrend

P/N 6510020317 Rev 02 10/27/11 8-1

8. Experion Objects

The standard Experion HDB objects are often used when creating and modifying QCS Displays. This section lists some special considerations when using these standard Experion HDB objects with QCS data. The following standard HDB objects are addressed in this section:

• Alphanumeric

• Textbox

• Checkbox

• Pushbutton

• Combobox

• Arrays

8.1. Alphanumeric Control As was shown in earlier sections of this manual, the alphanumeric control may be used with QCS data. The “Type of database link” property for the alphanumeric is normally set to “None” when used to display QCS Data. This is because the QCS Data is normally accessed using the data access methods provided by the QCS support Library Shape rather than the Experion database.

Each HDB display can specify only one style sheet. The QCS Styles style sheet is normally used for QCS displays. This style sheet includes a variety of styles for the Alphanumeric control. Using standard QCS styles makes it easier to maintain a common look for the QCS displays.

Another object property you will find on the “Animation” tab is called the “Use color to indicate off-scan state” property. You may want to deselect this option since the QCS data is not read by the normal Station data update scan but is instead read using script code.

Experion MX Display Builder Users Guide Experion Objects

10/27/11 P/N: 6510020317 Rev 02 8-2

8.2. Textbox Control Textbox control is used to place text on the display. If the text is to be set using script code then the “Type of database link” should be set to “None”.

The QCS Style Sheet provides a wide variety of styles for this control. When this is used on QCS display it is best to select a style for the textbox rather than leave this set to the default of <No Style>. This makes it easier to provide a common look for the QCS displays.

The default object name for a textbox is something like “textbox001”. If this is being used as a label for a text string like “Average”, it is best to give the textbox a more meaningful name (such as “txtAverage”).

Most user visible text strings are translated to the operator selected language. As was shown in section 5.3, this might be done using a LanguageChanged function such as the following:

Function LanguageChanged(Language)

txtAve.value = translator.Translate("Average")

txtSpread.value = translator.Translate("Spread")

End function

8.3. Checkbox Control Like the other standard Experion controls, the Checkbox properties should be set to “Type of Database link = None when the value of the checkbox is controlled from script code.

The QCS Styles style sheet provides several styles for the Checkbox control.

8.4. Pushbutton Control The standard Pushbutton control does not use a database link so there is no special setting required to use these on QCS displays.

Experion Objects Combobox Control

P/N 6510020317 Rev 02 10/27/11 8-3

The QCS Style Sheet does provide a variety of styles for the Pushbutton. Some of these such as the BtnStyleLink and the BtnStyleLinkWhite make the Pushbutton appear link a Hyperlink. Many QCS displays use these styles to provide buttons which navigate to other displays or open QCS Setups (such as the Setup button in the blue bar).

8.5. Combobox Control This example shows you how to create a combo box control with multiple data item from where you can choose the desired data item.


a. Click on the Toolbar toolbox.

b. Drag the pointer on the display area to create combo box control with a required shape and size.

2. Right-click the combobox control and then click Properties Page.

3. Click the Data tab.

a. In the Type of database link drop-down list, click None.

b. Click the General tab.

c. In the Name box, type the name as cmbProductionLine.

d. In the Style drop-down list, click the CboStyleBold style.

e. Close the combo box control Properties dialog box.

4. Create three Text boxes as shown in the following figure. To know the procedure to create a Textbox and apply style, see section 8.2

a. Right-click the textbox control created under the Combo box control and then click Properties Page.


10/27/11 P/N: 6510020317 Rev 02 8-4

b. In the General tab, type txtCurrentProdLine in the Name box.

c. Close the Textbox properties dialog box.

5. Right-click the combo box control and then click Edit Script. In the object selection drop-down list, click Page. In the event selection drop-down list, click OnPageComplete.

a. Copy and paste the following scripts in the Edit Script dialog box. This script is used for getting the selected item using value property of combo box control.

Sub Page_onpagecomplete

'Setting the combobox text alignment to center

cmbProductionLine.style.paddingTop = CalculatePaddingTopValue(cmbProductionLine)

'To initialize the combbox

call InitializeComboBox()

End Sub

When you call this display file in Station, the Combobox is displayed as shown in the following figure.

6. In the object selection drop-down list, click General.

a. Copy and paste the following script in the Script Editor dialog box. This script is used to initialize and adding items to combo box. The AddString() method is used to populate the combo box.

Sub InitializeComboBox()

'Clear the combobox

cmbProductionLine.ResetContent

'Adding production lines

for j=1 to 3

Experion Objects ArrayItems

P/N 6510020317 Rev 02 10/27/11 8-5

cmbProductionLine.AddString("PM"&j)

Next

'Initialize the selected index to the first value

cmbProductionLine.selectedIndex = 0

End Sub

7. In the object selection drop-down list, click cmbProductionLine. In the event selection dialog box, click onChange. Copy and paste the following script in the Script Editor.

Sub cmbProductionLine_onchange

'Getting the user selected value from the combobox

txtCurrentProdLine = cmbProductionLine.value

End Sub


9. Save and close the display file.

10. Open the Station Window.

11. Call the display you have created from the Station.

The respective QCS Display appears. Click the Combobox to view and select the data items.

8.6. ArrayItems This example shows you how to create an array of items, based on the selected array index, and the corresponding value is from another array.

1. Consider an array named selectionArrayItems[ ] with three elements. These elements can be added to a combobox named cmbSelection with the script code show below.

for j=0 to 2

cmbSelection.AddString(selectionArrayItems(j))

Next


10/27/11 P/N: 6510020317 Rev 02 8-6

2. For fetching the corresponding value from another array named valueArrayItems[ ] based on the selected index of the combo box, below code can be used in onChange event of combo box, txtValue = valueArrayItems(cmbSelection.SelectedIndex)

3. Create three Text box controls as shown in the following figure.

a. Right-click the Combobox control and then click Properties Page.

b. Under General tab, type cmdSelection in the Name box.

c. Close the combo box control Properties dialog box.

d. Right-click the text box control created under the Combo box control and then click Properties Page.

e. In the General tab, type txtValue in the Name box.

4. Copy and paste the following script in the Script Editor dialog box for getting the selected item using selected index property of combo box control. In the event selection drop-down list, click OnPageComplete.

Sub Page_onpagecomplete

'Setting the combobox text alignment to center

cmbSelection.style.paddingTop = CalculatePaddingTopValue(cmbSelection)

'To initialize the combbox

call InitializeComboBox()

Experion Objects ArrayItems

P/N 6510020317 Rev 02 10/27/11 8-7

End Sub

• Copy and paste the following script into the general section.

'To initialize array variables

Dim selectionArrayItems(2)

Dim valueArrayItems(2)

'Initializing the combo box

Sub InitializeComboBox()

'Clear the comboboxes

cmbSelection.ResetContent

To add items to first array

for j=0 to 2

selectionArrayItems(j) = "Selection"&j

Next

'Adding items to the second array

for j=0 to 2

valueArrayItems(j) = "Value"&j

Next

' Adding array items to the combo box

for j=0 to 2

cmbSelection.AddString(selectionArrayItems(j))

Next

'Initialize the selected index to the first value

cmbSelection.selectedIndex = 0

End Sub

• In event selection dialog box select OnChange. Copy and paste the following script.

Sub cmbSelection_onchange


10/27/11 P/N: 6510020317 Rev 02 8-8

'Getting the user selected index from the combobox

txtValue = valueArrayItems(cmbSelection.SelectedIndex)

End Sub


6. Open the Station Window.

7. Call the display you have created from the Station.

The respective QCS Display appears and you can view and select the array item you have created in the combobox.

P/N 6510020317 Rev 02 10/27/11 9-1

9. Troubleshooting

9.1. Error Logging Error or Message logging is a good programming practice, which makes it easier to locate the source program errors.

The QCS HMIWeb displays utilize the Experion HMI Web Log, Windows Event log and the ELMO logging system.

By default the messages considered as error or warning level messages are written both to Windows Event log and to ELMO. The lower level messages, informative and debug level messages can be configured to be logged in ELMO. By default these low level messages are filtered out and therefore not stored.

1. The RTDR data access errors are normally logged to the Windows Application Event log. If you are unable to access the desired RTDR data, check the Windows Application Event log for any errors related to your display.

2. You should also check the HMIWebLog for any other errors relegated to your display.

9.1.1. Experion HMIWeb log The Experion Station and associated applications write error and status messages to the following text file:

C:\ProgramData\Honeywell\HMIWebLog\Log.txt

Experion MX Display Builder Users Guide Troubleshooting

10/27/11 P/N: 6510020317 Rev 02 9-2

The Experion environment provides a method called LogMessage which can be called from script code to log message to the HMIweb Log.

Each message logged to this file has a date and time stamp.

To log a message at the end of this log file from your QCS display, add the following line:

window.external.Parent.LogMessage "Operation complete"

i NOTE:

By default the ProgramData folder (and its sub-folders) are configured as system folders and are hidden in the Windows Explorer. To view these system folders open the Windows Explorer, select Tools > Folder Options…, select the View tab and then select Show hidden files and folders option, and click OK.

9.1.2. Windows Event Log Entries written to Windows Event log can be viewed with the help of Event Viewer.

1. To view the Event Viewer on Windows 7 perform the following:

• Choose Start > Control Panel > System and Security >Administrative Tools > Event Viewer.

2. To view the Event Viewer on Windows Server 2008 perform the following:

• Choose Start > Control Panel > Administrative Tools > Event Viewer.

3. Double-click Event Viewer.

The User Account Control dialog box appears.

Troubleshooting Error Logging

P/N 6510020317 Rev 02 10/27/11 9-3

4. Click Allow.

The Event Viewer dialog box appears.

The QCS HMIWeb Objects log messages to the Windows Application Log.


10/27/11 P/N: 6510020317 Rev 02 9-4

9.1.3. ELMO Logging System Entries written to the ELMO logging system can be viewed using the PMD Event Viewer. A shortcut of this application will be available on the Windows desktop or you can also start this application from the Windows start menu

Choose Start > All Programs > RAE > Tools > PMD Event Log Viewer.

The QCS HMIWeb Objects log their entries in the Honeywell QCS Objects. LOG. You can select this entry from the Log-Files dropdown list.

The ELMO logging system supports different levels of messages. The following levels are used by the QCS HMIWeb Objects:

Table 9-1ELMO message logging levels

Message Level Level Value

Error 4 Warning 20 Information 50 Debug 100


P/N 6510020317 Rev 02 10/27/11 9-5

By default the Error or Warning level messages are stored and the Information and Debug messages are ignored. The logging level can be configured by editing elmo.ini text file.

To change the logging level for QCS HMIWeb Objects:

1. Check if the elmo.ini file can be found in C:\PMD_LOG folder. If elmo.ini is found, then go to step 3, else go to step 2.

2. Copy a sample ini file from C:\Program Files\Honeywell\PMDC\PMD Logging System\elmo.ini to C:\PMD_LOG folder.

3. Open the C:\PMD_LOG\elmo.ini using a text editor. For example, a Notepad. Add the entry for Honeywell QCS Objects if it is not there, see the entry in bold font in the following diagram.

; ; PMD Event Logging Configuration file ( on directory PMD_LOG ) ; ; The PMD Event Log Server changes the default level and category values of ; requested clients and also copies the .log files according following definitions: ; ; [ClientName] ; Level=97 // New default level value (original default value is 10) ; Cat=3 // New default category value (original default value is 1) ; Samples=1 // If this definitions exists the log files are copied to pmd_log\samples directory at start ; [Honeywell QCS Objects] Level=100 // New default level value (original default value is 10)

Set the Level value according to the levels listed in the Table 9-1. For example Level=100 means that all messages are stored and Level=4 means that only Error messages are stored while other messages are filtered out.

4. Save the changes in C:\PMD_LOG\elmo.ini.

5. Restart the ELMO logging service for the changes to take effect.

From the Windows Task Manager select the PMDELS.exe process. Kill the process by clicking End Process button.


10/27/11 P/N: 6510020317 Rev 02 9-6

The PMDELS.exe is restarted automatically when any client connects to it.

9.1.4. Debugging Runtime Script Errors When testing your display, you may encounter run-time script errors such as:

• When you click on the Advanced, the following dialog box appears.


P/N 6510020317 Rev 02 10/27/11 9-7

• This error information may be enough for you to locate the source of the error (like the mxgbox typo above). You can also use the Line information to locate source of the error. You may need to open the display .htm file with a tool like Notepade.exe to find the line number. In the Notepad select Edit > Go To, then enter the line number reported in the error popup.

P/N 6510020317 Rev 02 10/27/11 10-1

10. Technical Reference Information

This chapter provides information on the QCS Style Sheet and the properties, methods and events that are provided by the QCS Shapes and QCS objects.

i

NOTE: For additional information regarding the properties, methods, and events, see QCS HMI Objects.chm file located at

\Program Files\Honeywell\Experion PKS\RAE\Bin\HmiObjects

10.1. Style Sheets A Style Sheet helps you to create visually consistent displays. A style sheet contains a set of pre-defined Styles that controls the presentation related properties of a user interface item, such as color, line thickness and font. By default, all QCS standard displays use the QcsStyles.css style sheet which can be found in the folder:

\ProgramData\Honeywell\Experion PKS\Client\Abstract\Styles

10.1.1. Using a Style sheet Each HMIweb display can specify one main style sheet. This setting is found in the Display Properties on the Appearance tab. The advantage of using one main style sheet is that a common style (like the display background color for example) can be changed in one place and then all the displays which use that style will immediately use the new style.

Experion MX Display Builder Users Guide Technical Reference Information

10/27/11 P/N: 6510020317 Rev 02 10-2

The QCS Shapes and QCS Objects use many of the styles in the QCS Style Sheet so these styles would need to be included in any other style sheet that might be used in place of QcsStyles.css.

The QcsStyles.css style sheet is saved under the ProgramData folder with read/write access so the file can be modified as needed.

10.1.2. Structure of a Style A Style Sheet provides a collection of Styles. Each Style has a unique name and one or more properties.

For example, the display Background Style in the QcsStyles.css file is: .Background_Style { hw-element-class: #page; hw-fill-color: #e9e9e9; }

This style applies to objects with the “hw-element-class” of #page. In other words this style only applies to HMIweb pages (or displays).

The page fill color is #e9e9e9”. If we were to change this to some other color and save this file back to its original location, all displays which use this background style would immediately use the new background color.

Another example is the Bold Button Style (actually called “BtnStyleBold”). The style as it appears in the QcsStyles.css file is: .BtnStyleBold { /* Style class applies to following elements */ hw-element-class: hsc.button.1; hw-text-color: black; hw-text-effect: bold; hw-text-align: center; hw-text-family: Arial; hw-text-size: 12pt; hw-line-color: white; hw-line-width: 3; hw-line-style: outset; hw-fill-color: #cecece; }

This style applies to all standard pushbuttons which use the element class name of “hsc.button.1”.

This style sets the text color to Black with a Bold effect. The text is center aligned and the font in 12pt Arial. The fill color is #cecece.

Technical Reference Information Style Sheets

P/N 6510020317 Rev 02 10/27/11 10-3

If you were to change any of these properties and then save this file, all buttons which use this button style would now use the new properties.

Note that comments in this style sheet start with “/*” and end with “*/”.

A style definition must contain the attribute hw-element-class. This is a primary style attribute applicable to all display elements and it restricts the range of object types to which the style applies.

10.1.3. Qcs Controls and their Styles Table 10-1 lists the value of the hw-element-class attribute for the QCS Controls and the predefined classes in the style sheet.

Table 10-1 Qcs Controls

Qcs Control name Value of the hw-element-class attribute

Existing classes

QcsTable Qcs.Table .QcsTableStyle .QcsReportTableStyle .QcsTablePrintStyle

.QcsRollHistReportTableStyle .QcsMISReportTableStyle

.QcsMultiProfilesTableStyle QcsSummaryTable Qcs.SummaryTable .QcsSummaryTableStyle

QcsArrayChart Qcs.ArrayChart .QcsArrayChartStyle .QcsArrayChartPrintStyle

QcsListBox Qcs.Listbox .QcsListboxStyle QcsNumericUpDown Qcs.NumericUpDown .QcsNumericUpDownStyle

QcsSlider Qcs.Slider .QcsSliderStyle QcsColorGrid Qcs.ColorGrid .QcsColorGridStyle

QcsTrend Qcs.Trend .QcsTrendStyle MdShutdownTrend Qcs.MDShutdownTrend .QcsMdShutdownTrendStyle

MdShutdownControlLine Qcs.MDShutdownControlLines .QcsMdShutdownControlLineStyle Popup Navigation Control Qcs.Navigation .QcsNavigationControlStyle

Attributes available for the QCS controls

Table 10-2 lists the attributes with a brief description, and the applicable range of values and the QCS controls. Note that the “Color Code” in this vale may be “Black”, “White, or a hex color code such as “#rrggbb” where “rr” is the hex value for read, “gg is the hex value for green, and “bb” is the hex value for green.

Table 10-2 QCS Controls Attributes


10/27/11 P/N: 6510020317 Rev 02 10-4

Attribute Name Description Values Applicable to

Borderstyle Sets the border style of the table

Accepts String values Fixed3D

FixedSingle None

QcsTable, QcsSummaryTable,

QcsListbox, QcsNumericUpDown

header-text-color Sets the color of header font

Color Code QcsTable, QcsSummaryTable

header-text-effect Sets the effect of header font

Bold Italic

Strikeout Underline

QcsTable, QcsSummaryTable

header-text-family Sets the header font family

Accepts fonts available in the system.


header-text-size Sets the header font size

Accepts integer values between 8 and 72


cell-text-color Sets the color of cell text font


cell-text-effect Sets the cell text font effect

Bold Italic

Strikeout Underline


cell-text-family Sets the cell text family



cell-text-size Sets the size of the cell text font

Takes integer values between 8 and 72


cell-back-color Sets the background color of the cell


lockedcell-text-color Sets the size of the cell text font


lockedcell-text-effect Sets the cell text effect

Accepts any of the following String values -

Bold Italic

Strikeout Underline


lockedcell-text-family Sets the locked cell text family



lockedcell-text-size Sets the size of the locked cell text font



lockedcell-back-color Sets the background color of a locked cell


cell-back-color2 Sets the alternate row coloring of table


grayarea-color Sets the color Color Code QcsTable

Technical Reference Information Style Sheets

P/N 6510020317 Rev 02 10/27/11 10-5


shading of table. skinstyle Sets the style to the

selected built-in skins Accepts values between 0

and 13 0 – Classic

1 – Shamrock 2 -- Sandstorm 3 --ArcticSea 4 – Metallic

5 – Grayscale 6 – Sunburst 7 – Seashell 8 – Pastel 9 – Rose

10 – Newspaper 11 – Midnight

12 – Skins 13 -- printable skin

Default is 0


axis-text-effect Sets the axes text effect

Accepts any of the following String values –

Bold Italic

Strikeout Underline

QcsArrayChart

axis-text-family Sets the axes text family


QcsArrayChart

axis-text-size Sets the size of the axes text font


QcsArrayChart QcsArrayChart,

QcsNumericUpDown, QcsSlider,

QcsColorGrid Graph-backcolor Sets the color of the

graph Color Code QcsArrayChart

text-color Sets the color of the font

Color Code QcsListbox, QcsNumericUpDown,

QcsSlider, QcsColorGrid,

QcsTrend, MdShutdownControlLi

ne text-effect Sets the effect of the

font Accepts any of the

following String values –

Bold

QcsListbox, QcsNumericUpDown,

QcsSlider,


10/27/11 P/N: 6510020317 Rev 02 10-6


Italic Strikeout Underline

QcsColorGrid, QcsTrend,

MdShutdownControlLine,

Popup Navigation Control

text-family Sets the font family Accepts fonts available in the system.

QcsListbox, QcsNumericUpDown,

QcsSlider, QcsColorGrid,

QcsTrend, MdShutdownControlLi

ne, Popup Navigation

Control text-size Sets the size of the

text Accepts integer values

between 8 and 72 QcsListbox,

QcsNumericUpDown, QcsSlider,

QcsColorGrid, QcsTrend,

MdShutdownControlLine,

Popup Navigation Control

back-color Sets the background color

Color Codes QcsListbox, QcsNumericUpDown

10.2. QCS Shapes This section describes the following QCS shapes:

• Measurement Profile (layout 1)

• Measurement Profile (layout 2)

• MIS Profile

• High Resolution Measurement Profile

• Trend (layout 1)

• Trend (layout 2)

• Scanner Animation

• Indicator

Technical Reference Information QCS Shapes

P/N 6510020317 Rev 02 10/27/11 10-7

• Color Coordinate Slider

• TMMS Crepe Blade Measurement


• Control Line

• Fixed Point

• Fixed Point 01

• History Trend

10.2.1. Measurement Profile (layout 1) The QcsMeasurementProfile shape (QcsMeasurementProfile.sha) includes the QcsMeasurementProfile control and a set of native HDB controls and indicators as shown in Figure 10-1.

Figure 10-1 Measurement Profile (Layout 1)

The use of this shape was explained in section2.

Custom Properties

You will normally want to leave these properties set to their default values.

Properties Description

ShowOnFirstMxLoad PersistData

Hides shape until initial profile is loaded. 0 = False, 1 = True. Default = 0 Defines if user selections are persisted through a restart. 0 = False, 1 = True. Default = 1.


10/27/11 P/N: 6510020317 Rev 02 10-8

10.2.2. Measurement Profile (layout 2) The QcsMeasurementProfile shape called QcsMeasurementProfile02.sha is similar to QcsMeasurementProfile.sha except for the layout of the data. In QcsMeasurementProfile02.sha all statistical data are displayed below the profile , whereas in QcsMeasurementProfile.sha they are displayed on the right side of the profile.

Figure 10-2 Measurement Profile (Layout 2)

Custom Properties

You will normally want to leave these properties set to their default values.

10.2.3. MIS Profile MIS Profile shape (QcsMisProfile.sha) is used for analyzing the roll profiles. MIS Profile shape includes the logic to select a measurement of the selected roll, and analyze the data. A standard statistical field is present toward the right side of the shape.

Methods

Method QcsMisProfile_SetRollParameters


ShowOnFirstMxLoad PersistData

Hides shape until initial profile is loaded. 0 = False, 1 = True. Default = 0 Defines if user selections are persisted through a restart. 0 = False, 1 = True. Default = 1.


P/N 6510020317 Rev 02 10/27/11 10-9

Description Initializes the MIS profile shape corresponding to the production line, winder, and Roll ID.

Parameters qcsMisProfileShapeRef Shape reference ProductionLineID Production Line ID winderID Winder ID rollID Roll ID

For example:

QcsMisProfile_SetRollParameters QcsMisProfileShape01, “PM 1”, “WD1”, “Roll_25 2011-03-27 2053”

The list of roll ID can be obtained with the following script code:

Dim qcsObject Set qcsSystem = GetQcsSystem("") dim winders winders = qcsSystem.ApplicationPackages.Mis.MisHome.GetWinders() dim rollsCollection rollsCollection = winders(0).GetMisRolls() cboRolls.ResetContent() for each roll in rollsCollection cboRolls.AddString(roll.ID) next

10.2.4. High Resolution Measurement Profile High Resolution Measurement Profile shape (QcsHighResMeasurementProfiles.sha) divides the profile array data into three separate graphs as illustrated in the following figure.


10/27/11 P/N: 6510020317 Rev 02 10-10

Figure 10-3 High Resolution Profiles

The Statistical information for the selected measurement is displayed below the graphs.

The upper part of the profile consists of the following buttons.

For selecting a Measurement to analyze

To Freeze the visible profile array

Graph scaling

Custom Properties


ShowOnFirstMxLoad Hides shape until initial profile gets loaded.


P/N 6510020317 Rev 02 10/27/11 10-11

10.2.5. Trend (layout 1) The Trend shape (QcsTrend.sha) consists of a trend graph and several standard HMIWeb controls (pushbuttons, combo boxes, and textboxes. The QCS Trend shape can be used without the need to write any script code.

Figure 10-4Trend (Layout 1)

Custom Properties


PersistData Defines if the selections in the shape are persisted 0 – No 1 – Yes (default)

10.2.6. Trend (layout 2) This second trend shape (QcsTrend02.sha) is similar to the QcsTrend.sha, it has the same functionality but the layout is different. In the QcsTrend02. shape all statistical data is displayed below the graph, whereas in the QcsTrend shape the data fields are displayed at right side of the graph.

Figure 10-5 Trend (Layout 2)


10/27/11 P/N: 6510020317 Rev 02 10-12

Custom Properties



10.2.7. Scanner Animation The QcsScanner shape (QCSScanner.sha) is used to display an s animation showing the movement of the head, running across the sheet. The Scanner shape is developed using native HDB controls, and the Scanner shape consists of the following:

• Scanner Frame(white hollow rectangle)

• Sheet

• Scanning Heads

This QCS Shape does not automatically get the scanner information required to drive the animation. The methods provided by the shape must be called to periodically update the scanner position and other data shown on the shape.

Figure 10-6 Scanner Animation


P/N 6510020317 Rev 02 10/27/11 10-13

The QCS popup called QcsPopupScannerControl shows how to use this shape.

If the frame

Methods

Method SetScannerFrameLimits

Description Sets the Maximum and Minimum limits of the Scanner Frame.

Parameters DisplayShapeObjRef Shape reference ScaleMaximum Maximum limit of the Scanner Frame. ScaleMinimum Minimum limit of the Scanner Frame.

Method SetSheetEdges

Description Set the High and Low edges of Sheet running under Scanner frame. This method must be called after SetScannerFrameLimits method.

Parameters DisplayShapeObjRef Shape reference HighEdge Higher sheet edge. LowEdge Lower sheet edge.

Method SetScannerPosition

Description Set the Head position for the scanner head. This method must be called after ONLY after calling SetScannerFrameLimits and SetSheetEdges Methods.

Parameters DisplayShapeObjRef Shape reference Position Position of the scanner head.

If the frame limits

For example, if the frame limits where 0 and 1000 and the sheet edges were at 100 and 900, then the following calls could be used in the OnPageComplete event handler to initialize the scanner shape.

SetScannerFrameLimits shape001, 1000, 0 SetSheetEdges shape001, 900, 100

You might periodically read the actual head position and update this shape with the following call:

SetScannerPosition shape005, ActualHeadPosition


10/27/11 P/N: 6510020317 Rev 02 10-14

10.2.8. Indicator The QcsIndicator shape (QcsIndicator.sha) displays the current value in the form of a level indicator. The corresponding numeric value of the level indicator is displayed at the bottom of the shape. The QcsIndicator shape is shown below.

Figure 10-7 Indicator

QcsIndicator supports middle and high limit levels. The dotted line in the indictor control indicates the limit levels. The color of the indicator changes as the limit levels are exceeded.

• Green - Value is less than middle limit.

• Yellow - Value is between middle and high limits .

• Red - Value is more than the high limit.

Custom Properties


RangeMin Sets the minimum range of the indicator RangeMax Sets the maximum range of the indicator MiddleLimit Sets the middle limit value HighLimit Sets the high limit value MiddleLimitLabel Sets the text for the middle limit line HighLimitLabel Sets the text for the high limit line

Methods

Method QcsIndicator_SetIndicatorValue


P/N 6510020317 Rev 02 10/27/11 10-15

Description Sets the current display value (the level shown by the indicator).

Parameters qcsIndicatorShapeRef Shape reference value Numeric value that is displayed in the indicator

Place an instance of the QcsIndicator shape on a page. Open the Property pages for this shape. Select the custom Properties tab and then set the custom properties as desired.

In run-time you might periodically read some data from the RTDR and show this on the indicator with the following call.

QcsIndicator_SetIndicatorValue shape002, CurrentValue

10.2.9. ColorCoordinateSlider The QcsColorCoordinateSlider shape (QcsColorCoordinateSlider.sha) is used to represent any color coordinate value in deviation or absolute mode.

The data displayed in the QcsColorCoordinateSlider are Name of the Color Coordinate Slider, Upper Graph Value, Lower Graph value, and Current Value. A green indicator on the right side of the indicator points to the current value. An example of the shape is shown below.

This shape is used in QCSColorSpaceWindow display (QCSColorSpaceWindow.htm).

Methods

Method SetColorSliderName

Description Sets name of Color Slider.

Parameters DisplayShapeObjRef Shape reference LabelName Calls the Name of the slider.

Method SetColorSliderSettings

Description Sets the required configuration of color slider, where deviation or absolute mode, Scale, Target value and current value can be configured..

Parameters DisplayShapeObjRef Shape reference DivOrAbs 0 for deviation.

1 for absolute. Unit_divValue Units per division TargetValue Target or Setpoint values of color

coordinate measurement


10/27/11 P/N: 6510020317 Rev 02 10-16

NowValue Current values of color coordinate measurement

The indicator range is always 10 times the value of the Unit-divValue. The target value is always at the midpoint of the indicator and is marked with a green pointer on the right side. When the absolute mode is used, the midpoint value is the TargetValue. When the deviation mode is used, the midpoint is always zero.

For example, the following method calls:

SetColorSliderName shape007, "My Slider" SetColorSliderSettings shape007, 1, 10, 60, 50

Results in a QcsColorCoordinateSlider as shown below

Figure 10-8 Color Coordinate Slider

When deviation mode is used this appears as shown below:


P/N 6510020317 Rev 02 10/27/11 10-17

10.2.10. QcsTMMSCrepeBladeMeasurement This is a Machine sentinel Crepe Measurement shape (QcsTMMSCrepeBladeMeasurement.sha). This shape is used to show Crepe measurements using both roundness profile and a key value indicator.

To use this shape for a particular crepe measurement, you need to set the “CrepeBladeMeasId” to “TS”, “DS,” or “CS” (for Tending Side, Driver Side , or Center Side crepe measurements).

Figure 10-9 TMMSCrepeBlade Measurement


10/27/11 P/N: 6510020317 Rev 02 10-18

Custom Properties


CrepeBladeMeasId Set to TS,DS or CS for Tending, Driver or Center side crepe measurement. By Default TS is set

Methods

Method QCSTMMSCrepeBlade_SelectMeas

Description This Method can be used to select one of three Crepe Blade Measurements

Parameters ShapeRef accepts shape reference CrepeBladeMeasId accepts TS,DS or CS for Tending,

Driver and Center side crepe measurement.

10.2.11. QcsTMMSHistoryTrend This is a history trend shape (QcsTMMSHistoryTrend.sha) which is used for TMMS measurements. The history trend is displayed for the selected TMMS measurement and the key value from “key value selection” combo box.

The plot contains a red line to indicate the high alarm level, a yellow line to indicate the low alarm level, a linear graph for the trend measurement, and the selected Key Value. Blade changes are indicated with a vertical cyan line.

This shape has three cursor modes, they are: Now, Cursor and Event info. There are two Data Updating modes, they are: Continuous and History Data Mode

Figure 10-10 TMMSHistory Trend


P/N 6510020317 Rev 02 10/27/11 10-19

Custom Properties


PersistData Set “1” if selection made in shape are to be persisted, otherwise “0”

MsmtTypeName Set string ID to represent type of TMMS Measurement, Default is STA

10.2.12. QcsControlLine The QcsControlLine shape provides user access to traditional control loops running on the QCS server (QCSControlLine.sha). This shape has two basic modes, Control Line mode and Header mode.

In Header mode, the shape displays the Description, Setpoint, PV and Mode header labels as shown below.

In Control Line mode, the shape displays the loop name, setpoint, process value and mode of the specified control loop.

The Control Faceplate will appear when you click on the Setpoint. The Control Faceplate displays the detailed information for the specified control loop, and allows the user to enter setpoint and output values for controller. This faceplate may also be used to change the controller mode.

If the IsHeader custom property is set to ‘true’, shape is run in Header mode and if this is set to “false” the shape will run in Control Line mode.

The shape will be hidden in run-time if the Custom Properties are set incorrectly.

Custom Properties


IsHeader True = Header mode, False = Control line mode

ProductionLine Specifies the desired Production Line. May use


10/27/11 P/N: 6510020317 Rev 02 10-20

empty string for local Production Line. Only used in Control line mode.

ControlLineId Specifes the desired Control Line ID from the VIO table in the RTDR. Only used in Control Line mode.

Methods

Method ShapeCtrlLine_SetControlLineMode

Description This method is used to specify the desired Control Loop for this Control Line.

Parameters ShapeRef accepts shape reference productionLineId Production Iine ID. May use an

string empty string for the local production line

VIOId VIO ID from RTDR VIO table

Method ShapeCtrlLine_SetHeaderMode

Description This method places the control line in header mode

Parameters ShapeRef accepts shape reference

10.2.13. QcsFixedPoint This shape (QcsFixedPoint.sha) retrieves and plots fixed point measurement data. It can be used when the scanners are in Fixed Point mode and for fixed point sensor measurements.

Figure 10-11 QcsFixedPoint

Custom Properties Name Default value Description


P/N 6510020317 Rev 02 10/27/11 10-21

ShowOnFirstMxLoad 0 Hides shape until initial profile gets loaded.

PersistData 1 Defines if the selections in shape are persisted

10.2.14. QcsFixedPoint01 This shape (QcsFixedPoint01.sha) also retrieves and plots fixed point measurement data. It can be used when the scanners are in Fixed Point mode and for fixed point sensor measurements. The difference between this shape and the QcsFixedPoint shape is only in the data layout.

Figure 10-12 QcsFixedPoint01

Custom Properties

Name Default value Description

ShowOnFirstMxLoad 0 Hides shape until initial profile gets loaded.

PersistData 1 Defines if the selections in shape are persisted

10.2.1. History Trend The QCS History Trend shape (QcsHistoryTrend.sha) consists of a trend graph and several standard HMIWeb controls (pushbuttons, combo boxes, and textboxes as shown below. This trend shape can be used without writing any script code.


10/27/11 P/N: 6510020317 Rev 02 10-22

Figure 10-13 QCS History Trend

Custom Properties



10.3. QCS Objects This section describes the QCS Objects, explains how they may be used and documents the properties, methods and events provided by each QCS Object. The following QCs Objects are addressed:

• Measuement Profile

• Color Grid

• Array Chart

• Trend

• Table

• Summary Table

• ListBox

• Slider

• Numeric Up/Down


Technical Reference Information QCS Objects

P/N 6510020317 Rev 02 10/27/11 10-23

• TMMS Roundness Profile

• TreeView

• Polar Plot

• Checked ListBox

• Fixed Point Profile

10.3.1. Measurement Profile QcsMeasurementProfile ( ) objects may be used to display any of the available measurement profiles. . A sample measurement profile is shown below.

Figure 10-14 Measurement Profile

See section 7.2 for a simple example of using the QCS Measurement profile Object.

The following information is displayed on the profile object:

• The measurement graph

• X-axis scale and units

• Y-axis scale and units

• Scanner head position

• Trim Positions

• Frozen graph (optional)

• Low alarm limit (optional)

• High alarm limit (optional)


10/27/11 P/N: 6510020317 Rev 02 10-24

• Cursor (optional)

Data points on the profile outside of the alarm limits are shown in red rather than in green (assuming default color selections). The visibility of some of these items can be toggled through the associated configuration display.

Properties

Property Description

CurrentBinIndex Gets the current cursor position. CurrentBinValue Gets the current cursor value. CurrentStatus Gets the status of the profile (0 = profile is

valid, .1 = profile is not ready, 2 profile is invalid, -1 = profile array is Null)

FrozenArray Gets or sets the frozen array. FrozenDateTime Gets or sets the frozen date time. IsFrozen Boolean, True when a profile is frozen. Maximum Gets the x-scale maximum. MeasurementAverage Gets the profile Average. MeasurementDateTimeStamp Gets the measurement date time stamp (ex.

txtTimeStamp = QMP01.MeasurementDateTimeStamp)

MeasurementMaximum Gets the maximum value for the selected profile

MeasurementMinimum Gets the minimum value for the selected profile.

MeasurementRange Gets the measurement range. MeasurementSetpoint Gets the measurement setpoint MeasurementLowerLimit Gets the measurement alarm low limit. MeasurementSpread Gets the measurement spread. MeasurementUpperLimit Gets the measurement alarm high limit. Minimum Gets the x-scale minimum ScaleMaximum Gets the y-scale maximum. ScaleMinimum Gets the y-scale minimum. ScaleMode Gets the scale mode. 0 = Auto scale, 1 = Fixed,

2 = Span. ScaleSpan Gets the scale span. ZoomInMax Boolean, True when profile if fully zoomed in ZoomOutMax Boolean, True when profile is fully zoomed

out.

Methods

Method AutoScale

Description Autoscale the graph based profile max and min values.


P/N 6510020317 Rev 02 10/27/11 10-25

Method ClearProfile

Description Clears the Measurement Profile

Parameters Boolean If True then it fires the MeasurementLoaded event. If False it does not fire the MeasurementLoaded event.

Method GetMinPosition

Description Returns the minimum x-location.

Method GetMaxPosition

Description Gets the max position.

Method GetStreakData

Description Gets the streak data.

Parameters qcsStreakVariable qcsStreakVariable

Method MoveCursor

Description Moves the cursor.

Parameters direction The direction in which to move the cursor. zones The number of zones.

Method SetPrintLayout

Description Sets the print layout.

Method SetScreenLayout

Description Sets the screen layout.

Method SetupRangeForHighRes

Description Setups the range for high res.

Parameters startIndex Start range index endIndex End range index interval Interval


10/27/11 P/N: 6510020317 Rev 02 10-26

totalProfile Total count of profile items profileIndex Profile index displayUnit Display unit

Method SetupXAxis

Description Setups the X axis.

Parameters maximumVal Start range index minimumVal End range index displayUnit Interval totalProfile Total count of profile items profileIndex Profile index

Method UpdateMeasurementScaling

Description Changes the scaling.

Parameters scaleMode Sets the scalemode 0 – Autoscale 1 – Fixed 2 – Span

scaleMax Scale maximum value. If scaleMode = 1 (Range) then sets Y scale maximum to scaleMax, otherwise ignore.

scaleMin Scale minimum value. If scaleMode = 1 (Range) then sets Y scale minimum to scaleMin, otherwise ignore.

scaleRange If scaleMode = 2 (Span) then sets Y scale maximum to variable average + range / 2 and minimum to average – range / 2, otherwise ignored

Method UpdateMeasurementSelection

Description Displays the profile.

Parameters ProductionLineIdentifier Production line e.g. “PM 1”

FrameIdentifier Data from id field of Frame table in RTDR, eg. “SCN1”

MeasurementIdentifier Data from Description field of Measurement table in RTDR, e.g. “Upper Air Gap Temp”

MeasurementArrayIdentifier

Data from id field of MeasurementArray table in RTDR, e.g. “UAG11NA”


P/N 6510020317 Rev 02 10/27/11 10-27

ModeIdentifier “Absolute” “Percent around average” “Absolute around average” “Percent around setpoint” “Absolute around setpoint”

Method ZoomIn

Description Zooms in on the profile component.

Method ZoomOut

Description Zooms out on the profile component.

Method Freeze

Description Makes a snapshot of the current profile and leaves this frozen on the graph while allowing new profiles to appear. The default color of the frozen profile is yellow. Call Freeze again to remove the frozen profile.

Events

Event: CurrentBinChanged

Description: Occurs when current bin is changed.

Event: FrozenStatusChanged

Description: Event handler for frozen status changed.

Event: GraphZoomed

Description: Event handler for zooming..

Event: MeasurementConnectionStatusChanged

Description: Occurs when measurement connection status is changed.

Event: MeasurementLoaded

Description: Occurs when measurement is loaded.


10/27/11 P/N: 6510020317 Rev 02 10-28

Event: MeasurementUpdated

Description: Occurs when measurement is updated.

The following script code in the OnPageComplete event handler gives you a Measurement Profile showing the Basis Weight measurement with a specific y-scale.

QcsMeasurementProfile.ClearProfile (true)

QcsMeasurementProfile.UpdateMeasurementSelection "PM 1", "SCN1", "Basis Weight", "BW11TN”", "Absolute"

QcsMeasurementProfile.updateMeasurementScaling 1, 20, 12, 0

10.3.2. Color Grid QcsColorGrid ( ) displays the set of array data in a two-dimensional plot using colors to indicate the amplitude of the data. This display is typically used to analyze a series of profile arrays from scanning sensors, however, this can also be used to plot any array data in the database.

Using the built-in logic, the QcsColorGrid component establishes a connection with the QCS System to retrieve the required array data. This component also retrieves settings and persistence information from the QCS system.

Profile arrays can be viewed in 2D or 3D mode. The QcsColorGrid component supports several frequency modes (Linear, Logarithmic and dB) to locate any dominant frequencies that contribute to the variations in the measurement.

Properties


Average Gets the Average value of the whole scan data collection.

BinNumber Gets the selected Bin number. TimeStamp Gets the time stamp. VariableName Gets the name of the variable. StartDateTime Gets the start date time. EndDateTime Gets the end date time. CursorValue Gets the cursor value. DisplayMode Gets or sets the display mode. EventPosition Gets the events position. Events Gets the list of events (Roll change, grade change). MaxBinCount Gets/Sets the maximum bin count.


P/N 6510020317 Rev 02 10/27/11 10-29

MaxScanCount Gets/Sets the Maximum scan count . Maximum Gets the Maximum value of the whole scan data

collection. Minimum Gets the Minimum value of the whole scan data

collection. OnLineEnabled Gets or sets the online mode. ProductionLine Gets the name of the selected production line. ScaleMax Gets or sets the scale max. ScaleMin Gets or sets the scale min. ScaleMode Gets or sets the graph scale mode. ScaleRange Gets or sets the scale range. ScanNumber Gets the selected scan number. ShowCursorLines Gets/Sets the cursor line visibility status. StreakDataAvailable Gets a value indicating whether [streak data

available]. View3DMode Gets a value indicating whether 3D view is on.

Methods

Method: Connect

Description: Create connection to the QCS system.

Method: AllowNewData

Description: Gets the actual data and activate the automatic fetching when new data is available.

Parameters: productionLine Production line measurementID Array trend record number from

the Array Trend Buffer table in the host RTDR (first record is 0)

allowNewData true: Fetch automatically new data

Method: GetData

Description: Gets the actual data.

Parameters: productionLine Production line measurementID Array trend record number from

the Array Trend Buffer table in the host RTDR (first record is 0)

Method: AddScan

Description: Adds the single scan to the series.

Parameters: data[] Data values in scalar array


10/27/11 P/N: 6510020317 Rev 02 10-30

DateTime Date & Timestamp QcsGraphScaleMode Sets how colorgrid is scaled

0 - Automatic 1 - Range 2 – Span 3 – Step

Method: AddScanCollection

Description: Adds the collection of scans to the series.

Parameters: data[] Data values in scalar array DateTime[] Date & Timestamp in scalar array QcsGraphScaleMode Sets how colorgrid is scaled

0 - Automatic 1 - Range 2 – Span 3 – Step

deleteOldest true: Old values are deleted

Method: Clear

Description: Clears the series and scan collection classes.

Method: Dispose

Description: Clean up any resources being used.

Method: LoadPersistenceSettings

Description: Loads the persistence settings.

Method: SelectDataPoint

Description: Gets the datapoint value from the colorgrid.

Parameters: xPos X-position value

yPos Y-position value

Method: SetCursorPosition

Description: Sets the cursor position.

Parameters: xPos X-position value

yPos Y-position value

Method: SetDisplayMode


P/N 6510020317 Rev 02 10/27/11 10-31

Description: Sets the display mode.

Parameters: QcsColorGridDisplayMode

Defines the display mode how values are present 0 – Normal 1 – Linear 2 – Log 3 – dB 4 – Streak 5 – Limits

Method: SetPrintLayout

Description: Sets the print layout.

Method: SetScreenLayout

Description: SetScreenLayout().

Method: SetScaleMode

Description: Sets the graph scale mode.

Parameters: QcsGraphScaleMode Sets how colorgrid is scaled 0 - Automatic 1 - Range 2 – Span 3 – Step

max Scale max value

min Scale min value

span Span value

Method: SetViewMode

Description: Change the view mode to 2D or 3D.

Parameters: viewMode True: Data values are shown in 3D mode. False: Data values are shown in 2-dimensional plot.

Method: ShowInfoPanel

Description: Show/Hide the info panel.

Parameters: showPanel true: Infopanel is visible false: Infopanel is hidden


10/27/11 P/N: 6510020317 Rev 02 10-32

Method: ShowNumericValues

Description: Opens the numeric dialog box.

Method: Zoom

Description: Sets the graph scale mode.

Parameters: x0 Left point of the zoomed area

x1 Right point of the zoomed area

y1 Bottom point of the zoomed area

Method: UndoneZoom

Description: Zoom back to original state.

Events

Event: ColorGridClicked

Description: Occurs when colorgrid is clicked.

Event: ColorGridConnectionStatusChanged

Description: Occurs when colorgrid connection status is changed.

Event: ColorGridOnLineStatusChanged

Description: Online status change.

Event: ColorGridReFreshed

Description: Indicate ColorGrid changes.

Event: ColorGridScaleChanged

Description: Indicate ColorGrid changes.

Event: ColorGridStreakDataAvailable

Description: Occurs when Streak data available status changes.

Event: ColorGridUndoneZoom


P/N 6510020317 Rev 02 10/27/11 10-33

Description: Occurs when color grid is un zoomed.

Event: ColorGridZoomed

Description: Occurs when color grid is un zoomed.

You can use the following script code in the OnPageComplete event to view a profile map.

ColorGrid01.Connect ColorGrid01.AllowNewData "PM 1", 0, true

The QcsColorGraph should appear as shown below:


10/27/11 P/N: 6510020317 Rev 02 10-34

10.3.3. ArrayChart

QcsArrayChart ( ) displays the numeric array data in graphical format. The QcsArrayChart component establishes connection with the QCS system to retrieve data. The data must be provided from the HDB display. Also, the settings and persistence information for the QcsArrayChart must be set from the display.

QcsArrayChart supports different graph formats like Vertical and Horizontal modes, bar graphs and X-Y plot.

Figure 10-15ArrayChart

Properties


CursorPosition Gets or sets the cursor position. Inverted Gets or sets a value indicating whether graphs are inverted. Range Sets the range. ScaleMax Gets the scale max value. ScaleMin Gets the scale min value. Stairs Gets or sets a value indicating whether series is shown in stairs mode. VerticalMode Gets or sets a value indicating whether graph is in vertical mode. ZoomedX0 Gets/Sets the zoom position (X0) ZoomedX1 Gets/Sets the zoom position (X1) ZoomedY0 Gets/Sets the zoom position (Y0) ZoomedY1 Gets/Sets the zoom position (Y1)


P/N 6510020317 Rev 02 10/27/11 10-35

Methods

Method AddSeries

Description Adds the new series type to the QcsArrayChart.

Parameters seriesID Series ID. series type Series Type

line points histogram bar

description Description of the series color Series color separate axes True: Series uses separate x-y axes

False: Series uses common axes

Method ShowScalarData

Description Adds the scalar array values to the given series.

Parameters seriesID Series ID. scalarDataArray Numeric array to show

Method ShowArrayData

Description Adds the x and y array values to the given series

Parameters seriesID Series ID. xArray Data values (array) to the x-axis

yArray Data values (array) to the y-axis

Method ShowEvents

Description Show the event data. Events are indicated by drawing the line with event description.

Parameters dateTime Datetime for the event value. eventStringArray Event value/description array

Method ClearSeriesData

Description Clears the series data.

Method ClearOneSeriesData seriesID

Description Clears the series data.

Parameters seriesID Series ID


10/27/11 P/N: 6510020317 Rev 02 10-36

Method SetRange

Description Sets the x-axis range.

Parameters min Minimum range value

max Maximum range value

Method SetScale

Description Sets the y-axis scale.

Parameters min Minimum scale value

max Maximum scale value

Method RemoveSeries

Description Removes series from the graph.

Parameters seriesId Series ID

Method RemoveAllSeries()

Description Remove all series from the graph.


Method RemoveEvents ()

Description Removes all events from the graph.

Method SetXY

Description Change the graph mode to X-Y Plot.

Parameters enabled True: X-Y plot mode is enabled False: X-Y plot mode is disabled

Method GetCursorPosition

Description Gets the cursor position.

‘

Method GetCursorValue

Description Gets the series value where cursor points.


P/N 6510020317 Rev 02 10/27/11 10-37

Events

Event: ArrayChartClicked

Description Occurs when graph area in QcsArrayChart is clicked.

Event: ArrayChartZoomed

Description Occurs when graph area in QcsArrayChart is zoomed.

Event: ArrayChartUnZoomed

Description Occurs when QcsArrayChart is zoomed back to original state

10.3.4. Trend

QcsTrend ( ) control allows up to four variables to be rendered in a given time period and scaling. The control is also capable of showing historical trend data when it is cumulated. The variables can be displayed as a separated graphs as seen in following figure, or they can share one graph where all the variables are rendered, or any combination of these.

Figure 10-16Trend

The Trend control can also be configured to view only one variable at a time. This option is used in standard Mini Trend popup display.

The variables, which can be trended must first be configured using the Trend Plot Setup. The color definitions can also be changed from the same setup display.

Properties


10/27/11 P/N: 6510020317 Rev 02 10-38


AverageValue1 AverageValue4

Gets the average value of the trend variable. AverageValue1 corresponds to variable 1, AverageValue2 to variable 2 and so on.

AxisStyle Gets the axis style as follows: 0 - 1/2/3/4 : All variables in separate graphs (default) 1 - 1-2/3/4 2 - 1/2/3-4 3 - 1-2/3-4 4 - 1-2-3-4 : All variables in same graph

CursorDateTime Gets the timestamp at cursor position. CursorValue1 CursorValue4

Gets the value at cursor position.

DisableControl Gets or sets a value indicating whether control is in disabled mode. MaxValue1 MaxValue4

Gets the maximum value for the variable.

MinValue1 MinValue4

Gets the minimum value for the variable.

OnLineEnabled Gets or sets the online mode. Period Gets the period in minutes for the graph. RangeValue1 RangeValue4

Gets the range of Y values.

SpreadValue1 SpreadValue4

Gets the spread of Y values.

Trend1 Trend4

Gets the trend variable description.

TrendCount Gets or sets the maximum number of trend variables as follows: 1 - only one variable 4 - up to four variables (default)

Methods

Method ClearTrendGraph

Description Clears the trend variable from graph.

Parameters index Variable index (starting from 0).

Method Connect()

Description Create connection to the QCS system.



P/N 6510020317 Rev 02 10/27/11 10-39

Description Locates the maximum value of the trend variable and sets the cursor to that location.



Description Locates the minimum value of the trend variable and sets the cursor to that location.


Method GetScaleMode

Description Gets variable’s current scaling information as vector object. Vector contains following elements: [0] - Scale mode [1] - Scale Max [2] - Scale Min [3] - Scale range [4] - Variable description.


Method GetTrendColor

Description Gets variable’s color as Windows color.


Method GetTrendVariable

Description Gets current trend variables as vector object.

Method GetTrendVariables

Description Gets trend variable as an object.


Method PauseTrendDraw


Parameters pauseTrend Boolean values for setting pause or resume.

Method RemoveTrendVariable

Description Removes the trend variable from graph.



10/27/11 P/N: 6510020317 Rev 02 10-40

Method ScrollBackwardTrendData

Description Scrolls the trend backwards by the period defined with percentToScroll.

Parameters percentToScroll Percentage of the full period.

Method ScrollForwardTrendData

Description Scrolls the trend forwards by the period defined with percentToScroll.


Method ScrollToCurrentTrendData

Description Scrolls the trend to the latest data value.

Method SetAxis

Description Sets the layout how variables are rendered.

Parameters axisStyle Refer to AxisStyle property for supported values.

Method SetPeriod

Description Sets the X axis period in minutes.`

Parameters period Period in minutes.


Description Sets the print layout for the control.

Method SetScaleMode

Description Sets the scale mode for a trend variable.

Parameters index Variable index (starting from 0). mode Sets the scale mode

0 – Autoscale 1 – Range 2 – Span

maximum If mode = 1 (Range) then sets Y scale maximum to maximum, otherwise ignore.

minimum If mode = 1 (Range) then sets Y scale minimum to minimum, otherwise ignore.

span If mode = 2 (Span) then sets Y scale maximum to variable average + range / 2 and minimum to average – range / 2, otherwise


P/N 6510020317 Rev 02 10/27/11 10-41

ignored


Description Sets the screen layout for the control.

Method SetTrendVariables

Description

Parameters index Variable index (starting from 0) productionLine Production line name variableID Trend variable ID, refers to a record in

trend buffer table.

Method ShowCalendar

Description Opens the date and time selection dialog box.

Method ShowCursor

Description Sets the cursor mode.

Parameters mode Cursor mode 0 – Now value 1 – Cursor 2 – Event info

Method ShowEventInfo

Description Opens the event info dialog box.

Parameters defaultEvent The event selected from the list as default

Method ShowNumericValues

Description Opens the dialog box showing the numeric values of the trend variables.

Events

Events TrendConnectionStatusChanged

Description Occurs when trend connection status is changed.

Events TrendCursorChanged

Description Occurs when the cursor location changes.


10/27/11 P/N: 6510020317 Rev 02 10-42

Events TrendLayoutChanged

Description Occurs when trend layout changed.

Events TrendOnLineStatusChanged

Description Occurs when the on-line status changes.

Events TrendPeriodValueChanged

Description Occurs when the graph period changes.

Events TrendRefreshed

Description Occurs when trend's y-axis scaling change is requested.

Events TrendScaleChangeRequest

Description Occurs when trend's y-axis scaling change is requested.

Events TrendVariableNameChanged

Description Occurs when trend variable changes.

10.3.5. Table QcsTable ( ) displays data in a tabular format. The QcsTable can display data such as Numerical values, Strings, Buttons, Checkboxes, Status images, and Combo boxes. The QcsTable can display data in editable and non-editable cells.

Figure 10-17 Table

The data in a QcsTable is not automatically retrieved from any external source, but is set using script code.

Properties


P/N 6510020317 Rev 02 10/27/11 10-43


Row Gets the selected row index. Column Gets the selected column index. ColumnCount Gets or sets the number of columns required for the table RowCount Gets or sets the number of rows required for the table

SheetCount

Gets or sets the specified number of Spread Sheets

ColumnHeaderVisible Gets or Sets a boolean value to show/hide a column header. True = Show Fales = Hide

RowHeaderVisible

Gets or Sets a boolean value to show/hide a row header. True = Show Fales = Hide

Borderstyle3D Set value as True for a 3D border style BorderstyleSingle Set value as True for Fixed Single border style. ActiveSheet Gets or sets the active sheet number. Editmode Sets a boolean value to indicate whether the Table is in

editable or non-editable mode.. EditModePermanent Gets or Sets a boolean value to change the Table into

focus mode. True = Table loses the focus. False = Table retrievs the focus.

EditModeReplace Gets or sets a boolean value for cell in edit mode to verify whether the existing contents of a cell in the component are selected.

ProtectSheet Sets a boolean value to protect active sheet True = Protected False = Non-Protected

OperationMode Gets or sets a integer value to change the Operation mode,a s follows: 0 - Normal 1 - ReadOnly 2 - RowMode 3 - SingleSelect 4 - MultiSelect 5 – ExtendedSelect

TableWidth Gets or sets a integer valuse to define a Table width.

TableHeight Gets or sets a integer value to define Table height. EnableCellTextAdjustment Gets or sets a boolean value to whether the cell text

adjustment is enabled in the table. TableSkinStyle Sets a index value between 0 to 13 for a table skin style.

0 – Classic 1 – Shamrock


10/27/11 P/N: 6510020317 Rev 02 10-44


2 -- Sandstorm 3 --ArcticSea 4 – Metallic 5 – Grayscale 6 – Sunburst 7 – Seashell 8 – Pastel 9 – Rose 10 – Newspaper 11 – Midnight 12 – Skins 13 -- printable skin Default is 0

GrayAreaColor Sets a integer value of RGB color or win32 color in the coloured gray area of the QCS spread sheet using vbscript rgb() method. For example: R can take value from 0 to 255 G can take value from 0 to 255 B can take value from 0 t0 255 Hence, the RGB color value can be set as GrayAreaColor = rgb(190,255,190).

BorderstyleNone Sets a boolean value for border style none. BlinkMode Gets or sets a boolean value to enable or disable a blink

mode in QCS table. CellBackColor Gets the background color of the cell in win32 integer

color format . CellForeColor Gets the forecolor of the cell in win32 integer color

format. LockedCellBackColor Gets the background color of the locked cell in win32

integer color format. LockedCellForeColor Gets the forecolor of the locked cell in win32 integer color

format. HorizontalGridLineMode Gets or sets integer value for the horizontal grid line mode

as follows: 0 - None 1 - Flat 2 - Lowered 3 - Raised

VerticalGridLineMode

Gets or sets a integer value for the vertical grid line mode as follows: 0 - None 1 - Flat 2 - Lowered 3 - Raised

ColHeaderHorizontalGridLine Gets or sets a integer value for the column header


P/N 6510020317 Rev 02 10/27/11 10-45

Property Description Mode horizontal grid line mode as follows:

0 - None 1 - Flat 2 - Lowered 3 - Raised

ColHeaderVerticalGridLineMode

Gets or sets a integer value for the column header vertical grid line mode as follows: 0 - None 1 - Flat 2 - Lowered 3 - Raised

RowHeaderHorizontalGridLineMode

Gets or sets a integer value for the row header horizontal grid line mode as follows: 0 - None 1 - Flat 2 - Lowered 3 - Raised

RowHeaderVerticalGridLineMode

Gets or sets a integer value for the row header vertical grid line mode as follows: 0 - None 1 - Flat 2 - Lowered 3 - Raised

HorizontalGridLineColor Gets or sets win32 integer color format for the color of the horizontal grid line.using vbscript rgb() method. For example: R can take value from 0 to 255 G can take value from 0 to 255 B can take value from 0 t0 255 Hence, the RGB color value can be set as HorizontalGridLineColor = rgb(190,255,190).

VerticalGridLineModeColor Gets or sets win32 integer color format for the color of the vertical grid line. using vbscript rgb() method. For example: R can take value from 0 to 255 G can take value from 0 to 255 B can take value from 0 t0 255 Hence, the RGB color value can be set as VerticalGridLineModeColor = rgb(190,255,190)

AllowSheetCorner Gets or sets a boolean value indicating whether sheet corner is enabled or disabled.

ZoomFactor Gets or sets a floating value for the scaling factor for displaying this sheet.

ColumnHeaderWordWrap Gets or sets a boolean value for the column header word wrap setting.


10/27/11 P/N: 6510020317 Rev 02 10-46

Methods

Method SetCellValue

Description Sets the cell value by providing the data value, and the row and column number of a specific cell in the table...

Parameters Row Takes integer value and used for passing row number.

Column Takes integer value and used for passing column number.

Data Takes object value and used for passing cell value.

Return value Boolean If True then value got assigned to the specified cell or if False then value not got assigned

Method SetCellLocked

Description Sets the cell locked by providing the row and column number of a specific cell in the table.

Parameters row Takes integer value and used for passing row number

column Takes integer value and used for passing column number

locked Takes Boolean value and if True then specified cell gets locked or if False then cell not gets locked.

Method SetColumnHeader

Description Sets the table column by providing data value, and the Column number of a specific cell in the table.

Parameters column Takes integer value and used for passing column number.

Data Takes string value and used for passing column value.

Method SetColumnHeaderFont

Description Sets the column header font by providing font, size and style parameter, and the column number of a specific cell in the table..

Parameters column Takes integer value and used for passing column number and If column = -1 then all column headers are affected.

font Takes string value and used for setting the font of the column by passing value like bold, italic.

size Takes float value and used for setting size of the column.


P/N 6510020317 Rev 02 10/27/11 10-47

style Takes string value and used for setting style of the column like Arial, Times new Roman.

Method SetColumnHeaderForeColor

Description Sets the column header text color by providing a column number of a specific cell in the table.

Parameters column Takes integer value and used for passing column number and If column = -1 then all column headers are affected.

color Takes win32 integer value and used for setting fore color.

Method SetRowHeader

Description Sets the table row header by providing data value, and the row number of a specific cell in the table.

Parameters row Takes integer value and used for passing row number.

data Takes string value and used for passing row header value.

Method SetColumnWidth

Description Sets the width of the column by providing data value, and the column number of a specific cell in the table.


data Takes float value and used for setting column width.

Method SetRowHeaderWidth

Description Sets the width of the rowHeader by providing data value, and row number of a specific cell in the table.

Parameters data Takes float value and used for setting rowheader width and if value is -1 then all row Headers will gets effected

Method SetRowHeight

Description Sets the height of the row by providing data value, and the row number of a specific cell in the table..


data Takes float value and used for passing row height.


10/27/11 P/N: 6510020317 Rev 02 10-48

Method SetColumnHeaderHeight

Description Sets the height of the column headers

Paramters data Desired column height in pixels

Method SetColumnAlignment

Description Sets the column alignment. by providing data value, and the column number of a specific cell in the table.


data Takes string value and used for setting column alignment like left, right or center.

Method SetRowHeaderAlignment

Description Sets the row header alignment by providing data value, and the row number of a specific cell in the table.

Parameters data Takes string value and used for setting row header alignment like left, right or center.

Method SetCellBackColor

Description Sets the background color of the cell by providing rgbcolor, and the row and column number of a specific cell in the table.

Parameters row Takes integer value and used for passing row number and If row = -1 then all rows are affected

column Takes integer value and used for passing column number and If column = -1 then all columns are affected

rgbcolor Takes win32 integer value and used for setting background color, using vbscript rgb() method For example: R can take value from 0 to 255 G can take value from 0 to 255 B can take value from 0 to 255 Hence, the RGB color value can be set as SetCellBackColor(0,0,rgb(190,190,190))

Method SetCellNumberFormat

Description Sets the format of the cell to handle decimal precisions which is set by decimalCount, and the row and column number of a specific cell in the table.

Parameters row Takes integer value and used for passing row


P/N 6510020317 Rev 02 10/27/11 10-49

number column Takes integer value and used for passing column

number decimalCount Takes integer value and used to set precision

minValue Takes double value and used for the minimum value allowed for user entry

maxValue Takes double value and used for the maximum value allowed for user entry

Return value: bool Returns Boolean value and if it returns true then formatting is successful or it returns false.

Method SetCellGenFormat

Description Sets the data to the general format cell type by providing the row and column number of that cell in the table.



data Takes string value and used for setting the value to the cell

Return value: bool Returns Boolean value and if it returns true then data is set successful or it returns false.

Method SetCellImageFormat

Description Sets the cell image from the specified data file path.


column Takes integer value and used for passing column number.

data Takes string value and used for setting file path like D:\\Logos\\logo.jpg.

Return value: bool Returns Boolean value and if it returns true then image is set to the specified cell or it returns false.

Method SetCellValueArray

Description Sets the value to combo box cell type by providing data value for the specified cell.



data Takes object array value and used to set value to the cell.



10/27/11 P/N: 6510020317 Rev 02 10-50

Method SetCellProgressBarFormat

Description Sets the progress bar format to the cell by providing the row and column number of that cell in the table.



data Takes string value like lefttoright, righttoleft, toptobottom or bottomtotop and used to set orientation of the progress bar.

orientation Returns Boolean value and if it returns true then image is set to the specified cell or it returns false.

rgbFillColor Takes win32 integer number and used to set fill color.

rgbForeColor Takes win32 integer number and used to set foreground color.

minimum Takes integer value and used to set minimum value to the progress bar.

maximum Takes integer value and used to set maximum value to the progress bar

showText Takes Boolean value and if it is set to true then text is shown on progress bar

Return value: bool Returns boolean value and if it returns true then

progress bar is set to the specified cell or it returns false

Method SetCellAlignments

Description Sets the alignments of the cell by taking values from horizontalAlignment and verticalAlignment .



horizontalAlignment This takes string value and takes the value like "LEFT", "CENTER", or "RIGHT"

verticalAlignment This takes string value and takes the Value like "TOP", "CENTER", or "BOTTOM"


Method SetTableFont

Description Sets the font of the entire table for the specified font, size and style parameter.


P/N 6510020317 Rev 02 10/27/11 10-51


column Takes float value and used for setting size of the column

style Takes string value and used for setting style of the column like Arial, Times new Roman

Method SetSheetTabFont

Description Sets the font for the sheet tab by providing font and size parameter.

Parameters font Takes string value and used for setting the font of the column by passing value like bold, italic.


Method SetRowHeaderFont

Description Sets the table rowheader font by providing font, size and style parameter, and the row number of a specific cell in the table..

Parameters row Takes integer value and used for passing row number and If row = -1 then all rows are affected

font Takes string value and used for setting the font of the column by passing value like bold, italic.

size Takes float value and used for setting size of the column

Style Takes string value and used for setting style of the column like Arial, Times new Roman

Method SetRowHeaderForeColor

Description Sets the foreground color of the row Header by providing the color value, and the row number of a specific cell in the table.

Parameters row Takes integer value and used for passing row number and If row = -1 then all rows are affected.

color Takes win32 integer value and used for setting fore color using vbscript rgb() method For example: R can take value from 0 to 255 G can take value from 0 to 255 B can take value from 0 to 255 Hence, the RGB color value can be set as SetRowHeaderForeColor = (0,rgb(190,190,190))

Method SetHorizontalScrollBarVisible

Description Sets the horizontal scroll bar visible.

Parameters row Takes string value like AsNeeded, Always or


10/27/11 P/N: 6510020317 Rev 02 10-52

Never and default is AsNeeded.

Method GetCellValue

Description Gets the cell value from the specified row and column number.



Return value: object Returns cell value in object format

Method SetCellTag

Description Sets the customData reference into the cell memory by providing a row and column number of a specific cell in the table. But internally this reference is stored in the Hash table.



customData Takes object value and used to store reference into cell.

Method GetCellTag

Description Gets the object reference from the cell memory by providing row and column number of that cell in the table. But internally this reference is returned from the Hash table

Parameters row This is used to takes double value column This is used to take integer number of digits for

calculating precision

Return Value: object Returns object reference from the cell

Method SetCellStatusIconImage

Description Sets status icon image to the cell with the StatusColor by providing a row and column number of a specific cell in the table



StatusColor Color Name of the Cell status Icon;Available Colors are{"green","red","gray"}.

Return value: bool Returns Boolean value and if it returns true then status color is set successful or it returns false.

Method SetColWidthPercentages

Description Sets the column width in terms of percentage by providing


P/N 6510020317 Rev 02 10/27/11 10-53

colWidthPercentages as array. For example, colWidthPercentagesArray(0) = 30 colWidthPercentagesArray(0) = 30 SetColWidthPercentages(colWidthPercentages).

Parameters colWidthPercentages Takes object value and used to set column width.

Method SetCellComboBoxFormat

Description Creates a new combo box cell with default settings by providing a row and column number of specific cell in the table.



Return value: bool Returns Boolean value and if it returns true then setting combo box is successful or it returns false.

Method AddStringsToCmbBoxCell

Description Adds the strings to combo box cell for the specified row and column number.



StringItem This takes string value and used to add items to combo box.

Return value: bool Returns Boolean value and if it returns true then adding items to combo box is successful or it returns false.

Method ResetCmbBoxCellContent

Description Resets the content of the combo box cell by referring to row and column number of a specific cell in the table.



Return value: bool Returns true for success.

Method SetSelectedIndexCmbBoxCell

Description Sets the selected index of the combo box cell by providing a row and column number of a specific cell of the table.


column Takes integer value and used for passing column


10/27/11 P/N: 6510020317 Rev 02 10-54

number.

Return value: bool Returns true for success.

Method GetSelectedIndexCmbBoxCell

Description Gets the selected index of the combo box cell by referring to row and column number of that cell in the table.



Return value: int Returns selected index in integer format.

Method GetSelectedItemCmbBoxCell

Description Gets the selected item of the combo box cell by referring to row and column number of that cell in the table..



Return value: string Returns selected item from combo box in string format.

Method SetCellBlinkColor

Description Sets the color of the cell blink by providing rgbBlinkColor, and the row and column number of a specific cell in the table..



rgbBlinkColor Takes win32 integer value and used for setting blink color for the cell by using vbscript rgb() method For example: R can take value from 0 to 255 G can take value from 0 to 255 B can take value from 0 to 255 Hence, the RGB color value can be set as SetCellBlinkColor(1,0,rgb(10,190,190))

Return value: Bool Returns boolean value and if it returns True then setting the blink color is successful or it returns false.

Method SetCellBlinkState

Description If BlinkMode property of the table is enabled, then this method sets the


P/N 6510020317 Rev 02 10/27/11 10-55

Blink state of the cell other wise it will not have effect on blink state cell.



blink True enables the blink feature. False disabled the blink feature.

Return value: Bool Returns boolean value and if it returns true then setting the blink state to the cell is successful or it returns false.

Method SetSheetCorner

Description Sets the data string to sheet corner.

Parameters data Takes string value and used to set text in the corner of the sheet.

Return value: Bool Returns boolean value and if it returns true then setting the text to the sheet corner is successful or it returns false.

Method SetSheetCornerFont

Description Sets the font of the sheet corner text by providing font, size and style parameters.

Parameters font Takes string value and used for setting the font of the column by passing value like bold, italic.


style Takes string value and used for setting style of the column like Arial, Times new Roman.

Return value: Bool Returns boolean value and if it returns true then setting the font for the text of sheet corner is successful or it returns false.

Method SetSheetCornerForeColor

Description Sets the foreground color of the Sheet corner for the specified RGBColor.

Parameters RGBColor Takes win32 integer value and used for setting fore color by using vbscript rgb() method For example: R can take value from 0 to 255 G can take value from 0 to 255 B can take value from 0 to 255 Hence, the RGB color value can be set as SetSheetCornerForeColor(rgb(10,190,190))

Return value: Bool Returns boolean value and if it returns true then setting the foreground color of sheet corner is


10/27/11 P/N: 6510020317 Rev 02 10-56

successful or it returns false.

Method SetCellButtonFormat

Description Sets the text for the button cell by providing a row and column number of a specific cell with status in the table.



btnText Takes string value and used to set text for the button.

Return value: Bool Returns boolean value and if it returns true then setting the text to the button cell is successful or it returns false.

Method SetColumnHeaderRowCount

Description Sets the specified number of rows in the column header.

Parameters count Takes integer value and used to set specified number of rows inside column header.

Method SetColumnHeaderSpanCellHeightWise

Description Sets the column header height for the specified row number.


height Takes float value and used to set height of the column header.

Method SetColumnHeaderCells

Description Sets the labels for the spanned column header cells by providing a row and column number of a specific cell in the table.



value Takes string value and used to set the labels for the column header.

Method SetColumnHeaderSpanCellWidthWise

Description Set the column header cell spans for the specified column count.



colCount Takes integer value and used to span the columns.


P/N 6510020317 Rev 02 10/27/11 10-57

Method SetCellBorder

Description Sets the cell border for the specified row and column number.



color Takes string value and used to set color like red, blue, green.

thickness Takes integer value and used to set thickness of the cell border

Left, top, right, bottom

Takes boolean value and used to set border line.

Method SetColumnHeaderResizable

Description Sets the column header resizable.


resize Takes boolean value and if it is true then specified column is not resizable.

Method ShowRow

Description Changes position of visibility of a row, specified in row parameter at the required row position specified in the rowViewportIndex parameter of this method..

Parameters rowViewportIndex Takes integer value and used for setting Row index of viewport that has row.

row Takes integer value and used for passing row number.

verticalPosition Takes string value like top, center, bottom or nearest and by default it is top and used for setting vertical position of the row

Events

Event TableLeaveCell

Description Occurs when the pointer exit from the cell.

Parameters row Gets row number of the previously selected cell.. column Gets column number of the previously selected cell. newRow Gets new row number of the cell to which mouse

pointer is selecting the cell. newColumn Gets new column number of the cell to which mouse

pointer is selecting the cell.


10/27/11 P/N: 6510020317 Rev 02 10-58

Event TableCellChanged

Description Occurs when a cell content is edited or changed by selecting the particular cell. .

Parameters row Gets row number of the previously selected cell. column Gets column number of the previously selected

cell.

Event TableCellClicked

Description Occurs when clicking the cell.

Parameters row Gets currently selected row number of the cell. column Gets currently selected column number of the cell.

Event TableCellDoubleClicked

Description Occurs when double-clicking the cell.


Event TableEnterCell

Description Occurs when entering into the cell.


Event TablePreviewKeyDown

Description Occurs when cell is selected using the pointer, and any key is pressed such as Down Arrow, Up Arrow, or Tab Key and so on. .

Parameters keyValue Gets key value in ASCII format.

Event TableCmbboxCelSelChanged

Description Occurs when Combo box cell selection is changed .

Parameters row Gets currently selected row number of the cell. column Gets currently selected column number of the

cells. selectedIndex

Gets selected index number of the combo box.

Event TableButtonCellClicked

Description Occurs when table button cell clicked or by pressing [Enter] key.

Parameters row Gets currently selected row number of the cell. column Gets currently selected column number of the


P/N 6510020317 Rev 02 10/27/11 10-59

cell..

The following example shows how to create a simple QCS Table. ' Set the number of rows and columns QcsTable001.RowCount=3 QcsTable001.ColumnCount=4 'Make Headers Visible QcsTable001.ColumnHeaderVisible=True QcsTable001.RowHeaderVisible=True 'QcsTable001.Borderstyle3D = true 'QcsTable001.BorderstyleSingle = true 'QcsTable001.EditMode = false 'QcsTable001.ProtectSheet = true QcsTable001.OperationMode = 1 ' ReadOnly ' QcsTable001.TableSkinStyle = 2 ' Sandstorm ' Set Column Headers QcsTable001.SetColumnHeaderHeight 25 QcsTable001.SetColumnHeaderFont -1, "Bold", 13, "Calibri" QcsTable001.SetColumnHeader 0, "Units" QcsTable001.SetColumnHeader 1, "Reel" QcsTable001.SetColumnHeader 2, "Grade" QcsTable001.SetColumnHeader 3, "Target" ' Set Row Headers QcsTable001.SetRowHeaderWidth 200 QcsTable001.SetrowHeight 0, 25 QcsTable001.SetrowHeight 1, 25 QcsTable001.SetrowHeight 2, 25 QcsTable001.SetRowHeaderFont -1, "Bold", 13, "Calibri" QcsTable001.SetRowHeader 0, "Production" QcsTable001.SetRowHeader 1, "Production Rate" QcsTable001.SetRowHeader 2, "Machine Speed" ' Set the column widths QcsTable001.SetColumnWidth 0, 120 QcsTable001.SetColumnWidth 1, 170 QcsTable001.SetColumnWidth 2, 170 QcsTable001.SetColumnWidth 3, 170 QcsTable001.SetHorizontalScrollBarVisible "Never" QcsTable001.SetVerticalScrollBarVisible "Never" ' Enter Data (row, column) QcsTable001.SetCellValue 0, 0, "kg" QcsTable001.SetCellValue 0, 1, 389.2 QcsTable001.SetCellValue 0, 2, 1204.1 QcsTable001.SetCellValue 0, 3, 200.6 QcsTable001.SetCellValue 1, 0, "mtpd" QcsTable001.SetCellValue 1, 1, 170.5


10/27/11 P/N: 6510020317 Rev 02 10-60

QcsTable001.SetCellValue 1, 2, 155.6 QcsTable001.SetCellValue 1, 3, 2500.2 QcsTable001.SetCellValue 2, 0, "mpm" QcsTable001.SetCellValue 2, 1, 1500 QcsTable001.SetCellValue 2, 2, 1525 QcsTable001.SetCellValue 2, 3, 1550 ' Center align the Units QcsTable001.SetCellAlignments 0, 0, "CENTER", "CENTER" QcsTable001.SetCellAlignments 1, 0, "CENTER", "CENTER" QcsTable001.SetCellAlignments 2, 0, "CENTER", "CENTER"

The table should appear as shown below.

10.3.6. SummaryTable

QcsSummaryTable ( ) is a standalone component which retrieves configurasiton and data directly from the RTDR. An instance of this object is shown below.

xx

Figure 10-18 Summary Table

Properties


ActiveSet Gets or sets the active set index DisableControl Gets or sets a value indicating whether control is in disabled mode.


P/N 6510020317 Rev 02 10/27/11 10-61


ProductionLine Gets or sets the production line name in use RefreshRate Gets or sets the display refresh rate in seconds SelectedFrame Gets the active frame object SelectedMeasurement Gets the active measurement object

Methods

Method Connect

Description Creates connection to the QCS system and activates the data update to control

Events

Event SummaryFrameClicked

Description Occurs when frame hyperlink is clicked.

Event SummaryMeasurementClicked

Description Occurs when measurement hyperlink is clicked.

The following sample script code can be used to initialize the QCS Summary Object. QcsSummaryTable001.ProductionLine = "PM 1" QcsSummaryTable001.ActiveSet = 1 QcsSummaryTable001.DisableControl = false QcsSummaryTable001.Connect

10.3.7. Listbox

QcsListbox ( ) is a control where text items can be listed.


10/27/11 P/N: 6510020317 Rev 02 10-62

Figure 10-19 Listbox

Properties


Count Gets the item count in the listbox DisableControl Gets or sets a value indicating whether control is in disabled mode HorizontalScrollBar Gets or sets a value indicating whether the horizontal scrollbar is

shown if necessary. Default is true. ListBackColor Gets or sets the list back color ListBorderStyle Gets or sets the list border style

0 – No border 1 – FixedSingle 2 – Fixed3D (default)

ListForeColor Gets or sets the list fore color SelectedCount Gets the number of selected items SelectedIndex Gets or sets the index of the selected item SelectedValue Gets or sets the selected item value SelectedValues Gets the selected item values SelectionMode Gets or sets the selection mode

0 – None 1 – One (default) 2 – MultiSimple 3 – MultiExtended

Sorted Gets or sets a Boolean value indicating whether the listbox is alphabetically sorted (default is false)

Methods

Method AddString

Description Adds the item to the list.

Parameters item String item.


P/N 6510020317 Rev 02 10/27/11 10-63

Method DeleteString

Description Deletes the item with the index from the list.

Parameters index Item index (starting with 0)

Method ResetContent

Description Removes all items from the list.

Events

Event ListboxClicked

Description Occurs when listbox is clicked.

Event ListboxSelectionChanged

Description Occurs when listbox selection is changed.

10.3.8. Slider

QcsSlider ( ) allows you to select a value by moving the pointer along the track.

Figure 10-20 Slider

Properties


10/27/11 P/N: 6510020317 Rev 02 10-64


Minimum Gets or Sets the Minimum possible value of the range. Maximum Gets or Sets the Maximum possible value of the range. CurrentValue Gets or Sets the current value SliderStyle Sets the Slider style

VerticalOrientation = false VerticalOrientation = true

0

0

1

1

2

2

3

3

VerticalOrientation Gets or Sets the slider orientation LimitLabelsVisible Gets or Sets the labels visibility ScrollButtonsVisible Gets or Sets the scroll buttons visibility LargeChange Gets or Sets the large change SmallChange Gets or Sets the small change TickFrequency Gets or Sets the tick frequency

Methods


Description Sets the control layout more print friendly.


P/N 6510020317 Rev 02 10/27/11 10-65


Description Restore control layout back to original state from the print layout.

Events

Events: SliderValueChanged

Description: Occurs when range value changed.

10.3.9. NumericUpdown

QcsNumericUpDown ( ) allows you to set a value by typing or by using the Up / Down arrows on the control.

Figure 10-21 NumericUpdown

Properties


ReadOnly True: User cannot enter value directly to the entry field. Up and down arrow buttons are still enabled. False: User can enter values to the entry field.

StepIncrement Gets or Sets the step increment when clicking the up and down arrow buttons.

CurrentValue Gets or Sets the current value Maximum Gets or Sets the maximum range value Minimum Gets or Sets the minimum range value UpDownAlign Gets or Sets the Up and down arrow button positions:

"LEFT": Buttons are left side of the control '"RIGHT": Buttons are right side of the control

TextAlign Gets or Sets the text alignment on the entry field:

LEFT: Text is alignment left side of the entry field. CENTER: Text is alignment center of the entry field. RIGHT: Text is alignment right side of the entry field


10/27/11 P/N: 6510020317 Rev 02 10-66

Methods


Description Sets the control layout more print friendly.


Description Restore control layout back to original state from the print layout.

Events

Events: ValueChanged

Description Occurs when value is changed.

10.3.10. TMMSHistoryTrend Using TMMSHistoryTrend control you can obtain the history trend for Machine

Sentinel measurements ( ). The history trend is shown for the selected TMMS measurement’s key value.

In this Trend plot (as shown in Figure 10-21), there is a red straight line to indicate high alarm level, yellow straight line to indicate low alarm level, and linear graph in yellow dotted line(change in the color occurs based on the value with respect to high and low limits) for trend TMMS measurement and selected Key value. The vertical color line indicates Event changes (only in Event info Cursor Mode)

The Trend Control has three modes:

• Now: Trend data plot till latest trend data is shown and the yellow cursor is not available.

• Cursor: Yellow cursor is available.

• Event info Modes: Event info Vertical lines and Yellow cursors are visible.

This control supports continuous and history data update mode. In continuous update mode, TMMS History Trend control refreshes the data at an interval of one minute.


P/N 6510020317 Rev 02 10/27/11 10-67

Figure 10-22 QCSTMMSHistoryTrend Control in Event info Mode

The TMMS History Trend can plot single STA Machine Sentinel Measurement Key value along with Machine speed Key value trend (when ShowMachineSpeed property is set to true).

Properties


StyleClass Get or set Style Class string name associated with Control

MeasurementConnectionStatus Gets Connection status associated for the provided measurement details

DisableControl Gets or sets a value indicating whether control is in disabled mode.

ShowMachineSpeed Gets or sets a Boolean value to show Machine speed trend in QCSTMMSTrend control

Period Gets or sets time Period value in units of minutes

KeyValueScaleMode Gets Key value trend’s scale Mode, where 0- AutoScale 1- Fixed 2- PercentageKeyValueLimit

KeyValueScaleMax Gets Key value trend’s scale Max value, KeyValueScaleMin Gets Key value trend’s scale Min value KeyValuePercentOfLimits Gets Key value trend’s percentage of limits

scale value MachineSpeedScaleMode Gets Machine speed trend’s scale Mode,

where 0- AutoScale 1- Fixed 2- PercentageKeyValueLimit

MachineSpeedScaleMax Gets Machine speed trend’s scale Max value,

MachineSpeedScaleMin Gets Machine speed scale Min value MachineSpeedPercentOfLimits Gets Machine speed trend’s percentage of

limits scale value KeyValueCursorValue Gets KeyValue Cursor Value


10/27/11 P/N: 6510020317 Rev 02 10-68


MachineSpeedCursorValue Gets Machine speed cursor value CursorDateTime Gets Cursor Datetime value CursorMode Gets or sets Cursor Mode

Where 0-Now 1-Cursor 2- Event info

IsMeasurementLoaded Gets status of whether Measurement is loaded in this control

ProductionLine Gets Production line Id of measurement MachineId Gets Machine line Id of measurement SectionId Gets Section Id of measurement ComponentId Gets Component Id of Component MeasurementId Gets Measurement ID of measurement KeyValueId Gets selected KeyValue ID of

measurement KeyValueUnits Gets Units of Keyvalue MachineSpeedUnits Gets Units of Machine speed KeyValueFillColor Gets Fill Color of KeyValue KeyValueMaxValue Gets KeyValue Max KeyValueMinValue Gets KeyValue Min MachineSpeedMaxValue Gets MachineSpeed Max value MachineSpeedMinValue Gets MachineSpeed Min Value IsHistoryAvailable Gets Boolean to indicate whether History

is available OnLineEnabled Gets Boolean value to indicate whether

Trend is on Online

Methods


Description To Set QcsTMMSRoundnessProfile control in Print layout


Description To Set QcsTMMSRoundnessProfile control in normal layout

Method SetKeyValueSelection

Description To set selected KeyValue to QCSTMMSTrend Control

Parameters productionLine Production line id of measurement

MachineId Machine id of


P/N 6510020317 Rev 02 10/27/11 10-69

measurement

sectionId Section id of measurement

componentId Component id of measurement

measurementId Measurement id

KeyvalueId Selected key value id of measurement

Method SetKeyValueScaleMode

Description Sets the Scale mode for selected Key value trend of the measurement

Parameters

mode

Set the any of below scale modes 0- AutoScale 1- Fixed 2- PercentageKeyValueLimit

maximum

If mode = 1 (Fixed) then sets Y scale maximum to maximum, otherwise ignore.

minimum

If mode = 1 (Fixed) then sets Y scale minimum to minimum, otherwise ignore.

percentOfLimits

If mode = 2 (PercentageofKeyvalueLimits), provide percentage value between 0 to 100 otherwise ignored

Method SetMachineSpeedScaleMode

Description Sets the Scale mode for Machine speed key value trend of the measurement

Parameters

mode

Set the any of below scale modes 0- AutoScale 1- Fixed 2- PercentageKeyValueLimit

maximum

If mode = 1 (Fixed) then sets Y scale maximum to maximum, otherwise ignore.

minimum

If mode = 1 (Fixed) then sets Y scale minimum to minimum, otherwise ignore.

percentOfLimits

If mode = 2 (PercentageofKeyvalueLimits), provide percentage value between 0 to 100 otherwise ignored

Method ShowCalender

Description Opens the date and time selection dialog box.


10/27/11 P/N: 6510020317 Rev 02 10-70

Method ScrollForwardTrendData

Description Scrolls the trend forwards by the period defined with percentToScroll.


Method ScrollBackwardTrendData

Description Scrolls the trend backwards by the period defined with percentToScroll.


Method ScrollToCurrentTrendData

Description Scrolls the trend to the latest data value.

Method PauseTrendDraw


Parameters pauseTrend Boolean values for setting pause or resume.

Method ShowCursor

Description Sets the cursor mode.

Parameters

mode

Cursor mode 0 – Now value 1 – Cursor 2 – Event info

Method GetKeyValueMinPos

Description Gets Keyvalue visible Trend’s Minvalue Position

Method GetKeyValueMaxPos

Description Gets Keyvalue visible Trend’s Max value Position

Method GetMachSpeedMinPos

Description Gets machine speed visible Trend’s Min Position

Method GetMachSpeedMaxPos

Description To Select Node in TreeView Control with specified Key

Events

Events: TrendCursorChanged

Description Occurs when Trend’s cursor position is changed


P/N 6510020317 Rev 02 10/27/11 10-71

Events: TrendRefreshed

Description Occurs when data in Trend gets refreshed

Events: TrendOnLineStatusChanged

Description Occurs when Trend’s Online status is changed

Events: TrendPeriodValueChanged

Description Occurs when Trend’s period value is changed

Events: TrendKeyValueLoaded

Description Occurs when new Key value is loaded

Events: TrendConnectionStatusChanged

Description Occurs when the RTDR connection status changes

Events: MeasurementsConnectionStatusChanged

Description Occurs After any of TreeNode is selected in TreeViewControl

10.3.11. QcsTmmsRoundnessProfile The TMMS Roundness Profile is a Machine Sentinel Roundness profile ( ) control that plots the data using polar format. The ring of data (in Green color in figure 10-22) drawn on the Roundness Profile display represents the variation of measurement that is caused during a rotation of the component, averaged many times(STA – Synchronous Time Averaging). The polar format allows easier evaluation of the pattern of variations that is attributed to the component to be analyzed.

This profile control can be Update Continuously (by default), or can be modified to show only one data that is one data at a time of loading new measurement to this control.


10/27/11 P/N: 6510020317 Rev 02 10-72

Figure 10-23 QCSTMMSRoundnessProfile

This control provides the properties and methods that enable the user to set the scaling and also data & time stamp at which the selected measurement to be shown. Currently this control can plot only one measurement and show real time data only.

Properties



MeasurementConnectionStatus Gets Connection status associated for the provided measurement details

ProductionLine Get or sets production line string Id Meas1MachineId Gets or Sets Machine Id of first

measurement Meas1SectionId Gets or Sets Section Id of first

measurement Meas1ComponentId Gets or Sets Component Id of first

measurement


P/N 6510020317 Rev 02 10/27/11 10-73


MeasurementOneID Gets of Sets first Measurement Id TimeStamp Gets Time Stamp value UnitCode Gets Unit Code of first measurement MachineSpeed Gets Machine Speed of first measurement RoundnessProfileScaleMode Get or sets Profiles scale Mode

0- AutoScale 1- Fixed 2- PercentageKeyValueLimit

IsAutoUpdated Gets or Sets whether Control is in AutoUpdate mode. True – In Auto Update mode otherwise false


Methods


Description To Set QcsTMMSRoundnessProfile control in Print layout


Description To Set QcsTMMSRoundnessProfile control in normal layout


Description To Update QcsTMMSRoundnessProfile Control with Measurement one

Parameters productionLine ProductionLIne Id

meas1Machine Machine Id of measurement one

meas1Section Section Id of measurement one

meas1Component Component id of measurement one

measurementOne Measurement one Id

Method GetMeasurementOneKeyValues

Description Gets array of Key Value objects of Measurement one

Return Value Array of Object Returns array of key Value Objects.


10/27/11 P/N: 6510020317 Rev 02 10-74

Events

Events: MeasurementsLoaded

Description Occurs when Measurements are loaded.

Events: MeasurementsUpdated

Description Occurs when Measurements got updated

Events: MeasurementsConnectionStatusChanged()

Description Occurs when RTDR data connection status changes

10.3.12. TreeView

QcsTreeView ( ) allows you to display a hierarchy of nodes similar to the files and folders that are displayed in the left pane of the Windows Explorer. Each node in the tree view can contain other nodes, called child nodes. Nodes that contain child nodes (Parent Nodes) can be expanded or collapsed.

Figure 10-24 TreeView Control

TreeView Class

Properties


P/N 6510020317 Rev 02 10/27/11 10-75


ImageIndex Gets or sets the image-list index value of the default image that is displayed by the tree nodes. Images in Image-List of TreeView Control is updated by AddImageToImageList(string Path)) method of this control.

SelectedNode Gets a QcsTreeNode object that represents the selected tree node in the TreeView control.

SelectedImageIndex Gets or sets the image list index value of the image that is displayed when a tree node is selected Images in Image-List of TreeView Control is updated by AddImageToImageList(string Path)) method of this control.

TreeViewBackColor Gets or sets the background color for the control in win32 integer color format .

TreeViewBorderStyle Gets or sets the border style of the tree view control. Where 0 – No border (default) 1 – Fixed Single 2 – Fixed 3D

TreeViewForeColor The current foreground color for this control, which is the color (in win32 integer color format) the control uses to draw text .

Indent Gets or sets the distance to indent each child tree node level.

ItemHeight Gets or sets the height of each tree node in the tree view control.

PathSeparator Gets or sets the character that is used to delimit the node values that are specified by the ValuePath property.

RightToLeftLayout Gets or sets a Boolean that indicates whether the TreeView should be laid out from right-to-left.

Scrollable Gets or sets a value indicating whether the tree view control displays scroll bars when they are needed.

ShowLines Gets or sets a value indicating whether lines connecting child nodes to parent nodes are displayed.

ShowNodeToolTips Gets or sets a value indicating ToolTips are shown when the mouse pointer hovers over a TreeNode.

ShowPlusMinus Gets or sets a value indicating whether plus-sign (+) and minus-sign (-) buttons are displayed next to tree nodes that contain child tree nodes.

ShowRootLines Gets or sets a value indicating whether lines are drawn between the tree nodes that are at the root of the tree view.

TopNode Gets or sets the first fully-visible tree node in the tree view control.

VisibleCount Gets the number of tree nodes that can be fully

http://msdn.microsoft.com/en-us/library/system.web.ui.webcontrols.treenode.aspx�

http://msdn.microsoft.com/en-us/library/system.web.ui.webcontrols.treeview.aspx�

http://msdn.microsoft.com/en-us/library/system.web.ui.webcontrols.treenode.valuepath.aspx�

http://msdn.microsoft.com/en-us/library/system.windows.forms.treeview.aspx�

http://msdn.microsoft.com/en-us/library/system.windows.forms.treenode.aspx�


10/27/11 P/N: 6510020317 Rev 02 10-76

Property Description visible in the tree view control.

FullRowSelect Gets or sets a value indicating whether the selection highlight spans the width of the tree view control.

HideSelection Gets or sets a value indicating whether the selected tree node remains highlighted even when the tree view has lost the focus

Methods

Method AddRootNode(string Text, string key)

Description Adds new Root node to QCSTreeView Control

Parameters Text Name of Root Node

Key

Key Value of Root Node. Key value should be unique, which helps in easily searching this node by TreeViewControls Methods.

Return Value QcsTreeNode

Returns QCSTreeNode object of newly added Root node.

Method InsertRootNode

Description Inserts the new RootNode at specified index

Parameters Index Specifies Index value among root node collections of TreeViewControl.

Text Name of Root Node

Key Key Value of Root Node. Key value should be unique, which helps in easily searching this node by TreeViewControls Methods.

Return Value QcsTreeNode Returns QCSTreeNode object of newly inserted Root node.

Method ContainsRootNodeWithKey

Description Verifies whether RootNode with specified Key string value exists in TreeView Control


P/N 6510020317 Rev 02 10/27/11 10-77

Parameters key Unique string value representing RootNode

Return Value bool Returns True – if Root node exits False – if not exits

Method IndexOfRootNodeWithKey

Description Returns index value of Root node in Root node collection of TreeViewControl

Parameters key Unique string value representing RootNode

Return Value Integer value Returns Index value of Root Node if exists otherwise returns -1.

Method RemoveChildNodeAt

Description To remove Child Tree Node at specified Index

Parameters Index Specifies Index value T

Method RemoveChildNodeByKey

Description To remove Child Tree Node specified by Key

Parameters key Unique string value representing Child Node

Method AddImageToImageList

Description To Add images to Image List of TreeView Control

Parameters Path String value of Path & image file location

Method ClearImageList

Description Clear Images in Image-List of TreeView Control

Method CollapseAll

Description Collapses all the tree nodes

Method ExpandAll

Description Expands all the tree nodes.

Method GetNodeCount


10/27/11 P/N: 6510020317 Rev 02 10-78

Description Retrieves the number of tree nodes, optionally including those in all subtrees, assigned to the tree view control.

Parameters includeSubTrees

Boolean. True to count the Tree Node items that the subtrees contain; otherwise, false

Method SelectNodeWithText

Description To Select Node in TreeView Control with specified Text

Parameters SearchText Text String Value

Method SelectNodeWithKey

Description To Select Node in TreeView Control with specified Key

Parameters searchKey Key String Value

Events

Events: NodeMouseClicked

Description Occurs when any of TreeNode in TreeViewControl is Clicked by Mouse Pointer.

Events: NodeMouseDoubleClicked

Description Occurs when any of TreeNode in TreeViewControl is double Clicked by Mouse Pointer.

Events: AfterNodeSelect

Description Occurs After any of TreeNode is selected in TreeViewControl

Events: BeforeNodeSelect

Description Occurs Before any of TreeNode is selected in TreeViewControl

Tree Node Class

Properties


ImageIndex Gets or sets the image list index value of the image displayed when the tree node is in the unselected state.

http://msdn.microsoft.com/en-us/library/system.windows.forms.treenode(v=VS.90).aspx�


P/N 6510020317 Rev 02 10/27/11 10-79


Images in Image-List of TreeView Control is updated by AddImageToImageList(string Path)) method of the TreeView control.

SelectedImageIndex Gets or sets the image list index value of the image that is displayed when the tree node is in the selected state. Images in Image-List of TreeView Control is updated by AddImageToImageList(string Path)) method of the TreeView control.

Name Gets or sets the tree node Name Key.

Text Gets or sets the tree node Name Text.

BackColor Gets or sets the background color for the control. FirstChildNode Gets First Child QCSTreeNode Object of this Node FullPath Gets the path from the root tree node to the current

tree node Index Gets the position of the tree node in the tree node

collection. IsExpanded Gets a value indicating whether the tree node is in

the expanded state. IsSelected Gets a value indicating whether the tree node is in

the selected state. IsVisible Gets a value indicating whether the tree node is

visible or partially visible LastChildNode Gets the last child QCS Tree node Object. Level Gets the zero-based depth of the tree node in the

QCSTreeView control. ParentNode Gets the parent tree node object of the current tree

node NextNode Gets the next sibling tree node NextVisibleNode Gets the next visible tree node. PrevNode Gets the previous sibling tree node. PrevVisibleNode Gets the previous visible tree node. ToolTipText Gets or sets the text that appears when the mouse

pointer hovers over a TreeNode ChildNodeCount Gets Child node Count

Methods

Method Collapse

Description Collapses the TreeNode.

Method Collapse

http://msdn.microsoft.com/en-us/library/system.windows.forms.treeview.aspx�




10/27/11 P/N: 6510020317 Rev 02 10-80

Description Collapses the TreeNode and optionally collapses its children.

Parameters ignoreChildren True to leave the child nodes in their current state; false to collapse the child nodes

Method Expand

Description Expands the tree node.

Method ExpandAll

Description Expands all the child tree nodes.

Method GetNodeCount

Description Returns the number of child tree nodes

Parameters includeSubTrees true if the resulting count includes all tree nodes indirectly rooted at this tree node; otherwise, false

Method Remove

Description Removes the current tree node from the tree view control

For following script code may be used to create a simple instance of a QCS Tree View object.

dim RootNodeRef dim NodeRef 'Add a root node to the QcsTreeView control set RootNodeRef = QcsTreeView.AddRootNode("Frame List","RootNodeKey") 'Add a child node to the root node



P/N 6510020317 Rev 02 10/27/11 10-81

set NodeRef = rootNodeRef.AddChildNode("Wet End Scanner","NodeKey01") 'Add three child nodes to this node NodeRef.AddChildNode "Basis Weight","NodeKey11" NodeRef.AddChildNode "Water Weight","NodeKey12" 'Add a second child node to the root set NodeRef = rootNodeRef.AddChildNode("Dry End Scanner","NodeKey02") 'Add two child nodes to this node NodeRef.AddChildNode "Basis Weight","NodeKey21" NodeRef.AddChildNode "Moisture","NodeKey22" 'Add a third child node to the root set NodeRef = rootNodeRef.AddChildNode("Reel Scanner","NodeKey03") 'Add one child to this node NodeRef.AddChildNode "Basis Weight","NodeKey31" NodeRef.AddChildNode "Moisture","NodeKey32" NodeRef.AddChildNode "Caliper","NodeKey33" 'Expand all nodes in the treeview QcsTreeView.ExpandAll 'Get the number of nodes which can be visible txtMaxVisibleCount = QcsTreeView.VisibleCount() 'Select the Root Node QcsTreeView.SelectNodeWithKey "RootNodeKey" QcsTreeView.BorderStyle = 2 alpha001 = QcsTreeView.GetNodeCount(true)


10/27/11 P/N: 6510020317 Rev 02 10-82

10.3.13. PolarPlot

QcsPolarPlot( ) displays the numeric array data in a graphical format. The QcsPolarPlot component establishes connection with the QCS system to retrieve data. The data must be provided from the HDB display. The settings and persistence information for the QcsPolarPlot must be set from the display. QcsPolarPlot supports Radar Chart also.

Properties




Methods

Method AddSeries

Description Adds the new series type to the QcsPolarPlot.


P/N 6510020317 Rev 02 10/27/11 10-83

Parameters seriesID Series ID. series type Series Type

polar Radar

description Description of the series color Series color

Method SetPointerStyle

Description To Set Pointer Style of the series.


pointerStyle Pointer Style

visible True: Axis visible False: Axis Invisible

Method SetSeriesAxisVisible

Description To set the visibility of Axis


visible True: Axis visible False: Axis Invisible

Method SetLegendVisible

Description To set visibility of Legend Series ID

Parameter

legendVisible

True: Axis visible False: Axis Invisible


10/27/11 P/N: 6510020317 Rev 02 10-84

Method SetLegendPosition

Description To set Position of Legend

Parameter position Position of Legend

Method RemoveSeries

Description To Remove the Series

Parameter seriesId Series ID

Method RemoveAllSeries

Description To remove all the series

Method ClearSeriesData

Description To clear the series data

Method SetSeriesVisible

Description To set visibility of series

Parameter seriesId visible

Series ID True: Series Visible False: Series Invisible

Method SetLegendStyle

Description To set style of Legend

Parameter seriesId legendStyle

Series ID Legend Style

Method SetLegendTextStyle

Description To set Text Style of Legend

Parameter legendTextStyle Legend Text Style


P/N 6510020317 Rev 02 10/27/11 10-85

Method SetSeriesColor

Description To set series color

Parameter seriesId RGBColor

Series ID Series Color

Method SetGridColor

Description To set visibility of Legend

Parameter RGBColor Grid Color


Description To Set QcsPolarPlot control in Print layout


Description To Set QcsPolarPlot control in normal layout

Method ShowArrayData

Description Adds the x and y array values to the given series

Parameter seriesId angleData plotData

Series ID Angle Array Data

Method SetSeriesScale

Description Sets the y-Axis scale

Parameter seriesId maximum minimum

Series ID Maximum Value Minimum Value


10/27/11 P/N: 6510020317 Rev 02 10-86

Method SetSeriesMarks

Description Sets series Marks

Parameter seriesId marksStyle

Series ID Marks Style

Method SetCustomLegend

Description To set custom legend.

Parameter legend Legend value

Method SetSeriesWidth

Description To set series width

Parameter seriesId width

Series ID Series Width

Method GetMinMax

Description Gets minimum and maximum value of an array.

Parameter Data Min Max

Array Minimum Value Maximum Value


P/N 6510020317 Rev 02 10/27/11 10-87

10.3.14. QcsCheckedListbox The QcsCheckedListbox, is a generic control ( ). This control is used to show multiple items and has two types of user visible inputs.

• Checking or Un-checking: In this control a user can check and uncheck multiple items.

• Selecting [Highlighting]: A user can select or highlight a single item at a time.

Properties


Count Gets the item count in the checkedListBox HorizontalScrollBar Gets or sets a value indicating whether the

horizontal scrollbar is shown ListBackColor Gets or sets the color of the list back. ListBorderStyle Gets or sets the list border style where

0 = No border, 1 = FixedSingle, 2 = Fixed3D (default)

ListForeColor Gets or sets the color of the list fore SelectionMode Gets or sets the selection mode where

0 = None, 1 = One (default), 2 = MultiSimple, 3 = MultiExtended

SelectedIndex Gets or sets the index of the selected item. SelectedValue Gets or sets the selected value SelectedCount Gets the selected items count SelectedIndices Gets or sets the selected indices as an

object array SelectedValues Gets or sets the selected values as an object

array


10/27/11 P/N: 6510020317 Rev 02 10-88


CheckedIndices Gets or sets the checked indices as an object array

CheckedValues Gets or sets the checked values as an object array

Sorted Gets or sets a value indicating whether items are sorted.

IsEditable Gets and Sets whether items in control can be renamed

StyleClass Gets or sets the style class UsePersistence Gets or sets the use persistence StationWide Gets or sets a value indicating whether it is

station wide SetPersistence Gets or sets a value indicating whether to

set persistence. PriorityOrder Gets or sets a value indicating whether it is

priority order. DisableControl Gets or sets a value indicating whether

control is disabled.

Methods

Method AddString

Description To Add the string as an item

Parameters Item String item to add

Method DeleteString

Description To Delete the string as an index number.

Parameters index Index at which item to delete

Method InsertString

Description To insert a string as an item at a specified index.

Parameters index Index at which to insert string item.

item String item to insert.

Method ResetContent

Description Resets the content and removes all items.


P/N 6510020317 Rev 02 10/27/11 10-89

Events

Events: CheckedListboxClicked

Description Occurs when CheckedListbox is clicked

Events: CheckedListboxSelectionChanged

Description Occurs when CheckedListbox selection is changed

Events: CheckedListboxEdited

Description

Occurs when CheckedListbox item is edited

Events: CheckedListboxItemCheck

Description Occurs when checked listbox item is checked.

10.3.15. Fixed Point Profile QcsFixedPointProfile object can be used to display any of the available Fixed point measurement profiles. A sample Fixed Point profile is shown below.

Fixed Point Profile

The vertical axis on the profile shows the value of the variable being measured. The horizontal axis reflects the time interval for the selected measurement.

The following information is displayed on the profile object:


10/27/11 P/N: 6510020317 Rev 02 10-90

• The Fixed Point Measurement Array

• X-axis scale and units

• Y-axis scale and units

• Frozen Array (optional)

• Low Limit (optional)

• High Limit (optional)

• Cursor (optional)

Data points on the profile outside of the alarm the limits are shown in red rather than in green (assuming default color selections). The visibility of some of these items can be toggled through the associated configuration display.

Properties


CurrentBinIndex Gets the current cursor position. CurrentBinValue Gets the current cursor value. CurrentStatus Gets the current status. DisableControl Gets or sets a value indicating whether control

is in disabled mode. FrozenArray Gets or sets the frozen array. FrozenDateTime Gets or sets the frozen date time. IsFrozen Gets a value indicating whether a frozen profile

is in existence? Maximum Gets the maximum. MeasurementAverage Gets the profile Average. MeasurementDateTimeStamp Gets the measurement date time stamp. MeasurementMaximum Gets the maximum value MeasurementMinimum Gets the minimum value MeasurementRange Gets the range. MeasurementSetpoint Gets the measurement spread. MeasurementLowerLimit Gets the measurement lower limit. MeasurementSpread Gets the measurement spread. MeasurementUpperLimit Gets the measurement upper limit. Minimum Gets the minimum ScaleMaximum Gets the scale maximum. ScaleMinimum Gets the scale minimum. ScaleMode Gets the scale mode. ScaleSpan Gets the scale span. ZoomInMax Gets a value indicating whether zoom in is


P/N 6510020317 Rev 02 10/27/11 10-91

Property Description maximized state

ZoomOutMax Gets a value indicating whether zoom out is maximized state.

ZoomToReset Min Max Average Sigma Variance Setpoint Spread IsAnnoatationVisible AnnoatationText LowCutOff HighCutOff LowThreshold HighThreshold TrimmedSpread BoundType BandType LineFrozenColor GetCursorXPosition

Gets or Sets a value to the ZoomtoReset Gets Minimum for fixedPointAnalysis display Gets Maximum for fixedPointAnalysis display Gets Average for fixedPointAnalysis display Gets Sigma for fixedPointAnalysis display Gets Variance for fixedPointAnalysis display Gets Setpoint for fixedPointAnalysis display Gets Spread for fixedPointAnalysis display Gets or sets a value indicating whether annotation is visible. Gets or sets the annotation text Gets or sets the LowCutOff for fixedPointAnalysis display Gets or sets the HighCutOff for fixedPointAnalysis display Gets or sets the LowThreshold for fixedPointAnalysis display Gets or sets the HighThreshold for fixedPointAnalysis display Gets or sets the TrimmedSpread for fixedPointAnalysis display Gets or sets the BoundType for fixedPointAnalysis display Gets or sets the BandType for fixedPointAnalysis display Gets the color of the line frozen Gets the Cursor X Position for fixedPointAnalysis display

ProductionLineIdentifier Gets or sets the Production Line Identifier CurrentProductionLineDescription FrameIdentifier Gets the Current Production Line Description CurrentFrameDescription Gets or sets the Frame Identifier Gets the Current Frame Description MeasurementIdentifier Gets or sets the Measurement Identifier CurrentMeasurementDescription Gets the Current Measurement Description


10/27/11 P/N: 6510020317 Rev 02 10-92

MeasurementArrayIdentifier Gets or sets the Measurement Array Identifier CurrentMeasurementArrayDescription Gets the Current Measurement Array

Description ModeTypeDescription Gets or sets the Mode Type Description ModeTypeIdentifier Gets or sets the Mode Type Identifier IsProfileValid Gets the Profile Validity FixedPointRawBufferSize Gets the Fixed Point Raw Buffer Size FixedPointBufferSecPerElement Gets the Fixed Point Buffer Sec Per Element GoodDataInSec Gets the Good Data In Sec XAxisTitle Gets or sets the XAxisTitle CursorXPositionInTime Gets the Cursor XPosition In Time ShapeType Gets or sets the Shape Type

Methods

Method AutoScale

Description Autoscale the graph based on data values. The default behavior is to AutoScale with each new profile measurement.

Method ClearProfile

Description Clears the Fixed point Profile

Parameters Boolean If True then it fires the MeasurementLoaded event. If False it does not fire the MeasurementLoaded event.


Description Gets the min position.


Description Gets the max position.

Method MoveCursor

Description Moves the cursor.

Parameters direction The direction in which to move the cursor. zones The number of zones.


P/N 6510020317 Rev 02 10/27/11 10-93


Description Sets the print layout.


Description Sets the screen layout.

Method SetupXAxis

Description Setups the X axis.

Parameters maximumVal Start range index minimumVal End range index displayUnit Interval totalProfile Total count of profile items profileIndex Profile index

Method UpdateMeasurementScaling

Description Changes the scaling.

Parameters scaleMode Sets the scalemode 0 – Autoscale 1 – Fixed 2 – Span

scaleMax Scale maximum value. If scaleMode = 1 (Range) then sets Y scale maximum to scaleMax, otherwise ignore.

scaleMin Scale minimum value. If scaleMode = 1 (Range) then sets Y scale minimum to scaleMin, otherwise ignore.

scaleRange If scaleMode = 2 (Span) then sets Y scale maximum to variable average + range / 2 and minimum to average – range / 2, otherwise ignored


Description Displays the profile.

Parameters ProductionLineIdentifier Production line e.g. “PM 1”

FrameIdentifier Data from id field of Frame table in RTDR, eg. “SCN1”


10/27/11 P/N: 6510020317 Rev 02 10-94

MeasurementIdentifier Data from Description field of

Measurement table in RTDR, e.g. “Upper Air Gap Temp”

MeasurementArrayIdentifier

Data from id field of MeasurementArray table in RTDR, e.g. “UAG11NA”

ModeIdentifier “Absolute” “Percent around average” “Absolute around average” “Percent around setpoint” “Absolute around setpoint”

Method ZoomIn

Description Zooms in on the profile component.

Method ZoomOut

Description Zooms out on the profile component.

Method updateLimits

Description Update the Lower and Higher Limits.

Method ReDrawYAxis

Description Redraws the Y axis when called.

Method updateFixedPointSettings

Description Updates the fixed point settings.

Method updateFixedPointSettings

Description Updates the fixed point settings.

Parameters productionLine Production Line, like “PM 1”

scanner Scanner like “SCN1”


P/N 6510020317 Rev 02 10/27/11 10-95

selectedBufferType Selected Buffer Type like “Spectrum raw buffer” ,”Measurement” or “Channel”

selectedBuffer Selected Buffer id example for Spectrum raw buffer “SPEC11” and for Measurement or Channel “UAG11”

selctedMode

Selected Mode index from buffer Selection popup. For Spectrum raw buffer use -1 and for Measurement and Channel pass Mode use an index value like 0, 1

Method UpdateBufferSelection

Description Updates the buffer selection.

Parameters ProductionLineIdentifier Production Line Identifier like “PM 1”

FrameIdentifier Frame Identifier like “SCN1” BufferIdentifier Buffer Identifier like

“Spectrum raw buffer”, “Measurement”, ”Channel”

TypeIdentifier Type Identifier, example for Spectrum raw buffer “Spectrum 1”, for Measurement “Upper Air Gap Temp” and for Channel ”Wet End SS1 Performance

TypeIDIdentifier ModeIdentifierID ModeIdentifierID

Type ID Identifier. Example for Spectrum raw buffer “Spec11” and for Measurement and Channel like “UAG11 Mode Identifier. For Spectrum raw buffer empty string, for Measurement like “Absolute around setpoint”, for Channel like “UAG” Mode Identifier ID. For Spectrum raw buffer -1, for Measurement and channel; mode index from buffer selection popup like 0,1

Method UpdateBufferMeasurementSelection


10/27/11 P/N: 6510020317 Rev 02 10-96

Description Updates the buffer measurement selection.


FrameIdentifier Frame Identifier like “SCN1”

MeasurementIdentifier Measurement Identifier like “Upper Air Gap Temp”

MeasurementArrayIdentifier Measurement Array Identifier like “UAG11”

ModeIdentifier ModeIdentifierID BufferIdentifier

ModeIdentifier like “Absolute around setpoint” Mode Identifier ID can be 1,2 or 3 Buffer Identifier like "Measurement"

Method UpdateBufferChannelSelection

Description Updates the buffer channel selection.



MeasurementIdentifier Measurement Identifier like “Wet End SS1 Performance”

MeasurementArrayIdentifier Measurement Array Identifier like “UAG11”


ModeIdentifier like “UAG” Mode Identifier ID can be 1,2 or 3 Buffer Identifier like "Channel"

Method UpdateBufferSpectrumSelection

Description Updates the buffer spectrum selection.



MeasurementIdentifier Measurement Identifier like “Spectrum 1”

MeasurementArrayIdentifier Measurement Array Identifier like “SPEC11”


P/N 6510020317 Rev 02 10/27/11 10-97


ModeIdentifier like “UAG” Mode Identifier ID always 4 Buffer Identifier like "Spectrum raw buffer"

Events

Event: FrozenStatusChanged

Description: Event handler for frozen status changed.

Event: GraphZoomed

Description: Event handler for zooming..

Event: MeasurementConnectionStatusChanged

Description: Occurs when measurement connection status is changed.

Event: MeasurementLoaded

Description: Occurs when measurement is loaded.

Event: MeasurementUpdated

Description: Occurs when measurement is updated.

Event: ScannerHeadPositionUpdated

Description: Occurs when Head Position is updated.


10/27/11 P/N: 6510020317 Rev 02 10-98

10.4. QCS Non-Display Objects This chapter describes the QCS Objects which have no user interface but can be very useful in HMIWeb script code.

10.4.1. Support Libraries The two support libraries documented in this section are provided as HMIWeb shapes. You need to insert these shapes into you display to use their methods.

10.4.1.1. QcsSupportLibrary shape

Methods

Method DisposeObject

Description Calls the object’s dispose method and sets the object reference to nothing. Normally called in the OnPageUnload event handler.

Parameter object The object reference

Usage DisposeObject(QcsSystem)

Method LaunchLabViewPopup

Description Launches a LabVIEW popup.

Parameters viName vi file name

Usage LaunchLabViewPopup(“System setup & debug.vi”)

Method LaunchApplication

Description Launches a Windows application program.

Parameters exeName Executable file name currentDirectory Current directory for application

Usage

LaunchApplication “Notepad.exe”, “”

Technical Reference Information QCS Non-Display Objects

P/N 6510020317 Rev 02 10/27/11 10-99

Method GetEnvironmentKeys

Description Gets environment keys which can be used with the call to save persistent data (SetPersistentData). Returns an object, with the following properties:

ClientID = Client id DisplayID = Display name OperatorID = Logged user

Parameters None

Usage

Dim EnvKeys set EnvKeys = GetEnvironmentKeys() ClientID = EnvKeys.ClientID DisplayID = EndKeys.DisplayID OperatorID = EnvKeys.OperatorID

Method GetProductionLine

Description Gets the name of the local production line.

Usage PLname = GetProductionLine()

Method GetProductionLines

Description Gets a list of all production lines defined for this system. .

Usage Dim PLines PLines = GetProdcutionLines()

Method GetDefaultQcsSystem

Description Gets the reference to QCS system object.

Usage Set qcsSystem = GetDefaultQcsSystem()

Method GetQcsTranslator

Description Gets the reference to Qcs Localization object.

Method GetQcsSettings

Description Gets the reference to Qcs Settings object.


10/27/11 P/N: 6510020317 Rev 02 10-100

Method GetQcsPersistence

Description Gets the reference to Qcs Persistence object.

Method GetQcsSupportMethods

Description Gets the reference to Qcs Support Methods object.

Method ParseDisplayName

Description Parses the display name from display url For example: displayUrl = "\\server\folder\display1.htm?ts=13.1.2009" returns "display1"

Parameters displayUrl Display URL path

Method ConvertTimeToMinutes

Description Converts time string given in format "NN UNIT" to minutes For example: Input = "5 h" -> Output = 300

Parameters timeStr Time string to convert

Method OpenDialog

Description Opens a dialog box that require a callback reference

Parameters dialogName Dialog box name to open.

callbackFunc Name of the callback function.

Method OpenScalingDialog

Description Opens the scaling dialog box.

Parameters callbackFunc Name of the callback function.

Method OpenTrendSelectionDialog

Description Opens scalar variable selection dialog box.


Method OpenArrayTrendSelectionDialog

Description Opens the array variable selection dialog box.


P/N 6510020317 Rev 02 10/27/11 10-101


Method OpenProfileSelectionDialog

Description Opens the profile selection dialog box.


Method OpenDropDownDialog

Description Opens dropdown dialog box.


Method OpenNumericSelectionDialog

Description Opens numeric selection dialog box.


Method OpenMultiProfileSetup

Description Opens Multiple Profiles Setup.


Method FindScalingDialog

Description Checks whether the scaling dialog box is open.

Parameters dialogName To find a Dialog box name.

Method FindTrendSelectionDialog

Description Verifies whether the scalar measurement selection dialog box is open.

Method FindArrayTrendSelectionDialog

Description Verifies whether the array measurement selection dialog box is open.

Method FindProfileSelectionDialog

Description Verifies whether the profile selection dialog box is open.

Method StorePopupWindowSizeAndLocation

Description Stores popup-window's size and location information.


10/27/11 P/N: 6510020317 Rev 02 10-102

Parameters windowRef Popup window reference

Method RestorePopupWindowSizeAndLocation

Description Restores popup-window's size and location information.


Method RestorePopupWindowSize

Description Restores popup-window's size and location information.


Method QcsSetCallerReference

Description Stores a value to the Station dictionary with the name defined by Key. This method is called in the parent display before calling QcsPopup to store the dialog name and object of QcsCallerInfoClass in the station dictionary. In this case, Key represents the dialog name and value represents the QcsCallerInfoClass object.

Parameters key Key to identify saving value

value Value to save

Method QcsGetCallerReference

Description Gets the caller reference from the station dictionary. For example, this method is called in a QcsPopup while its loading to get the caller reference from the station dictionary which is stored by using QcsSetCallerRefernce method.

Parameters key Key to find caller reference

Method QcsGetCallerCallback

Description

Gets the caller reference form the station dictionary.

Parameters

key Key to find callback function

Method QcsRemoveCallerReference

Description Removes the caller reference from the station dictionary.

Parameters key Key to find caller reference

Method IfNumisNAN


P/N 6510020317 Rev 02 10/27/11 10-103

Description Method returns "NAN" string value if number is "NAN" otherwise the input number as string. Where the input Number parameter is return values from .Net CCW instance's methods or properties.

Parameters Number Number to check

Method GetCurrentOperator

Description This function returns the name of the current Station operator when using Operator-Based Security.

Usage x = GetCurrentOperator

Method IsViewOnly

Description Returns true if the user logged into Station is a Viewonly user.

Method RefreshDisplay

Description Refresh the HMI display.

Method DisableControl

Description A common routine to disable HMI controls.

Parameters control Any native Display builder control or Qcs component.

flag True: Disable control False: Enable control

Method CalculatePaddingTopValue

Description Used to center the text of the dropdown menu.

Parameters ctrl Dropdown control.

Usage cmbProductionLine.style.paddingTop = CalculatePaddingTopValue(cmbProductionLine) See section 8.5

Method ActivatePrintEvents

Description Activates the necessary print events.

Method onBeforePrinting

Description Sets the Print friendly layout to the all Qcs – controls.


10/27/11 P/N: 6510020317 Rev 02 10-104

Method onAfterPrinting

Description Sets the default screen layout to the all Qcs - controls.

Method OpenKeyBoardDialog

Description Opens the Keyboard dialog box.


Method FindKeyBoardDialog

Description Verifies if the KeyBoard dialog box is open.

Method OpenMaintenanceSelectDialog

Description Opens Qcs Maintenance select dialog box.


Method FindMaintenanceSelectDialog

Description Verifies if the Qcs Maintenance select dialog box is open.


Method OpenStoreStandardSpectratoDSRDialog

Description Verifies if the Qcs Maintenance select dialog box is open.


Method FindStoreStandardSpectratoDSRDialog

Description Verifies if the Qcs Store Standard Spectra to DSR dialog box is open.

10.4.2. QCS System The QCS System object (or QCS System Data class) provides a wide variety of sub-classes, properties and methods which may be used to access QCS data from the local Production Line (the local QCC Server) or other Production Lines (others QCS Servers) in the same network. This section describes some of these sub-classes, properties and methods. Additional information on these may be found in the QCS HMI Objects Help File which is located in the folder:

C:\Program Files\Honeywell\Experion PKS\RAE\Bin\HMIObjects


P/N 6510020317 Rev 02 10/27/11 10-105

The file name is QCS HMI Objects.chm.

The following script code may be used to create an instance of a QcsSystem object (an instance of the QcsSystemData Class).

Dim qcsSystem

Set qcsSystem = GetQcsSystem(selectedProductionLine)

i

NOTE: The selectedProductionLine parameter defines the desired Production Line (for example, “PM 1”). This parameter can be replaced with an empty string (“”) to access the local or default Production Line.

i

NOTE: The QcsSupportLibrary shape (QcsSupportLibrary.sha) must be inserted on the local display before you can use the QCS System object.

Methods

Method AddConnectionStatusChangedHandler

Description Subscribe to a connection status changed event.

Parameters functionRef Reference to a vbscript function which is called when this event occurs.

Usage Dim qcsSystem Set qcsSystem = GetQcsSystem("") qcsSystem.AddConnectionStatusChangedHandler(getref("ConnectionStatusChanged"))

Method Dispose

Description Performs resource cleanups.

Usage Dim qcsSystem Set qcsSystem = GetQcsSystem("") … qcsSystem.Dispose()

Method GetFrames

Description Gets the frames in the system as frame object vector.

Usage Dim qcsSystem Set qcsSystem = GetQcsSystem("") dim frames


10/27/11 P/N: 6510020317 Rev 02 10-106

frames = qcsSystem.GetFrames for i = 0 to ubound(frames) msgbox frames(i).Description next qcsSystem.Dispose()

Method RemoveConnectionStatusChangedHandler

Description Unsubscribe to a connection status changed event.

Parameters functionRef Reference to a vbscript function which is called when this event occurs.

Usage Dim qcsSystem Set qcsSystem = GetQcsSystem("") … qcsSystem.RemoveConnectionStatusChangedHandler(getref("ConnectionStatusChanged"))

10.4.2.1. Data Access

This sub-class of the QCS System Object provides general access to any data stored in RTDR.

Methods

Method GetData

Description Returns data from RTDR.

Parameters address Address to a RTDR location. For example, “./System/Customer name”.

Sample vbscript usage:

Dim qcsSystem Set qcsSystem = GetQcsSystem("") customerName = qcsSystem.DataAccess.GetData("./System/Customer name") qcsSystem.Dispose()

Method SetData

Description Write data to the RTDR.

Parameters address Address of the desired RTDR data item. For example, “./System/dummy/double”.

Sample vbscript usage:


P/N 6510020317 Rev 02 10/27/11 10-107

Dim qcsSystem Set qcsSystem = GetQcsSystem("") qcsSystem.DataAccess.setData "./system/dummy/double", 123.45 qcsSystem.Dispose()

10.4.3. Translator class The Translator class provides support for runtime localization of operator visible text strings.

Properties


Language Gets or Sets the current language Languages Gets the available languages as an array NumberOfLanguages Gets the number of available languages

Methods

Method AddLanguageChangeHandler

Description Subscribes the client to the language change event..

Parameters callbackFunction Reference to vbscript function which gets called when the language change event occurs.

Method Dispose

Description Cleans up any resources being used.

Method RemoveLanguageChangeHandler callbackFunction

Description Unsubscribes the client from the language change event.

Parameters callbackFunction Reference to vbscript function which gets called when the language change event occurs.

Method Translate

Description Translates the text to current language.

Parameters text String to translate.

Sample Script code: dim translator Set translator = GetQcsTranslator()


10/27/11 P/N: 6510020317 Rev 02 10-108

txtAve.value = translator.Translate("Average") txtSpread.value = translator.Translate("Spread") DisposeObject(translator)

10.4.4. Persistence class QCS Persistence provides methods which may be used to save and retrieve data from a persistent (non-volatile) database. This data is retained through system restarts and power failures. The main methods in this class are listed below. See section 5.2 for sample script using these methods.

Methods

Method SetPersistence

Description Sets the persistence value.

Parameters ProductLineID Production line being viewed. This helps to view the data across multiple production lines.

ClientID Client identifier or machine name of the connecting computer. In cases where terminal services are being used, this indicates the name of the node connecting to the terminal server.

MonitorID Required when using multiple monitors. Each monitor has an identifier that can be used for this setting.

DisplayID Display name (that is the HTM title) ControlType Specify the control type (button, textbox,

QcsMeasurementProfile) ControlID A unique identifier for each control, that is

counter. Each control type maintains its own counter value. This is useful for cases where multiple trends and/or profiles (for example) are on a page and persistence values for all need storing.

UserID Logon name of the Operator.. ValueToSave Value to persist

Method GetPersistence

Description Gets the persistence value.

Parameters ProductLineID Production line being viewed. This helps to view the data across multiple production lines.

ClientID Client identifier or machine name of the connecting computer. In cases where terminal services are being used, this indicates the name


P/N 6510020317 Rev 02 10/27/11 10-109

of the node connecting to the terminal server. MonitorID This is required while using multiple monitors.

Each monitor has an identifier that can be used for this setting.

DisplayID Display name (HTM title) ControlType Specify the control type (button, textbox,

QcsMeasurementProfile) ControlID A unique identifier for each control, that is

counter. Each control type maintains its own counter value. This is useful in cases where multiple trends and/or profiles (for example) are on a page and persistence values for all need storing.

UserID Logon name of the Operator..

Method Dispose

Description Releases all resources used in QCS Persistence.

10.4.5. Settings class The Settings class provides methods to access display or component specific setting information from the RTDR. Most of these methods are intended for a specific standard QCS display.

Methods

Method GetColorGridSettings

Description Gets the settings object for Advanced Color Map display.

Parameters productLineID Production line that is being displayed. This method supports to view data across multiple production lines.

clientID Client identifier or machine name of the connecting computer. In cases where terminal services are being used, this indicates the name of the node connecting to the terminal server.

userID Logon name of the Operator.

Method GetMeasurementProfileSettings

Description Gets the measurement profile settings object.


clientID Client identifier or machine name of the connecting computer. In cases where terminal


10/27/11 P/N: 6510020317 Rev 02 10-110

services are being used, this indicates the name of the node connecting to the terminal server.


Method GetMeasurementProfileSetSettings

Description Gets the settings object for measurement profile sets.

Method GetQualitySummarySettings

Description Gets the settings object for Quality Summary display.


Method GetTrendSettings

Description Gets the settings object for Trend display.

Method GetLimitAlertSettings

Description Gets the settings object for Limit Alert display.


Method GetRecipeChangeSettings

Description Gets the settings object for Recipe Change display.

Method GetProductionDataSettings

Description Gets the settings object for Production Data display.

Parameters productLineID

Production line that is being displayed. This method supports to view data across multiple production lines.

Method GetScannerStatusDetailsSettings

Description Gets the settings object for Scanner Status display.


Method GetDataDisplaySettings productLineID

Description Gets the settings object for Data Display.

Parameters productLineID Production line that is being displayed. This


P/N 6510020317 Rev 02 10/27/11 10-111

method supports to view data across multiple production lines.

Method GetColorLoopsMonitorSettings

Description Gets the settings object for Color Loops Monitor display.


Method GetColorSpaceWindowSettings

Description Gets the settings object for Color Space Window display.


clientID Client identifier or machine name of the connecting computer. In cases where terminal services are being used, this indicates the name of the node connecting to the terminal server.


Method GetMisProfileSettings

Description Gets the settings object for Mis Profiles.


Method GetMisBasicReportSettings

Description Gets the settings object for Mis Profiles.

Parameters productLineID Production line that is being displayed. This method supports to view data across multiple production lines..

displayID Display name (HTM title).

10.4.6. Scripting Support class The Scripting Support class provides provide several useful general purpose methods.

You can get an instance of this class by calling GetQcsSupportMethods().

For example:


10/27/11 P/N: 6510020317 Rev 02 10-112

Dim ScriptSupport Set ScriptSupport = GetQcsSuppoprtMethods x = ScriptSupport.GetEnvironmentVariableValue("MxServerEnable")

Methods Method Clamp

Description Clamps an input value to specific upper and lower limit based on the forceOutput flag.

Parameters input This is the input value upperClamp The upper clamp (upper limit). lowerClamp The lower clamp (lower limit) forceOutput Boolean. If true, then input value will be

clamped between the upper and lower limits. If false, then the input value is returned. (Note this logic is currently coded with the opposite meaning)

Return value double Returns clamped input value

Method ConvertColorToRGB

Description Converts the hexadecimal color in string format to RGB in integer format.

Parameters RGB This takes color value in string format. For example, “#00AAFF”

Return value int Returns RGB value in integer format.

Method Floor

Description This is used to round off a number type such as decimal or double to the nearest lowest integer.

Parameters number This takes double value and used for Flooring the number”

Return value double Returns Floored value for the given number.

Method Ceiling

Description This is used to round off a number specified number value to the next highest integer.

Parameters number This takes double value and used for Ceiling the number.

Return value double Returns Ceiling value for the given number.

Method IsFileExistsInEnvPath


P/N 6510020317 Rev 02 10/27/11 10-113

Description Determines whether specified filename exist in the Path environment variable.

Parameters filename This takes string value and used for accepting filename.

Return value double Returns true if specified file exits or returns false if does not exists.

Method GetEnvironmentVariableValue

Description Returns the environment variable value for the specified Environment Variable Name.

Parameters envVariableName This takes string value and used for accepting environment variable name.

Return value string Returns environment variable value.

Method OpenSaveFileDialog

Description Opens the Save File dialog box to save the specified fileName.

Parameters initialPath This takes string value and used for setting default path to save the file

fileName This takes string value and used for setting the file name

filter

This takes string value and used for to view only those file type in the save dialog box. For example: “*.cvs”, If the String Value is taken only for *.cvs file, then only files with“.cvs” extension are displayed in Save dialog box.

Return value SaveDlgReturnValues (object instance)

Returns object instance and this object has the properties like SavedFile: Returns or sets the saved file name in string format SavedLocation: Returns or sets the saved location in string format IsCancelled: Returns or sets a value indicating whether this instance is cancelled or not in boolean format

experion mx r600 display builiders guide

Documents