Manufacturing Execution System (MES)

.NET Controls

Developer Guide

Version 6.0
June, 2018
© 2018 AVEVA Group plc or its subsidiaries. All rights reserved.
The Schneider Electric industrial soft ware business and AVEVA have merged to trade as AVEVA Group
plc, a UK listed company. The Schneider Electric and Life is On trademarks are owned by Schneider
Electric and are being licensed to AVEVA by Schneider Electric.
No part of this documentation shall be reproduced, stored in a ret rieval system, or transmitted by any
means, electronic, mechanical, photocopying, rec ording, or otherwise, without the prior written
permission of AVEVA. No liability is assumed with respect to the use of the information contained herein.
Although precaution has been taken in the preparation of this documentation, AV EVA assumes no
responsibility for errors or omissions. The information in this documentation is subject to change without
notice and does not represent a commitment on the part of AVEVA. The soft ware described in this
documentation is furnished under a license agreement. This soft ware may be used or copied only in
accordance with the terms of such license agreement.
ArchestrA, Aquis, Avantis, DYNS IM, eDNA, EYESIM, InBatch, InduSoft, InStep, IntelaTrac, InTouch,
PIPEPHASE, PRiSM, PRO/II, PROV IS ION, ROMeo, SIM4ME, SimCentral, SimSci, Skelta,
SmartGlance, Spiral Software, Termis, WindowMaker, WindowViewer, and Wonderware are trademarks
of AVEVA and/or its subsidiaries. An extensive listing of AVEVA trademarks can be found at:
https://sw.aveva.com/legal. All other brands may be trademarks of their respective owners.
Publication date: 6/29/2018
Contact Information
AVEVA Group plc
High Cross
Madingley Road
Cambridge
CB3 OHB. UK
https://sw.aveva.com/
For information on how to cont act sales, customer training, and technical support, see
https://sw.aveva.com/contact.
 MES .NET Controls Developer Guide

Contents
Chapter 1 Using .NET Controls ......................................................................................... 21
Introduction to Using .NE T Controls ......................................................................................... 21
About .NE T Controls ............................................................................................................... 22
Organizing .NE T Controls ........................................................................................................ 22
Importing .NE T Controls .......................................................................................................... 23
MES .NET Control .dll Files................................................................................................ 25
Example of Installing the Utilization and Button Bar Controls ................................................ 26
Importing Previously Exported .NE T Controls ...................................................................... 26
Exporting .NE T Controls .................................................................................................... 26
Securing .NE T Controls ........................................................................................................... 27
Configuring .NE T Cont rol E vent Scripts .................................................................................... 27
Selected Row Changed E vent ............................................................................................ 28
Properties of the SelectedRowChanged E vent .............................................................. 29
Pre- and Post-Button Click Events ...................................................................................... 29
Properties of the PreB uttonClicked and PostButtonClicked E vents ................................. 30
Example of Configuring an E vent Script for the Utilization Control ........................................ 31
Using Controls in ArchestrA Symbols ....................................................................................... 32
Embedding . NE T Controls into a Symbol ............................................................................ 32
Configuring Cont rols .......................................................................................................... 34
Using Controls in InTouch........................................................................................................ 36
Logging On and Off Controls .............................................................................................. 36
InTouch Not Using InTouch Security ............................................................................. 36
InTouch Using InTouch Security ................................................................................... 37
Using Properties in Application Server Scripts........................................................................... 37
Using Common Control Properties ........................................................................................... 37
Docking the Controls Within a Symbol ................................................................................ 37
Logging on the Cont rols Automatically ................................................................................ 38
Logging on to Entities Automatically ................................................................................... 39
Refreshing the Controls Automatically ................................................................................ 39
Viewing and Changing the Properties of .NE T Cont rols ............................................................. 39
Example of Changing the Dock Property............................................................................. 40
Example of Changing the ControlInCharge and ButtonBarName Properties .......................... 42
Viewing Additional .NE T Control Information ............................................................................. 43
Viewing the .NE T Control Assemblies ................................................................................. 43
Viewing Class Name, Vendor, and Version of a .NE T Control .............................................. 44
Viewing Objects and Symbols Referencing .NE T Cont rols ................................................... 44
Binding .NE T Control Properties to Attributes or Element References ......................................... 45
Example of Dat a Binding in the Utilization Control ............................................................... 46
Animating .NE T Controls ......................................................................................................... 47

Version 6.0 3
MES .NET Controls Developer Guide Contents

About Operator Cont rols .......................................................................................................... 47

About Data Editor Cont rols ...................................................................................................... 49
About Miscellaneous Controls .................................................................................................. 49
On-Screen Keyboard............................................................................................................... 50

Chapter 2 Common Properties and Methods.................................................................. 51

Common Properties ................................................................................................................ 51
AppendSaveConfigName Property ..................................................................................... 51
AutoLoginUser Property..................................................................................................... 52
AutoLogonEnt Property ..................................................................................................... 52
ButtonBarName Property ................................................................................................... 52
Cont rolLicensed Property .................................................................................................. 53
ExecuteEnabled Property .................................................................................................. 53
Font Property .................................................................................................................... 53
HeadingFont Property ....................................................................................................... 53
IgnoreRefres hE vents Property ........................................................................................... 53
LoginUserID Property ........................................................................................................ 54
LoginUserPassword Property ............................................................................................. 54
LogOnEnt Name Property ................................................................................................... 54
LogOnSite Property ........................................................................................................... 54
SaveConfigName Property ................................................................................................ 55
Common Methods ................................................................................................................... 55
BeginInit() Method ............................................................................................................. 55
EndInit() Method ............................................................................................................... 55
Execute() Method .............................................................................................................. 55
ExecuteButtonMenuCommand() Method ............................................................................ 56
GetButtonMenuItems() Method .......................................................................................... 56
Help() Method ................................................................................................................... 56
InitializeS uperclass() Method ............................................................................................. 56
IsButtonMenuItemE nabled() Method ................................................................................... 57
LaunchBrowser() Method................................................................................................... 57
OpenForm() Method .......................................................................................................... 57
RefreshData() Method ....................................................................................................... 58
ResetAppendSaveConfigName() Method ............................................................................ 58
ResetAutoLoginUser() Method ........................................................................................... 58
ResetAutoLogonE nt() Method ............................................................................................ 58
ResetButtonB arName() Method ......................................................................................... 58
ResetHeadingFont() Method .............................................................................................. 58
Reset IgnoreRefreshE vents() Method .................................................................................. 59
ResetSaveConfigName() Method ....................................................................................... 59
SetGraphicSite() Method ................................................................................................... 59
SwitchUser() Method ......................................................................................................... 59
Translat eColumnHeadings() Method .................................................................................. 59
Passing Information with the ButtonBar Execute() and LaunchBrowser() Methods ................. 60

Chapter 3 Audit Control ...................................................................................................... 63

Introduction to the Audit Control ............................................................................................... 63
Configuring the Audit Control ................................................................................................... 63
Properties of the Audit Control ................................................................................................. 64
AuthorizeE nabled Property ................................................................................................ 64
RefreshEnabled Property ................................................................................................... 64
Methods of the Audit Control .................................................................................................... 64

4 Version 6.0
Contents MES .NET Controls Developer Guide

Sign Off() Method .............................................................................................................. 64

Chapter 4 Button Bar Control............................................................................................. 67

Introduction to the Button Bar Control ....................................................................................... 67
Configuring the Button Bar Cont rol ........................................................................................... 67
Embedding the Button Bar Control ..................................................................................... 67
Docking the Button Bar Cont rol .......................................................................................... 68
Associating the Button Bar Cont rol with Ot her Controls ........................................................ 68
Showing the Buttons for a Specific Cont rol .......................................................................... 68
Properties of the Button Bar Control ......................................................................................... 69
AllowConfiguration Property ............................................................................................... 69
BackColor Property ........................................................................................................... 70
ButtonSize Property .......................................................................................................... 70
Cont rolInCharge Property .................................................................................................. 70
DefaultButtonBackColor Property ....................................................................................... 70
DefaultButtonForeColor Property........................................................................................ 70
Dock Property ................................................................................................................... 71
ForeColor Property ............................................................................................................ 71
Horiz ontalBoundary Property ............................................................................................. 71
Horiz ontalSeparation Property ........................................................................................... 71
NumButtonLines Property .................................................................................................. 71
ScrollButtonBackColor P roperty ......................................................................................... 72
ScrollButtonForeColor Property .......................................................................................... 72
ScrollButtonHeight Property ............................................................................................... 72
ScrollButtonWidth Property ................................................................................................ 72
ShowAllControlB uttons Property ........................................................................................ 72
Size Property .................................................................................................................... 73
SpacerHeight Property ...................................................................................................... 73
SpacerWidth Property........................................................................................................ 73
UserButtonExecutionLevel Property ................................................................................... 73
VerticalBoundary Property ................................................................................................. 73
VerticalSeparation Property ............................................................................................... 74
Methods of the Button Bar Control ........................................................................................... 74
EnableButton() Method ...................................................................................................... 74
IsButtonEnabled() Method ................................................................................................. 74
ResetAllowConfiguration() Method ..................................................................................... 75
ResetBackColor() Method .................................................................................................. 75
ResetButtonSize() Met hod ................................................................................................. 75
ResetControlInCharge() Method......................................................................................... 75
ResetDefaultButtonBackColor() Method .............................................................................. 75
ResetDefaultButtonForeColor() Method .............................................................................. 75
ResetDock() Method.......................................................................................................... 75
ResetForeColor() Method .................................................................................................. 76
ResetHorizontalBoundary() Method .................................................................................... 76
ResetHorizontalSeparation() Method .................................................................................. 76
ResetNumButtonLines() Method ........................................................................................ 76
ResetScrollB uttonBackColor() Met hod ................................................................................ 76
ResetScrollB uttonForeColor() Method ................................................................................ 76
ResetScrollB uttonHeight() Met hod...................................................................................... 76
ResetScrollB uttonWidth() Method ....................................................................................... 76
ResetShowAllControlsButtons() Method ............................................................................. 77
ResetSize() Method........................................................................................................... 77
ResetSpacerHeight() Method ............................................................................................. 77
ResetSpacerWidth() Method .............................................................................................. 77

Version 6.0 5
MES .NET Controls Developer Guide Contents

ResetUs erButtonExecutionLevel() Method .......................................................................... 77

ResetVerticalBoundary() Method ........................................................................................ 77
ResetVerticalSeparation() Method ...................................................................................... 77
SetButtonColor() Method ................................................................................................... 77
UnregisterControl() Method................................................................................................ 78

Chapter 5 Consumption Control ........................................................................................ 79

Introduction to the Consumption Control ................................................................................... 79
Configuring the Consumption Control ....................................................................................... 79
Properties of the Consumption Cont rol ..................................................................................... 80
AddConsEnabled Property................................................................................................. 80
ConsWasteEnabled Property ............................................................................................. 80
FilterEnabled Property ....................................................................................................... 80
ItemAttribut esEnabled Property .......................................................................................... 80
OpenFormEnabled Property .............................................................................................. 80
SetLotDataEnabled Property .............................................................................................. 81
Methods of the Cons umption Control ........................................................................................ 81
AddConsumption() Met hod ................................................................................................ 81
ConsWaste() Method......................................................................................................... 81
Show_BOMStep_Filter_Dialog() Method ............................................................................. 81
SetCurrentConsLot Data() Met hod ...................................................................................... 81
SelectRowByKey() Met hod ................................................................................................ 81

Chapter 6 Counts/Duration KPI Control ........................................................................... 83

Introduction to the Counts/Duration KPI Control ........................................................................ 83
Using the Counts/Duration KP I Control ..................................................................................... 83
Logging On to the Counts/Duration KPI Control ................................................................... 84
Switching Entities .............................................................................................................. 84
Associating the Button Bar Cont rol ..................................................................................... 85
Properties of the Counts/Duration KPI Cont rol .......................................................................... 85
CDKP IFilter.FilterEndOffset Property .................................................................................. 85
CDKP IFilter.FilterStartOffset Property ................................................................................. 85
CDKP IFilter.FilterTime Property ......................................................................................... 85
CDKP IFilter. TypeFilter Property ......................................................................................... 86
ChartBackColor Property ................................................................................................... 86
Cont rolStyle Property ........................................................................................................ 86
GraphType Property .......................................................................................................... 87
DisplayEntity Property ....................................................................................................... 87
DurationRefreshRate Property ........................................................................................... 87
FilterDefaultsFromDB Property........................................................................................... 88
FilterDuration Property....................................................................................................... 88
FilterEnabled Property ....................................................................................................... 88
LabelFont Property ............................................................................................................ 88
LabelFontColor Property .................................................................................................... 88
NumberOfBars Property .................................................................................................... 89
OEEStatusFilter Property ................................................................................................... 89
Reas onGroupColors Property ............................................................................................ 89
ValueFont Property ........................................................................................................... 89
ValueFontColor Property ................................................................................................... 90
Methods of the Counts/Duration KP I Control ............................................................................. 90
Filter () Met hod.................................................................................................................. 90
FillSampleDataCountsDuration() Method ............................................................................ 90

6 Version 6.0
Contents MES .NET Controls Developer Guide

GetButtonMenuItems() Method .......................................................................................... 90

IntializeB arGraph() Method ................................................................................................ 90
RefreshDisplay() Method ................................................................................................... 90
Update Display() Method ................................................................................................... 90
E vents of the Counts/Duration KPI Control ............................................................................... 91
OnClick() event ................................................................................................................. 91

Chapter 7 Data Log Control ............................................................................................... 93

Introduction to the Data Log Control ......................................................................................... 93
Configuring the Data Log Cont rol ............................................................................................. 93
Properties of the Data Log Control ........................................................................................... 94
curEnt Property ................................................................................................................. 94
curUser Property ............................................................................................................... 94
Font Property .................................................................................................................... 94
IsSaveNeeded Property ..................................................................................................... 94
LotNo Property .................................................................................................................. 94
MaxValues Property .......................................................................................................... 95
NewRowE nabled Property ................................................................................................. 95
RemoveEnabled Property .................................................................................................. 95
SaveE nabled Property ....................................................................................................... 95
StepNo P roperty ............................................................................................................... 95
SublotNo Property ............................................................................................................. 95
ToggleChartEnabled Property ............................................................................................ 96
Methods of the Data Log Control .............................................................................................. 96
AddNewRow() Method....................................................................................................... 96
CheckAndSave() Method ................................................................................................... 96
Delet eDataLogRow() Method ............................................................................................. 96
SaveRows() Method .......................................................................................................... 97
SelectRowByKey() Met hod ................................................................................................ 97

Chapter 8 Entity Usage Editor Control ............................................................................. 99

Introduction to the Entity Usage Editor Control .......................................................................... 99
Configuring the Entity Usage Editor Control .............................................................................. 99
Properties of the Entity Usage Editor Control ............................................................................ 99
AppendSaveConfigName Property ................................................................................... 100
SaveConfigName Property .............................................................................................. 100
Methods of the Entity Usage Editor Control ............................................................................. 100

Chapter 9 Folders Control ................................................................................................ 101

Introduction to the Folders Control ......................................................................................... 101
Configuring the Folders Control .............................................................................................. 101
Setting the Icon Size........................................................................................................ 102
Properties of the Folders Control ............................................................................................ 102
CompareEnabled Property............................................................................................... 102
EditEnabled Property....................................................................................................... 102
FilterEnabled Property ..................................................................................................... 102
PrintEnabled Property ..................................................................................................... 103
UseLargeTreeIcons Property ........................................................................................... 103
ViewEnabled Property ..................................................................................................... 103
Methods of the Folders Control .............................................................................................. 103

Version 6.0 7
MES .NET Controls Developer Guide Contents

ApplyFilter() Method ........................................................................................................ 103

Edit() Method .................................................................................................................. 104
Filter() Method ................................................................................................................ 104
Print() Method ................................................................................................................. 104
ResetUs eLargeTreeIcons() Method .................................................................................. 104
SelectRowByKey() Met hod .............................................................................................. 104
View() Method................................................................................................................. 105

Chapter 10 Genealogy Control ........................................................................................ 107

Introduction to the Genealogy Control .................................................................................... 107
Configuring the Genealogy Control ......................................................................................... 107
Properties of the Genealogy Control ....................................................................................... 108
OpenFormEnabled Property ............................................................................................ 108
ReclassifyConsEnabled Property ..................................................................................... 108
ReduceConsEnabled Property ......................................................................................... 108
Methods of the Genealogy Control ......................................................................................... 108
ReduceCons umption() Method......................................................................................... 108
ReclassifyConsumption() Method ..................................................................................... 108
SelectRowByKey() Met hod .............................................................................................. 109

Chapter 11 Inventory Control ........................................................................................... 111

Introduction to the Inventory Control ....................................................................................... 111
Configuring the Inventory Control ........................................................................................... 111
Selecting Multiple Rows in the Inventory Control ............................................................... 112
Showing the Tree of Entities in the Inventory Control ......................................................... 112
Showing the Storage Entity Status Grid in the Inventory Cont rol ......................................... 112
Setting the Icon Size........................................................................................................ 113
Properties of the Inventory Control ......................................................................................... 113
Methods of the Inventory Control ........................................................................................... 113
ClearEntityTreeFilter() Met hod ......................................................................................... 113
ClearInventoryFilter() Method ........................................................................................... 114
ResetAllowMultipleSection() Method ................................................................................. 114
ResetShowE ntityTree() Method........................................................................................ 114
ResetShowStorageStatusGrid() Method ........................................................................... 114
ResetUs eLargeTreeIcons() Method .................................................................................. 114
SetEntityTreeFilter() Method ............................................................................................ 114
SetInventoryFilter() Method.............................................................................................. 115
SelectRowByKey() Met hod .............................................................................................. 115

Chapter 12 Item Consumption Editor Control ............................................................... 117

Introduction to the Item Consumption Editor Cont rol ................................................................ 117
Configuring the Item Consumption Edit or Control .................................................................... 117
Properties of the Item Consumption Editor Control .................................................................. 117
AppendSaveConfigName Property ................................................................................... 117
SaveConfigName Property .............................................................................................. 117
Methods of the Item Consumption Editor Control..................................................................... 118

Chapter 13 Item Lot Editor Control ................................................................................. 119

Introduction to the Item Lot Editor Cont rol ............................................................................... 119

8 Version 6.0
Contents MES .NET Controls Developer Guide

Configuring the Item Lot Editor Control ................................................................................... 119

Properties of the Item Lot Editor Control ................................................................................. 120
Methods of the Item Lot Editor Control .................................................................................... 120

Chapter 14 Item Production Editor Control.................................................................... 121

Introduction to the Item Production Editor Control .................................................................... 121
Configuring the Item Production Editor Control ........................................................................ 121
Properties of the Item Production Editor Control ...................................................................... 121
AppendSaveConfigName Property ................................................................................... 121
SaveConfigName Property .............................................................................................. 121
Methods of the Item Production Editor Control ........................................................................ 122
GetQuantityForDownstreamOperation() Method ................................................................ 122
Get TotalQuantityForOperation() Method ........................................................................... 122

Chapter 15 Job Step Data Editor Control ...................................................................... 125

Introduction to the Job Step Data Editor Control ...................................................................... 125
Configuring the Job Step Data Editor Cont rol .......................................................................... 125
Properties of the Job Step Data Editor Control ........................................................................ 125
AppendSaveConfigName Property ................................................................................... 125
SaveConfigName Property .............................................................................................. 125
Methods of the Job Step Data E ditor Control .......................................................................... 126

Chapter 16 Job Summary Control................................................................................... 127

Introduction to the Job Summary Controls .............................................................................. 127
Configuring the Job Summary Control .................................................................................... 127
Using the Job Summary Control ............................................................................................. 127
Switching Entities ............................................................................................................ 128
Properties of the Job Summary Control .................................................................................. 128
Display Titlebar Property................................................................................................... 128
Methods of the Job Summary Cont rol ..................................................................................... 128
InitEntitySelect() Method .................................................................................................. 128
ResetDis play TitleBar() Method......................................................................................... 129
SelectRowByKey() Met hod .............................................................................................. 129

Chapter 17 Labor Usage Editor Control ......................................................................... 131

Introduction to the Labor Usage Editor Control ........................................................................ 131
Configuring the Labor Usage Editor Control ............................................................................ 131
Properties of the Labor Usage Editor Control .......................................................................... 131
AppendSaveConfigName Property ................................................................................... 131
SaveConfigName Property .............................................................................................. 131
Methods of the Labor Usage Editor Control ............................................................................ 132

Chapter 18 OEE KPI Control ........................................................................................... 133

Introduction to the OEE KPI Control ....................................................................................... 133
Using the OEE KPI Control .................................................................................................... 134

Version 6.0 9
MES .NET Controls Developer Guide Contents

Switching Entities ............................................................................................................ 134

Associating the Button Bar Cont rol ................................................................................... 134
Properties of the OEE KPI Control ......................................................................................... 134
CurrentValue Property ..................................................................................................... 135
DisplayEntity Property ..................................................................................................... 135
FilterDefaultsFromDB Property......................................................................................... 135
FilterEnabled Property ..................................................................................................... 135
FirstZoneColor Property................................................................................................... 136
FirstZoneCut off Property.................................................................................................. 136
GaugeBackColor Property ............................................................................................... 136
GaugeBorderColor Property............................................................................................. 136
GaugeBorderVisible Property ........................................................................................... 136
GaugeFillCol or Property .................................................................................................. 136
GaugeForeColor Property ................................................................................................ 137
GaugeGradientEnabled Property...................................................................................... 137
GaugeMarkerFont Property.............................................................................................. 137
GaugeTitleFont Property.................................................................................................. 137
GaugeTitleTextVisible Property ........................................................................................ 137
GaugeValueTextVisible Property ...................................................................................... 138
KPIControlStyle Property ................................................................................................. 138
KPIType Property ............................................................................................................ 138
OEEKPIFilter.FilterDuration Property ................................................................................ 138
OEEKPIFilter.FilterEndOffset Property.............................................................................. 139
OEEKPIFilter.FilterStartOffset Property ............................................................................ 139
OEEKPIFilter.FilterTimeUnit Property ............................................................................... 139
OEEKPIFilter.FilterType Property ..................................................................................... 140
SecondZoneColor Property .............................................................................................. 140
SecondZoneCutoff Property ............................................................................................. 140
TargetValue Property ...................................................................................................... 140
ThirdZoneColor Property ................................................................................................. 141
Methods of the OEE KPI Control ............................................................................................ 141
Filter() Method ................................................................................................................ 141

Chapter 19 Production Control ........................................................................................ 143

Introduction to the Production Cont rol ..................................................................................... 143
Configuring the P roduction Control ......................................................................................... 143
Using the Production Control ................................................................................................. 144
Properties of the Production Control ....................................................................................... 144
AddAssignSerialNumbersEnabled Property ...................................................................... 144
AddProdEnabled Property ............................................................................................... 144
ProcessEnabled Property ................................................................................................ 144
ReduceProdEnabled Property .......................................................................................... 145
RejectsEnabled Property ................................................................................................. 145
SetLotDataEnabled Property ............................................................................................ 145
Trans ferSerialNumbersEnabled Property .......................................................................... 145
ViewItemAttribut esEnabled Property................................................................................. 145
Methods of the Production Control ......................................................................................... 145
AddAssignSerialNumbers() Method .................................................................................. 146
AddProduction() Method .................................................................................................. 146
ItemAttribut es() Met hod ................................................................................................... 146
Process() Method ............................................................................................................ 146
ReduceProduction() Method ............................................................................................ 146
RejectProduction() Method .............................................................................................. 147
10 Version 6.0
Contents MES .NET Controls Developer Guide

SelectRowByKey() Met hod .............................................................................................. 147

SetLotData() Method ....................................................................................................... 147
Trans ferSerialNumbers() Method ..................................................................................... 147

Chapter 20 Production Progress Control ....................................................................... 149

Introduction of the Production Progress Control ...................................................................... 149
Using the Production Progress Control ................................................................................... 149
Logging On to the Production Progress Control ................................................................. 150
Switching Entities ............................................................................................................ 150
Switching Jobs ................................................................................................................ 150
Setting Target Values ...................................................................................................... 151
Properties of the Production Progress Control ......................................................................... 151
BatchSize Property.......................................................................................................... 151
Data. CurrentProduction Property...................................................................................... 151
Data. Deviation P roperty ................................................................................................... 151
DeviationfromPlannedFont Property ................................................................................. 152
DisplayProjectedDetails Property ..................................................................................... 152
FirstZoneColor Property................................................................................................... 152
FirstZoneP ercent Property ............................................................................................... 152
GaugeTextFont Property ................................................................................................. 152
ProductionUnitOfMeasure P roperty .................................................................................. 153
ProjectedP roduction Property........................................................................................... 153
SecondZoneColor Property .............................................................................................. 153
SecondZonePercent Property .......................................................................................... 153
TargetBarColor Property .................................................................................................. 153
TargetQuantity Property................................................................................................... 154
TargetRate Property ........................................................................................................ 154
TargetRateFromDB Property ........................................................................................... 154
TargetUnreachable Property ............................................................................................ 154
ThirdZoneColor Property ................................................................................................. 155
ValueLegendLabelFont Property ...................................................................................... 155
ValueLegendValueBackColor Property ............................................................................. 155
ValueLegendValueColor Property .................................................................................... 155
ValueLegendValueFont Property ...................................................................................... 155
E vents of the Production Progress Control .............................................................................. 155
TargetQuantityChanged E vent ......................................................................................... 156
TargetRateChanged E vent .............................................................................................. 156

Chapter 21 Queue Control ............................................................................................... 157

Introduction to the Queue Control ........................................................................................... 157
Configuring the Queue Cont rol ............................................................................................... 157
Switching Entities ............................................................................................................ 158
Associating the Button Bar Cont rol ................................................................................... 158
Properties of the Queue Control ............................................................................................. 158
AttributesEnabled Property .............................................................................................. 158
BatchJobBGColorOption Property .................................................................................... 159
BatchJobBGCustomColors Property ................................................................................. 160
ColumnHeaderBackColor Property ................................................................................... 160
ColumnHeaderBackColorDifferentEnt Property ................................................................. 160
ColumnHeaderForeColor Property ................................................................................... 160
EndJobE nabled Property ................................................................................................. 160
FlowDiagramEnabled Property ......................................................................................... 161
Font Property .................................................................................................................. 161

Version 6.0 11
MES .NET Controls Developer Guide Contents

ItemAttribut esEnabled Property ........................................................................................ 161

NotesEnabled Property.................................................................................................... 161
PauseJobE nabled Property.............................................................................................. 162
PreviewB omEnabled Property.......................................................................................... 162
ReadyJobEnabled Property ............................................................................................. 162
StartJobEnabled Property ................................................................................................ 163
StartSomeEnabled Property............................................................................................. 163
Methods of the Queue Control ............................................................................................... 163
ApplyDefaultSortParameters() Method .............................................................................. 163
CreateWO() Method ........................................................................................................ 163
EnableDisableButtons() Met hod ....................................................................................... 164
EndJob() Method............................................................................................................. 164
IsPartOfBatch() Method ................................................................................................... 165
JobLogOff() Method ........................................................................................................ 165
LoadConfigS ettings() Method........................................................................................... 166
ParseConfigS ettings() Method ......................................................................................... 166
PauseJob() Met hod ......................................................................................................... 166
PopupAddAssignS erialNumbersDlg() Method ................................................................... 167
PopupItemAttrsDlg() Method ............................................................................................ 168
PopupJobAttrsDlg() Method ............................................................................................. 168
PopupJobBOMDlg() Method ............................................................................................ 168
PopupJobLinksDlg() Method ............................................................................................ 169
PopupJobSplit Dlg() Method ............................................................................................. 169
PopupNotesDlg() Method ................................................................................................ 169
PopupStartSomeDlg() Method ......................................................................................... 170
PopupTransferS erialNumbersDlg() Method ....................................................................... 170
PromptForProdQtys() Method .......................................................................................... 171
ReadyJob() Method ......................................................................................................... 171
ResetBatchJobB GCustomColors() Method ....................................................................... 171
ResetBatchJobColorOptions() Met hod .............................................................................. 171
RestoreGridUIS ettings() Method ...................................................................................... 171
SelectFirstRunningJob() Method ...................................................................................... 172
SelectRowByKey() Met hod .............................................................................................. 172
SerializeConfigSettings() Method ..................................................................................... 172
SetFilterColumns() Met hod .............................................................................................. 172
SetGroupByColumns() Met hod......................................................................................... 173
SetSortColumns () Method................................................................................................ 173
ShowWOFlowDiagram() Method ...................................................................................... 173
StartJob() Method ........................................................................................................... 173

Chapter 22 Route Control................................................................................................. 175

Introduction to the Route Control ............................................................................................ 175
Configuring the Route Control ................................................................................................ 175
Properties of the Route Cont rol .............................................................................................. 176
RefreshEnabled Property ................................................................................................. 176
Methods of the Rout e Control ................................................................................................ 176

Chapter 23 Sample Viewer Control ................................................................................ 177

Introduction to the Sample Viewer Cont rol .............................................................................. 177
Configuring the Sample Viewer Control .................................................................................. 177
Using the Sample Viewer Control ........................................................................................... 178
Logging on to the Sample Viewer ..................................................................................... 178
Viewing the Samples ....................................................................................................... 178

12 Version 6.0
Contents MES .NET Controls Developer Guide

Sample Data Dis play ................................................................................................. 179

Characteristic Data Display ........................................................................................ 180
Result Data Display ................................................................................................... 180
Selecting Context ............................................................................................................ 180
Editing Sample Information .............................................................................................. 181
Pulling Samples .............................................................................................................. 181
Unpulling Samples .......................................................................................................... 182
Toggling the Sample Final Flag ........................................................................................ 182
Launching an SPC Chart ................................................................................................. 182
Entering and Editing Sample Results ................................................................................ 183
Verifying the Result Entries ........................................................................................ 184
How the Results Are Processed ................................................................................. 184
Canc eling a Sample ........................................................................................................ 185
Filtering the Samples Displayed in the Sample Viewer Control ........................................... 185
Setting Status Color Coding for Samples, Characteristics, and Results ............................... 187
Properties of the Sample Viewer Cont rol ................................................................................ 190
Canc elSampleEnabled Property ....................................................................................... 190
EditResultsEnabled Property ........................................................................................... 190
EditSampleE nabled Property ........................................................................................... 191
EndTimeFilter Property .................................................................................................... 191
EntityFilter Property ......................................................................................................... 191
EntityFilterRestriction Property ......................................................................................... 191
FilterEnabled Property ..................................................................................................... 192
ItemCategory NameFilter Property .................................................................................... 192
ItemFilter Property ........................................................................................................... 192
LaunchSpcChartEnabled Property.................................................................................... 192
OperationFilter Property................................................................................................... 193
PullSampleE nabled Property ........................................................................................... 193
RequireEntityLogon Property ........................................................................................... 193
RefreshRate Property ...................................................................................................... 193
SampleNameFilter P roperty ............................................................................................. 194
SpcChartEnabled Property .............................................................................................. 194
StartTimeFilter P roperty ................................................................................................... 194
StatusFilter Property ........................................................................................................ 194
ToggleSampleFinalFlagEnabled Property ......................................................................... 195
UnpullSampleEnabled Property........................................................................................ 195
UserFilter Property .......................................................................................................... 195
WorkOrderFilter Property ................................................................................................. 195
Methods of the Sample Viewer Control ................................................................................... 196
Canc elSample() Method .................................................................................................. 196
EditSampleInfo() Method ................................................................................................. 196
EditSampleResults() Method............................................................................................ 196
Filter() Method ................................................................................................................ 196
LaunchSpcChart() Met hod ............................................................................................... 196
PullSample() Method ....................................................................................................... 197
SelectRowByKey() Met hod .............................................................................................. 197
ToggleFinalFlag() Method ................................................................................................ 197
ValidEntityFilter() Method................................................................................................. 198
E vents of the Sample Viewer Cont rol ..................................................................................... 198
SelectedRowChanged E vent ........................................................................................... 198
StatusChanged E vent ...................................................................................................... 198

Chapter 24 SPC Chart Control ........................................................................................ 199

Introduction to the SPC Chart Cont rol ..................................................................................... 199

Version 6.0 13
MES .NET Controls Developer Guide Contents

Using the SPC Chart Control ................................................................................................. 200

Retrieving Data ............................................................................................................... 200
Displaying Data ............................................................................................................... 201
Chart Ty pes .................................................................................................................... 202
Displaying Control Rule Violations .................................................................................... 203
Runtime Interaction with the Chart ......................................................................................... 205
Toggling Areas of the Chart Window On and Off ............................................................... 206
Zooming on a Chart ......................................................................................................... 207
Assigning a Cause to a Sample Point ............................................................................... 208
Adding a Not e to a Sample Point ...................................................................................... 209
Marking a Sample Point as a Control Move ....................................................................... 210
Marking a Sample Point to Be Ignored in Sample Calculations ........................................... 210
Properties of the SPC Chart Control ....................................................................................... 211
AlarmPointColor Property ................................................................................................ 211
CharacteristicNameFilter Property .................................................................................... 212
Chart Title Property .......................................................................................................... 212
Chart Type Property ......................................................................................................... 213
ColorPointsInAlarm Property ............................................................................................ 214
DataPointColor P roperty .................................................................................................. 214
DisplayChartEnabled Property ......................................................................................... 215
Display XaxisLabelChanges Property ................................................................................ 215
Display XaxisLabelFrequency Property.............................................................................. 216
EnableCollapsibleToggles Property .................................................................................. 216
EndTimeFilter Property .................................................................................................... 216
EntityIdFilter Property ...................................................................................................... 217
EntityNameFilter Property ................................................................................................ 217
Graph Position Properties ................................................................................................ 217
HeaderLevel Property ...................................................................................................... 219
ItemCategory IdFilter Property .......................................................................................... 219
ItemCategory NameFilter Property .................................................................................... 220
ItemIdFilter Property ........................................................................................................ 220
LanguageStrings Property ............................................................................................... 220
LineAttributeColor Property .............................................................................................. 221
NumberOfPointsFilter Property......................................................................................... 222
OperationIdFilter Property ................................................................................................ 222
OutOfLimitsPointSymbol Property .................................................................................... 223
OutOfLimitsPointSymbolSize Property .............................................................................. 224
PlotPrimaryMeasurementValues Property ......................................................................... 224
PointsPerPage Property .................................................................................................. 225
Primary ChartMinY and PrimaryChartMaxY Properties ....................................................... 225
ProcessIdFilt er Property .................................................................................................. 226
RefreshRate Property ...................................................................................................... 226
ResetFiltersEnabled Property........................................................................................... 226
SecondaryChartMinY and SecondaryChartMaxY Properties .............................................. 226
SegmentRequirementIdFilter Property .............................................................................. 227
SegmentRes ponseIdFilter Property .................................................................................. 227
ShowAlarmIndicators Property ......................................................................................... 227
ShowCalculatedV alues Property ...................................................................................... 228
ShowControlMove Property ............................................................................................. 229
ShowCpkValues Property ................................................................................................ 229
ShowCpV alues Property .................................................................................................. 229
ShowIgnoreS ample Property ........................................................................................... 230
ShowNot esIndicators Property ......................................................................................... 230
ShowP pkValues Property ................................................................................................ 231
ShowP pValues Property .................................................................................................. 231

14 Version 6.0
Contents MES .NET Controls Developer Guide

ShowP rimaryChart Property............................................................................................. 231

ShowP rimaryHistogram Property...................................................................................... 232
ShowRes ultValues Property............................................................................................. 232
ShowS ampleSizes Property ............................................................................................. 233
ShowS econdary Chart Property ........................................................................................ 233
ShowS econdary Histogram Property ................................................................................. 234
ShowTable Property ........................................................................................................ 235
ShowTimes Property ....................................................................................................... 235
ShowZones Property ....................................................................................................... 236
SiteNameFilter Property................................................................................................... 236
SpareNFilter Properties ................................................................................................... 237
StartTimeFilter P roperty ................................................................................................... 237
TableAlarmEmphasis Property ......................................................................................... 237
TableB ackgroundColor Property ...................................................................................... 238
TableStripeColor Properties ............................................................................................. 238
UserId Property ............................................................................................................... 239
WorkOrderIdFilt er Property .............................................................................................. 239
XAxisLabel Property ........................................................................................................ 239
XAxisLabelRotation Property ........................................................................................... 240
Methods of the SPC Chart Control ......................................................................................... 241
ClearFilters() Method ....................................................................................................... 241
DisplayChart() Met hod ..................................................................................................... 242
ResetFilters () Method ...................................................................................................... 242

Chapter 25 Spec Control .................................................................................................. 243

Introduction to the Spec Control ............................................................................................. 243
Configuring the Spec Control ................................................................................................. 243
Properties of the Spec Control ............................................................................................... 243
EditSpecificationsEnabled Property .................................................................................. 243
RefreshEnabled Property ................................................................................................. 244
UpdateJobSpecsEnabled Property ................................................................................... 244
UpdateTemplat eSpecsEnabled Property .......................................................................... 244
ViewSpecDocumentEnabled Property .............................................................................. 244
Xceed.Grid.RowSelectedJobSpecGroupRow Property ...................................................... 244
Methods of the Spec Control .................................................................................................. 245
PopUpEditSpecDlg() Method ........................................................................................... 245
SelectRowByKey(Int32,String) Method ............................................................................. 245
SelectRowByKey(Int32,String,Boolean) Method ................................................................ 245
UpdateSpecValues() Method ........................................................................................... 246

Chapter 26 Steps Control ................................................................................................. 247

Introduction to the Steps Control ............................................................................................ 247
Configuring the Steps Cont rol ................................................................................................ 247
Properties of the Steps Control .............................................................................................. 248
ActionEnabled Property ................................................................................................... 248
AuthorizeE nabled Property .............................................................................................. 248
BypassEnabled Property ................................................................................................. 248
CompleteEnabled Property .............................................................................................. 248
E ventEnabled Property .................................................................................................... 248
LoginEnabled Property .................................................................................................... 249
LogoutEnabled Property .................................................................................................. 249
ReworkEnabled Property ................................................................................................. 249
SetLotDataEnabled Property ............................................................................................ 249
Version 6.0 15
MES .NET Controls Developer Guide Contents

ShowListEnabled Property ............................................................................................... 249

ViewEnabled Property ..................................................................................................... 249
Methods of the Steps Control ................................................................................................. 250
Authorize() Met hod .......................................................................................................... 250
DisplayJobE ventDialog() Method...................................................................................... 250
ExecuteStepAction() Method............................................................................................ 250
LaunchCurrentStepDocument () Method ........................................................................... 250
LogoutCurrentStep() Method............................................................................................ 250
OnLotNoChanged() Method ............................................................................................. 250
OnStepDataE ntered() Method .......................................................................................... 251
OnStepGroupChanged() Method...................................................................................... 251
OnStepStateChanged() Method ....................................................................................... 251
PopupAnalogEnt ry() Method ............................................................................................ 251
PopupRadioB uttonEntry () Method .................................................................................... 252
ProcessDataTy peForSelectedLot() Method ....................................................................... 252
Rework() Method............................................................................................................. 252
SetLotData() Method ....................................................................................................... 252
ShowOperat orsOnThisStep() Method ............................................................................... 252
StepBypass() Method ...................................................................................................... 252
StepComplet e() Method................................................................................................... 253
StepLogin() Method ......................................................................................................... 253

Chapter 27 Utilization Control .......................................................................................... 255

Introduction to the Utilization Control ...................................................................................... 255
Configuring the Utilization Control .......................................................................................... 255
Using the Utilization Control ................................................................................................... 256
Switching Entities ............................................................................................................ 257
Associating the Button Bar Cont rol ................................................................................... 257
Configuring the Filters...................................................................................................... 258
Multiple Selection for Reason Entry/Editing ....................................................................... 259
Configuring Split Utilization Functionality........................................................................... 259
Using Split Utilization Functionality ................................................................................... 261
Splitting an E vent ............................................................................................................ 261
Properties of the Utilization Control ........................................................................................ 263
AddProductionEnabled P roperty ...................................................................................... 263
AutoSelNewE vents Property ............................................................................................ 263
EditFinalReasonEnabled Property .................................................................................... 263
EndJobE nabled Property ................................................................................................. 263
FilterDefaultsFromDB Property......................................................................................... 264
FilterEnabled Property ..................................................................................................... 264
SetPastReasonEnabled Property ..................................................................................... 264
SetReas onEnabled Property ............................................................................................ 264
StartDEJobE nabled Property ........................................................................................... 264
StartDEJobP rodRat eFieldVisible Property ........................................................................ 265
StartDEJobUOMFieldVisible Property ............................................................................... 265
UtilRefreshEnabled Property ............................................................................................ 265
UtilizationFilter.FilterEndOffset Property............................................................................ 265
UtilizationFilter.FilterLastNE vents Property ....................................................................... 266
UtilizationFilter.FilterLastNHours Property ......................................................................... 266
UtilizationFilter.FilterMinDuration Property ........................................................................ 266
UtilizationFilter.FilterStartOffset Property .......................................................................... 266
UtilizationFilter.FilterTime P roperty ................................................................................... 267
UtilizationFilter. UtilFilterUnAck Property ............................................................................ 267
UtilizationFilter. UtilStatusFilter Property ............................................................................ 267

16 Version 6.0
Contents MES .NET Controls Developer Guide

UtilizationFilter. UtilTimeFilterType Property ....................................................................... 268

UtilizationSplitEnabled Property ....................................................................................... 268
Methods of the Utilization Control ........................................................................................... 268
AddProduction() Method .................................................................................................. 268
EditComment() Method.................................................................................................... 269
EditFinalReason() Method ............................................................................................... 269
EndJob() Method............................................................................................................. 269
Filter() Method ................................................................................................................ 269
GetButtonMenuItems() Method ........................................................................................ 269
GetOEEExecDat a() Method ............................................................................................. 269
SetPastReason() Method................................................................................................. 270
SetReas on() Method ....................................................................................................... 270
StartDEJob() Method ....................................................................................................... 270
UtilizationSplit() Method ................................................................................................... 270

Appendix A Buttons ........................................................................................................... 271

Introduction to Buttons........................................................................................................... 272
Action................................................................................................................................... 273
Accept Job ........................................................................................................................... 273
Add Consumption ................................................................................................................. 273
Add Production ..................................................................................................................... 273
Authorize .............................................................................................................................. 274
Add/Assign SNo's ................................................................................................................. 274
BOM Preview ....................................................................................................................... 274
Bypass ................................................................................................................................. 274
Copy Row ............................................................................................................................ 275
Complete.............................................................................................................................. 275
Create Work Order................................................................................................................ 275
Delet e Lot and Sublots .......................................................................................................... 276
Delet e Rows ......................................................................................................................... 276
Edit ...................................................................................................................................... 276
EditComment ........................................................................................................................ 276
Edit Reason.......................................................................................................................... 277
Edit Results .......................................................................................................................... 277
Edit Row............................................................................................................................... 277
Edit Sample .......................................................................................................................... 278
Edit Specs ............................................................................................................................ 278
End Job................................................................................................................................ 278
Entity Logon ......................................................................................................................... 278
E vent ................................................................................................................................... 279
Execute ................................................................................................................................ 279
File Filter .............................................................................................................................. 279
Filter .................................................................................................................................... 279

Version 6.0 17
MES .NET Controls Developer Guide Contents

Help ..................................................................................................................................... 280

Insert Entity Usage Row ........................................................................................................ 280
Insert Job Detail Row ............................................................................................................ 280
Insert Lot or Sublot ................................................................................................................ 280
Insert New Row .................................................................................................................... 281
Job Attributes ....................................................................................................................... 281
Job Logoff ............................................................................................................................ 281
Launch Browser .................................................................................................................... 281
Link Jobs .............................................................................................................................. 282
Log In................................................................................................................................... 282
Log Out ................................................................................................................................ 282
Login.................................................................................................................................... 282
Logout .................................................................................................................................. 283
Lot Attributes ........................................................................................................................ 283
New Row.............................................................................................................................. 283
Notes ................................................................................................................................... 283
Open/Launch Form ............................................................................................................... 284
Pause Job ............................................................................................................................ 284
Print ..................................................................................................................................... 284
Process ................................................................................................................................ 285
Pull Sample .......................................................................................................................... 285
Receive Inventory ................................................................................................................. 285
Reclassify ............................................................................................................................. 285
Reduce Consumption ............................................................................................................ 286
Reduce Production................................................................................................................ 286
Refresh ................................................................................................................................ 286
Rejects ................................................................................................................................. 286
Remove ............................................................................................................................... 287
Rename Lot or Sublot ........................................................................................................... 287
Rework................................................................................................................................. 287
Save Row............................................................................................................................. 287
Scrap ................................................................................................................................... 288
Set Lot Data ......................................................................................................................... 288
Set Past Reason ................................................................................................................... 288
Set Reason .......................................................................................................................... 288
Show List ............................................................................................................................. 289
SPC Chart ............................................................................................................................ 289

18 Version 6.0
Contents MES .NET Controls Developer Guide

Split Job ............................................................................................................................... 289

Split Lot ................................................................................................................................ 289
Start Job............................................................................................................................... 290
Start Some ........................................................................................................................... 290
Switch User .......................................................................................................................... 290
Toggle Chart ......................................................................................................................... 291
Toggle Sample Final Flag ...................................................................................................... 291
Trans fer In ............................................................................................................................ 291
Trans fer Out ......................................................................................................................... 291
Trans fer Serial Numbers........................................................................................................ 292
UnPull Sample ...................................................................................................................... 292
Update Job Spec. Values ...................................................................................................... 292
Update Template Spec. Values .............................................................................................. 292
Utilization Split ...................................................................................................................... 293
View..................................................................................................................................... 293
View Flow Diagram ............................................................................................................... 293
View Item Attributes .............................................................................................................. 293
Waste .................................................................................................................................. 294

Index ....................................................................................................................................... 295

Version 6.0 19
 MES .NET Controls Developer Guide

C HAPTER 1
Using .NET Controls
In This Chapter
Introduction to Using .NE T Controls ............................................................................................... 21
About .NE T Controls ..................................................................................................................... 22
Organizing .NE T Controls .............................................................................................................. 22
Importing .NE T Controls ................................................................................................................ 23
Securing .NE T Controls ................................................................................................................. 27
Configuring .NE T Cont rol E vent Scripts .......................................................................................... 27
Using Controls in ArchestrA Symbols ............................................................................................. 32
Using Controls in InTouch ............................................................................................................. 36
Using Properties in Application Server Scripts ................................................................................ 37
Using Common Control Properties ................................................................................................. 37
Viewing and Changing the Properties of .NE T Cont rols ................................................................... 39
Viewing Additional .NE T Control Information ................................................................................... 43
Binding .NE T Control Properties to Attributes or Element R eferences .............................................. 45
Animating .NE T Controls ............................................................................................................... 47
About Operator Cont rols ............................................................................................................... 47
About Data Editor Cont rols ............................................................................................................ 49
About Miscellaneous Controls........................................................................................................ 49
On-Screen Keyboard .................................................................................................................... 50

Introduction to Using .NET Controls

This section shows you how to import the .NE T controls into a Galaxy, configure them, and use them at
run time in an InTouch application.
Hereafter, the word "control" refers to any of the .NE T controls.
The following list summarizes the major steps in using the .NE T cont rols:
1. Import the .NE T cont rols.
2. Embed the .NE T controls into ArchestrA symbols.
3. Configure the ArchestrA symbols to access data and contain s cripts.
4. Embed the ArchestrA symbols into a managed InTouch application.
5. Deploy the InTouch application to one or more target computers.
6. Run InTouch WindowViewer on the target computers and interact with the soft ware server.
You can plac e multiple .NE T controls into one single A rchestrA symbol. You can also place multiple
instances of the same .NE T control into one single ArchestrA control. There is no limit to the number of
.NET controls you can embed into an A rchestrA symbol.
The MES .Net controls can be localized using the Language strings. You can use the MES Client
Languages module to search for a specific string and make the modification. For more information, see
the Language section in the MES Client User’s Guide or online help.

Version 6.0 21
MES .NET Controls Developer Guide Using .NET Controls

About .NET Controls

.NET controls give you functionality to use in symbols. To use this functionality, you must:
 Import the .dll file containing one or more .NE T controls. The .NE T control is imported into the
Graphic Toolbox.
 Browse and embed one or more of the .NE T controls into a new or existing symbol. The .NE T
controls appear as elements.
 View and edit the ex posed . NE T control properties.
 Bind the .NET control properties to ArchestrA attributes, symbol custom properties, or InTouch tags.
Do this using the data binding animation.
 Configure scripts for .NE T control events. Do this using the events animation.
You can then use the symbol containing the embedded .NE T control in an InTouch applicati on.

Organizing .NET Controls

You can organize the .NE T cont rols within the Graphic Toolbox the same way as you would with
ArchestrA Graphics. You can do the following:
 Rename .NE T controls.
 Move .NE T controls in and out of Graphic Toolsets.
 Delet e .NE T controls.
For more information, see the Creating and Managing ArchestrA Graphics User’s Guide.

22 Version 6.0
Using .NET Controls MES .NET Controls Developer Guide

Importing .NET Controls

The . NE T Controls are installed in the MES\ Control s folder during the installation. All the control . dll files
present in the MES\Control s directory are enclos ed in the MES Control s.aaPKG file. You can also
import individual control .dll files or all the .NE T Cont rols into the ArchestrA IDE by importing the
MES Control s.aaPKG file.
To import the MES Control s.aaPKG file, click Galaxy > Import > Object(s).
If y ou import a newer version of a . NE T cont rol that is already used in the ArchestrA IDE or in the InTouch
HMI as an embedded ArchestrA Symbol, you need to restart the ArchestrA IDE or the InTouch HMI.
To import a .NE T control, you must have security permissions to import graphic objects.
After importing .NE T controls, you can organize them in the Graphic Toolbox similar to the ArchestrA
Symbols. For more information, see Organizing .NET Controls on page 22.

Note: If you select .NET .dll files that do not contain .NET controls, the import process ignores these and
continues at the next .dll file.

To import .NET controls

1. Open the ArchestrA Integrat ed Development Environment (IDE ).
2. On the Galaxy menu, point to Import, and then click Client Control. The Import Client Control(s)
dialog box appears.

3. Browse to the MES\ Control s folder creat ed during MES installation.

4. Select the .dll files for the .NE T controls you want to use.
For a list of the available .dll files, see MES .NET Control .dll Files on page 25.
5. Click Open. The Import Preferences dialog box appears.

Version 6.0 23
MES .NET Controls Developer Guide Using .NET Controls

6. Click OK. The Import Client Control (s) progress dialog box appears.

7. When the import is finished, click Close.

8. In the Graphic Toolbox, expand the Galaxy name node. The imported controls appear in the list.

Note: If the import fails, a message indicates the er ror in the Import Client Control(s) dialog box.

24 Version 6.0
Using .NET Controls MES .NET Controls Developer Guide

MES .NET Control .dll Files

The following table lists the available MES .NE T Control .dll files and links to the topics that describe how
they can be used.

DLL Name Control Name and Links to More Information

FactMES.Controls.ButtonBar Configuring the Button Bar Cont rol on page 67

FactMES.Controls.Audit Configuring the Audit Control on page 63

FactMES.Controls.Consumption Configuring the Consumption Control on page 79

FactMES.Controls.CountsOrDurationControl Counts/Duration KPI Control on page 83

FactMES.Controls.DataLog Configuring the Data Log Cont rol on page 93

FactMES.Controls.EntityUsageEditor Configuring the Entity Usage Editor Control on page

99
FactMES.Controls.Folders Configuring the Folders Control on page 101

FactMES.Controls.Genealogy Configuring the Genealogy Control on page 107

FactMES.Controls.Inventory Configuring the Inventory Control on page 111

FactMES.Controls.ItemConsEditor Configuring the Item Consumption Editor Control on

page 117

FactMES.Controls.ItemLotEditor Configuring the Item Lot Editor Control on page 119

FactMES.Controls.ItemProdEditor Configuring the Item Production Editor Control on
page 121
FactMES.Controls.JobStepDataEditor Configuring the Job Step Data Editor Cont rol on
page 125
FactMES.Controls.JobS ummary Configuring the Job Summary Control on page 127

FactMES.Controls.LaborUsageEditor Configuring t he Labor Usage Editor Control on page

131
FactMES.Controls.OEEKPIControl OEE KPI Control on page 133

FactMES.Controls.Production Configuring the P roduction Control on page 143

FactMES.Controls.ProductionProgressControl Production Progress Control on page 149

FactMES.Controls.Queue Configuring the Queue Cont rol on page 157

FactMES.Controls.Rout e Configuring the Route Control on page 175

FactMES.Controls.SampleViewer Configuring the Sample Viewer Cont rol on page 177

FactMES.Controls.Spec Configuring the Spec Control on page 243

FactMES.Controls.Steps Configuring the Job Step Data Editor Cont rol on

page 125
FactMES.Controls.Utilization Configuring the Utilization Control on page 255

Version 6.0 25
MES .NET Controls Developer Guide Using .NET Controls

Example of Installing the Utilization and Button Bar Controls

You can install the Utilization and Button Bar controls from the .dll files. You can then use these controls
to create an Arc hestrA Symbol containing the Utilization and Button Bar controls.
To install the Utilization and Button Bar control
1. Open the ArchestrA IDE.
2. On the File menu, point to Import, and then click Client Control. The Import Client Control(s)
dialog box appears.
3. Browse to the C:\Program Files\Wonderware\MES\Control s directory and select the following
files:
o Fact.Control s.ButtonBar.dll
o FactMES. Control s.Utilization.dll
4. Click Open. The Import Preferences dialog box appears.
5. Leave the default settings and click OK.
6. When the import is complete, click Close.
7. Open the Graphic Toolbox and expand the Galaxy node. The Utilization control and Button Bar
control are listed as .NE T controls.

Importing Previously Exported .NET Controls

You can import one or more previously exported .NE T controls from an ArchestrA package file (.aaPKG).
Previously the .NE T controls may have been:
 Exported without a symbol or an AutomationObject instance or template.
 Embedded in a symbol and the symbol was export ed.
 Embedded in a symbol and contained in an AutomationObject instance or template and the
AutomationObject was exported.
To import a previously exported ArchestrA package containing one or more .NET
controls
 Import the exported .NE T controls the same way as you would import an AutomationObject from a
package file (.aaPKG). For more information, see the Application Server User’s Guide.

Exporting .NET Controls

You can export .NE T controls as ArchestrA package files (.aaPKG). You can export them:
 Directly from the Graphic Toolbox.
 Indirectly when you export AutomationObjects or symbols referencing them.
You can import the .NE T controls agai n from the exported .aaPKG files.

26 Version 6.0
Using .NET Controls MES .NET Controls Developer Guide

To export .NET controls directly as ArchestrA package files

1. In the Graphic Toolbox, select one or more .NE T controls that you want to export.
2. On the Galaxy menu, point to Export, and then click Object(s).
3. Follow the general procedure for exporting AutomationObjects. For more information, see the
Application Server User’s Guide.

Securing .NET Controls

The .NE T controls use the same security setting as the symbols. You can set the security for .NE T
controls and symbols in the Security dialog box of the ArchestrA IDE. For more information, see the
Creating and Managing ArchestrA Graphics User’s Guide.

Configuring .NET Control Event Scripts

You can configure an ArchestrA script that runs when a .NET control event occurs. You do this using the
Event animation.
To configure an ArchestrA script for a .NET control event
1. Double-click the embedded .NE T control on the canvas. The Edi t Animations dialog box appears.

2. In the animation list, click Event. The right pane shows the events configuration.
3. In the Event list, select the event for which you want to execute a script. The Parameters list shows
for the selected event:
o Type: the data type of each parameter.
o Name: the name of each parameter.
4. In the script area, write the event script.

Version 6.0 27
MES .NET Controls Developer Guide Using .NET Controls

5. If y ou want to insert an event parameter in your script, click the Select Event Parameter icon. Select
the paramet er. The paramet er name is inserted into the script at the cursor position.

6. If you want to configure scripts for other events, select the event from the Event list.
You can select the following three main events from the Event list:
o SelectedRowChanged
o PreButtonClick
o PostButtonClick
7. The script area is cleared and you can write the script for the newly selected event.
8. When you are finished, save and close.

Selected Row Changed Event

When the script runs and needs an information from a row, you can use the SelectedRowChanged
event. This event is triggered when an operator selects a new row. The row is returned as a part of the
event. This event does not trigger when the grid is initially loaded or shows only one rec ord.

However, for scripts outside the .NE T control, a referenc e to the name of the control is required. For
example, to get access to the Queue Control displayed in the image, a referenc e to the name is required:
dim row as xceed.grid.datarow;
row = QueueControl1.FactGrid.SelectedRow;
if (row <> null) then
ProcessID = row.Cells("process_id").value;
endif;

28 Version 6.0
Using .NET Controls MES .NET Controls Developer Guide

Properties of the SelectedRowChanged Event

The properties shown in the SelectedRowChanged event depend on the control that you select in the
Event list.

For example, the Queue control displays the following properties:

 EntId
 WOId
 OperId
 SeqNo
 Row
The EntId, WOId, OperId, and SeqNo properties return the key information for a job as the Job Queue
control is selected for configuration. However, all controls display a Row or Rows property, which
contains the information about the selected row. The Cells option in this Row property retrieves data
from a specific column in the row object.
However, some of the .NE T control grids allow you to select multiple rows. You can use the
SelectedRows property for these grids. To access a specific row when multiple rows are selected, use
the FactGrid.SelectedRows.Item(0) data type. The (0) in this parameter indicates the first row in the
collection.

Pre- and Post-Button Click Events

The button bar that is associated with a .NE T control sends the pre - and post-button click events on the
associated control.
For example, when an operator opens a window in the application that provides the Job/Work Queue
control and an associated button bar.

Version 6.0 29
MES .NET Controls Developer Guide Using .NET Controls

1. If the control does not locate an existing client session, then the user is prompted to connect, and
then log on to one or more entities.
The Job Queue control displays various jobs assigned to an entity.
2. If the user selects one of the jobs, and then clicks the Start Job button on the button bar, the Start
Job button event is triggered.
The PreButtonClicked event is triggered.
In the following example, the PreButtonClicked event is captured using the e.ButtonID property of
the event.

Each button cont ains an associated ID. However, you can also create custom buttons and assign a
custom ID number to the buttons.
3. The start event is detected and the row that a user selects in the grid is retrieved.
4. The values from the selected row are read into attributes and the Start command is canceled.
If a command is canceled, the .NE T c ontrol does not execute the start transaction and calls a c ustom
script to perform the Start command to include additional transactions.

Properties of the PreButtonClicked and PostButtonClicked Events

The PreButtonClicked and PostButtonClicked events contain the following common properties:
 Cancel
The Cancel property is only available on the PreButtonClicked event that cancels the execution of
the button code.
 ButtonDesc
 ButtonID

30 Version 6.0
Using .NET Controls MES .NET Controls Developer Guide

 UserData

For information on the ButtonI D property, see Buttons on page 271. The ButtonDesc and UserData
properties are configured by an operat or.
The PostButtonClicked event is similar to the PreButtonClicked event. However, it is triggered after
the button command is completed and is used to perform the post condition transactions, such as
updating attributes or logging information to an external system.

Example of Configuring an Event Script for the Utilization Control

Install and embed the Utilization control into a symbol as described in:
 Example of Installing the Utilization and Button Bar Controls on page 26.
 Embedding . NET Controls into a S ymbol on page 32.
In this example, when one of the rows in the Utilization grid is selected, a message is logged in the Log
Viewer.
To configure the Utilization control to log a message when a row is selected
1. In the Arc hestrA Symbol Editor, double-click the embedded Utilization control.
2. In the animation list, click Event.
3. In the Event list, click the SelectedRowChanged event.
4. In the script area, type the following:
LogMessage("User selected a row.");
5. Save and close the Edit Animations dialog box.
6. Save and close the A rchestrA Symbol Editor.
7. Embed the symbol in a managed InTouch application.
8. Switch to run time and log on to the software.
9. Select a row in the grid of the Utilization control.
10. Check the SMC Log Viewer. The message Us er selected a row appears.

Version 6.0 31
MES .NET Controls Developer Guide Using .NET Controls

Using Controls in ArchestrA Symbols

After you import cont rols, you can configure them by embedding them into ArchestrA symbols.
You can embed one or more controls into an ArchestrA symbol and add graphical feat ures from the
ArchestrA Symbol Editor to access the methods and properties of the control.
For example, you can create an ArchestrA symbol to contain the:
 Button Bar control
 Utilization control
The Button Bar control is a special .NET cont rol. You can associate the Button Bar control with another
.NET control in the symbol. At run time, the Button Bar control provides a collection of buttons you can
use to pass commands to the .NE T control.
You can furt her add buttons, input boxes, and many other elements to your symbol to interact with these
embedded controls.

Embedding .NET Controls into a Symbol

You must embed the installed .NE T controls into ArchestrA symbols so that you can configure and use
them.
We recommend that you do not overlap . NE T controls with other elements on the canvas. Ot herwise, the
.NET controls may not work correctly.
Note: Embedding the Button Bar cont rol is a special case. For more information, see Embedding the
Button Bar Control on page 67.

To embed a .NET control into an ArchestrA Symbol

1. Open the ArchestrA IDE.
2. In the Graphic Toolbox, select the Galaxy.
3. On the Galaxy menu, point to New, and then click Symbol. A new symbol is added to the list with a
default name.
4. Rename the symbol, for example as OperatorPanel.
5. Double-click the symbol. The ArchestrA Symbol Editor appears.
6. On the Edit menu, click Embed Graphic.

32 Version 6.0
Using .NET Controls MES .NET Controls Developer Guide

The Galaxy Browser appears.

7. Select the control you want to embed from the right pane and click OK.

The pointer changes to paste mode .

8. Click on the canvas where you want to place t he control. The .NE T c ontrol is placed onto the c anvas.

Version 6.0 33
MES .NET Controls Developer Guide Using .NET Controls

You are now ready to configure the control or you can embed more controls.

Configuring Controls
You can configure controls in the same way as you would configure .NE T client controls embedded into
ArchestrA symbols:
 Bind control properties to ArchestrA attributes, InTouch tags, properties of elements, or symbol
custom properties.
 Write scripts and associate them with .NE T events.
 Access .NET properties and methods from ot her elements in the ArchestrA symbol.
To bind ArchestrA attributes, InTouch tags, element properties or custom properties to
a control
1. Open the symbol in the ArchestrA Symbol Editor that contains the control.
2. Double-click the embedded control. The Edit Animations dialog box appears.

3. In the left pane, select Data Binding.

4. In the right pane, locate the control property you want to bind.
5. In the Reference box, type the name of the ArchestrA attribute, InTouch tag, element property, or
custom property. For more information, see the Creating and Managing Arc hestrA Graphics User’s
Guide.
6. When you are finished, click OK.
To associate scripts with control events
1. Open the symbol in the ArchestrA Symbol Editor that contains the control.

34 Version 6.0
Using .NET Controls MES .NET Controls Developer Guide

2. Double-click the embedded control. The Edit Animations dialog box appears.

3. In the left pane, select Event.

4. In the Event list, select the control event that triggers the script.
5. Write your script in the script window. For more information on scripting, see the Application Server
User’s Guide.
6. When you are finished, click OK.
To access .NET properties and methods from other symbol elements
1. Open the symbol in the ArchestrA Symbol Editor that contains the control.
2. Double-click on the elements you want to interact with the embedded cont rol. The Edit Animations
dialog box appears.
3. Add an appropriate animation to the left pane.
In the right pane, depending on the animation type, you can configure and browse for references.
4. Browse for a reference. The Galaxy Browser appears.

Version 6.0 35
MES .NET Controls Developer Guide Using .NET Controls

5. Click the Element Browser tab.

6. In the left pane, select the embedded control. The right pane shows the methods and properties of
the control.
7. Select a property or method and click OK.

Using Controls in InTouch

You can configure InTouch to use the soft ware controls similar to any other .NE T control that you
indirectly embed by using ArchestrA symbols. For more information about embedding Arc hestrA
symbols that contain .NE T controls, see the ArchestrA and InTouch Integration Guide.

Logging On and Off Controls

The controls can use InTouch security to authenticate a run time operat or.

InTouch Not Using InTouch Security

If an InTouch application does not use InTouch security or if the current InTouch us er is not an MES
software user, the login dialog appears.
Do one of the following:
 Enter a user name and password to log on to the control. Depending on the control type, a list
appears to pick an entity, or the control is ready for use.
 Click Cancel. The control shows only the No User button. If you click this button, either the Switch
User dialog box appears (if other users are already logged on), or the Login dialog box appears.
When you log off from a control that requires authentication, one of the following events may occur:

36 Version 6.0
Using .NET Controls MES .NET Controls Developer Guide

 The Switch User dialog box appears if another user is logged on to the cont rol.
 The Login dialog box appears if you are the only user using this control.
If you click Cancel on either the Switch User or Login dialog box, the control shows only the No User
button. If you click this button, either the Switch User dialog box appears (if other users are already
logged on), or the Login dialog box appears.

InTouch Using InTouch Security

When using InTouch Security, controls are dis abled until you log on to InTouch.
When you attempt to use a control that requires authentication and identical users are set up, you are
automatically logged on. Depending on the control type, a list is shown for you to pick an entity, or the
control is ready for use.
However, if you are using an InTouch user name that is not configured, the logon dialog box appears, as
it would if you were not using InTouch security. For more information, see InTouch Not Using InTouch
Security on page 36.
If you log off from the control, you remain logged on to InTouc h security.
If you log off from InTouch s ecurity, you can no longer use the control until you log on to InTouch s ecurity
again.

Using Properties in Application Server Scripts

Some properties are not visible in the Application Server Attribut e browser, but you can use them in
scripts if you manually type the property name.

Using Common Control Properties

This section shows you how to:
 Dock a control within an ArchestrA symbol.
 Log on to a control automatically.
 Log on to an entity automatically.
 Refresh a control automatically.
 Save the control configuration.

Docking the Controls Within a Symbol

You can dock a cont rol to the top, bottom, left, or right of a symbol. If you want to dock a control, you must
draw a rectangle first; then you can dock the control to the rectangle.
After docking, the control is moved accordingly.
To dock a control
1. Select the control on the canvas.
2. In the Properties Editor, locate the Dock property.

Version 6.0 37
MES .NET Controls Developer Guide Using .NET Controls

3. Click the arrow down icon. A positioning field appears.

4. Click on the appropriate layout option to position the control in relation to the symbol.

Setting Control and Buttons Alignment

Top Top side of the symbol boundary; horizontally

Right Right side of the symbol boundary; vertically

Bottom Bottom side of the symbol boundary;

horizontally

Left Left side of the symbol boundary; vertically

Fill All sides of the symbol boundary.

None Not docked

Logging on the Controls Automatically

You can configure the controls having an AutoLoginUsers property to log a run time operator on the
control automatically. If you set this property to True, at run time either the logon dialog box appears for
the control, or the current InTouch user is logged on automatically. You can also set a fixed value in the
LoginUserID and LoginUserPass word attributes for the control to logon the operator aut omatically.

Note: The LoginUserI D and LoginUserPa ssword fields only accept hard-coded values and not
references to the object attributes.

If the AutoLoginUsers property is set to False, you need to include a script to log on users to the
controls. For more information, see the MES Stateful API Reference online help.
To log on the software controls automatically
1. Select the control for which you want to enable aut omatic logon.
2. In the Properties Editor, locate the property AutoLoginUsers.
3. Set the value of the property to True.

38 Version 6.0
Using .NET Controls MES .NET Controls Developer Guide

Logging on to Entities Automatically

If one or more controls in your symbol require the run time operator to log on to an entity, you can set the
AutoLogOnEnt property of those controls that require a logon to True. At run time, the control then
opens the logon dialog box for the control. You can also set a fixed value in the LogOnSite and
LogOnEnt Name attribut es for the control to logon to the entity automatically.
The LogOnSite and LogOnEntName fields only accept hard-c oded values and not references to the
object attribut es.
If the AutoLogOnEnt property is set to False, you need to configure a script to log on users to the
controls.
To log on the entity used in software controls automatically
1. Select the control for which you want to enable aut omatic logon to the entity.
2. In the Properties Editor, locate the property AutoLogOnEnt.
3. Set the value of the property to True.

Refreshing the Controls Automatically

You can configure controls to ignore any:
 Internal attempt to refresh the control.
 External attempt to refresh the control with the RefreshData command.
To ignore refres h events, you set the IgnoreRefreshEvents property to True.

Tip: This setting is useful if the symbol contains more than one control and only one of the controls is
visible at a time. Ignoring refresh events also improves performance becaus e hidden cont rols are not
refres hed. For the visible control, set the IgnoreRefreshEvents property to False so that it can show the
latest data.

To ignore refresh events in software controls

1. Select the control for which you want to ignore refresh events.
2. In the Properties Editor, locate the property IgnoreRefreshEvents.
3. Set the value of the property to True.

Viewing and Changing the Properties of .NET Controls

When you embed a .NE T control into a symbol, the native properties of the .NE T cont rol are imported
into the Properties Editor in property categories.
Also, the element container of the .NE T control has properties such as:
 Name
 X, Y, Width, Height, AbsoluteOrigin, RelativeOrigin, and Locked
 FillColor
 TextColor and Font
 Enabled, TabOrder, TabStop, and Vi sible
The element container properties override the native properties of the .NE T control.
You can view and change the properties of the control in the Properties Editor.

Version 6.0 39
MES .NET Controls Developer Guide Using .NET Controls

To view or change the properties of a .NET control

1. Select the embedded .NE T cont rol on the canvas.
2. In the Properties Editor, locate a:
o Cont ainer property in the property categories Graphic, Appearance, Fill Style, Text Style or
Runtime Behavior.
o Native property in other property categories.
3. View or change the locat ed property. For more information, see the Creating and Managing
ArchestrA Graphics User’s Guide.

Example of Changing the Dock Property

Install and embed the Utilization and Button Bar controls into a symbol as described in:
 Example of Installing the Utilization and Button Bar Controls on page 26
 Embedding . NET Controls into a S ymbol on page 32
In this example the Dock properties of the Button Bar and Utilization controls are set.
The Dock properties are set to enable the controls to fill the symbol, resize correctly when the symbol
size is changed, and maintain the correct relative position with other objects when the symbol is resized.
For more information, see Dock Property on page 71.
To set the Dock property of the Button Bar and Utilization controls
1. Select the embedded Button Bar cont rol. The Properties Editor shows all properties of the Button Bar
control.

2. In the Layout property category, locate the property Dock.

40 Version 6.0
Using .NET Controls MES .NET Controls Developer Guide

3. Open the Dock property list and click the Bottom panel (highlighted below) on the layout template.

The Button Bar control is docked to the bottom of the symbol defined by the previously drawn
rectangle.

4. Select the embedded Utilization control. The Properties Editor shows all properties of the Utilization
control.

Version 6.0 41
MES .NET Controls Developer Guide Using .NET Controls

5. In the Layout property category, open the Dock property list and click the Fill panel (highlighted
below) on the layout template.

The Utilization control is resized to fill the size of the previously drawn rectangle.

Example of Changing the ControlInCharge and ButtonBarName

Properties
Install and embed the Utilization and Button Bar controls into a symbol as described in:
 Example of Installing the Utilization and Button Bar Controls on page 26
 Embedding . NET Controls into a S ymbol on page 32
In this example, the ControlInCharge property of the Button Bar control and the ButtonBarName
property of the Utilization controls are set.
The ButtonBarName property is set to associate the Button Bar control with the Utilization control. For
more information, see ButtonB arName Propert y on page 52.
The ControlInCharge property is used to set or get the ID of the control that currently has control of the
Button Bar control. For more information, see ControlInCharge Propert y on page 70.
To set the ControlInCharge property of the ButtonBar control
1. Select the embedded Button Bar control.
The Properties Editor shows all properties of the Button Bar control.
2. In the property category, locate the property ControlInCharge.
3. Set the ControlInCharge property to the name of the Utilization control.

42 Version 6.0
Using .NET Controls MES .NET Controls Developer Guide

To set the ButtonBarName property of the Utilization control

1. Select the embedded Utilization control.
The Properties Editor shows all properties of the Utilization cont rol.
2. In the property category, locate the property ButtonBarName.
3. In the property category, set the ButtonBarName property to the name of the button bar.

Viewing Additional .NET Control Information

You can view:
 Which .dll files, or assemblies, are used for the .NE T control.
 The class name, vendor, and version.
 Which AutomationObjects and Arc hestrA Symbols use the .NE T control.
This information is contained in the .NE T cont rol Properties panels.
The .NE T control properties are different than the properties of the embedded .NE T control. The .NE T
control properties can be viewed in the IDE directly. The properties of the embedded . NE T cont rol can be
viewed in the Properties Editor of the ArchestrA Symbol Editor.

Viewing the .NET Control Assemblies

You can view which .NE T cont rol .dll files, or assemblies, are used for the .NE T control.
To view the .NET control assemblies
1. In the Graphic Toolbox, select the .NE T control.

Version 6.0 43
MES .NET Controls Developer Guide Using .NET Controls

2. On the Galaxy menu, click Properties. The Propertie s dialog box appears.

3. On the General tab, you can view:

o The Primary Assembly, which is the main .dll file.
o Additional Assemblies, which are linked to the main .dll file and automatically loaded.

Viewing Class Name, Vendor, and Version of a .NET Control

You can view the class name, vendor, and version of a .NE T control in its Properties panel.
To view the class name, vendor, and version of a .NET control
1. In the Graphic Toolbox, select the .NE T control.
2. On the Galaxy menu, click Properties. The Propertie s dialog box appears.
3. Click the General tab.

Viewing Objects and Symbols Referencing .NET Controls

You can view which AutomationObjects and ArchestrA Symbols use a given .NE T control. This can be
viewed in the Propertie s dialog box of the .NE T cont rol.
To view objects and symbols referencing a .NET control
1. In the Graphic Toolbox, select the .NE T control.
2. On the Galaxy menu, click Properties. The Propertie s dialog box appears.

44 Version 6.0
Using .NET Controls MES .NET Controls Developer Guide

3. Click Referenced By. The list of objects and symbols using the .NE T control is shown.

Binding .NET Control Properties to Attributes or Element

References
You can bind the properties of an embedded . NE T cont rol to attributes or element references. By binding
properties of an embedded .NE T control, you can use attribut es and element references as source and
consumer of data for the .NE T control properties. You do this with the Data Binding animation.

Version 6.0 45
MES .NET Controls Developer Guide Using .NET Controls

The Data Binding table contains the following information:

Name
The name of the .NE T cont rol property.
Type
The .NE T data type of the property.
Value
The default value of the .NE T control property.
Direction
Indicates if the property is read/ write or just read-only.

Read/write property

Read-only property

Write-only property

Reference
The attribute or element reference the property is bound to

Note: You cannot remove the Dat a Binding animation.

To bind a .NET control property with an attribute or element reference

1. Double-click the embedded .NE T control on the canvas. The Edi t Animations dialog box appears
and the Data Binding animation is selected by default.
2. Locate the .NE T control property that you want to bind with an attribute or element reference.
3. Double-click the Reference box.
4. Do one of the following:
 Type an attribute or element reference.
 Browse for an attribute or element reference by clicking the Brow se button.
5. Repeat above for any other properties you want to bind.
6. Click OK.

Example of Data Binding in the Utilization Control

Install and embed the Utilization control into a symbol as described in:
 Example of Installing the Utilization and Button Bar Controls on page 26
 Embedding . NET Controls into a S ymbol on page 32
In this example, the boolean symbol custom property URE controls whether the Utilization control can be
refres hed.
To use data binding in the Utilization control
1. Create a boolean custom property and rename it URE.
2. In the Arc hestrA Symbol Editor, double-click the embedded Utilization control.
3. From the list of properties in the Data Binding configuration area, locate the UtilRefre shEnabled
property.

46 Version 6.0
Using .NET Controls MES .NET Controls Developer Guide

4. Double-click the Reference box of the UtilRefre shEnabled property.

5. In the Galaxy Browser, select the URE custom property and click OK.
The UtilRefre shEnabled property is now assigned to the element reference URE.

6. Click OK.
7. Place a button on the canvas and configure it with a boolean pushbutton animation that toggles th e
custom property URE.
8. Save and close the symbol.
9. Embed the symbol in a managed InTouch application and test the dat a binding by clicking on the
button in WindowViewer. When you do so, the ability for the Utilization control to refres h is toggled.

Animating .NET Controls

E very .NE T cont rol has these animation types:
 Data binding animations determine which attributes and element references can read and write to
the .NE T control.
 E vent animations assign scripts to individual .NE T control events.
You can add the following animations that correspond to the supported .NE T control container
properties:
 Visibility
 Fill Style
 Text Style
 Location Horizontal
 Location Vertical
 Width
 Height
 Tooltip
 Disable
If you configure thes e animations, the resulting behavior and appearance overrides the behavior and
appearance given by the native properties of the .NE T control.
To add animation to embedded .NET controls
1. Double-click the embedded .NE T control on the canvas. The Edi t Animations dialog box appears.
2. Add animations as you would with any other element. For more information, see the Creating and
Managing ArchestrA Graphics User’s Guide.

About Operator Controls

You use Operator .NE T controls to include parts of the Operator functionality in ArchestrA symbols. You
can use the ArchestrA symbols that contain Operator controls during run time in WindowViewer and
interact with the software.
You can configure the following Operator controls. These .NE T controls correspond to functional areas
of the MES Operator application.

Version 6.0 47
MES .NET Controls Developer Guide Using .NET Controls

Audit
Shows all audit-type certifications required for a job to be complet ed and provides a way for users to
sign-off on these certifications.
Consum ption
Lists the BOM (Bill of Materials) items for the active job. It can be used to report consumption for
those BOM items, and to change their lot numbers or storage locations.
Data Log
Shows the “log” of data values recorded for the active job and allows you to enter new data values.
Folders
Allows an operator to view, edit, and print collection of files associated with a specific job. It also
allows an operat or to download and upload part programs.
Genealogy
Shows the consumption history against the running work order. These records include goods and
waste consumption. It also allows an operator to change previously reported consumption
information.
Inventory
Maintains item consumption editor and storage status of the currently logged on entity and all the
movable storage entities located at the current entity. Allows the operator to view the item
consumption editor and storage status of other entities.
Job Summary
Shows all current job information of a given entity. When multiple jobs are running at once, it
determines which job is active so that you can view and work with that job’s data.
Labor
Shows a history of the current operator’s labor activity.
Allows operators to log on, log off, change their labor codes and their entities.
Production
Reports produced items and allows the operat or to change the lot data and quantity amounts for
each job, and to include good and rejected production of the produced item and its by -products.
Allows the operator to change previously reported production information, to set up default
information for additional production, and to mark a production lot as pr ocessed.
Queue
Shows all jobs queued to an entity. Allows the operat or to change the state of jobs queued to an
entity.
Route
Shows the routing and status of all jobs of a given work order.
Spec
Shows the specifications assigned to the active job, but not assigned to any particular step. Using
this control, you can consult the minimum, maximum, and set point values, as well as any attached
files or comments/instructions. The actual value for the active job is reported here. With the
appropriate user privileges, you can change the specification guidelines, for this job only or for all
subsequent jobs.
Steps
Shows the steps of the currently running job as a procedure guide if steps have been defined for this
job.
Utilization
Shows the history of entity utilization and allows the operator to enter changes to the entity state. If
entity has the ability to track overall equipment efficiency (OEE), calculates the current OEE
percentage for the active entity, and compares that to the entity’s target OEE percentage.

48 Version 6.0
Using .NET Controls MES .NET Controls Developer Guide

About Data Editor Controls

You use the Data Editor .NE T controls to view and edit historical dat a records from the MES database.
You can also use the Data Edit or controls to insert and delet e records.
You can use the following Data Editor controls.
Enti ty Usage Editor
Views, edits, inserts, and delet es the utilization dat a of all entities that are configured to capture
utilization data. Allows data in the util_log and job_util_log_link tables to be maintained.
Item Consumption Editor
Views, edits, inserts, and delet es usage of all cons umed items. Provides the ability to allow normal
consumption data in the item_cons table to be maintained.
Item Lot Editor
Views, edits, inserts, and delet es usage of all item lots. Provides the ability to maintain the lot and
sublot number for an item.
Item Production Editor
Views, edits, inserts, and delet es usage of all produc ed items.
Job Step Data Editor
Views, edits, inserts, and deletes usage of all job steps. Allows data in the job_step_data table to be
maintained.
Labor Usage Editor
Views, edits, inserts, and delet es usage of all labor. Allows data in the labor_usage table to be
maintained.

About Miscellaneous Controls

You can use the following miscellaneous .NET controls.
Sample Viewer
Shows the current, past, and the future samples. Also shows the characteristics assigned to the
samples and the res ults collected for the characteristics. This control allows the user t o modify
existing results and to add new results to characteristics which are associated with current and past
samples. The Sample Viewer control also launches the SPC Chart control to display the results of
measurements taken for a particular characteristic, associated with a set of samples.
SPC Chart
Monitors characteristics associated with the product and the process. Displays the graphical
representation of the data associated with product and process characteristics.
Counts/Duration KPI
Displays a Paret o graph of counts and/or duration of entity's utilization states, reason groups, or
reasons.
OEE KPI
Shows Overall Equipment Effectiveness (OEE) or one aspect of OEE on a dial or bar graph which
displays OEE, Quality, Availability, or Performance an d also indicat es its target value.
Production Progre ss
Displays an operator's progress towards a provided target for the current shift. If there is no current
job or no current shift, the control indicates this and does not display any data.
Button Bar
Hosts buttons for multiple controls on a form. You can set up the Button Bar control to show all the
buttons for all controls or to show only the buttons for the currently active control. This control does
not apply to Job Summary control and SPC Chart control.

Version 6.0 49
MES .NET Controls Developer Guide Using .NET Controls

On-Screen Keyboard
To assist users who do not have a physical keyboard attached to the local machine, text boxes in MES
.NET applications, such as Operator and Data Editor, include a keyboard button. Clicking this button
opens an on-screen keyboard, as shown below.

 After opening the keyboard, the focus for the text entry will be to the text box associated with the
keyboard button.
 You can leave the keyboard open (either displayed or minimized). However, if the keyboard is open
and you click another text box keyboard button, the focus will go to the keyboard and not to the new
text box. You must first click in the new text box before typing on the keyboard to enter text into it.
 The Enter and Tab keys work just like they do on a physical keyboard.
 The keyboard can be resized by clicking and dragging an edge or corner.
Depending on the Windows version, there are additional keyboard features, such as the Fade key
(making it transparent) and selectable options on the option keys. For more information about the
on-screen keyboard features, see the help topic "Use the On-Screen Key board (OSK) to type" on the
Microsoft Support web site.
To change the keyboard language
 Open the Input Method menu on the system tray and select the language.

50 Version 6.0
 MES .NET Controls Developer Guide

C HAPTER 2
Common Properties and Methods
In This Chapter
Common Properties ...................................................................................................................... 51
Common Methods ........................................................................................................................ 55

Common Properties
This section describes properties that are common to the following MES .NE T cont rols: Audit,
Cons umption, Counts/Duration KPI, Data Log, Entity Usage Editor, Folders, Genealogy, Inventory, Item
Cons umption Editor, Item Lot Editor, Item Production Editor, Job Step Data Editor, Job Summary, Labor
Usage Editor, OEE KPI, P roduction, Production Progress, Queue, Route, Sample Viewer, Specs, Steps,
and Utilization.

AppendSaveConfigName Property
Use the AppendSaveConfigName property to determine if the SaveConfigName property value is
appended to an entity ID.
When the configuration data (column widths or sort orders) for a control is saved to the dat abase, the
instance name for the saved configuration (specifically, this is the config_id field in t he UI_Config t able) is
the entity ID by default. The AppendSaveConfigName and SaveConfigName properties allow this
default to be changed.
 If AppendSaveConfigName is set to True and the SaveConfigName is not an empty string, the
SaveConfigName is prepended to the entity ID to form the instance name for the saved
configuration.
For example, if SaveConfigName is ABC and the entity ID is 53, setting the
AppendSaveConfigName to True causes the control’s configuration data to be stored with an
instance name of ABC53.
If AppendSaveConfigName is True, but SaveConfigName is an empty string, the
AppendSaveConfigName property has no effect; the entity ID is used.
 If AppendSaveConfigName is False and the SaveConfigName is not an empty string, the
SaveConfigName is used instead of the entity ID. In other words, the entity ID is not used at all in the
instance name for the saved configuration data.
For example, if SaveConfigName is set to XY Z and AppendSaveConfigName is False, the
control’s configuration data is saved wit h an instance name of XY Z.

Data Type Read/Write Default Value

Boolean R/W True

Version 6.0 51
MES .NET Controls Developer Guide Common Properties and Methods

AutoLoginUser Property
Use the AutoLoginUser property to log an operator on the control automatically. If you set the property
AutoLoginUsers t o True, at run time either the logon dialog box appears for the control, or the current
InTouch user is logged on automatically.
If the AutoLoginUsers property is set to False, you need to configure a script to log on operators to the
controls.

Data Type Read/Write Default Value

Boolean R/W True

AutoLogonEnt Property
Use the AutoLogonEnt property to automatically open the entity logon dialog box.
If one or more controls in your symbol require the run time operator to log on to an entity, you can set the
AutoLogonEnt property of those controls that require a logon to True.
If the AutoLogonEnt property is set to:
 True, the control should automatically open the entity logon dialog box after the operator logs on to
the software.
 False, you need to configure a script to log on operators to the controls.

Data Type Read/Write Default Value

Boolean R/W True

ButtonBarName Property
Use the ButtonBarName property to associate the Button Bar control with the cont rol.
If the optional Button Bar control is to be used in association with a given control, the ButtonBarName
property must be set to the Name property of the ButtonBar instance to be used. This is required
because a form can contain multiple controls and multiple ButtonBars.
The ButtonBarName property is used to associate the correct ButtonBar with the correct control.
Example
For example, suppose a form contains bot h the Utilization and Production controls, and two ButtonBars
named "ButtonBar1" and "ButtonBar2".
If the Utilization cont rol is to be associated wit h the first of these ButtonB ars, its ButtonBarName
property must be set to "ButtonBar1".
Similarly, the Production control’s ButtonBarName property must be set to "ButtonBar2".

Data Type Read/Write Default Value

String R/W ""

52 Version 6.0
Common Properties and Methods MES .NET Controls Developer Guide

ControlLicensed Property
Use the ControlLicensed property to specify that the control is licensed.

Data Type Read/Write Default Value

Boolean Read Only True

ExecuteEnabled Property
Use the ExecuteEnabled property to specify whether the Execute function is enabled.

Data Type Read/Write Default Value

Boolean Read Only True

Font Property
Use the Font property to override the fonts.

Data Type Read/Write Default Value

Font R/W Arial 12 pt

HeadingFont Property
Use the HeadingFont property to set or get the heading font of the grid associated with the control. This
property is only applicable to controls that contain a grid.
The HeadingFont property allows a different font to be used for the grid’s headings. This could be
useful, for example, to show the grid column headings with a larger or bold font.

Data Type Read/Write Default Value

Font R/W Microsoft Sans

Serif, 9.75F,
Regular

IgnoreRefreshEvents Property
Use the IgnoreRefre shEvents property to set whether refresh events are ignored by the control. This
setting is useful if the symbol contains more than one control and only one of the controls is visible at a
time.
Ignoring refresh events also improves performance because hidden controls are not refreshed.
For the visible control, set the IgnoreRefreshEvents property to False so that it can show the lat est
data.

Version 6.0 53
MES .NET Controls Developer Guide Common Properties and Methods

Data Type Read/Write Default Value

Boolean R/W False

LoginUserID Property
Use the LoginUserID property to specify the UserID of an operat or to log on to the control automatically.
The LoginUserPassword property must be set up and the AutoLoginUser property must be True.

Data Type Read/Write Default Value

String R/W

LoginUserPassword Property
Use the LoginUserPassword property to specify the password of an operator to log on to the cont rol
automatically.
The LoginUserPassword property must be set up and the AutoLoginUser property must be True.

Data Type Read/Write Default Value

String R/W ""

Reading this property does not return the user's password unless the password has been previously
written though the same property. That is, it does not provide a way to access a user's password if they
are logging in normally.

LogOnEntName Property
Use the LogOnEntName property to specify the name of the entity to which an operator can
automatically log on.
The AutoLogonEnt property must be True.

Data Type Read/Write Default Value

String R/W ""

LogOnSite Property
Use the LogOnSi te property to specify the site name that det ermines the entity. An operator can log on
to this entity automatically.
The LogOnSite property is required only if sites are used.

Data Type Read/Write Default Value

String R/W ""

54 Version 6.0
Common Properties and Methods MES .NET Controls Developer Guide

SaveConfigName Property
Use the SaveConfigName property to set or get the instance name for the saved configuration. The
instance name can be appended to or replace the entity ID. If blank, the entity ID is used.
For more information, see AppendS aveConfigName Property on page 100.

Data Type Read/Write Default Value

String R/W ““

Common Methods
This section describes methods that are common to the following MES .NE T controls: Audit,
Cons umption, Counts/Duration KP I, Data Log, Entity Usage Editor, Genealogy, Inventory, Item
Cons umption Editor, Item Lot Editor, Item Production Editor, Job Step Data Editor, Job Summary, Labor
Usage Editor, OEE KPI, P roduction, Production Progress, Queue, Route, Sample Viewer, Specs, Steps,
and Utilization controls.
The Job Summary control can access all methods except the I sButtonMenuItemEnabled() met hod.

BeginInit() Method
Use the BeginInit() method to prevent the screen from being updated while a control is starting.
Syntax
BeginInit();

EndInit() Method
Use the EndInit() method to allow screen updates after the control has been started.
Syntax
EndInit();

Execute() Method
Use the Execute() method to start an external application specified in t he commandInfo parameter. If the
underlying control cont ains a grid and a row is selected in t he grid, the method can pass information from
the selected row to the external application. The method can also be used to pass gl obal information to
the external application.
This method is available by means of the Button Bar control and allows the Execute function to be
accessed in a context where a Button Bar cont rol does not exist.
For example, to place the Utilization control in a form that contains a menu, but does not contain the
Button Bar control, the method can be called by a script with corresponding menu options.
For information about how to pass global information or information from the selected row in a grid, see
Passing Information with the ButtonBar Execut e() and LaunchBrowser() Methods on page 60.
Syntax
Execute(commandInfo);
Parameter
commandInfo
A string that specifies the application being launched and any command -line information needed by
the application.

Version 6.0 55
MES .NET Controls Developer Guide Common Properties and Methods

ExecuteButtonMenuCommand() Method
Use the ExecuteButtonMenuCommand() method to execute the specified button menu command.
Syntax
result = ExecuteButtonMenuCommand(menuID, userData);
Parameters
menuI D
An integer that is the ID of the menu command to execute.
userData
The user data attached to the button menu command.

GetButtonMenuItems() Method
Use the GetButtonMenuItem s() method to return the button menu for the associated cont rol. If no
button bar is attached to the control, an empty button menu is returned.
Syntax
result=GetButtonMenuItems();
Return Value
result
A ButtonMenuArrayList of the buttons supported by the control.

Help() Method
Use the Help() method to open the online help file.
This method is available by means of the Button Bar control and allows the Help function to be accessed
in a context where a Button Bar control does not exist.
For example, to place the Utilization control in a form that contains a menu but does not contain the
Button Bar control, the method can be called by script wit h corresponding menu options.
Syntax
Help();

InitializeSuperclass() Method
Use the InitializeSuperclass() method to load the required information from the subclass (the inheriting
control). The InitializeSuperclass() method must be called in the inheriting control's constructor.

Note: This method should be used only to develop a new control bas ed on the comm on control
(FactMES.Cont rols). It should not be used to work with an existing control, such as Utilization, Production
or Queue.

There are two overloads for this method based on whether the inheriting control contains a grid or not.
Syntax for controls containing a grid
InitializeSuperClass(FactGrid, controlType, formStateButton);
Parameters
FactGrid
A reference to the wrapper class to the control's grid.
controltype
A string that defines the type of the descendant control. For example, "Util" or "Steps".
This is the screen portion of the UI_Config key for the control's configuration settings.

56 Version 6.0
Common Properties and Methods MES .NET Controls Developer Guide

formStateButton
A string that appears on the large button in the center of the control that indicates the control's state
when the cont rol is not active. For example, "No User" or "No Entity".
Syntax for controls not containing a grid
InitializeSuperClass(controlType, formStateButton);
Parameters
controltype
A string that indicates the type of the descendant control. For example, "Util" or "Steps".
This is the screen portion of the UI_Config key for the control's configuration settings.
formStateButton
A string that appears on the large button in the center of the control that indicates the control's state
when the cont rol is not active. For example, "No User" or "No Entity".

IsButtonMenuItemEnabled() Method
Use the I sButtonMenuItemEnabled() method to determine whether the specified button menu item is
enabled.
A button menu item is a Button Bar control function, for example Execute, End Job, Refres h, which is
referenced from a menu.
Syntax
result = IsButtonMenuItemEnabled(menuID);
Parameters
menuI D
A integer that indicates the ID of the button menu item.
result
A Boolean value. If True, the button menu it em is enabled. If False, the button menu item is disabled.

LaunchBrowser() Method
Use the LaunchBrow ser() method to launch the browser application specified in the commandInfo
parameter. If the underlying c ontrol contains a grid and a row is selected in the grid, the method can pass
information from the row to the application. The method can also be us ed to pass global information to the
external application.
This method is available by means of the Button B ar control and allows the LaunchBrow ser() function to
be accessed in a context where a Button Bar control does not exist.
For example, to place the Utilization control in a form that contains a menu but does not contain the
Button Bar control, the method can be called by a script with corresponding menu options.
For information about how to pass global information or information from the selected row in a grid, see
Passing Information with the ButtonBar Execut e() and LaunchBrowser() Methods on page 60.
Syntax
LaunchBrowser(commandInfo);
Parameter
commandInfo
A string that provides information needed by the specific application being launched

OpenForm() Method
Use the OpenForm () method to open an external form. This method is only available if the system
parameter, Form Program, is set up.

Version 6.0 57
MES .NET Controls Developer Guide Common Properties and Methods

This method is available by means of the Button Bar control and allows the Execute function to be
accessed in a context where a Button Bar cont rol does not exist.
For example, to place the Utilization control in a form that contains a menu but does not contain the
Button Bar control, the method can be called by a script with corresponding menu options.
Syntax
OpenForm(userData);
Parameter
userData
A string that provides the name of the form and arguments.

RefreshData() Method
Use the Refre shData() met hod to refresh the control by retrieving dynamic data from the database,
re-applying UI configuration settings, and enabling or disabling relevant buttons.
Syntax
RefreshData();

ResetAppendSaveConfigName() Method
Use the Re setAppendSaveConfigName() method to set the AppendSaveConfigName property to its
default value (True).
Syntax
ResetAppendSaveConfigName();

ResetAutoLoginUser() Method
Use the Re setAutoLoginUser() met hod to set the AutoLoginUser property to its default value (True).
Syntax
ResetAutoLoginUser();

ResetAutoLogonEnt() Method
Use the Re setAutoLogonEnt() method to set the AutoLogonEnt property to its default value (True).
Syntax
ResetAutoLogonEnt();

ResetButtonBarName() Method
Use the Re setButtonBarName() method to clear the ButtonBarName property.
Syntax
ResetButtonBarName();

ResetHeadingFont() Method
Use the Re setHeadingFont() method to set the HeadingFont property to its default value (MS Sans
Serif, 9.75 pt).
Syntax
ResetHeadingFont();

58 Version 6.0
Common Properties and Methods MES .NET Controls Developer Guide

ResetIgnoreRefreshEvents() Method
Use the Re setIgnoreRefre shEvents() method to set the Re setIgnoreRefre shEvents property to its
default value (False).
Syntax
ResetIgnoreRefreshEvents();

ResetSaveConfigName() Method
Use the Re setSaveConfigName() method to set the SaveConfigName property to its default value
(empty string).
Syntax
ResetSaveConfigName();

SetGraphicSite() Method
Use the SetGraphicSite() met hod to set the Graphic Site object used to get the InTouch User ID and
Domain.

Note: This method is called by InTouc h to set up the ability to log on the current InTouch user. We do not
recommend using this method in scripting.

Syntax
SetGraphicSite(site);
Parameter
site
IGraphicSite the indicates the object representing the Graphic Site.

SwitchUser() Method
Use the SwitchUser() method to open the Switch User dialog box. The Switch User dialog box is used
to set the currently active operator. If anot her operator logs on, the user interface is changed
appropriately. For example, the new operator's language is used.
This method is available by means of the Button Bar control and allows the SwitchUser function to be
accessed in a context where a Button Bar cont rol does not exist.
For example, to place the Utilization control in a form which cont ains a menu, but does not contain the
Button Bar control, the method could be called by script wit h corresponding menu options.
Syntax
SwitchUser();

TranslateColumnHeadings() Method
Use this method to translate the grid column heading strings, which can contain an embedded string ID.
If the column heading is blank, use a default.
This method translates the grid column heading strings and the grid title. These strings can contain an
embedded string ID. An angle bracket delimited integer is appended to the string, which ref erences a
string_id in the Language table. If a column heading is blank, a default string is used.
Syntax
TranslateColumnHeadings(FactGrid);

Version 6.0 59
MES .NET Controls Developer Guide Common Properties and Methods

Parameter
FactGrid
A string to specify the ID of the grid whose column headings and title are to be translated.

Passing Information with the ButtonBar Execute() and

LaunchBrowser() Methods
The ButtonB ar Execute() and LaunchBrow ser() met hods will pass along the selected row to the
external application if the underlying control contains a grid and a row is selected in the grid.
The value from a column in t he selected row from the grid will be passed if the column name from the grid
is specified in the method's commandInfo parameter. The columns names for the grid can be found by
right-clicking on the grid in the cont rol and then clicking Configure.
These methods can also get global information and pass it on to the external application in the
commandInfo parameter by specifying any of the values listed below wit h an "@" preceding the name.
se ssi on_id
The current session ID.
ent_id
The ID of the current entity.
ent_name
The name of the current entity.
user_id
The ID of the current user.
wo_id
The ID of the current job's work order.
oper_id
The ID of the current job's operation.
seq_no
The sequenc e number of the current job.
item_id
The ID of the item being made by the current job.
item_desc
The description of the item being made by the current job.
wo_desc
The description of the current job's work order.
job_desc
The description of the current job.
util_state_de sc
The description of the utilization state for the current entity.
qty_at_start
The starting quantity of the current job.
batch_size
The batch size of the current job.
qty_prod
The quantity produced for the current job.
qty_reqd
The quantity required for the current job.

60 Version 6.0
Common Properties and Methods MES .NET Controls Developer Guide

qty_rejected
The quantity rejected for the current job.
note s
Notes for the current job

Version 6.0 61
 MES .NET Controls Developer Guide

C HAPTER 3
Audit Control
In This Chapter
Introduction to the Audit Control ..................................................................................................... 63
Configuring the Audit Control ......................................................................................................... 63
Properties of the Audit Control ....................................................................................................... 64
Methods of the Audit Control ......................................................................................................... 64

Introduction to the Audit Control

The Audit control shows all audit-type certifications required for a job to be completed. This control also
lists the operators who have already signed off on a certification. You can use the Audit control to permit
an operator to sign-off these certific ations and enter a comment for each certification.

Configuring the Audit Control

When you use an Audit control in an ArchestrA symbol and the current job has been configured to require
audit sign-off, you can associate the Button Bar control with it. For more information, see Associating the
Button Bar Control with Other Cont rols on page 68.
Operators can use the Button Bar control at run time to:
 Refresh the Audit grid.
 Sign-off and add comments to the selected certification.
 Change the active user.
 Start an external application.
 Start Internet Explorer.
 Open the Help window.

Version 6.0 63
MES .NET Controls Developer Guide Audit Control

Note: The Audit control corresponds to the Audi t tab of MES Operator. For more information, see the
Audit Tab section in the MES Operator Guide or online help.

Properties of the Audit Control

This section describes the properties of the Audit control. For information about the common properties
shared by this control, see Common Properties on page 51.

AuthorizeEnabled Property
Use the AuthorizeEnabled property to get a Boolean value indicating whet her an operator can sign off
on a certification.

Data Type Read/Write Default Value

Boolean Read Only True

RefreshEnabled Property
Use the Refre shEnabled property to get a Boolean value indicating whether this control can be
refres hed or not. This control cannot be refreshed if the operator is not logged on to an MES application
or any MES entity.

Data Type Read/Write Default Value

Boolean Read Only True

Methods of the Audit Control

This section describes the met hods of the Audit control. For information about the common methods
shared by this control, see Common Methods on page 55.

Sign Off() Method

Use the Signoff() method to sign off the certification. An inspector dialog box is displayed to authenticate
a user. After the user is authenticated, the selected certification row in the grid is signed off.

64 Version 6.0
Audit Control MES .NET Controls Developer Guide

Syntax
SignOff();

Version 6.0 65
 MES .NET Controls Developer Guide

C HAPTER 4
Button Bar Control
In This Chapter
Introduction to the Button Bar Control ............................................................................................. 67
Configuring the Button Bar Cont rol ................................................................................................. 67
Properties of the Button Bar Control ............................................................................................... 69
Methods of the Button Bar Control ................................................................................................. 74

Introduction to the Button Bar Control

The buttons for multiple controls on a form can be hosted in a single Button Bar control. You can set up
the Button Bar control to show all the buttons for all controls or to show only the buttons for the currently
active control.

Configuring the Button Bar Control

The Button Bar control is a special control that provides a set of buttons that can be used to send
commands to any other control in the same ArchestrA symbol.
A symbol can contain a control but does not require the B utton Bar control. But, a symbol cont aining only
a Button Bar cont rol does not provide any functionality.
The following list summarizes the major steps in configuring the symbol with the Button Bar Control:
1. Embed the Button Bar cont rol on the canvas.
2. Dock the Button Bar control to the symbol.
3. Embed ot her controls in your symbol.
4. Associate the Button Bar control with a control.

Embedding the Button Bar Control

Before you embed the Button Bar control on the canvas, you should set definite boundaries to the
ArchestrA symbol. To set symbol boundaries, paste a rectangle on the canvas first.

Note: Due to limitations in Microsoft .NE T Framework, you must place the Button Bar control on the
canvas before you embed the control it is referencing.

To embed the Button Bar control

1. Create a new ArchestrA symbol and open it.
2. Select the Rectangle primitive from the Tool s panel.
3. Paste the Rectangle element on the canvas.
4. On the Edit menu, click Embed Graphic. The Galaxy Browser appears.
5. From the Graphic Toolbox, select ButtonBar, and t hen click OK. The cursor appears in insert mode.

Version 6.0 67
MES .NET Controls Developer Guide Button Bar Control

6. Click near the rectangle where you want to paste the Button Bar control. The Button Bar control is
pasted on the canvas.

Docking the Button Bar Control

After you embed the Button Bar control on the canvas, you must dock it to the symbol to prevent it from
overlapping any other controls.
Docking lets you aut omatically position the control in relation to the other elements. You can do this for
the Button Bar cont rol and other controls. For more information, see Dock ing the Controls Within a
Symbol on page 37.

Associating the Button Bar Control with Other Controls

After embed any other control on the canvas, you can associate it with the Button Bar control. You
associate it with the Button Bar cont rol by setting the ButtonBarName property of the other control.
You can also associate multiple controls with the same Button Bar control. For more information, see
Showing the Buttons for a Specific Cont rol on page 68.
To associate a control with the Button Bar control
1. Select the control you want to associate with the Button Bar control.
2. In the Properties Editor, locate the ButtonBarName property.
3. In the Value box, type the name of the Button Bar control you want to associate with the control.

Showing the Buttons for a Specific Control

If multiple controls are associated wit h the same Button Bar control, you assign the buttons of the Button
Bar control to specific controls.

68 Version 6.0
Button Bar Control MES .NET Controls Developer Guide

You assign controls to Button Bar buttons by setting the ShowAllControl sButton property to False and
the ControlInCharge property to the control name.

Control C1 Control C2

ButtonBarName = B1 ButtonBarName = B1

Buttons for C2

Button Bar ShowAllControlsButton = False

Control B1 ControlInCharge = C2

To show the buttons of a specific control in the Button Bar control

1. Select the Button Bar control on the canvas.
2. In the Properties Editor, set the ShowAllControl sButton property to False.
3. In the Properties Editor, locate the ControlInCharge property.
4. In the value box, type the name of the cont rol for which you want to show the buttons.

Note: You must change the ControlInCharge property at runtime to enable buttons for any specific
control.

Properties of the Button Bar Control

This section describes the properties of the Button Bar control. The Button B ar control does not share
any common properties with the other cont rols.

AllowConfiguration Property
Use the AllowConfiguration property to set or get whether the Configure Button Bar dialog box is
available at run time.
This property is set by the controls using the Button Bar control and is base d on the operat or’s
permissions.
Set this property to True to permit the operator to right-click on the Button Bar control, click Configure,
and open the Configure Button Bar dialog box.

Data Type Read/Write Default Value

Boolean R/W True

Version 6.0 69
MES .NET Controls Developer Guide Button Bar Control

BackColor Property
Use the BackColor property to set the color of the background of the area on which the buttons are
placed.

Data Type Read/Write Default Value

System.Drawing.C R/W Cont rol

olor

ButtonSize Property
Use the ButtonSize property to set or get the size (in pixels) of buttons. Button dimensions are in the
form widt h, height.

Data Type Read/Write Default Value

String R/W 64x64

ControlInCharge Property
Use the ControlInCharge property to set or get the ID of the control that currently has control of the
Button Bar control. This property is also set by the controls when they become the active control.

Data Type Read/Write Default Value

String R/W ""

DefaultButtonBackColor Property
Use the DefaultButtonBackColor property to set or get the default background color of buttons.

Data Type Read/Write Default Value

System.Drawing.C R/W Cont rol

olor

DefaultButtonForeColor Property
Use the DefaultButtonForeColor property to set or get the default text color of button captions.

Data Type Read/Write Default Value

System.Drawing.C R/W Cont rolText

olor

70 Version 6.0
Button Bar Control MES .NET Controls Developer Guide

Dock Property
Use the Dock property to set or get the docking location of the control. Possible values are Top, Bottom,
Left, Right, None.
If the Dock property is set to anything but None, you must draw a rectangle on the symbol before the
Button Bar control is placed in the symbol.
The rectangle defines the symbol size that enables the Button Bar control to dock properly.

Data Type Read/Write Default Value

String R/W Top

ForeColor Property
Use the ForeColor property to set or get the foreground color us ed to show text and graphics in the
control.

Data Type Read/Write Default Value

System.Drawing.C R/W Cont rolText

olor

HorizontalBoundary Property
Use the HorizontalBoundary property to set or get the horizontal separation (in pixels) between the top
and bottom of the buttons and the edge of the control.

Data Type Read/Write Default Value

Integer R/W 0

HorizontalSeparation Property
Use the HorizontalSeparation property to set or get the horizontal separation (in pixels) between
buttons. Only applicable when the Dock property is set to Top, Bottom, or None.

Data Type Read/Write Default Value

Integer R/W 0

NumButtonLines Property
Use the Num ButtonLine s property to set or get the number of:
 Rows of buttons if the Dock property is set to Top or Bottom.
 Columns of buttons if the Dock property is set to Left or Right.

Version 6.0 71
MES .NET Controls Developer Guide Button Bar Control

Data Type Read/Write Default Value

Integer R/W 1

ScrollButtonBackColor Property
Use the ScrollButtonBackColor property to set or get the background color of the scroll buttons.

Data Type Read/Write Default Value

System.Drawing.C R/W Cont rol

olor

ScrollButtonForeColor Property
Use the ScrollButtonForeColor property to set or get the text and graphics color used on the scroll
buttons.

Data Type Read/Write Default Value

System.Drawing.C R/W Cont rolText

olor

ScrollButtonHeight Property
Use the ScrollButtonHeight property to set or get the height (in pixels) of scroll buttons. This property is
only applicable when the Dock property is set to Left, Right, or None.

Data Type Read/Write Default Value

Integer R/W 16

ScrollButtonWidth Property
Use the ScrollButtonWidth property to set or get the width (in pixels) of scroll buttons. This property is
only applicable when the Dock property is set to Top, Bottom, or None.

Data Type Read/Write Default Value

Integer R/W 16

ShowAllControlButtons Property
Use the ShowAllControlButtons property to set or get whether the Button Bar control:
 Shows the buttons for all the controls registered with it (set True).
 Only shows the buttons for the cont rol currently in charge of the Button Bar cont rol (set False).

72 Version 6.0
Button Bar Control MES .NET Controls Developer Guide

Data Type Read/Write Default Value

Boolean R/W True

Size Property
Use the Size property to set or get the size of the control in pixels. Dimensions are expressed as widt h,
height.

Data Type Read/Write Default Value

String R/W

SpacerHeight Property
Use the SpacerHeight property to set or get the height (in pixels ) of the button separation line. This
property is only applicable when the Dock property is set to Left or Right.

Data Type Read/Write Default Value

Integer R/W 32

SpacerWidth Property
Use the SpacerWidth property to set or get the width (in pixels) of the button separation line. This
property is only applicable when the Dock property is set to Top or Bottom.

Data Type Read/Write Default Value

Integer R/W 32

UserButtonExecutionLevel Property
Use the UserButtonExecutionLevel property to set or get the operator's button execution level.
The UserButtonExecutionLevel property is set by the controls using the Button Bar control and is
based on the operator’s permissions.
The UserButtonExecutionLevel property must be greater than or equal to a button's execution level in
order for the button to be enabled. The button's execution level is set on the configuration dialog or when
the button is added to the Button Bar control.

Data Type Read/Write Default Value

Integer R/W 1

VerticalBoundary Property
Use the VerticalBoundary property to set or get the vertical separation (in pixels) bet ween the left and
right of the buttons and the edge of the cont rol.

Version 6.0 73
MES .NET Controls Developer Guide Button Bar Control

Data Type Read/Write Default Value

Integer R/W 0

VerticalSeparation Property
Use the VerticalSeparation property to set or get the vertical separation (in pix els) between buttons.
Only applicable when the Dock property is set to Left or Right.

Data Type Read/Write Default Value

Integer R/W 0

Methods of the Button Bar Control

This section describes the met hods of the Button Bar control. For information about the common
methods shared by this control, see Common Methods on page 55.

EnableButton() Method
Use the EnableButton() method to enable or disable the named button associated with the specified
control.
Syntax
result = ButtonEnabled(controlID, buttonID, enabled);
Parameters
controlID
A string that indicates the ID of the control associated wit h the Button Bar control.
buttonID
An integer that indicates the ID of the button. For more information, see Buttons on page 271.

Note: If you omit this parameter, all buttons associated wit h the specified control are enabled or dis abled.

enabled
A Boolean value that indicates whether to enable (1) or disable (0) the button.

IsButtonEnabled() Method
Use the I sButtonEnabled() method to loop through all buttons in the Button Bar control looking for the
button specified by the supplied information. If the button is found, the enabled status is returned. If it is
not found, False is returned.
Syntax
result = IsButtonEnabled(controlID, buttonID, userData);
Parameters
controlID
A string that indicates the ID of the control associated wit h the Button Bar control.
buttonID
An integer that indicates the ID of the button. For more information, see Buttons on page 271.
userData
An object that provides the user data of the button.

74 Version 6.0
Button Bar Control MES .NET Controls Developer Guide

result
A Boolean value. The value is True if button is found and the button is enabled; otherwise the value is
False.

ResetAllowConfiguration() Method
Use the Re setAllowConfiguration() method to res et the AllowConfiguration property to its default
value of True.
Syntax
ResetAllowConfiguration();

ResetBackColor() Method
Use the Re setBackColor() method to reset the BackColor property to the default background color for
a control.
Syntax
ResetBackColor();

ResetButtonSize() Method
Use the Re setButtonSize() method to reset the button size (in pixels) to the default value of 64x64.
Syntax
ResetButtonSize();

ResetControlInCharge() Method
Use the Re setControlInCharge() method to reset the ControlInCharge property to an empty string.
Syntax
ResetControlInCharge();

ResetDefaultButtonBackColor() Method
Use the Re setDefaultButtonBackColor() method to reset the DefaultButtonBackColor property to
default background color for a control.
Syntax
ResetDefaultButtonBackColor();

ResetDefaultButtonForeColor() Method
Use the Re setDefaultButtonForeColor() method to reset the DefaultButtonForeColor property to
default foreground color for a control.
Syntax
ResetDefaultButtonForeColor();

ResetDock() Method
Use the Re setDock() method to reset the Dock property value to Top.
Syntax
ResetDock();

Version 6.0 75
MES .NET Controls Developer Guide Button Bar Control

ResetForeColor() Method
Use the Re setForeColor() method t o reset the ForeColor property to the default foreground c olor of the
control.
Syntax
ResetForeColor();

ResetHorizontalBoundary() Method
Use the Re setHorizontalBoundary() method to reset the HorizontalBoundary property to a value of 0.
Syntax
ResetHorizontalBoundary();

ResetHorizontalSeparation() Method
Use the Re setHorizontalSeparation() method to reset the HorizontalSeparation property to a value of
0.
Syntax
ResetHorizontalSeparation();

ResetNumButtonLines() Method
Use the Re setNumButtonLines() method to reset the Num ButtonLine s property to the value of 1.
Syntax
ResetNumButtonLines();

ResetScrollButtonBackColor() Method
Use the Re setScrollButtonBackColor() method to reset the ScrollButtonBackColor property to
default background color for a control.
Syntax
ResetScrollButtonBackColor();

ResetScrollButtonForeColor() Method
Use the Re setScrollButtonForeColor() method to res et the ScrollButtonForeColor property to default
foreground color for a control.
Syntax
ResetScrollButtonForeColor();

ResetScrollButtonHeight() Method
Use the Re setScrollButtonHeight() method to reset the ScrollButtonHeight property to 16.
Syntax
ResetScrollButtonHeight();

ResetScrollButtonWidth() Method
Use the Re setScrollButtonWidth() method to reset the ScrollButtonWidth property to 16.
Syntax
ResetScrollButtonWidth();

76 Version 6.0
Button Bar Control MES .NET Controls Developer Guide

ResetShowAllControlsButtons() Method
Use the Re setShowAllControl sButtons() method to reset the ShowAllControl sButtons property to
True.
Syntax
ResetShowAllControlsButtons();

ResetSize() Method
Use the Re setSize() method to reset the Size property.
If the Button Bar control is laid out horizontally, the height is set to the number of button lines times the
button height plus two times the horizontal boundary.
If the Button Bar control is laid out vertically, the width is set to the number of button lines times the width
of the buttons plus two time the vertical boundary.
Syntax
ResetSize();

ResetSpacerHeight() Method
Use the Re setSpacerHeight() method to res et the SpacerHeight property to 32.
Syntax
ResetSpacerHeight();

ResetSpacerWidth() Method
Use the Re setSpacerWidth() method to reset the SpacerWidth property to 32.
Syntax
ResetSpacerWidth();

ResetUserButtonExecutionLevel() Method
Use the Re setUserButtonExecutionLevel() method to reset the UserButtonExecution property to 1.
Syntax
ResetUserButtonExecutionLevel();

ResetVerticalBoundary() Method
Use the Re setVerticalBoundary() method to reset the VerticalBoundary property to a value of 0.
Syntax
ResetVerticalBoundary();

ResetVerticalSeparation() Method
Use the Re setVerticalSeparation() method to reset the VerticalSeparation property to a value of 0.
Syntax
ResetVerticalSeparation();

SetButtonColor() Method
Use the SetButtonColor() met hod t o set the background and foreground colors of all buttons associated
with the specified control.

Version 6.0 77
MES .NET Controls Developer Guide Button Bar Control

Syntax
SetButtonColor(controlID[, buttonID], backColor, foreColor);
Parameters
controlID
A string that indicates the ID of the control associated wit h the Button Bar control.
buttonID
An integer that indicates the ID of the button. If this parameter is omitted, all the buttons for this
control are affected. For more information, see Buttons on page 271.
back Color
The color to use for the button’s background.
foreColor
The color to use for the button’s foreground.

UnregisterControl() Method
Use the UnregisterControl() method to remove controls associated with the button bar. All the control
buttons are removed, and the cont rol will no longer appear on the run time configuration dialog.
Syntax
UnregisterControl(controlID)
Parameters
controlID
A string that indicates the ID of the control associated wit h the Button Bar control.

78 Version 6.0
 MES .NET Controls Developer Guide

C HAPTER 5
Consumption Control
In This Chapter
Introduction to the Consumption Control ......................................................................................... 79
Configuring the Consumption Control ............................................................................................. 79
Properties of the Consumption Cont rol ........................................................................................... 80
Methods of the Cons umption Control ............................................................................................. 81

Introduction to the Consumption Control

The Consumption control consists of a grid that displays the Bill of Material (BOM) for the currently
running job on the selected entity.

Configuring the Consumption Control

You use the Consumption control to report consumption against a job. You can report the consumption
for a consumable Bill of Material item that is listed in the table.
You can use the Consumption control to record this consumption as scrap from this control and change
the lot data.
When you use the Consumption control in an ArchestrA symbol, you can associate the Button Bar
control with it. For more information, see Associating the Button Bar Control with Other Controls on page
68.

The operator can use the Consumption control to:

 Add consumption.
 Record scrap of consumable items.
 Set the lot data.
 Refresh the Consumption cont rol.
 Filter the ent ries on the Consumption control.
 Switch the active user.
 View item attributes.

Version 6.0 79
MES .NET Controls Developer Guide Consumption Control

 Open or launch a form, if the Path to Form Program system parameter is set.
This control corresponds to the BOM tab of MES Operat or. For more information, see the BOM Tab
section in the MES Operator Guide or MES online help.

Properties of the Consumption Control

This section describes the properties of the Consumption control. For information about the common
properties shared by this control, see Common Properties on page 51.

AddConsEnabled Property
Use the AddConsEnabled property to determine if the Add Consumption button and functionality is
enabled.

Data Type Read/Write Default Value

Boolean Read Only True

ConsWasteEnabled Property
Use the ConsWa ste Enabled property to determine if the Consumption Waste button and functionality
is enabled.

Data Type Read/Write Default Value

Boolean Read Only True

FilterEnabled Property
Use the FilterEnabled property to determine if the Filter button and functionality is enabled.

Data Type Read/Write Default Value

Boolean Read Only True

ItemAttributesEnabled Property
Use the ItemAttribute sEnabled property to determine if the Item Attribute s button and functionality is
enabled.

Data Type Read/Write Default Value

Boolean Read Only True

OpenFormEnabled Property
Use the OpenForm Enabled property to determine if the Open Form button and functionality is enabled.

80 Version 6.0
Consumption Control MES .NET Controls Developer Guide

Data Type Read/Write Default Value

Boolean Read Only True

SetLotDataEnabled Property
Use the SetLotDataEnabled property to determine if the Set Lot Data button and functionality is
enabled.

Data Type Read/Write Default Value

Boolean Read Only True

Methods of the Consumption Control

This section describes the met hods of the Consumption control. For information about the common
methods shared by this control, see Common Methods on page 55.

AddConsumption() Method
Use the AddConsumption() method to open the form for adding consumption.
Syntax
AddConsumption();

ConsWaste() Method
Use the ConsWaste() met hod to open the form for consumption waste.
Syntax
ConsWaste();

Show_BOMStep_Filter_Dialog() Method
Use the Show_BOMStep_Filter_Dialog() method to open a dialog box for specifying Invent ory Filter.
Syntax
Show_BOMStep_Filter_Dialog();

SetCurrentConsLotData() Method
Use the SetCurrentConsLotData() method to open the form to set the current Lot information.
Syntax
SetCurrentConsLotData();

SelectRowByKey() Method
Use the SelectRowByKey() method to search and select the first row in the grid that matches the
specified work order, operation, sequence, and BOM position. If no such row is found and the
selectFirstRowAs Default parameter is set to True, the first row in the grid is selected. Otherwise the
previous row selection is not changed.
Syntax
result = SelectRowByKey(string woId, string operId, int seqNo,
int bomPos, bool selectFirstRowAsDefault);

Version 6.0 81
MES .NET Controls Developer Guide Consumption Control

Parameters
woId
A string value that is the work order ID to match.
operId
A string value that is the operation ID to match.
seqNo
An integer value that is the sequenc e number to match.
bomPos
An integer value that is the BOM position to match.
selectFirstRowAs Default
A Boolean value that is set to True if the first row must be selected when there is no match. It is set to
False if the row selection must not change when there is no match.
Return Value
result
A Boolean value that is True if a match is found; otherwise it returns False.

82 Version 6.0
 MES .NET Controls Developer Guide

C HAPTER 6
Counts/Duration KPI Control
In This Chapter
Introduction to the Counts/Duration KPI Control .............................................................................. 83
Using the Counts/Duration KP I Control ........................................................................................... 83
Properties of the Counts/Duration KPI Cont rol ................................................................................ 85
Methods of the Counts/Duration KP I Control ................................................................................... 90
E vents of the Counts/Duration KPI Control ..................................................................................... 91

Introduction to the Counts/Duration KPI Control

The Counts/Duration KPI Control is used to display a Pareto graph of either the counts or duration of an
entity's utilization states, reason groups, or reasons.

Using the Counts/Duration KPI Control

When configuring Counts/Duration KPI control, the designer will typically set a default
CountsAndDurationControlStyle (counts or duration or both), the CountsAndDurationGraphType
(UtilStates, Reas onGroups, or Reasons), and filter defaults (TypeFilter, FilterDuration,
CDKPIFilter.FilterTime, CDKPIFilter.FilterStartOffset, CDKPIFilter.FilterEndOffset). The user can
also set the maximum number of bars to be seen in the graph ( NumberOfBars), the duration refresh rate
(DurationRefre shRate), filtering based on utilization state (OEES tatusFilter), and reason group colors
(ReasonGroupColors). It is also possible to specify that various property values will be configured by
the operator at run time and saved to or retrieved from the MES database on a per-user basis. If this is
the case, configuring these properties will be disabled at design time. See the FilterDefaultsFromDB
Property on page 264 for more on this.

Version 6.0 83
MES .NET Controls Developer Guide Counts/Duration KPI Control

At design time or run time, when configuring filters, a Filter dialog exists to help coordinate the setting of
several properties at once. This Filter dialog can be invoked at design time by selecting the browse
button next to the TypeFilter property. At run time, it is invoked by calling the Filter() method or using
the button bar.

At run time, the control is refreshed whenever a UtilizationStateChanged event is detected from the
MES database if utilization states are being displayed, or when an UtilizationReasonChanged event is
detected from the MES database if reason groups or reasons are being displayed. This event is handled
internally by the control. The control is also refreshed when the CountsAndDurationControlStyle or
CountsAndDurationGraphType property is set. Setting the other properties will not cause an aut omatic
refres h, so you will need to call the Refre shData() method (for more information on this method, see
RefreshData() Method on page 58). If durations are being displayed, the control can also be refres hed
based on a timer that is set to the value of the DurationRefre shRate property. The
IgnoreRefreshEvents property can be set to True to avoid unwanted refreshes from occurring while you
are setting properties.
The Counts/Duration KPI control has a context menu that allows a user with the proper permissions to
save the configuration of the control to the database for either a specific entity, all the logged on entities,
or as a default. Only the button bar setup and the current filter settings will be saved as configuration
data.

Logging On to the Counts/Duration KPI Control

To use the Counts/Duration KPI control, the operator must log on to a session and select one or more
entities, or set the Di splayEntity property which will use the display entity as the source of the data. If the
operator is not already logged on to a session and logged on to at least one entity, and the Di splayEntity
property is set to null or an empty string, the control automatically initiates the log on process by one of
the following met hods:
 Logging on the current InTouch user to the session.
 Presenting the operator with a log on dialog box.
After the operator is logged on to the session, the cont rol by default pres ents the operator with an entity
log on dialog box. These behaviors can be overridden by setting the AutoLoginUser or the
AutoLogOnEnt properties to False. If this is done, logging on to a session and logging on to an entity
must be done with a script. If the user is logged onto an entity, but the DisplayEntity property is set, the
entity in the Di splayEntity property will be used instead of the current logged on entity.

Switching Entities
The Counts/Duration KPI control shows information only for the current entity or the display entity. If the
Job Summary control is included in the form, you can use it to change the current entity. You can also
change the current entity by using a script.

84 Version 6.0
Counts/Duration KPI Control MES .NET Controls Developer Guide

Associating the Button Bar Control

When you use the Counts/Duration KPI control in an ArchestrA symbol, you can associate the Button
Bar control with it. For more information, see Associating the Button Bar Control with Other Controls on
page 68.

Properties of the Counts/Duration KPI Control

This section describes the properties of the Counts/Duration KP I Control. For information about the
common properties shared by this control, see Common Properties on page 51.

CDKPIFilter.FilterEndOffset Property
The CDKPIFilter.FilterEndOffset property specifies the end of the filter period relative to now. This filter
value is only legitimate when the TypeFilter property is set to Custom. If the TypeFilter property is not
set to Custom, this property is set to 0 if the type is ThisHour, LastNHours, CurrentShift, Current Day,
CurrentWeek, or CurrentMonth; it is set to 1 if the type is LastShift, Yesterday, LastWeek, or
LastMonth. The value of this property should always be less than the value of the
CDKPIFilter.FilterStartOffset property and great er than or equal to 0.

Data Type Read/Write Default Value

Integer R/W 0

CDKPIFilter.FilterStartOffset Property
The CDKPIFilter.FilterStartOffset property specifies the start of the filter period relative to now. This
filter value is only legitimate when the TypeFilter property is set to Custom. If the TypeFilter property is
not set to Custom, this property is set to 1 if the type is ThisHour, CurrentShift, CurrentDay,
CurrentWeek, or CurrentMonth; it is set to 2 if the type is LastShift, Yesterday, LastWeek, or LastMonth.
It is set to N if the type is set to LastNHours. The value of this property should always be greater than the
value of the CDKPIFilter.FilterEndOffset property and should always be greater than or equal to 1.

Data Type Read/Write Default Value

Integer R/W 1

CDKPIFilter.FilterTime Property
The CDKPIFilter.FilterTime property specifies the time unit for a custom filter type. This filter value is
only legitimate when the TypeFilter property is set to Custom. If the TypeFilter property is not set to
Custom, this property is set to a value that matches the type (hour if type is ThisHour or LastNHours;
Shift is type is CurrentShift or LastShift; Day if type is CurrentDay or Yesterday; Week if type is
CurrentWeek or LastWeek; or Month if type is CurrentMonth or LastMonth).
When this property is set to hour, the results will include data for 0 or more entire hour periods, relative to
the current time. For all other settings (Shift, Day, Week, Month or Y ear), the results will start at the
beginning of the time unit specified by the CDKPIFilter.FilterStartOffse t property.

Version 6.0 85
MES .NET Controls Developer Guide Counts/Duration KPI Control

Data Type Read/Write Default Value

Enum {Hour=0, R/W Hour

Shift=1,
Day=2,
Week=3,
Month=4,
Year=5}

CDKPIFilter.TypeFilter Property
The CDKPIFilter.TypeFilter property specifies which filter to use including a custom filter. If LastNHours
is selected, you will also need to set the FilterDuration property. If Custom is selected, you will also
need to set the CDKPIFilter.FilterTime, CDKPIFilter.FilterStartOffset, and
CDKPIFilter.FilterEndOffset properties.

Data Type Read/Write Default Value

Enum {ThisHour=0. R/W ThisHour

LastNHours=1,
CurrentShift=2,
LastShift=3,
CurrentDay=4,
Yesterday=5,
CurrentWeek=6,
LastWeek=7,
CurrentMont h=8,
LastMonth=9,
Custom=10}

ChartBackColor Property
Use the ChartBackColor property to get and set the background color of the chart.

Data Type Read/Write Default Value

Color R/W

ControlStyle Property
The ControlStyle property is an enumeration type that specifies whether the control is showing counts,
duration, or both. If Counts is chosen, the number of times a State, Reason Group, or Reason was
chosen within t he time period set by the filter is displayed on the graph. If Duration is chos en, the amount
of time spent in a State, Reason Group, or Reason is displayed on the graph. If CountsWithDuration is
chosen, a group of two bars for each State, Reason Group, or Reason is displayed on the graph with the
top bar being the counts and the bottom bar being the duration. If DurationWithCounts is chosen, a group
of t wo bars for each State, Reason Group, or Reason is displayed on the graph with the top bar being the
duration and the bottom bar being the counts. When either CountsWithDuration or Du rationWithCounts
is chosen, the graph is sorted by the top bar in the grouping.

86 Version 6.0
Counts/Duration KPI Control MES .NET Controls Developer Guide

Data Type Read/Write Default Value

Enum {Counts=0, R/W Counts

Duration= 1,
CountsWithDuration= 2,
DurationWithCounts = 3}

GraphType Property
The GraphType property specifies the type of data that will be shown in the Pareto graph (see the table
below for the list of choices ). If UtilStates is selected, each bar in the graph represents the counts or
duration of a utilization state. If ReasonGroups is selected, each bar in the graph repres ents the counts
or duration of a reason group. If Reasons is selected, each bar in the graph represents the counts or
duration of a reason.

Data Type Read/Write Default Value

Enum {UtilStates=0, R/W UtilStates

Reas onGroups=1,
Reas ons = 2}

DisplayEntity Property
When the Di splayEntity property is set to a specific entity name, the control will use that entity as the
source of the data instead of the currently logged in entity. This will enable multiple KPI controls to exist
on the same screen, each one showing values for a different entity (dashboard setup).
Dynamic entity names can be configured through the symbol editor by data -binding the tag reference or
custom property in the reference column.
If this property is set to null or an empty string, the currently logged in entity will be used as the source of
data.

Data Type Read/Write Default Value

String R/W Null

DurationRefreshRate Property
The DurationRefre shRate property specifies the amount of time in minutes between refreshes. This
property is only legitimate when the CountsAndDurationControlType property is set to Duration. This
property must have a value greater than or equal to zero. If the value is set to 0, the graph will only
refres h when there is a change in utilization.

Data Type Read/Write Default Value

Integer R/W 5

Version 6.0 87
MES .NET Controls Developer Guide Counts/Duration KPI Control

FilterDefaultsFromDB Property
The FilterDefaultsFrom DB property controls whether the default filter settings (TypeFilter,
FilterDuration, CDKPIFilter.FilterTime, CDKPIFilter.FilterStartOffset, and
CDKPIFilter.FilterEndOffset properties) are established during design time or if they will be pulled in
from the MES database during run time. If this property is set to False, the default filter s ettings will not be
loaded from the database. If the property is set to True, the default filter settings will be pulled from the
MES databas e. In this case, the design -time setting of the filter properties is disabled.

Data Type Read/Write Default Value

Boolean R/W False

FilterDuration Property
The FilterDuration property specifies the N in the Last N Hours filter type. The value of this property is
only legitimate when the TypeFilter property is set to Last N Hours.

Data Type Read/Write Default Value

Integer R/W 0

FilterEnabled Property
The FilterEnabled property indicates whether the Filter() met hod may be called. If it is set to False, the
Filter() method may not be called. This property is set by the control whenever the state of the control
changes. It will be set to False if there is no MES session, no user, or no entity. At all other times it should
be set to True.

Data Type Read/Write Default Value

Boolean Read Only False

LabelFont Property
Use the LabelFont property to set or get the font for the labels in a bar chart.
The font size can be up t o 30 pt. It should be adjusted t o a size that is appropriate for the size of t he chart.
The font size can be set to more than 9 pt for controls whose ControlStyle property is set to Counts or
Duration by not CountsWithDuration or DurationWithCounts.

Data Type Read/Write Default Value

Font R/W

LabelFontColor Property
Use the LabelFontColor property to set the font color for the labels in a bar chart.

88 Version 6.0
Counts/Duration KPI Control MES .NET Controls Developer Guide

Data Type Read/Write Default Value

Color R/W
(System.Drawing.Color)

NumberOfBars Property
The NumberOfBars property specifies the maximum number of bars for individual utilization states,
reason groups, or reasons that will appear on the graph. The number of bars is an upper limit for the
number of bars shown. If there is not enough data to show that many bars, fewer will be displayed. If
there are more values than the number of bars, another bar will be added showing the sum of the
remaining values.

Data Type Read/Write Default Value

Integer R/W 5

OEEStatusFilter Property
The OEEStatusFilter property determines what filtering, if any, will be performed based on utilization
status (Runtime and Downtime).

Data Type Read/Write Default Value

Enum {Runtime=0, R/W All

Downtime= 1,
Neither=2,
All=3}

ReasonGroupColors Property
The Rea sonGroupColors property is an array with a size equal to the value of the NumberOfBars
property plus one for the summary bar. When displaying utilization states and reasons, the colors for the
bars come from the dat abas e. Since reason groups do not have colors defined in the database, this
property allows the us er to s pecify the bar colors when displaying reason groups. The colors will not map
to a particular reason group, but instead will specify what color by bar position.

Data Type Read/Write Default Value

Array of Color R/W Red for all positions

ValueFont Property
Use the ValueFont property to set the font for the values in a bar chart.

Data Type Read/Write Default Value

Font R/W

Version 6.0 89
MES .NET Controls Developer Guide Counts/Duration KPI Control

ValueFontColor Property
Use the ValueFontColor property to set the font color for the values in a bar chart.

Data Type Read/Write Default Value

Color R/W
(System.Drawing.Color)

Methods of the Counts/Duration KPI Control

This section describes the met hods of the Counts/Duration KPI Control. For information about the
common met hods shared by this control, see Common Methods on page 55.

Filter () Method
The Filter() method can only be called when the FilterEnabled property is set to True. Call this method
to display the same Filter dialog box that is used to set properties at design -time wit h one additional list
for setting the OEE Status Filter.
Syntax
Filter();

FillSampleDataCountsDuration() Method
Use the FillSampleDataDuration() method to fill the sample data for the Bar Chart at design time.
Syntax
FillSampleDataCountsDuration();

GetButtonMenuItems() Method
Use the GetButtonMenuItem s() method to retrieve the button menu for the Utilization control. If no
Button Bar control is associated with the Utilization control, an empty button menu is returned.
Syntax
result = GetButtonMenuItems();

IntializeBarGraph() Method
Use the IntializeBarGraph() method to initialize the Bar Graph at constructor.
Syntax
InitalizeBarGraph();

RefreshDisplay() Method
Use the Refre shDi splay() met hod t o refresh and updat e the display in t he control where the data source
to the bar chart is assigned.
This method updates the display only if the dat abase of CaDViewData class is updated.
Syntax
RefreshDisplay();

Update Display() Method

Use the UpdateDi splay() method to updat e the Counts/Duration KPI control at run time and design time.

90 Version 6.0
Counts/Duration KPI Control MES .NET Controls Developer Guide

Syntax
UpdateDisplay();

Events of the Counts/Duration KPI Control

This section describes events of the Counts/Duration KPI Control.

OnClick() event
The OnClick() event is fired when the user clicks on any bar on the OEE KPI control. When fired, the
graph type displayed will change based on the bar that was clicked on. If reason groups are being
displayed, clicking on a reason group will update the graph with the reason data for the selected reason
group using the same filters. The CountsAndDurationGraphType property will not be changed; the
users will have to catch the click event if they want to update the UI to indicate that reas ons are being
displayed. If the graph is displaying the reasons for a particular reason group, the UI must provide a
means for getting back to displaying the reason groups. If reasons are being displayed and a reason is
clicked on, the graph will change to display the utilization states associated with the reason. If utilization
states are being display ed and a state is clicked on, the graph will change to display the reason groups
that the utilization state is part of. Again, the same filters will be applied and the
CountsAndDurationGraphType property will not be changed.
Syntax
OnClick();

Version 6.0 91
 MES .NET Controls Developer Guide

C HAPTER 7
Data Log Control
In This Chapter
Introduction to the Data Log Control ............................................................................................... 93
Configuring the Data Log Cont rol ................................................................................................... 93
Properties of the Data Log Control ................................................................................................. 94
Methods of the Data Log Control ................................................................................................... 96

Introduction to the Data Log Control

The Data Log control allows you to view and edit the data logs associated with the job running on the
current entity. It also allows toggling between a grid and chart to view the retrieved dat a.

Configuring the Data Log Control

You can use the Data Log cont rol to record any information about the current job that is being run on a
selected entity.
The collected data is typically not a value that is specified prior to running the job. The fields that appear
in this control are created in Supervisor.
When you use the Data Log control in an ArchestrA symbol, you can associate the Button Bar cont rol
with it. For more information, see Associating the Button Bar Control with Other Controls on page 68.

The operator can use the Data Log control to:

 Add a new row to the grid.
 Save all entered data.
 Refresh the Data Log grid.
 Delet e the selected row from the grid.
 Open the Help window.
 Start an external application.
 Start Internet Explorer.
 Switch between grid display and chart display.

Version 6.0 93
MES .NET Controls Developer Guide Data Log Control

 Switch the active user.

 Open or launch a form, if Path to form program system paramet er is set.
The Data Log control corresponds to the Data Log tab of the MES Operator application. For more
information, see the Data Log Tab section in the MES Operat or Guide or MES online help.

Properties of the Data Log Control

This section describes the properties of the Data Log cont rol. For information about the common
properties shared by this control, see Common Properties on page 51.

curEnt Property
Use the curEnt property to return a reference to the current Ent object for the current logged on user.

Data Type Read/Write Default Value

Ent Read Only

curUser Property
Use the curUser property to return a reference to the current User object for the currently logged on
user.

Data Type Read/Write Default Value

User Read Only

Font Property
Use the Font property to change the font of each constituent control to that is specified for the "whole"
control in design mode. This property overrides the master control Font property.

Data Type Read/Write Default Value

Font R/W 0

IsSaveNeeded Property
Use the I sSaveNeeded property to indicate whet her the data needs to be saved.

Data Type Read/Write Default Value

Boolean Read Only True

LotNo Property
Use the LotNo property to get the current lot number for which to retrieve data.

94 Version 6.0
Data Log Control MES .NET Controls Developer Guide

Data Type Read/Write Default Value

String Read Only ""

MaxValues Property
Use the MaxValues property to ret urn t he maximum number of value fields (16 or 48) for the current data
log group. If a current group does not exist, this property returns 0.

Data Type Read/Write Default Value

Boolean Read Only 0

NewRowEnabled Property
Use the NewRowEnabled property to specify whether the Insert Row button action is enabled.

Data Type Read/Write Default Value

Boolean Read Only False

RemoveEnabled Property
Use the RemoveEnabled property to specify whether the Remove button action is enabled.

Data Type Read/Write Default Value

Boolean Read Only False

SaveEnabled Property
Use the SaveEnabled property to specify whether the Save button action is enabled.

Data Type Read/Write Default Value

Boolean Read Only False

StepNo Property
Use the StepNo property to get the current step number for whic h to take data.

Data Type Read/Write Default Value

Integer Read Only

SublotNo Property
Use the SublotNo property to get the current sublot number for which to take data.

Version 6.0 95
MES .NET Controls Developer Guide Data Log Control

Data Type Read/Write Default Value

String Read Only

ToggleChartEnabled Property
Use the ToggleChartEnabled property to specify whether the Toggle Chart button action is enabled or
not.

Data Type Read/Write Default Value

Boolean Read Only False

Methods of the Data Log Control

This section describes the methods of the Data Log control. For information about the common methods
shared by this control, see Common Methods on page 55.

AddNewRow() Method
Use the AddNewRow() method to add a new row to the data log grid for a new set of data log samples.
Syntax
AddNewRow(int stepNo, string lotNo, string subLotNo,
string stepDesc);
Parameters
stepNo
An integer value, if not Null, that is the current step number to which this dat alog row applies.
lotNo
An integer value, if not Null, that is current lot number to which this datalog row applies.
subLotNo
An integer value, if not Null, that is current sublot number to whic h this datalog row applies.
stepDesc
A string value, if not Null, that is current step description to which this datalog row applies.

CheckAndSave() Method
Use the CheckAndSave() method to verify if any data needs to be saved. It prompts the user if a save is
required, and saves the data upon user action if the user chooses.
Syntax
CheckAndSave();

DeleteDataLogRow() Method
Use the DeleteDataLogRow() method to delete the selected row from the relevant Data Log
table—Data_Log_16 table or Data_Log_48 table.
Syntax
DeleteDataLogRow();

96 Version 6.0
Data Log Control MES .NET Controls Developer Guide

SaveRows() Method
Use the SaveRows() method to save all the data log rows that are edited or inserted. This method
checks if the data log row must be saved in Data_Log_16 table or Data_Log_48 table.
Syntax
SaveRows();

SelectRowByKey() Method
Use the SelectRowByKey() method to select the specified row in the grid. If the row is not found
optionally, the last row is selected based on a paramet er. If the specified row cannot be found and the
selectLastRowAsDefault parameter is False, then the existing selected row is left and a False value is
returned. If a new row is selected, it enables/disables any buttons based on this new selection.
Syntax
result = SelectRowByKey(rowID, selectLastRowAsDefault);
Parameters
rowI D
An integer that is the row ID of the selected row.
selectLastRowAsDefault
A Boolean value that is the last row if the row is not found.
Return Value
result
A Boolean value that is True, if the row ID is found; otherwise it returns False.

Version 6.0 97
 MES .NET Controls Developer Guide

C HAPTER 8
Entity Usage Editor Control
In This Chapter
Introduction to the Entity Usage Editor Control ................................................................................ 99
Configuring the Entity Usage Editor Control .................................................................................... 99
Properties of the Entity Usage Editor Contr ol .................................................................................. 99
Methods of the Entity Usage Editor Control .................................................................................. 100

Introduction to the Entity Usage Editor Control

The Entity Usage Editor control allows users to edit data in the Util_Log table and Job_Util_Log_Link
table.

Configuring the Entity Usage Editor Control

You use the Entity Usage Editor control to view, filter, edit, insert, and delete entity usage data directly in
the database tables.
When you use the Entity Usage Editor control in an ArchestrA symbol and view this symbol in
WindowViewer, it automatically shows the entity usage data f rom the MES database.

The Entity Usage Editor is based on the Entity Use tab in the MES Data Editor. From the editor, you can
filter, edit, insert, delete, and refresh records during run time. For more information, see the Entity Use
Tab section of the MES Dat a Editor Guide or MES online help.

Properties of the Entity Usage Editor Control

This section describes the properties of the Entity Usage Editor cont rol. For information about the
common properties shared by this control, see Common Properties on page 51.

Version 6.0 99
MES .NET Controls Developer Guide Entity Usage Editor Control

AppendSaveConfigName Property
The AppendSaveConfigName property is an override of the AppendSaveConfigName property and
cannot be browsed. This property cannot be browsed because the configuration data is always saved by
a user.

Data Type Read/Write Default Value

Boolean R/W True

SaveConfigName Property
The SaveConfigName property is an override of the SaveConfigName property and cannot be
browsed. This property cannot be browsed because the configuration data is always saved by a user.

Data Type Read/Write Default Value

String R/W The instance name for the saved

configuration. This may be appended
to or replace the entity ID. If left blank,
the entity ID is used.

Methods of the Entity Usage Editor Control

The Entity Usage Editor control does contain any unique methods. For information about the common
methods shared by this control, see Common Methods on page 55.

100 Version 6.0

 MES .NET Controls Developer Guide

C HAPTER 9
Folders Control
In This Chapter
Introduction to the Folders Control ............................................................................................... 101
Configuring the Folders Control ................................................................................................... 101
Properties of the Folders Control ................................................................................................. 102
Methods of the Folders Control .................................................................................................... 103

Introduction to the Folders Control

The Folders control allows you to show the folder for the currently running job. If no job is running, a
folders tree shows all the folders for the current entity or all entities if the user has the override entity
privilege.

Configuring the Folders Control

You use the Folders control to view, edit, and print files.
When you use the Folders control in an ArchestrA symbol, you can associate the Button Bar control with
it. For more information, see Associating the Button Bar Control with Other Controls on page 68.

The operator can use the Folders control to:

 View the selected file.
 Edit the selected file.
 Refresh the Folders cont rol.
 Enter a file filter.
 Start an external application.
 Start Internet Explorer.
 Open the Help window.
 Switch the active user.
 Print the selected file.

Version 6.0 101

MES .NET Controls Developer Guide Folders Control

 Open/Launch Form, if the Path to Form Program system parameter is set.

The Folders control corresponds to the Folders tab of the MES Operator application. For more
information, see the Folders Tab section in the MES Operator Guide or MES online help.

Setting the Icon Size

You can select the desired folder from the tree in the left pane, when the Folders control is displayed
outside the context of a running job. If the control is displayed in the context of a running job, the desired
folder is already selected.
You can use the properties of the Folders control to set the icon size. You can set the icon size in the
Folders control to either small (16x16 pixels) or large (32x32 pixels ). If you set the property
UseLargeTreeIcons to True, large icons are used in the tree.
To set the icon size in the Folders control
1. Select the Folders control for which you want to set the icon size.
2. In the Properties Editor, locate the property UseLargeTreeIcons.
3. Set the value of the property to:
o True for large icons (32x32 pixels)
o False for small icons (16x16 pixels)

Properties of the Folders Control

This section describes the properties of the Folders control. For information about the common
properties shared by this control, see Common Properties on page 51.

CompareEnabled Property
Use the CompareEnabled property to set or get whether the Compare command is available at run
time.

Data Type Read/Write Default Value

Boolean Read Only True

EditEnabled Property
Use the EditEnabled property to set or get whether the Edit command is available at run time.

Data Type Read/Write Default Value

Boolean Read Only True

FilterEnabled Property
Use the FilterEnabled property to set or get whether the Filter command is available at run time.

Data Type Read/Write Default Value

Boolean Read Only True

102 Version 6.0

Folders Control MES .NET Controls Developer Guide

PrintEnabled Property
Use the PrintEnabled property to set or get whether the View command is available at run time.

Data Type Read/Write Default Value

Boolean Read Only True

UseLargeTreeIcons Property
Use the UseLargeTreeIcons property to set or get a value to indicat e whether large icons are used on
the folders tree. The value is set to True if the cont rol us es large icons, and set to False if the control uses
small icons.

Data Type Read/Write Default Value

Boolean R/W False

ViewEnabled Property
Use the ViewEnabled property to set or get whether the View command is available at run time.

Data Type Read/Write Default Value

Boolean Read Only True

Methods of the Folders Control

This section describes the met hods of the Folders control. For information about the common methods
shared by this control, see Common Methods on page 55.

ApplyFilter() Method
Use the ApplyFilter() method to set filter values and display the folders tree based on the filter values. If
a null value is passed, the current filter value does not change. If an empty string is passed as a filter
value, the filter is cleared. This method affects the control if no job is running on the current entity.
Syntax
ApplyFilter(itemClassIDFilter, itemClassDescFilter, itemIDFilter,
itemDescFilter, operIDFilter, operDescFilter, entIDFilter, verIDFilter,
udf1Filter, udf2Filter, fileFilter);
Parameters
itemClassIDFilter
A string value of the Item Class ID filter. You need to pass null to use the current value.
itemClassDescFilter
A string value of the Item Class description filter. You need to pass null to use the current value.
itemIDFilter
A string value of the Item ID filter. You need to pass null to use the current value.
itemDescFilter
A string value of the Item description filter. You need to pass null to use the current value.

Version 6.0 103

MES .NET Controls Developer Guide Folders Control

operIDFilter
A string value of the operation ID filter. You need to pass null to use the current value.
operDescFilter
A string value of the operation description filter. You need to pass null to use the current value.
entIDFilter
A string value of the entity ID filter. The string must cont ain a number or an empty string. Y ou need to
pass null to use the current value.
verIDFilter
A string value of the folder version ID filter. You need to pass null to use the current value.
udf1Filter
A string value of the first user-defined filter. You need to pass null to use the current value.
udf2Filter
A string value of the second user-defined filter. You need to pass null to use the current value.
fileFilter
A string value of the file filter. Only folders containing a matching file are displayed. You need to pass
null to use the current value.

Edit() Method
Use the Edit() met hod to check if a row is selected in the grid, and t hen to check if you have the edit level
permission for t he selected file. If t he check is successful, the EditFile() method in the Documents class
invok es the editor for the selected file type.
Syntax
Edit();

Filter() Method
Use the Filter() met hod to specify folder filter. If you apply the filter, the RefreshData() method reloads
the folders tree.
Syntax
Filter();

Print() Method
Use the Print() method to check if a row is selected in the grid, and then to check if you have the view
level permission for editing the selected file. If the check is successful, the PrintFile() method in the
Documents class prints the file.
Syntax
Print();

ResetUseLargeTreeIcons() Method
Use the Re setUseLargeTreeIcons() method to reset the UseLargeTreeIcons property to its default
value of False.
Syntax
ResetUseLargeTreeIcons();

SelectRowByKey() Method
Use the SelectRowByKey() method to select the row in the grid cont aining the file path. If the file is not
found and the selectFirstRowAsDef ault parameter is set, the first row in the grid is selected. Otherwise,
the current row selection remains unchanged.

104 Version 6.0

Folders Control MES .NET Controls Developer Guide

Syntax
result = SelectRowByKey(fileSource, filePath, selectFirstRowAsDefault);
Parameters
fileSource
An enumeration type { ItemFile= 0, WorkOrderFile=1, FolderFile=2, FolderEntity=3, RunEntity=4}
that is a file source to determine whether the file is an Item file, a Work Order file, a Folder file
(specifies a file for the Entity for which the folder was built) or a Run Entity (specifies a file for the
current Entity on which the job is running).
filePath
A file path that is the path of the selected file.
selectFirstRowAs Default
A Boolean value that is set to True to select the first row if the specified pat h is not found.
Return Value
result
A Boolean value that is True if the row containing the file pat h is found; otherwis e, it returns False.

View() Method
Use the View() method to check if a row is selected in the grid, and then to check if you have the view
level permission for the selected file. If the check is successful, the ViewFile() method in the Documents
class invokes the viewer for the selected file type.
Syntax
View();

Version 6.0 105

 MES .NET Controls Developer Guide

C HAPTER 10
Genealogy Control
In This Chapter
Introduction to the Genealogy Control .......................................................................................... 107
Configuring the Genealogy Control .............................................................................................. 107
Properties of the Genealogy Control ............................................................................................ 108
Methods of the Genealogy Control ............................................................................................... 108

Introduction to the Genealogy Control

The Genealogy control consists of a grid that displays the item consumption history for the currently
running job of the selected entity. This table maintains the finished goods to raw mat erial lot
traceability/genealogy data.

Configuring the Genealogy Control

You use the Genealogy control to show the consumption history against the running work ord er.
When you use the Genealogy control in an ArchestrA symbol, you can associate the Button Bar control
with it. For more information, see Associating the Button Bar Control with Other Controls on page 68.

The Filter Genealogy By buttons allow the operator to limit the consumption data displayed based on
users or shifts.
The operator can use the Genealogy control to:
 Reduce consumption in the current job.
 Change the reason the item was consumed by the job. This is known as "Reclassify".
 Refresh the Genealogy control.
 Switch the active user.
 Open the Help window.
 Open or launch a form, if the Path to Form Program system parameter is set.

Version 6.0 107

MES .NET Controls Developer Guide Genealogy Control

The Genealogy control corresponds to the Genealogy tab of the MES Operator application. For more
information, see the Genealogy Tab section in the MES Operator Guide or MES online help.

Properties of the Genealogy Control

This section describes the properties of the Genealogy control. For information about the common
properties shared by this control, see Common Properties on page 51.

OpenFormEnabled Property
Use the OpenForm Enabled property to determine if the Open Form button and functionality is enabled.

Data Type Read/Write Default Value

Boolean Read Only False

ReclassifyConsEnabled Property
Use the Recla ssifyConsEnabled property to determine if the Recla ssify Consumption button is
enabled to change the reason of the item that is consumed by a job.

Data Type Read/Write Default Value

Boolean Read Only False

ReduceConsEnabled Property
Use the Reduce ConsEnabled property to determine if the Reduce Consumption button is enabled to
reduce consumption of items in the current job.

Data Type Read/Write Default Value

Boolean Read Only False

Methods of the Genealogy Control

This section describes the met hods of the Genealogy control. For information about the common
methods shared by this control, see Common Methods on page 55.

ReduceConsumption() Method
Use the Reduce Consumption() method to open the form for reducing consumption.
Syntax
ReduceConsumption();

ReclassifyConsumption() Method
Use the Recla ssifyConsumption() method to open the form for reclassifying consumption.
Syntax
ReclassifyConsumption();

108 Version 6.0

Genealogy Control MES .NET Controls Developer Guide

SelectRowByKey() Method
Use the SelectRowByKey() method to search for the specified row ID in the grid. If the row ID is found,
the row is selected. If the row ID is not found and the SelectFirstRowAsDefault parameter is set to True,
the first row is selected; otherwise the row selection is not changed.
Syntax
result = SelectRowByKey(int rowID, bool selectFirstRowAsDefault);
Parameters
rowI D
An integer value that indicates the row ID of a row in the item_prod table.
selectFirstRowAs Default
A Boolean value that is set to True if the first row must be selected when the row ID is not found. It is
set to False, if the row selection must not change when the row ID is not found.
Return Value
result
A Boolean value that is True if the row ID is found; otherwise it returns False.

Version 6.0 109

 MES .NET Controls Developer Guide

C HAPTER 11
Inventory Control
In This Chapter
Introduction to the Inventory Control ............................................................................................. 111
Configuring the Inventory Control ................................................................................................. 111
Properties of the Inventory Control ............................................................................................... 113
Methods of the Inventory Control ................................................................................................. 113

Introduction to the Inventory Control

The Inventory control is used to view and maintain item consumption editor and storage status of the
currently logged on entity and all the movable storage entities located at the current entity.
This control is also used to view the Item Consumption editor and storage status of other enti ties.

Configuring the Inventory Control

You use the Inventory control t o show the current inventory status of a given entity. You can also trans fer
in, transfer out, and reclassify inventory at a given location.
When you use the Inventory control in an A rchestrA symbol, you can associate the Button Bar control
with it. For more information, see Associating the Button Bar Control with Other Controls on page 68.

The operator can use the Invent ory control to:

 Trans fer inventory from another entity to the selected storage location. This is referred to as "trans fer
in."
 Trans fer inventory from the s elected entity to another storage location. This is referred to as "trans fer
out."
 Change the grade and status of the selected lot. This is referred to as "reclassify."
 Remove all or some of the items from the invent ory of the selected storage location. This is referred
to as "scrap."

Version 6.0 111

MES .NET Controls Developer Guide Inventory Control

 Add, remove, and change the attributes of the selected lot.

 Filter parameters to limit the view of the Inventory control.
 Refresh the Inventory control.
 Switch the active user.
 Show the attribut es of the selected lot.
 Receive inventory from an external location.
 Trans fer serial numbers.
 Open or launch a form, if the Path to Form Program system parameter is set.
The Inventory control corresponds to the Inventory tab of the MES Operator application. For more
information, see the Invent ory Tab section in the MES Operator Guide or MES online help.
You can also use the properties of the Inventory control to allow selection of multipl e rows, show an entity
tree, show the storage entity status grid, and set the icon size.

Selecting Multiple Rows in the Inventory Control

You can allow the run time operator to select multiple rows in the Inventory control by setting the property
AllowMultipleSelection to True. Selecting multiple rows is useful when the operat or needs to run the
Reclassi fy and TransferOut commands.
To allow multiple row selection in the Inventory control
1. Select the Inventory control for which you want to allow multiple row selection.
2. In the Properties Editor, locate the property AllowMultipleSelection.
3. Set the value of the property to True.

Showing the Tree of Entities in the Inventory Control

You can set the Inventory control to show a tree of entities at run time. Set the ShowEntityTree property
to True to show the entities. At the terminal node of a branch, you can only view entities that can store
items.
To show the tree of entities in the Inventory control
1. Select the Inventory control for which you want to show the tree of entities.
2. In the Properties Editor, locate the property ShowEntityTree.
3. Set the value of the property to True.

Showing the Storage Entity Status Grid in the Inventory Control

You can set the Inventory control to show a storage entity status grid. To do this, set the
ShowStorageEntityS tatusGrid property of the cont rol to True.
To show the storage entity status grid in the Inventory control
1. Select the Inventory control for which you want to show the storage entity status grid.
2. In the Properties Editor, locate the property ShowStorageEntityS tatusGrid.
3. Set the value of the property to True.

112 Version 6.0

Inventory Control MES .NET Controls Developer Guide

Setting the Icon Size

You can set the icon size in the Inventory control to either small (16x16 pix els) or large (32x32 pixels). If
you set the property UseLargeTreeIcons to True, large icons are us ed in the tree.
To set the icon size in the Inventory control
1. Select the Inventory control for which you want to set the icon size.
2. In the Properties Editor, locate the property UseLargeTreeIcons.
3. Set the value of the property to:
o True for large icons (32x32 pixels)
o False for small icons (16x16 pixels)

Properties of the Inventory Control

The properties of the Invent ory control are as follows:
 UseLargeTreeIcons property
 ShowEntityTree property
 ShowStorageStatusGrid property
 FilterEnabled property
 TransferInEnabled property
 Reclassi fyEnabled property
 TransferOutEnabled property
 ScrapInventoryEnabled property
 SplitLotEnabled property
 CombineLotEnabled property
 LotAttribute sEnabled property
 SelectedRows property
 FactGrid property
 AllowMultipleSection property
 ReceiveInventoryEnabled property
 HeadingFont property
For information about the common properties shared by this control, see Common Properties on page
51.

Methods of the Inventory Control

This section describes the methods of the Invent ory control. For information about the common methods
shared by this control, see Common Methods on page 55.

ClearEntityTreeFilter() Method
Use the ClearEntityTreeFilter() method to clear the entity tree filter and to refresh the control so that the
entity tree displays all the entities.

Version 6.0 113

MES .NET Controls Developer Guide Inventory Control

Syntax
ClearEntityTreeFilter();

ClearInventoryFilter() Method
Use the ClearInventoryFilter() method to clear the inventory filter and to refresh the inventory grid.
Syntax
ClearInventoryFilter();

ResetAllowMultipleSection() Method
Use the Re setAllowMultipleSection() method to reset the AllowMultipleSection property to its default
value (True).
Syntax
ResetAllowMultipleSection();

ResetShowEntityTree() Method
Use the Re setShowEntityTree() method to reset the default value (True) to the ShowEntityTree
property.
Syntax
ResetShowEntityTree();

ResetShowStorageStatusGrid() Method
Use the Re setShowStorageStatusGrid() method to reset the default value (True) to the
ShowStorageStatusGrid property.
Syntax
ResetShowStorageStatusGrid();

ResetUseLargeTreeIcons() Method
Use the Re setUseLargeTreeIcons() method to reset the UseLargeTreeIcons property to its default
value of False.
Syntax
ResetUseLargeTreeIcons();

SetEntityTreeFilter() Method
Use the SetEntityTreeFilter() method to set the entity tree, bas ed on the specified array of entity IDs.
The specified entity IDs must appear at the top level of the entity tree and you must have view permission
for the invent ory of entities. This method refreshes the control so that the entity tree displays only the
specified entities.
Syntax
SetEntityTreeFilter(int [] entIDs);
Parameter
entIDs
An integer array holding the IDs of the entities, which must appear in the entity tree.

114 Version 6.0

Inventory Control MES .NET Controls Developer Guide

SetInventoryFilter() Method
Use the SetInventoryFilter() method to set the inventory filter and then to refresh the data in the
inventory grid to reflect the change in the filter. You can set any of the parameters, except the
recurseE ntities parameter, to Null.
Syntax
SetInventoryFilter(string itemClassID, string itemClassDesc, string itemID,
string itemDesc,string lotNo, string expiryDate, int [] gradeCodes, int []
statusCodes,
bool recurseEntities);
Parameters
itemClassID
A string that holds the filter setting for the item class ID.
itemClassDesc
A string that holds the filter setting for the item class description.
itemID
A string that holds the filter setting for the item ID.
itemDesc
A string that holds the filter setting for the item description.
lotNo
A string that holds the filter setting for the lot number.
expiryDate
A string that holds the filter setting for the expiry date.
gradeCodes
An integer array that holds grade codes, which may be empty.
statusCodes
An integer array that holds status codes, which may be empty.
recurseE ntities
A Boolean that is True if the invent ory for the entities located at the selected entity must be displayed.

SelectRowByKey() Method
Use the SelectRowByKey() method to search for the specified row ID in the grid. If the row ID is found,
the row is selected. If the row ID is not found and the SelectFirstRowAsDefault parameter is set to True,
the first row is selected; otherwise the row selection is not changed.
Syntax
result = bool SelectRowByKey(int rowID, bool selectFirstRowAsDefault);
Syntax (with overload)
result = public bool SelectRowByKey(int [] rowIDs,
bool selectFirstRowAsDefault);
Parameters
rowI D
An integer value that is the row ID of a row in the Item_Inv table.
selectFirstRowAs Default
A Boolean value that is set to True if the first row must be selected when there is no match. It is set to
False, if the row selection must not change when there is no match.

Version 6.0 115

MES .NET Controls Developer Guide Inventory Control

Return Value
result
A Boolean value that is True if the row ID is found; otherwise it returns False.

116 Version 6.0

 MES .NET Controls Developer Guide

C HAPTER 12
Item Consumption Editor Control
In This Chapter
Introduction to the Item Consumption Editor Cont rol ...................................................................... 117
Configuring the Item Consumption Edit or Control .......................................................................... 117
Properties of the Item Consumption Editor Control ........................................................................ 117
Methods of the Item Consumption Editor Control .......................................................................... 118

Introduction to the Item Consumption Editor Control

The Item Consumption Editor cont rol is used to view, filter, edit, insert, and delete item consumption data
stored in the Item_Cons table.

Configuring the Item Consumption Editor Control

When you use the Item Consumption E ditor control in an Arc hestrA symbol and view this symbol in
WindowViewer, it automatically shows the item consumption dat a from the MES database.
The Item Cons umption Editor is based on the Item Consumption tab in the MES Data Editor. From the
editor, you can filter and edit records during run time. For more information, see the Item Consumption
Tab section of the MES Dat a Editor Guide or MES online help.

Properties of the Item Consumption Editor Control

This section describes the properties of the Item Consumption Editor control. For information about the
common properties shared by this control, see Common Properties on page 51.

AppendSaveConfigName Property
The AppendSaveConfigName property is an overridden property that cannot be browsed. This
property is made nonbrowsable for you to always save the configuration data.

Data Type Read/Write Default Value

Boolean R/W True

SaveConfigName Property
The SaveConfigName property is an overridden property that cannot be browsed. This property cannot
be brows ed to allow you to always save the configuration data.

Data Type Read/Write Default Value

Version 6.0 117

MES .NET Controls Developer Guide Item Consumption Editor Control

Data Type Read/Write Default Value

String R/W The instance name for the saved

configuration. This may either be
appended to or replace the entity ID. If
left blank, the entity ID is used.

Methods of the Item Consumption Editor Control

The It em Consumption Editor Control does not contain any unique methods. For information about the
common met hods shared by this control, see Common Methods on page 55.

118 Version 6.0

 MES .NET Controls Developer Guide

C HAPTER 13
Item Lot Editor Control
In This Chapter
Introduction to the Item Lot Editor Cont rol ..................................................................................... 119
Configuring the Item Lot Editor Control ......................................................................................... 119
Properties of the Item Lot Editor Control ....................................................................................... 120
Methods of the Item Lot Editor Control ......................................................................................... 120

Introduction to the Item Lot Editor Control

The It em Lot Editor control is used to edit associations among item classes, items, lots, and sub lots.

Configuring the Item Lot Editor Control

You can use the Item Lot Editor control to maintain t he lot and sublot num ber for an it em. To use the Item
Lot Editor, the Data Editor and Tracking modules must be licensed and you must have both the May run
Data Editor and May edit lot data privileges.

To insert a new lot or sublot in the Item Lot Editor control during run time
1. In the left pane, highlight the item, lot, or sublot where you want to insert the new lot or sublot.
2. In the Button Bar for the Item Lot Editor control, click Insert. The Insert dialog box appears.
3. In the Name box, type the name of the lot or sublot you want to insert.
4. Click OK.
To change the parent of a lot or sublot in the Item Lot Editor control during run time
1. In the left pane, highlight the lot or sublot for which you want to change the parent.

Version 6.0 119

MES .NET Controls Developer Guide Item Lot Editor Control

2. In the Button Bar for the Item Lot Editor control, click Change Parent. The Change Parent dialog
box appears.
3. In the left pane of the Change Parent dialog box, highlight the new parent.
4. Click OK.
To rename a lot or sublot in the Item Lot Editor control during run time
1. In the left pane, select the lot or sublot you want to rename.
2. In the Button Bar for the Item Lot Editor control, click Rename. The Rename dialog box appears.
3. In New Name, enter the name you want to assign to the lot or sublot.
4. Click OK. The select lot or sublot is renamed in all occurrences of the MES database.
To delete an existing lot or sublot in the Item Lot Editor control during run time
1. In the left pane, highlight the item, lot, or sublot you want to delet e
2. In the Button Bar for the Item Lot Editor control, click Delete. A confirmation dialog box appears.
3. Click OK. The currently selected lot or sublot deleted from the Item Class tree and MES database. In
addition, all child lots and sublots are deleted from the Item Class tree and MES database.
To refresh records in the Item Lot Editor control during run time
 In the Button Bar for the Item Lot Editor control, click Refresh. The data in the control is updat ed.

Properties of the Item Lot Editor Control

The It em Lot Editor control does not contain any unique properties. For information about the common
properties shared by this control, see Common Properties on page 51.

Methods of the Item Lot Editor Control

The It em Lot Editor control does not contain any unique methods. For information about the common
methods shared by this control, see Common Methods on page 55.

120 Version 6.0

 MES .NET Controls Developer Guide

C HAPTER 14
Item Production Editor Control
In This Chapter
Introduction to the Item Production Editor Control ......................................................................... 121
Configuring the Item Production Editor Control ............................................................................. 121
Properties of the Item Production Editor Co ntrol............................................................................ 121
Methods of the Item Production Editor Control .............................................................................. 122

Introduction to the Item Production Editor Control

The It em Production Editor control is used to view, filter, edit, insert, and delete item production data in
the database tables.

Configuring the Item Production Editor Control

When you use the Item Production Editor cont rol in an ArchestrA symbol and view this symbol in
WindowViewer, it automatically shows the item production data from the MES database.
The Item Production Editor is based on the Item Production tab in the MES Data E ditor. From the editor,
you can filter, edit, insert, delete, and refresh records during run time. For more information, see the Item
Production Tab section of the MES Data Editor Guide or MES online help.

Properties of the Item Production Editor Control

This section describes the properties of the Item Production Edit or control. For information about the
common properties shared by this control, see Common Properties on page 51.

AppendSaveConfigName Property
The AppendSaveConfigName property is an override of the AppendSaveConfigName property and
cannot be browsed. This property cannot be browsed because the configuration data is always saved by
a user.

Data Type Read/Write Default Value

Boolean R/W True

SaveConfigName Property
The SaveConfigName property is an override of the SaveConfigName property and cannot be
browsed. This property cannot be browsed because the configuration data is always saved by a user.

Version 6.0 121

MES .NET Controls Developer Guide Item Production Editor Control

Data Type Read/Write Default Value

String R/W The instance name for the saved

configuration. This may be appended
to or replace the entity ID. If left blank,
the entity ID is used.

Methods of the Item Production Editor Control

This section describes the met hods of the Item Production Editor control. For information about the
common met hods shared by this control, see Common Methods on page 55.

GetQuantityForDownstreamOperation() Method
Use the GetQuantityForDownstreamOperation() method to compute the total quantity produced for an
operation that is immediately downstream from the specified job and lot.
Syntax
result = GetQuantityForDownstreamOperation(woID,operID, seqNo, lotNo,
sublotNo);
Parameters
woID
A string that is the work order ID of a job.
operID
A string that is the operation ID of a job.
seqNo
An integer that is the sequence number of a job.
lotNo
A string that is the lot number.
sublotNo
A string that is the sublot number.
Return Value
result
A floating point number that is the total quantity for the downstream operation.

GetTotalQuantityForOperation() Method
Use the GetTotalQuantityForOperation() met hod to compute the total quantity produced for the
specified operation. The operation can be split amongst multiple jobs that have the same work order ID,
operation ID, lot number, and sublot number.
Syntax
result = GetTotalQuantityForOperation(woID,operID, seqNo, lotNo, sublotNo);
Parameters
woID
A string that is the work order ID of a job.
operID
A string that is the operation ID of a job.
seqNo
An integer that is the sequence number of a job.

122 Version 6.0

Item Production Editor Control MES .NET Controls Developer Guide

lotNo
A string that is the lot number.
sublotNo
A string that is the sublot number.
Return Value
result
A floating point number that is the total quantity for the specified operation.

Version 6.0 123

 MES .NET Controls Developer Guide

C HAPTER 15
Job Step Data Editor Control
In This Chapter
Introduction to the Job Step Data Editor Control ............................................................................ 125
Configuring the Job Step Data Editor Cont rol ................................................................................ 125
Properties of the Job Step Data Editor Control .............................................................................. 125
Methods of the Job Step Data E ditor Control ................................................................................ 126

Introduction to the Job Step Data Editor Control

You use the Job Step Data Edit or control to view, filter, edit, insert, and delete job step data in the
Job_Step_Data table.

Configuring the Job Step Data Editor Control

When you use the Job Step Data Editor control in an ArchestrA symbol and view this symbol in
WindowViewer, it automatically shows the job step data from the MES databas e.
The Job Step Data Editor is based on the Steps Data tab in the MES Data Editor. From the editor, you
can filter, edit, insert, delete, and refresh records during run time. For more information, see the Steps
Data Tab section of the MES Data Edit or Guide or MES online help.

Properties of the Job Step Data Editor Control

This section describes the properties of the Job Step Dat a Editor control. For information about the
common properties shared by this control, see Common Properties on page 51.

AppendSaveConfigName Property
The AppendSaveConfigName property is an override of the AppendSaveConfigName property and
cannot be browsed. This property cannot be browsed because the configuration data is always saved by
a user.

Data Type Read/Write Default Value

Boolean R/W True

SaveConfigName Property
The SaveConfigName property is an override of the SaveConfigName property and cannot be
browsed. This property cannot be browsed because the configuration data is always saved by a user.

Version 6.0 125

MES .NET Controls Developer Guide Job Step Data Editor Control

Data Type Read/Write Default Value

String R/W The instance name for the saved

configuration. This may be appended
to or replace the entity ID. If left blank,
the entity ID is used.

Methods of the Job Step Data Editor Control

The Job Step Data Editor Control does not contain any unique methods. For information about the
common met hods shared by this control, see Common Properties on page 51.

126 Version 6.0

 MES .NET Controls Developer Guide

C HAPTER 16
Job Summary Control
In This Chapter
Introduction to the Job Summary Controls .................................................................................... 127
Configuring the Job Summary Control .......................................................................................... 127
Using the Job Summary Control .................................................................................................. 127
Properties of the Job Summary Control ........................................................................................ 128
Methods of the Job Summary Cont rol .......................................................................................... 128

Introduction to the Job Summary Controls

The Job Summary control shows all current job information of a given entity.
The Job Summary control corresponds to the head er of the Job window in Operator application. For
more information, see the Job section in the MES Operator Guide or online help.

Configuring the Job Summary Control

You can configure the Job Summary control to show the title bar at run time. The title bar can be used at
run time to set the entity the Job Summary control is referencing.
You can also use the Di splayTitleBar property of the Job control to show or hide th e title of the Job
Summary control. Setting the Di splayTitleBar property to True shows the Job Summary control title bar.
If y ou do not configure the Job S ummary control to show the title bar, the only way you can switch entities
at run time is by scripting.
When the entity can capture utilization, the title bar blinks to alert the user that a non -final reason has
been entered via the Utilization Capability Object and that a final reason is required for this entity.
To show the title bar in the Job Summary control
1. Select the Job Summary control for which you want to show the title bar.
2. In the Properties Editor, locate the property Di splayTitleBar.
3. Set the value of the property to True.

Using the Job Summary Control

The JobSummary class provides a control to view job information for all jobs running on an entity. The
JobSummary class also provides a means for users to log on and log off from entities. Also, the control
includes a title bar control that can be made visible through a control property to set the current entity.
To use the Job Summary control, you must log on to the control and select one or more entities.
Version 6.0 127
MES .NET Controls Developer Guide Job Summary Control

Switching Entities
If the operator is going to be logged on to more than one entity, you can use the Job Summary control to
allow the operat or to select the current entity in one of the following ways:
 Clicking an entity name in the title bar and selecting a different entity from the list of entities that the
operator is currently logged on to.
 Clicking the Logon Entity button and using the entity selector to log on to one or more entities.
The Job Summary control only shows information for the current entity.
If the current entity can only run one job at a time, the Job Summary control shows the job information for
the job that is currently running on the entity.
If t he current entity can run more than one job at a time, the Job Summary control shows a grid. Each row
on the grid corresponds to a job currently running on the entity.
The Job Summary control contains a single push button the operator can use to open the notes editor.
The Job Summary control does not have a Button Bar control associated with it.

Properties of the Job Summary Control

This section describes the properties of the Job Summary control. For information a bout the common
properties shared by this control, see Common Properties on page 51.

DisplayTitlebar Property
Set the Di splayTitlebar property to True if the control should show the title bar wit h the entity name to
use as the entity selector.

Data Type Read/Write Default Value

Boolean R/W True

Methods of the Job Summary Control

This section describes the met hods of the Job Summary cont rol. For information about the common
methods shared by this control, see Common Methods on page 55.

InitEntitySelect() Method
Use the InitEntitySelect() method to display the entity list dialog, which allows you to do the following:
 Select a different entity to use as the current entity
 Log on or log off entities
 Log off job, if job-based login is used
If an entity can capture utilization, the defined color of the utilization state of the entity is used for the text
of the entity name.
Syntax
InitEntitySelect();

128 Version 6.0

Job Summary Control MES .NET Controls Developer Guide

ResetDisplayTitleBar() Method
Use the Re setDi splayTitleBar() method to reset the Di splayTitleBar property to the default of True.
When the Di splayTitleBar property is True, the title bar showing th e current entity name with link to the
entity select list is shown on the Job Summary Control.
Syntax
ResetDisplayTitleBar();

SelectRowByKey() Method
Use the SelectRowByKey() method to search for the specified job in the grid and select the row
containing the job. If the job is not found, the first row of the grid is selected by default.
Syntax
result = SelectRowByKey(Job, SelectFirstRowAsDefault);
Parameters
job
A string containing the work order ID + "_" + the operation ID + "_" + the sequence number of the job.
SelectFirstRowAsDefault
A Boolean value that specifies whether to select the first row as default. The first row is always
selected by default if the job is not found.
Return Value
result
A Boolean value that is True, if the row containing the job is found; otherwise it returns False.

Version 6.0 129

 MES .NET Controls Developer Guide

C HAPTER 17
Labor Usage Editor Control
In This Chapter
Introduction to the Labor Usage Editor Control .............................................................................. 131
Configuring the Labor Usage Editor Control .................................................................................. 131
Properties of the Labor Usage Editor Control ................................................................................ 131
Methods of the Labor Usage Editor Control .................................................................................. 132

Introduction to the Labor Usage Editor Control

You use the Labor Usage Editor control to view, filter, edit, insert, and delete labor usage data in the
Labor_Usage table.

Configuring the Labor Usage Editor Control

When you use the Labor Usage Editor cont rol in an ArchestrA symbol and view this symbol in
WindowViewer, it automatically shows the labor usage data from the MES databas e.
The Labor Usage E ditor is based on the Labor Use tab in the MES Data Edit or. From the editor, you can
filter, edit, insert, delete, and refresh records during run time. For more information, see the Labor Use
Tab section of the MES Dat a Editor Guide or MES online help.

Properties of the Labor Usage Editor Control

This section describes the properties of the Labor Us age Edit or control. For information about the
common properties shared by this control, see Common Properties on page 51.

AppendSaveConfigName Property
The AppendSaveConfigName property is an override of the AppendSaveConfigName property and
cannot be browsed. This property cannot be browsed because the configuration data is always saved by
a user.

Data Type Read/Write Default Value

Boolean R/W True

SaveConfigName Property
The SaveConfigName property is an override of the SaveConfigName property and cannot be
browsed. This property cannot be browsed because the configuration data is always saved by a user.

Version 6.0 131

MES .NET Controls Developer Guide Labor Usage Editor Control

Data Type Read/Write Default Value

String R/W The instance name for the saved

configuration. This may be appended
to or replace the entity ID. If left blank,
the entity ID is used.

Methods of the Labor Usage Editor Control

The Labor Usage Editor Control does not contain any unique methods. For information about the
common met hods shared by this control, see Common Methods on page 55.

132 Version 6.0

 MES .NET Controls Developer Guide

C HAPTER 18
OEE KPI Control
In This Chapter
Introduction to the OEE KPI Control ............................................................................................. 133
Using the OEE KPI Control .......................................................................................................... 134
Properties of the OEE KPI Control ............................................................................................... 134
Methods of the OEE KPI Control .................................................................................................. 141

Introduction to the OEE KPI Control

The OEE KPI control shows OEE or one aspect of OEE on a dial or bar graph. The control shows OEE,
Quality, Availability, and/or Performance actual values for an entity. It also shows the associated target
values.

Version 6.0 133

MES .NET Controls Developer Guide OEE KPI Control

Using the OEE KPI Control

When configuring the OEE KPI cont rol, the designer will typically set a default Control Style (dial or bar
graph) and Filter Defaults (TypeFilter, FilterDuration, OEEKPIFilter.FilterTime,
OEEKPIFilter.FilterStartOffset, OEEKPIFilter.FilterEndOffse t). It is also possible to specify that
various property values will be c onfigured by the operator at run time and 's aved to' or 'ret rieved from' the
MES databas e on a per user basis. If this is the case, configuring these properties will be disabled at
design time. See the FilterDefaultsFromDB Propert y on page 264 for more on this.
At design time or run time, when configuring filters, a Filter dialog box exists to help coordinate the
setting of several properties at once. This Filter dialog box can be invoked at design time by selecting the
ellipsis button next to the TypeFilter property. At run time, it is invok ed by calling the Filter() method or
using the button bar.

At run time, the control is refreshed whenever an OEEChanged event is detected from the MES
database. This event is handled int ernally by the control. The control is also refreshed when various
properties are set (such as ControlStyle, TypeFilter, and so on). To prevent a refresh from occurring in
the middle of setting the filters, the control supports the common IgnoreRefre shEvents property and
Refre shData() method scheme. For more information on this method, see RefreshData() Method on
page 58.
The OEE KPI control has a context menu that allows a user with the proper permissions to save the
configuration of the control to the database for either a specific entity, all the logged on entities, or as a
default. Only the button bar setup and the curr ent filter settings will be saved as configuration data.
To use the OEE KPI control, the operator must log on to a session and select one or more entities, or set
the Di splayEntity property which will use the display entity as the source of the data.

Switching Entities
The OEE KP I cont rol shows information only for the current entity. If the Job Summary cont rol is included
in the form, you can use it to change the current entity. You can also change the current entity by using a
script.

Associating the Button Bar Control

When you use the OEE KPI control in an ArchestrA symbol, you can associate the Button Bar con trol
with it. For more information, see Associating the Button Bar Control with Other Controls on page 68.

Properties of the OEE KPI Control

This section describes the properties of the OEE KPI Control. For information about the common
properties shared by this control, see Common Properties on page 51.

134 Version 6.0

OEE KPI Control MES .NET Controls Developer Guide

CurrentValue Property
The CurrentValue property indicates the current value for the configured KPI.

Datatype Read/Write Default Value

Double Read Only N/A

DisplayEntity Property
When the Di splayEntity property is set to a specific entity name, the control will use that entity as the
source of the data instead of the currently logged in entity. This will enable multiple KPI controls to exist
on the same screen, each one showing values for a different ent ity (dashboard setup).
Dynamic entity names can be configured through the symbol editor by data -binding the tag reference or
custom property in the reference column.
If this property is set to null or an empty string, the currently logged in entity will be used as the source of
data.

Data Type Read/Write Default Value

String R/W Null

FilterDefaultsFromDB Property
The FilterDefaultsFrom DB property controls whether the default filter settings (TypeFilter,
FilterDuration, OEEKPIFilter.FilterTime, OEEKPIFilter.FilterStartOffset, and
OEEKPIFilter.FilterEndOffset properties ) are established during design time or if they will be pulled in
from the MES database during run time. If this property is set to False, the default filter s ettings will not be
loaded from the database. This could be suitable when the control is running within ArchestrA – the
default filter would be set during design-time. If t he property is set to True, the default filter settings will be
pulled from either the UI_Config table or the UI_Config_Default table during run time. In this case, the
design-time setting of the properties is disabled.

Datatype Read/Write Default Value

Boolean R/W False

FilterEnabled Property
The FilterEnabled property indicates whether the Filter() met hod may be called. If it is set to False, the
Filter() method may not be called. This property is set by the control whenever the state of the control
changes. It will be set to False if there is no MES session, no user, or no entity. At all other times it should
be set to True.

Datatype Read/Write Default Value

Boolean Read Only False

Version 6.0 135

MES .NET Controls Developer Guide OEE KPI Control

FirstZoneColor Property
The FirstZoneColor property indicates the color to use when a value is in the first zone. When using a
dial, the background of the dial should be displayed in this color if the value is within the first zone. When
using a bar graph, the bar should be this color if the value is within the first zone.

Datatype Read/Write Default Value

Color R/W Red

FirstZoneCutoff Property
The FirstZoneCutoff property indicates the cutoff for the worst values. The first zone runs from 0 to
FirstZoneCut off. This value must be great er than or equal to 0 and less than or equal to 100 and it must
be less than or equal to the value of SecondZoneCutoff.

Datatype Read/Write Default Value

Double R/W 40

GaugeBackColor Property
Use the GaugeBackColor property to set the color of the dial area for the dial control and the
background of the bar control.

Data Type Read/Write Default Value

Color R/W

GaugeBorderColor Property
Use the GaugeBorderColor property to set the color of the border for both the dial control and the bar
control.

Data Type Read/Write Default Value

Color R/W

GaugeBorderVisible Property
Use the GaugeBorderVi sible property to set the visibility of the border of the dial control and the bar
control.

Data Type Read/Write Default Value

Color R/W

GaugeFillColor Property
Use the GaugeFillColor property to set the color of the area that surrounds the dial control view.

136 Version 6.0

OEE KPI Control MES .NET Controls Developer Guide

Data Type Read/Write Default Value

Color R/W

GaugeForeColor Property
Use the GaugeForeColor property to set the color of the text on the dial control and the bar control. For
the dial control, this property also sets the color for the minor and major tick marks.

Data Type Read/Write Default Value

Color R/W

GaugeGradientEnabled Property
Use the GaugeGradientEnabled property to set the visibility of the gradient for the dial control and the
bar control. For the dial control, this property enables or disables the gradient over the dial area. For the
bar cont rol, it enables or disables the gradient of the bar elements on the graph.

Data Type Read/Write Default Value

Boolean R/W True

GaugeMarkerFont Property
Use the GaugeMarkerFont property to set the font properties for the marker values. You can use this
property to separately configure the dial cont rol and the bar control. For the dial c ontrol, this property also
sets the font for the value label.

Data Type Read/Write Default Value

Font R/W

GaugeTitleFont Property
Use the GaugeTitleFont property to set the font properties for the title label. You can use t his property to
separately configure the dial control and the bar control.

Data Type Read/Write Default Value

Font R/W

GaugeTitleTextVisible Property
Use the GaugeTitleTextVisible property to set the visibility of the title label for the dial control and the
bar cont rol.

Version 6.0 137

MES .NET Controls Developer Guide OEE KPI Control

Data Type Read/Write Default Value

Boolean R/W True

GaugeValueTextVisible Property
Use the GaugeValueTextVisible property to set the visibility of the value label for the dial control.

Data Type Read/Write Default Value

Boolean R/W True

KPIControlStyle Property
The KPI ControlStyle property is an enumeration type that specifies how the data is displayed. The
control will either dis play the data on a dial or in a bar graph. If a dial is being us ed, the position of the
needle will be set according to the value being displayed (as determined by the KPIType property) and a
tick mark made at the target value. If a bar graph is being used, there will be a bar for the value being
displayed and another bar for the associated target value.

Datatype Read/Write Default Value

Enum {Dial=0, R/W Dial

BarGraph=1}

KPIType Property
The KPIType property indicates whether the OEE, Quality, Availability, or Performance will be displayed
for the specified filter period.

Datatype Read/Write Default Value

Enum {OEE=0, R/W 0

Quality=1,
A vailability=2,
Performance= 3}

OEEKPIFilter.FilterDuration Property
The OEEKPIFilter.FilterDuration property specifies the N in the Last N Hours filter type. The value of
this property is only legitimate when the TypeFilter property is set to Last N Hours.

Datatype Read/Write Default Value

Integer R/W 0

138 Version 6.0

OEE KPI Control MES .NET Controls Developer Guide

OEEKPIFilter.FilterEndOffset Property
The OEEKPIFilter.FilterEndOffse t property specifies the end of the filter period relative to now. This
filter value is only legitimate when the TypeFilter property is set to Custom. If the TypeFilter property is
not set to Custom, this property is set to:
 0 if the type is ThisHour, LastNHours, CurrentShift, CurrentDay, CurrentWeek, or CurrentMonth
 1 if the type is LastShift, Yesterday, LastWeek, or LastMonth
The value of this property should always be less than the value of the FilterStartOffset property and
greater than or equal to 0.

Datatype Read/Write Default Value

Integer R/W 0

OEEKPIFilter.FilterStartOffset Property
The OEEKPIFilter.FilterStartOffset property specifies the start of the filter period relative to now. This
filter value is only legitimate when the TypeFilter property is set to Custom. If the TypeFilter property is
not set to custom, this property is set to:
 1 if the type is ThisHour, CurrentShift, CurrentDay, CurrentWeek, or CurrentMonth;
 2 if the type is LastShift, Yesterday, LastWeek, or LastMonth
 N if the type is set to LastNHours
The value of this property should always be greater than the value of the FilterEndOffset property and
should always be greater than or equal to one.

Datatype Read/Write Default Value

Integer R/W 1

OEEKPIFilter.FilterTimeUnit Property
The OEEKPIFilter.FilterTimeUnit property specifies the time unit for a custom filter type. This filter
value is only legitimate when the TypeFilter property is set to Custom. If the TypeFilter property is not
set to custom, this property is set to value that matches the type (hour if type is ThisHour or LastNHours;
Shift type is CurrentShift or LastShift; Day if type is Current Day or Yesterday; Week if type is
CurrentWeek or LastWeek; or Month if type is CurrentMonth or LastMonth).
When this property is set to Hour, the results will include data for 0 or more entire hour periods, relative to
the current time. For all other settings (Shift, Day, Week, Month, or Year), the results will start at the
beginning of the time unit specified by the FilterStartOffse t property.

Datatype Read/Write Default Value

Enum {Hour=0, R/W Hour

Shift=1,
Day=2,
Week=3,
Month=4,
Year=5}

Version 6.0 139

MES .NET Controls Developer Guide OEE KPI Control

OEEKPIFilter.FilterType Property
The OEEKPIFilter.FilterType property specifies which filter to use including a custom filter. If
LastNHours is selected, you will also need to set the FilterDuration property. If Custom is selected, you
will also need to set the OEEKPIFilter.FilterTime, OEEKPIFilter.FilterStartOffse t, and
OEEKPIFilter.FilterEndOffset properties.

Datatype Read/Write Default Value

Enum {ThisHour=0. R/W ThisShift

LastNHours=1,
CurrentShift=2,
LastShift=3,
CurrentDay=4,
Yesterday=5,
CurrentWeek=6,
LastWeek=7,
CurrentMont h=8,
LastMonth=9,
Custom=10}

SecondZoneColor Property
The SecondZoneColor property indicates the color to use when a value is the second zone. When
using a dial, the background of the dial should be displayed in this color if the value is within the second
zone. When using a bar graph, the bar should be this color if the value is within the second zone.

Datatype Read/Write Default Value

Color R/W Yellow

SecondZoneCutoff Property
The SecondZoneCutOff property indicates the cutoff for t he middle values. Values that are greater t han
the FirstZonePercent and less than or equal to the SecondZoneCutoff in the second zone. The value
of SecondZone Cutoff must be greater than or equal to 0 and less than or equal to 100 and it must be
greater than or equal to the value of FirstZoneCutoff.

Datatype Read/Write Default Value

Double R/W 80

TargetValue Property
The TargetValue property indicates the target value for the configured KPI.

Datatype Read/Write Default Value

Double Read Only N/A

140 Version 6.0

OEE KPI Control MES .NET Controls Developer Guide

ThirdZoneColor Property
The ThirdZoneColor property indicates the color to use when a value is the third zone. A value is in the
third zone if it is great er than the value of the SecondZoneCutoff property and less than or equal to 100.
When using a dial, the background of the dial should be displayed in this color if the value is within the
third zone. When using a bar graph, the bar should be this color if the value is within the third zone.

Datatype Read/Write Default Value

Color R/W Green

Methods of the OEE KPI Control

This section describes the met hods of the OEE KPI Control. For information about the common methods
shared by this control, see Common Methods on page 55.

Filter() Method
The Filter() method can only be called when the FilterEnabled property is set to True. Call this method
to bring up the Filter dialog box.
Syntax
Filter();

Version 6.0 141

 MES .NET Controls Developer Guide

C HAPTER 19
Production Control
In This Chapter
Introduction to the Production Cont rol .......................................................................................... 143
Configuring the P roduction Control .............................................................................................. 143
Using the Production Control ....................................................................................................... 144
Properties of the Production Control ............................................................................................. 144
Methods of the Production Control ............................................................................................... 145

Introduction to the Production Control

The Production control allows users to view and maintain an entity's production.
You can also use the Production control to:
 Add new serial numbers and assign serial numbers to a job when a job is producing a serialized item.
 Trans fer serialized parts between storage locations when a job is producing serialized items.

Configuring the Production Control

You use the Production control to report produced items and change the lot data.
When you use the Production control in an Arc hestrA symbol, you can associat e the Button Bar control
with it. For more information, see Associating the Button Bar Control with Other Controls on page 68.

The operator can use the Production control to:

 Add good units to the production.
 Add rejected units to the production.
 Mark the production lot as proc essed.
 Set a new lot number, production code and storage location.
 Reduce units from the production.
 Refresh the Production control.
 Start an external application.
 Start Internet Explorer.

Version 6.0 143

MES .NET Controls Developer Guide Production Control

 Open the Help window.

 Switch the active user.
 Add/assign serial numbers.
 Trans fer serial numbers.
 View attributes of the produced item.
 Open or launch a form, if the Path to Form Program system parameter is set.
This control corresponds to the Production tab of the MES Operator application. For more information,
see the Production Tab section in the MES Operator Guide or online help.

Using the Production Control

To use the Production control, the operator must log on to a session and select one or more entities.
When you use the Production control in an Arc hestrA symbol, you can associate the Button Bar control
with it. For more information, see Associating the Button Bar Control with Other Controls on page 68.

Properties of the Production Control

This section describes the properties of the Production control. For information about the common
properties shared by this control, see Common Properties on page 51.

AddAssignSerialNumbersEnabled Property
Use the AddAssignSerialNumbersEnabled property to determine if Add/Assign Serial Numbers
button and functionality is enabled.

Data Type Read/Write Default Value

Boolean Read Only False

AddProdEnabled Property
Use the AddProdEnabled property to determine if the Add Production button and functionality is
enabled.

Data Type Read/Write Default Value

Boolean Read Only False

ProcessEnabled Property
Use the Proce ssEnabled property to determine if the Proce ss button and functionality is enabled.

Data Type Read/Write Default Value

Boolean Read Only False

144 Version 6.0

Production Control MES .NET Controls Developer Guide

ReduceProdEnabled Property
Use the ReduceProdEnabled property to determine if the Reduce Production button and functionality
is enabled.

Data Type Read/Write Default Value

Boolean Read Only False

RejectsEnabled Property
Use the RejectsEnabled property to determine if the Recla ssify Production button and functionality is
enabled.

Data Type Read/Write Default Value

Boolean Read Only False

SetLotDataEnabled Property
Use the SetLotDataEnabled property to determine if the Set Lot Data button and functionality is
enabled.

Data Type Read/Write Default Value

Boolean Read Only False

TransferSerialNumbersEnabled Property
Use the TransferSerialNumbersEnabled property to determine if the Transfer Serial Numbers button
and functionality is enabled.

Data Type Read/Write Default Value

Boolean Read Only False

ViewItemAttributesEnabled Property
Use the ViewItemAttributesEnabled property to determine if the View Item Attributes button and
functionality is enabled.

Data Type Read/Write Default Value

Boolean Read Only False

Methods of the Production Control

This section describes the met hods of the Production control. For information about the common
methods shared by this control, see Common Methods on page 55.

Version 6.0 145

MES .NET Controls Developer Guide Production Control

AddAssignSerialNumbers() Method
The AddAssignSerialNumbers() met hod can only be called when the
AddAssignSerialNumbersEnabled property is True. Use the AddAssignSerialNumbers() method to
open the Add/Assi gn Serial Numbers dialog box to add, assign, or unassign serial numbers to the
currently selected work order for the serialized item it produces.
Syntax
AddAssignSerialNumbers();

AddProduction() Method
The AddProduction() method can only be called when the AddProductionEnabled property is True.
Use the AddProduction() method to open a dialog box that allows entering either of good or rejected
production. The dialog box will contain fields to set the amount of production to be added, to select the
reason code to associate with the production being added and the item that is being produced, the lot,
and the storage location for the produced item.
If there are defaults for any of these fields, they will be filled in when the dialog box is opened. Entering a
quantity and clicking the Save button will add the good or rejected production for the reason.
Syntax
AddProduction();

ItemAttributes() Method
The ItemAttributes() method can only be called when the ItemAttribute sEnabled property is True. Use
the ItemAttribute s() method to open a dialog box that allows for the ent ering of item attribute values
and/or notes.
Syntax
ItemAttributes();

Process() Method
Use the Proce ss() method to open a dialog box that allows marking a production lot as processed.
Syntax
Process();

ReduceProduction() Method
The ReduceProduction() method can only be called when the ReduceProductionEnabled property is
True. Use the ReduceProduction() method to open a dialog box that allows the reduction of previously
entered production. The dialog box will contain a field to set the amount of production to be reduced. It
will also display the reason code, the item produced, the lot, and the storage l oc ation for the produc ed
item. Entering a quantity and clicking the OK button will reduce the previous production quantity.
Syntax
ReduceProduction();

146 Version 6.0

Production Control MES .NET Controls Developer Guide

RejectProduction() Method
The RejectProduction() method can only be called when the RejectProductionEnabled property is
True. Us e the RejectProduction() method to open the Reclassi fy Production dialog box that allows
the reclassification of previously entered production. The dialo g box will cont ain fields to set the amount
of production to be changed, to select the reason code to associate with the production being changed,
the item that is being produced, the lot, and the storage location for the produced item. The previously
recorded values for thes e fields will be filled in when the dialog box is opened. Entering a quantity and
clicking the OK button will update the production.
Syntax
RejectProduction();

SelectRowByKey() Method
Use the SelectRowByKey() method to search for the specified row ID in the grid. If the row ID is found,
the row is selected.
If the row ID is not found and the SelectFirstRowAsDefault parameter is set to True, the first row is
selected; otherwise the row selection is not changed.
Syntax
result = SelectRowByKey(rowID, selectFirstRowAsDefault);
Parameters
rowI D
An integer that indicates the row ID of a row in the item_prod table.
selectFirstRowAs Default
A Boolean value that is set to True if the first row should be selected if the row ID is not found or set
to False if the row selection should not be changed if the row ID is not found.
Return Value
result
A Boolean value that is True, if the row ID is found, otherwise it returns False.

SetLotData() Method
Use the SetLotData() method to open the Set Lot Data dialog box that allows setting of lot data for the
current job. This is used to set the production information prior to adding production so that calls to
consumption will also record the produced lot number. There must be a current user logged on to at l east
one entity, and the current entity must be running a job. If the lot data is changed, the grid is refreshed.
Syntax
SetLotData();

TransferSerialNumbers() Method
Use the TransferSerialNumbers() method to open the Transfer Serial Numbers dialog box to allow
transferring of serialized parts from one inventory location to anot her.
Syntax
TransferSerialNumbers();

Version 6.0 147

 MES .NET Controls Developer Guide

C HAPTER 20
Production Progress Control
In This Chapter
Introduction of the Production Progress Control ............................................................................ 149
Using the Production Progress Control ......................................................................................... 149
Properties of the Production Progress Control .............................................................................. 151
E vents of the Production Progress Control ................................................................................... 155

Introduction of the Production Progress Control

The Production P rogress control is used to display an operator's progress towards a provided target for
the current shift. If there is no current job or there is no current shift, the control would indicate this and
not display any data.

Using the Production Progress Control

The Production P rogress control is a horizontal overlaid bar chart that displays a bar for the current
production, with its left edge at zero. The projected production is based on the current rate of production
for the current job running on the current machine. The current production and projected production bars
display in the colors as defined by the properties of the control.

There is also a tick mark showing the t arget production. If the projected production is less than the target,
the control displays a warning to the user to indicate that the target production will not be reached. This
warning should not be shown until the user has reported some quantities for the shift. The control has
120 scale markings on it with every 10th marking, starting with the 0t h mark, being a larger mark. The
scale has no fixed meaning. The Target tick mark is always placed at the 100 mark, and the scale is
calculated from there.
The TargetQuantity or a TargetRate and TargetRateUnits can be set at run time, resulting in the other
target values being recalculated using the new value and the cont rol being refres hed based on the new
target. See section on Setting Target Values on page 151. The control also refreshes when the current
job changes or the job quantity of the current job changes.

Version 6.0 149

MES .NET Controls Developer Guide Production Progress Control

Logging On to the Production Progress Control

To use the Production Progress Control, the operator must log on to a session and select one or more
entities that can run jobs. The operator must then log int o a job. If t he operator is not already logged on to
a session and logged on to at least one entity the control automatically initiates the log on process by one
of the following methods:
 Logging on the current InTouch user to the session.
 Presenting the operator with a log on dialog box.
After the operator is logged on to the session, the cont rol by default pres ents the operator with an entity
log on dialog box. These behaviors can be overridden by setting the AutoLoginUser or the
AutoLogOnEnt properties to False. If this is done, logging on to a session and logging on to an entity
must be done with a script. Once the user is logged onto an entity, they must start a job on the entity if
one is not already running. The projected production is based on the current rat e of production for the
current job running on the current machine. If there is no current job or there is no current shift, the control
would indicate this and not display any data. The Queue control can be used to start a job if it is included
on the form, or a dat a entry job can be started thro ugh the Utilization Control if it is included on the form.
Otherwise, the job will have to be started by using script.

Switching Entities
The Production P rogress Control shows information only for the current job on the current entity. If the
Job Summary control is included in the form, you can use it to change the current entity. You can also
change the current entity by using a script.

Switching Jobs
The Production P rogress control shows information only for the current job and the current shift. If the
Job Summary control is included in the form, and the current entity can run multiple jobs, and it currently
has multiple jobs running, you can use the Job Summary control to change the current job by selecting a
different job on the grid. The Queue control and Utilization control can also be used to c hange the current
job if they are on the form. To do this, the current job would be ended using the Stop Job button that
appears on the button bar of both of these controls. Then, on the Queue control, another job would be
selected from t he grid and t he Start Job button would be pushed. The selected job will be started and set
as the current job. On the Utilization control, the user would start a data entry job by clicking the Start
Job button, which will open a dialog for entering data entry job information. Setting the information to the
appropriate dat a entry job and clicking OK will start the job. You can also change the current job by using
a script.

150 Version 6.0

Production Progress Control MES .NET Controls Developer Guide

Setting Target Values

If the TargetRateFromDB property is set to True, the TargetRate, ProductionUnitOfMeasure , and
BatchSize properties are set by getting the values from the MES database and the TargetQuanti ty
property is calculated from the TargetRate. These values can not be set at design-time or run time in this
case. If the TargetRateFrom DB property is False, either the TargetQuantity property or the
TargetRate property must be set at design time or run time to get the production target. To set the values
at design time, the user opens the form for editing in ArchestrA and clicks on the Production Progress
Cont rol and goes to the Properties section on the right side of the window. A value can be entered for the
TargetQuantity or TargetRate property as well as other properties of the Progress Production Control
if the defaults are not to be used. To set the values at run time, the user must hook an ArchestrA tag to
the properties. When the value of the ArchestrA tag is changed during run time, the property hooked to it
will be updated with the new value. To do this, the user opens the form in ArchestrA and double clicks on
the Production Progress Control. This will open an Edit Animations dialog. Click Data Binding in the
Configuration list on the left side of the dialog box. On the right side, a list will appear containing the
properties of t he Production Progress Control. A tag can be filled into t he Reference c olumn on the row of
the property want to hook to the tag. The tag can be typed in directly, or browsed for by clicking the
browse button at the end of the reference field. Clicking OK will then hook this tag to the property. Script
can also be used to set the target property values at run time.

Properties of the Production Progress Control

This section describes the properties of the Production Progress Control. For information about the
common properties shared by this control, see Common Properties on page 51.

BatchSize Property
The BatchSize property indicates the quantity of items in each batch. Since the TargetRate property is
expressed in terms of batches per time unit or time unit per batch, the batch size is required to determine
the target quantity.

DataType Read/Write Default Value

Double R/W 1

Data.CurrentProduction Property
The Data.CurrentP roduction property exposes the value being used to draw the bar on the graph for
the current production.

DataType Read/Write Default Value

Double Read Only 0

Data.Deviation Property
The Data.Deviation property exposes the deviation bet ween target and projected productions.

DataType Read/Write Default Value

Double Read Only

Version 6.0 151

MES .NET Controls Developer Guide Production Progress Control

DeviationfromPlannedFont Property
The DeviationfromPlannedFont property sets or gets the font for the Deviation from Planned legend.

DataType Read/Write Default Value

Font R/W

DisplayProjectedDetails Property
The Di splayProjectedDetails property specifies the visibility of the projected quantity indicator.

DataType Read/Write Default Value

Boolean R/W

FirstZoneColor Property
The FirstZoneColor property indicates the color to use when a value is in the first zone. The actual bar
will be displayed using this color.

DataType Read/Write Default Value

Color R/W Red

FirstZonePercent Property
The FirstZonePercent property indicates the cutoff for the worst values. If the projected production is
below the target quantity by a percent age that is greater then or equal to this percent age, the actual bar
will be display ed using the color specified by the FirstZoneColor property. This value must be between
0 and 100 and it must be greater than the value of the SecondZonePercent property.

DataType Read/Write Default Value

Double R/W 5

GaugeTextFont Property
The GaugeTextFont property sets or gets the font for the Gauge text.

DataType Read/Write Default Value

Font R/W

152 Version 6.0

Production Progress Control MES .NET Controls Developer Guide

ProductionUnitOfMeasure Property
The ProductionUnitOfMeasure property specifies how many batches are being produced in a given
time period. The possible values are Batch esPerSecond (0), BatchesPerMinut e (1), BatchesPerHour
(2), SecondsPerB atch (3), MinutesPerB atch (4), and HoursPerB atch (5). The first three values specify
that N batches are made every (second, minute, or hour), while the last three specify that it takes N
(seconds, minut es, or hours) to make a batch. Without units, the TargetRate is a meaningless number.

DataType Read/Write Default Value

Enum R/W BatchesPerHour

{BatchesPerS econd=0,
BatchesPerMinute=1,
BatchesPerHour=2,
SecondsPerBatch=3,
MinutesPerB atch=4,
HoursPerB atch=5}

ProjectedProduction Property
The ProjectedProduction property exposes the value being used to draw the bar on the graph for the
projected production.

DataType Read/Write Default Value

Double Read Only 0

SecondZoneColor Property
The SecondZoneColor property indicates the color to use when a value is the second zone. The actual
bar will be displayed using this color.

DataType Read/Write Default Value

Color R/W Yellow

SecondZonePercent Property
The SecondZonePercent property indicates the cutoff for the middle values. If the projected production
is below the target quantity by a percentage that is less than the value of the FirstZonePercent but
greater than this percent, the actual bar will be displayed using the color specified by the
SecondZoneColor property. This value must be bet ween 0 and 100 and it must be less than the value of
FirstZonePercent property.

DataType Read/Write Default Value

Double R/W 0

TargetBarColor Property
The TargetBarColor property specifies the color to use when drawing the target bar on the graph.

Version 6.0 153

MES .NET Controls Developer Guide Production Progress Control

DataType Read/Write Default Value

Color R/W Blue

TargetQuantity Property
The TargetQuantity property provides one of two ways to specify the target for the operator. If the
TargetQuantity is set, the TargetRate is calculated at run time by dividing the TargetQuantity by the
length of the shift or the duration from the beginning of the current job to the end of the shift if the job
begins after the shift has started. If this property is set at design-time, the TargetRate is set to 0.

DataType Read/Write Default Value

Double R/W 0

TargetRate Property
The TargetRate property provides one of two ways to specify the target for the operator. If the
TargetRate is set, the TargetQuantity is calculated at run time by multiplying the TargetRate with either
the length of the shift or the duration from the beginning of the current job to the end of the shift if the job
begins after the shift has started. If this property is set at design-time, the TargetQuantity is set to 0.

DataType Read/Write Default Value

Double R/W 0

TargetRateFromDB Property
The TargetRateFromDB property is a flag indicating whether or not the target rate will be set by the rate
in the MES database for the current job. If this is set to True, the TargetRate,
ProductionUnitOfMea sure, and BatchSize properties will be set by getting the values from the MES
database and the TargetQuantity property will be calculated from the TargetRate. If it is set to False,
either the TargetQuantity property or the TargetRate property must be set at design time or run time to
get the production target.

DataType Read/Write Default Value

Boolean R/W False

TargetUnreachable Property
The TargetUnreachable property exposes a flag indicating whether or not the projected production is
less than the target. It is set to True if the projected production is less than the target. It is set to False if
the projected production is greater than or equal to the target or if no production has been reported for
the shift.

DataType Read/Write Default Value

Boolean Read Only False

154 Version 6.0

Production Progress Control MES .NET Controls Developer Guide

ThirdZoneColor Property
The ThirdZone Color property indicates the color to use for the actual bar when a value is in the third
zone. A value is in the third zone if the projected production is below the target quantity by a percentage
that is less than or equal to the value of the SecondZonePercent or if t he projected production is greater
than the target quantity.

DataType Read/Write Default Value

Color R/W Green

ValueLegendLabelFont Property
The ValueLegendLabelFont property sets or gets the font for the V alue Legend labels.

DataType Read/Write Default Value

Font R/W

ValueLegendValueBackColor Property
The ValueLegendValueBackColor property sets or gets the font for the Value Legend values.

DataType Read/Write Default Value

Color R/W

ValueLegendValueColor Property
The ValueLegendValueColor property sets or gets the font for the Value Legend values.

DataType Read/Write Default Value

Color R/W

ValueLegendValueFont Property
The ValueLegendValueFont property sets or gets the font for the Value Legend values.

DataType Read/Write Default Value

Font R/W

Events of the Production Progress Control

This section describes the events of the Production Progress Control.

Version 6.0 155

MES .NET Controls Developer Guide Production Progress Control

TargetQuantityChanged Event
The TargetQuantityChanged event is raised by the Production Progress Control when the value of the
TargetQuantity property changes. When this event occurs, the TargetRate is recalculated using the
new target value, and the control will force a refresh of its data using the new value.

TargetRateChanged Event
The TargetRateChanged event is raised by the Production Progress Control when the value of the
TargetRate property changes. When this event occurs, the TargetQuantity will be recalc ulated using
this new target value and the control will force a refresh of it's data using the new value.

Event Handled/Raised Action

TargetQuantityChanged Raised by: - Cont rol Refresh Control with

values from the database.

Target Rate Changed Raised by: - Cont rol Refresh Control with
values from the database.

156 Version 6.0

 MES .NET Controls Developer Guide

C HAPTER 21
Queue Control
In This Chapter
Introduction to the Queue Control ................................................................................................ 157
Configuring the Queue Cont rol .................................................................................................... 157
Properties of the Queue Control ................................................................................................... 158
Methods of the Queue Control ..................................................................................................... 163

Introduction to the Queue Control

The Queue class provides a control to view all jobs queued to an entity and to change the state of jobs
queued to an entity.

Configuring the Queue Control

You use the Queue control to:
 Log on to and log off from jobs of a given entity.
 Cont rol which jobs are run on this entity at any given time.
When you use the Queue control in an ArchestrA symbol, you can associate the Button Bar control with
it. For more information, see Associating the Button Bar Control with Other Controls on page 68.

The operator can use the Queue control to:

 Start the selected job.
 Stop the currently running job.
 Pause the currently running job.
 Changes the selected job’s state from New to Ready.
 Show the routing diagram for eit her the currently running job, or the selected job.
 Show all required components for either the currently running job, or the selected job.
 Create a new work order to replenish the inventory level for a selected item.

Version 6.0 157

MES .NET Controls Developer Guide Queue Control

 Show attributes of the currently running job, or the selected job.

 Refresh the Queue control.
 Switch the active user.
 Start an external application.
 Start Internet Explorer.
 Open the Help window.
 View job notes.
 Show attributes of the item being produced.
 Split a job.
 Link jobs together in a batch.
 Start a portion of a job.
 Add/assign serial numbers.
 Trans fer serial numbers.
 Log off the job.
 Open or launch a form, if the Path to Form Program system parameter is set.
The Queue control corresponds to the Work Queue tab of the MES Operator application. For more
information, see the Queue Tab section in the MES Operator Guide or online help.
An operator must log on to MES and use the Queue control to select one or more entities. This is the
default behavior.

Switching Entities
By default, the Queue control shows the job queue information for the current entity.
The operator can use the Job Summary control to select the current entity. This is the default behavi or.
The job queue for other entities that the operator has access to can be shown by selecting the other
entity in the Accessible Entities list.
Functionality is limited when viewing the job queue of an entity other than the current entity.

Associating the Button Bar Control

When you use the Queue control in an ArchestrA symbol, you can associate the Button Bar control with
it. For more information, see Associating the Button Bar Control with Other Controls on page 68.

Properties of the Queue Control

This section describes the properties of t he Queue control. For information about the common properties
shared by this control, see Common Properties on page 51.

AttributesEnabled Property
Use the Attribute sEnabled property to determine if the Job Attribute s button is enabled.
The Attribute sEnabled property is also used in the methods PopupJobAttrsDlg() and
PopupItemAttrsDlg() to determine if the attributes can be viewed.

158 Version 6.0

Queue Control MES .NET Controls Developer Guide

Data Type Read/Write Default Value

Boolean Read Only False

BatchJobBGColorOption Property
Use the BatchJobBGColorOption property to specify the background color to use for linked jobs. This is
an enumeration of the batch job color options available to the Queue Control to concurrently run batches
of jobs.

Data Type Read/Write Default Value

enum { R/W PredefinedPastel

MatchSupervisor,
PredefinedPastel,
Custom }

The MatchSupervisor option sets the batch job color options according to what was configured in
Supervisor for the Queue window in this executable.
The PredefinedPastel option uses the predefined pastel color scheme defined within the Queue control.

Enum Setting

0 System.Drawing.Color. Thistle

1 System.Drawing.Color.Violet

2 System.Drawing.Color.LightSteelBlue

3 System.Drawing.Color.Lavender

4 System.Drawing.Color.LightCyan

5 System.Drawing.Color.Khaki
6 System.Drawing.Color.MistyRose

7 System.Drawing.Color.Moccasin

8 System.Drawing.Color.LightPink

9 System.Drawing.Color.LightSalmon

10 System.Drawing.Color.PowderBlue

11 System.Drawing.Color.LightSkyBlue

12 System.Drawing.Color.PaleGreen

13 System.Drawing.Color.PeachP uff

14 System.Drawing.Color.PaleGoldenrod

15 System.Drawing.Color.LightGoldenrodYellow

The Custom option allows the operator to specify custom colors as a design-time property of the control.

Version 6.0 159

MES .NET Controls Developer Guide Queue Control

There is a predefined limit of 16 different colors. After that, colors are reused for batches.

BatchJobBGCustomColors Property
Use the BatchJobBGCustom Colors property to specify the custom background colors of linked jobs if
the BatchJobBGColorOption property is set to Custom.

Data Type Read/Write Default Value

array of GDI+ R/W Thistle, Violet, LightSteelBlue,

System.Drawing.Color Lavender, Light Cyan, Khaki,
structures MistyRose, Moccasin,
LightPink, LightSalmon,
PowderBlue, LightSkyBlue,
PaleGreen, PeachPuff,
PaleGoldenrod,
LightGoldenrodY ellow

ColumnHeaderBackColor Property
Use the ColumnHeaderBackColor property to specify the background color of the column header row
when the current entity is selected.

Data Type Read/Write Default Value

System.Drawing.Color R/W Cont rol

ColumnHeaderBackColorDifferentEnt Property
Use the ColumnHeaderBackColorDifferentEnt property to specify the background color of the column
header row when the current entity is NOT selected in the combobox.

Data Type Read/Write Default Value

System.Drawing.Color R/W Yellow

ColumnHeaderForeColor Property
Use the ColumnHeaderForeColor property to specify the foreground color of the column header row.

Data Type Read/Write Default Value

System.Drawing.Color R/W Black

EndJobEnabled Property
Use the EndJobEnabled property to determine if the functionality of the End Job button is enabled.
The default value is False, but is set to True in the EnableDi sableButtons() method if the selected job is
running and the operator has the privilege to end jobs.

160 Version 6.0

Queue Control MES .NET Controls Developer Guide

The EndJobEnabled property also indicates whether or not the selected job on the Queue grid c an be
completed because the method can be called directly without using the button on the Button Bar control.

Data Type Read/Write Default Value

Boolean Read Only False

FlowDiagramEnabled Property
Use the FlowDiagramEnabled property to determine if the functionality of the View Flow Diagram
button is enabled.
The default value is False, but it is set to True in the EnableDisableButtons() method if a job is selected
on the queue grid.
The FlowDiagramEnabled property also indicates if a job flow diagram can be shown bec ause the
method can be called directly without using the button on the Button Bar control.

Data Type Read/Write Default Value

Boolean Read Only False

Font Property
Use the Font property to allow the font property of the controls on the Queue control to be changed.

Data Type Read/Write Default Value

Font R/W Same as base

control

ItemAttributesEnabled Property
Use the ItemAttribute sEnabled property to determine if the functionality of the Job Attribute s button is
enabled. The Job Attribute s dialog box allows the operator to view the attributes of the item of the
selected job.
The default value is False, but the value is changed to True in the EnableDisableButtons() method if a
job is selected on the queue grid.
The ItemAttribute sEnabled property also indicat es if the Item Attribute s dialog box can be shown
because the method can be called directly without using the button on the Button Bar control.

Data Type Read/Write Default Value

Boolean Read Only False

NotesEnabled Property
Use the Note sEnabled property to determine if the functionality of the Note s button is enabled. The
Note s button opens the Note s dialog box to view the not es for the selected job.
The default value is False, but the value is changed to True in the EnableDisableButtons() method if a
job is selected on the queue grid.
Version 6.0 161
MES .NET Controls Developer Guide Queue Control

The Note sEnabled property also indicates if a notes editor can be shown because the met hod can be
called directly without using the button on the Button B ar control.

Data Type Read/Write Default Value

Boolean Read Only False

PauseJobEnabled Property
Use the PauseJobEnabled property to determine if the functionality of the Pause Job button is enabled.
This button allows the operator to put the selected job into a Suspended, New, or Onhold state.
The default value is False, but the value is changed to True in the EnableDisableButtons() method if a
job is selected on the queue grid and the job is in a running or suspended state, or it is on hold and the
operator has the privilege to take a job off of hold.
The PauseJobEnabled property also indicates if the selected job can be paused because the method
can be called directly without using the button on the button bar.

Data Type Read/Write Default Value

Boolean Read Only False

PreviewBomEnabled Property
Use the PreviewBomEnabled property to determine if the button to open the Job BOM dialog box for
the selected job is enabled.
The default value is False, but the value is changed to True in the EnableDisableButtons() method if a
job is selected on the queue grid and the job contains job BOM data for a BOM position that is greater
then zero.
The PreviewBomEnabled property also indicates if a Job BOM dialog box can be shown because the
method can be called directly without using the button on the Button Bar control.

Data Type Read/Write Default Value

Boolean Read Only False

ReadyJobEnabled Property
Use the ReadyJobEnabled property to determine if the button to ready the selected job is enabled.
The default value is False, but the value is changed to True in the EnableDisableButtons() method if a
job is selected on the queue grid and the operat or has the privilege to ready a job, and the selected job is
running or suspended, or it is complete and the operator has the privilege to uncomplet e a job, or the job
is on hold and the operator has the privilege to take a job off of hold.
The ReadyJobEnabled property also indicates if the selected job can be put in a ready state because
the method can be called directly without using the button on the Button Bar cont rol.

Data Type Read/Write Default Value

Boolean Read Only False

162 Version 6.0

Queue Control MES .NET Controls Developer Guide

StartJobEnabled Property
Use the StartJobEnabled property to determine if the functionality of the Start Job button is enabled.
The Start Job button allows the operator to start the selected job.
The default value is False, but the value is changed to True in the EnableDisableButtons() method if a
job is selected on t he queue grid and the job is not running or canceled, and the entity has the capacity to
run this job, and the operator has the privilege to override the queue or the selected job is the next job in
the queue.
The StartJobEnabled property indicates if the selected job can be started because the method can be
called directly without using the button on the Button B ar control.

Data Type Read/Write Default Value

Boolean Read Only False

StartSomeEnabled Property
Use the StartSomeEnabled property to determine if the functionality of the Start Some button is
enabled. The Start Some dialog box allows the selected job to be split with the specified amount being
set as the start quantity of the split job and then starts the split job.
The default value is False, but the value is changed to True in the EnableDisableButtons() method if a
job is selected on t he queue grid and the job is not running or canceled, and the entity has the capacity to
run this job, and the operator has the privilege to override the queue or the selected job is the next job in
the queue.
The StartSomeEnabled property indicates if the selected job can be split and started because the
method can be called directly without using the button on the Button Bar control.

Data Type Read/Write Default Value

Boolean Read Only False

Methods of the Queue Control

This section describes the met hods of the Queue control. For information about the common methods
shared by this control, see Common Methods on page 55.

ApplyDefaultSortParameters() Method
Use the ApplyDefaultSortParameters() met hod to apply the sort criteria configured in Supervisor for
the current entity's Queue.
Syntax
ApplyDefaultSortparameters();

CreateWO() Method
Use the CreateWO() method to open the Create a job from shortage dialog box. The Create a job
from shortage dialog box allows an operator to select an item short age on the entity to create a work
order for, and then opens the form for creating the work order from the proc ess used to create the item.
This method returns True if the dialog box opens.
Syntax
CreateWO();

Version 6.0 163

MES .NET Controls Developer Guide Queue Control

EnableDisableButtons() Method
Use the EnableDisableButtons() method to enable or disable the buttons on the Button Bar control
associated with the Queue cont rol. The buttons are enabled or disabled depending on the current
context.
Syntax
EnableDisableButtons();

EndJob() Method
Use the EndJob() method to end the specified job if the following conditions exist:
 The job is in a running or in a suspended state.
 The operator is authorized to end jobs.
 The required quantity for the job has been met.
Syntax
EndJob(woId,operId,seqNo,woDesc,jobDesc,statusNotes,canAppendNotes,
canReplaceNotes,qtyGood,qtyRejected,qtyStart,qtyReqd,selJobState,
userCancelled[,concurrentLink]);
Parameters
woID
A string that indicates the work order ID of the job to be ended.
operID
A string that indicates the operation ID of the job to be ended.
seqNo
An integer that represents the sequence number of the job to be ended.
woDesc
A string that indicates the work order description used in the confirmation dialog box.
jobDesc
A string that indicates the Job description used in the confirmation dialog box.
statusNotes
A string that holds the status notes of the job that are shown in the confirmation dialog. These notes
can be appended to or edited on this dialog if the operator has the privileges to do so.
canAppendNotes
A Boolean value that is True if this operat or can append to the Status Not es in the confirmation dialog
box.
canReplaceNotes
A Boolean value that is True if this operator can replace the Status Notes in the confirmation dialog
box.
qtyGood
A double data type value that indicates the total produced quantity for this job that are good.
qtyRejected
A double data type value that indicates the total produced quantity for this job that are rejected.
qtyStart
A double data type value that indicates the start quantity for this job. The quantit y produced can not
be less then this amount when ending the job.

164 Version 6.0

Queue Control MES .NET Controls Developer Guide

qtyReqd
A double data type value that indicates the total required quantity for this job. This quantity must be
met in order to end the job.
selJobState
An enumeration data type that indicates the state of the job selected to be ended. The enumerated
data type can have the following values:
o NoJob (A value to set a current job state property to JobStates, if no job is running)= -1
o New (A job that is scheduled but not yet ready to run) = 1
o Ready ( A job that is ready to run) = 2
o Running (A job that is currently running on an entity) = 3
o Complete (A job that has finished) = 4
o Suspended (A job that has not run to completion, but is no longer running on an enti ty) = 5
o Onhold (A job that is no longer ready to run) = 6
o Canc elled (A job that no longer needs to be run) = 7
userCanc elled
A Boolean value that is returned as True if the operator cancels this action when prompted for
confirmation.
concurrentLink
An integer value for the specified job that is used to determine if this is a batch of jobs or not. If this
value is great er than zero and other jobs in the queue contain the same value, then this job is a part
of a batch. This is an optional paramet er and the default value is 0.

IsPartOfBatch() Method
Use the I sPartOfBatch() method to check the queue of the current entity to determine if there are any
jobs in that queue with a concurrent link value that matches a specified value.
Syntax
boolResult=IsPartOfBatch(ConcurrentLink);
Parameter
concurrentLink
An integer that is used to determine if a job is part of a batch of jobs.
If there is more then one job in the current entities queue wit h this concurrent link value, True is
returned signifying that the job is part of a batch. Otherwise, False is returned signifying that the job is
not in a batch.

JobLogOff() Method
Use the JobLogOff() method to open the Job Log Off dialog box if the current operator has a Job Based
Login Required restriction and is logged on to the selected job.
Syntax
JobLogOff(woID, operID, seqNo);
Parameters
woId
A string that indicates the work order ID used to identify the job that the operator is to be logged off
from.
operId
A string that is used to identify the job that the operator is to be logged off from.

Version 6.0 165

MES .NET Controls Developer Guide Queue Control

seqNo
An integer that is used to identify the job that the operator is to be logged off from.

LoadConfigSettings() Method
Use the LoadConfigSettings() method to load and apply the previously saved UI configuration settings
from the database for the specified entity or the default UI settings for t his control type. This includes both
the grid and Button Bar cont rol settings.
Syntax
LoadConfigSettings(UseDefaults);
Parameter
useDefaults
A Boolean value specifying whether the default configuration should be loaded. If it is False, the
configuration for the current entity is loaded and applied.

ParseConfigSettings() Method
Use the ParseConfigSettings() method to parse an XML string containing the configuration settings
and to save the grid configuration settings and Button Bar control configuration settings into separate
strings.
Syntax
ParseConfigSettings (configSettings);
Parameter
configSettings
An XML string that contains the configuration settings for the control.
The separat e strings for the grid configuration and Button Bar control configuration are set to empty
strings if there is an error in parsing the configSettings string.

PauseJob() Method
Use the PauseJob() method to pause the specified job if the following conditions exist:
 The job is in a running or in a suspended state.
 The operator is authorized to end jobs.
 The job is On Hold and the operator has the privilege to take a job off hold.
Syntax
PauseJob(woId,operId,seqNo,woDesc,jobDesc,statusNotes,canAppendNotes,
canReplaceNotes,selJobState,editTime,userCancelled
[,concurrentLink]);
Parameters
woID
A string that indicates the work order ID of the job to be ended.
operID
A string that indicates the operation ID of the job to be ended.
seqNo
An integer that represents the sequence number of the job to be ended.
woDesc
A string that indicates the WO description used in the confirmation dialog box.

166 Version 6.0

Queue Control MES .NET Controls Developer Guide

jobDesc
A string that indicates the Job description used in the confirmation dialog box.
statusNotes
A string that holds the status notes of the job that are shown in the confirmation dialog box. These
notes can be appended to or edited on this dialog box if the operator has the privileges to do so.
canAppendNotes
A Boolean value that is True if t he operator can append to the Status Notes in the confirmation dialog
box.
canReplaceNotes
A Boolean value that is True if the operator can replace the Status Notes in the confirmation dialog
box.
selJobState
An enumeration data type that indicates the state of the selected job, which is to be ended. The
enumerated data type can have the following values:
o NoJob (A value to set a current job state property to JobStates, if no job is running)= -1
o New (A job that is scheduled but not yet ready to run) = 1
o Ready ( A job that is ready to run) = 2
o Running (A job that is currently running on an entity) = 3
o Complete (A job that has finished) = 4
o Suspended (A job that has not run to completion, but is no longer running on an entity) = 5
o Onhold (A job that is no longer ready to run) = 6
o Canc elled (A job that no longer needs to be run) = 7
editTime
A string that indicates the last edit time for the specified job to ensure the operator is working on the
latest data for the job.
userCanc elled
A Boolean value that is returned as True if the operator cancels this action when prompted for
confirmation.
concurrentLink
An integer value for the specified job that is used to determine if this is a batch of jobs or not. If this
value is greater than 0 and other jobs in the queue contain the same value, then this job is part of a
batch. This is an optional parameter and the default value is 0.

PopupAddAssignSerialNumbersDlg() Method
Use the PopupAddAssignSerialNumbersDlg() method to open the Add/ Assign Serial Numbers
dialog box to add, assign, or unassign serial numbers to the currently selected work order for the
serialized item it produc es.
Syntax
PopupAddAssignSerialNumbersDlg(woID, itemID, operID);
Parameters
woId
A string that indicates the work order ID that the serial numbers are to be ass igned to.
itemId
A string that indicates the item ID that is being produced and is used to determine the number of
serial numbers that can be assigned.

Version 6.0 167

MES .NET Controls Developer Guide Queue Control

operId
A string that identifies the job that the serial numbers are assigned to.

PopupItemAttrsDlg() Method
Use the PopupItemAttrsDlg() method to open the Item Attribute s dialog box for the item specified to
view and edit the attributes of the item if the Attribute sEnabled property is True.
Syntax
PopupItemAttrsDlg(itemID);
Parameter
itemID
A string that indicates the item whose attributes are to be viewed and edited.

PopupJobAttrsDlg() Method
Use the PopupJobAttrsDlg() method to open the Job Attribute s dialog box for the job specified to
show the attributes of the job if the Attribute sEnabled property is True.
Syntax
PopupJobAttrsDlg(woID, operID, seqNo, jobDesc);
Parameters
woId
A string that indicates the work order ID used to identify the job whose attributes are shown.
operId
A string that indicates the operation ID used to identify the job whose attribut es are shown.
seqNo
An integer t hat represents the sequence number used t o identify the job whose attributes are shown.
jobDesc
A string that indicates the job description of the job whose attributes are shown. The description
appears in the title bar of the Job Attribute s dialog box.

PopupJobBOMDlg() Method
Use the PopupJobBOMDlg() method to open the Job BOM dialog box for the job specified to show the
BOM of the job if the PreviewBomEnabled property is True.
Syntax
PopupJobBOMDlg(woID, operID, seqNo, jobDesc);
Parameters
woId
A string that indicates the work order ID used to identify the job whose BOM is shown.
operId
A string that indicates the operation ID used to identify the job whose BOM is shown.
seqNo
An integer that represents the sequence number used to identify the job whose BOM is shown.
jobDesc
A string that indicates the job description of the job whose BOM is shown. The description appears in
the title bar of the BOM grid.

168 Version 6.0

Queue Control MES .NET Controls Developer Guide

PopupJobLinksDlg() Method
Use the PopupJobLinksDlg() method to open the Job Link dialog box if the current operator has the
privilege to modify batches. All the jobs in the queue for the current entity that are not running, completed,
or canceled are displayed. The jobs can then be selected to link them together into a batch of jobs.
Syntax
PopupJobLinksDlg();

PopupJobSplitDlg() Method
Use the PopupJobSplitDlg() met hod to open the Job Split dialog box to split the specified job if the
amount of good production reported for it so far is less than the good quantity that is required. The entity
to split the job to and the quantity that is to be assigned to the new job from the quantity left to be
produced on the specified job can be specified before splitting.
Syntax
PopupJobSplitDlg(woID, operID, seqNo, jobDesc, reqdQty, prodQty, processID);
Parameters
woId
A string that indicates the work order ID used to identify the job to be split.
operId
A string that indicates the operation ID used to identify the job to be split.
seqNo
An integer that represents the sequence number to identify the job to be split.
jobDesc
A string that indicates the job description of the job to be split. The descripti on appears in the title on
the split job dialog box.
reqdQty
A double data type that represents the required quantity of the job to be split. Used to determine how
much quantity is left to split.
prodQty
A double data type that represents the quantity already produced for the job to be split. Used to
determine how much quantity still needs to be produc ed that can be split.
processId
A string that indicates the process ID of the job to be split. The process ID is used to retrieve the
entities that can run this operation to allow the entity the split is to be assigned to be selected on the
Job Split dialog box.

PopupNotesDlg() Method
Use the PopupNotesDlg() method to open the Note s dialog box to show the notes of the specified job if
the Note sEnabled property is True.
Syntax
PopupNotesDlg(notes, woID, operID, seqNo, itemID);
Parameters
notes
A string that indicates the current job notes of the specified job.
woId
A string that indicates the work order ID used to identify the job whose notes are shown.

Version 6.0 169

MES .NET Controls Developer Guide Queue Control

operId
A string that indicates the operation ID used to identify the job whose notes are shown.
seqNo
An integer that represents the sequence No to identify the job whose not es are shown.
itemID
A string that indicates the item ID of the job. If specified, the item notes of the job are viewable by
selecting the Item Note s option on the Notes dialog box.

PopupStartSomeDlg() Method
Use the PopupStartSomeDlg() method to open the Start Some dialog box to split the specified job and
start the split job if the StartSomeEnabled property is True.
Syntax
PopupStartSomeDlg(woID, operID, seqID, jobDesc, batchSize, startQty, reqdQty,
prodQty);
Parameters
woId
A string that indicates the work order ID used to identify the job that is to be split.
operId
A string that indicates the operation ID used to identify the job that is to be split.
seqNo
An integer that represents the sequence number to identify the job that is to be split.
jobDesc
A string that indicates the job description of the job that is to be split. The description appears in the
title of the Start Some dialog box.
batchSize
A double data type that indicates the batch size of the job that is to be split. A batch is used to
determine the standard production time for a given amount of product. Standard production times are
expressed either in time per batch, or batches per time. For example, assume that you want to track
all of the cookies that are baked during a shift as a group, and that you want to determine the cookie
production’s OEE. That calculation is based on the batch size and the batch production rate. If a
batch size is 100 cookies and it takes 20 minutes to bake a batch of cookies, then up to 24 batches of
cookies could be baked during an 8-hour shift, or a maximum of 2,400 cookies in a lot.
startQty
A double data type that indicates the start quantity of the job that is to be split. The start quantity of
the split job defaults to half of this value. The start quantity of the split job can be edited on the Start
Some dialog box, but can not exceed this amount.
reqdQty
A double data type that indicates the required quantity of the job that is to be split. This quantity is
used to determine how much quantity is left to produce and the default quantity of the spl it job is set
to half of this amount. This quantity can be edited on the Start Some dialog box, but can not exceed
this amount.
prodQty
A double data type that indicates the produced quantity of the job that is to be split. This quantity is
used to determine how much quantity is left to produce.

PopupTransferSerialNumbersDlg() Method
Use the PopupTransferSerialNumbersDlg() method to open the Transfer Serial Numbers dialog box
to allow for the trans ferring of serialized parts from one inventory location to another.

170 Version 6.0

Queue Control MES .NET Controls Developer Guide

Syntax
PopupTransferSerialNumbersDlg();

PromptForProdQtys() Method
Use the PromptForProdQtys() method to open the Add Production dialog box to prompt for
production quantities for the currently selected job on the Queue control.
Syntax
PromptForProdQtys();

ReadyJob() Method
Use the ReadyJob() met hod to set the state of the specified job to Ready if the following conditions are
True:
 The Ready Job button is enabled.
 An operator is currently logged on.
Syntax
ReadyJob(woID, operID, seqNo, editTime);
Parameters
woId
A string that indicates the work order ID used to identify the job that is to be readied.
operId
A string that indicates the operation ID used to identify the job that is to be readied.
seqNo
An integer that represents the sequence number that is used to identify the job that is to be readied.
editTime
A string that indicates the last edit time for the specified job to ensure this operat or is acting on the
latest data for the job.

ResetBatchJobBGCustomColors() Method
Use the Re setBatchJobBGCustomColors() method to reset the BatchJobBGColorOption property
to its default value depending on the BatchJobColorOption that is set.
Syntax
ResetBatchJobBGCustomColors();

ResetBatchJobColorOptions() Method
Use the Re setBatchJobColorOptions() method to res et the BatchJobColorOption property to the
default of PredefinedPastel.
Syntax
ResetBatchJobColorOptions();

RestoreGridUISettings() Method
Use the RestoreGridUISettings() method to reapply the current loaded and cached grid settings for this
entity if the grid configuration is not empty. This method also translates the column headings.
Syntax
RestoreGridUISettings();

Version 6.0 171

MES .NET Controls Developer Guide Queue Control

SelectFirstRunningJob() Method
Use the SelectFirstRunningJob() method to select the row in the grid corres ponding to the first running
job. If none of the above are valid, then the first row in the grid is selected.
Syntax
SelectFirstRunningJob(selectFirstJobAsDefault);
Parameter
selectFirstJobAsDefault
A Boolean value that, if True, tells the method to select the first job if no jobs are running.

SelectRowByKey() Method
Use the SelectRowByKey() method to select the row in the grid corresponding to t he specified job. If the
row is not found, the method optionally selects the first row based on a parameter.
If the specified job cannot be found and the selectFirstRowAsDefault parameter is False, then leave the
existing selected rows as is and return False.
If a new job is selected, a call is made to enable/disable any buttons based on this new selection.
Syntax
result = SelectRowByKey(woID, operID, seqNo, selectFirstRowAsDefault);
Parameters
woId
A string that indicates the work order ID used to identify the job that is to be selected.
operId
A string that indicates the operation ID used to identify the job that is to be selected.
seqNo
An integer that represents the sequence number used to ident ify the job that is to be selected.
selectFirstRowAs Default
A Boolean value that, if True, signifies to select the first row if the specified job is not found.
Return Value
result
A Boolean value that is True, if a match is found; otherwise it returns False.

SerializeConfigSettings() Method
Use the SerializeConfigSettings() method to retrieve the configuration settings from the grid and
associated Button Bar control associated with the Queue control and to create and return an XML string
containing all current configuration settings.
Syntax
SerializeConfigSettings();

SetFilterColumns() Method
Use the SetFilterColumns() method to apply a comma-separat ed list or string array of filter columns and
their filter values to the grid.
Syntax
SetFilterColumns(FilterColumnList, FilterColumnValues);

172 Version 6.0

Queue Control MES .NET Controls Developer Guide

Parameters
FilterColumnList
A comma-separated list of filter columns (no spac es after comma)/string array of filter columns.
FilterColumnValues
A comma-separated list of filter values (no spaces after comma)/string array of filter column values.

SetGroupByColumns() Method
Use the SetGroupByColumns() method to apply a comma-separated list of Group By columns to the
grid and to group rows toget her which share common values in the Group By column(s).
Syntax
SetGroupByColumns(groupByList);
Parameter
groupB yList
A comma-separated list of columns, with no spaces after commas, by which to group the grid.

SetSortColumns() Method
Use the SetSortColumns() method to apply a comma-separat ed list or string array of sort columns to
the grid and to sort the grid according to the specified columns.
Syntax
SetSortColumns(sortColumn[, sortColumnDirection]);
Parameters
sortColumn
A comma-separat ed list (with no spaces after commas) or a string array of columns by which to sort
the grid.
sortColumnDirection
An array of Xceed.Grid.SortDirection values that defines the sort column direction as either
ascending or descending. The default sort direction is ascending. You can use this parameter only if
sortColum is a string array.

ShowWOFlowDiagram() Method
Use the ShowWOFlowDiagram() method to open the Job Flow Diagram dialog box to show the flow
diagram for the specified work order if the corresponding button is enabled.
Syntax
ShowWOFlowDiagram(woId);
Parameter
woId
A string that indicates the work order that the job flow diagram that is shown is for.

StartJob() Method
Use the StartJob() method to start the specified job on the current entity if the following conditions exist:
 The _start Job flag is True.
 An operator is currently logged on.
 The operator is logged on to at least one entity.
 The maximum number of jobs is not already running or entity can run jobs concurrently.

Version 6.0 173

MES .NET Controls Developer Guide Queue Control

 The job is not currently running.

The operator is prompted to confirm the action of starting the job.
Syntax
StartJob(woId, operId, seqNo, woDesc, jobDesc, statusNotes, canAppendNotes,
canReplaceNotes, userCancelled[,concurrentLink]);
Parameters
woId
A string that indicates the work order ID used to identify the job to be started.
operId
A string that indicates the operation ID used to identify the job to be started.
seqNo
An integer that represents the sequence number used to identify the job to be started.
woDesc
A string that indicates the work order description used in the confirmation dialog box.
jobDesc
A string that indicates the job description used in the confirmation dialog box.
statusNotes
A string that indicates the status notes used in the confirmation dialog box.
canAppendNotes
A Boolean value that is True if this operat or can append to the Status Not es in the confirmation dialog
box.
canReplaceNotes
A Boolean value that is True if this operator can replace the Status Notes in the confirmation dialog
box.
userCanc elled
A Boolean value that is returned as True if the operator cancels this action when prompted for
confirmation.
concurrentLink
An integer for the specified job used to dete rmine if this is a batch of jobs or not. A value is greater
than 0 and where other jobs have the same value means it is part of a batch. This is an optional
parameter and the default value is 0.

174 Version 6.0

 MES .NET Controls Developer Guide

C HAPTER 22
Route Control
In This Chapter
Introduction to the Route Control ................................................................................................. 175
Configuring the Route Control...................................................................................................... 175
Properties of the Route Cont rol .................................................................................................... 176
Methods of the Rout e Control ...................................................................................................... 176

Introduction to the Route Control

The Route Control is used to show operation-wise material flow for a work order and associated entities.

Configuring the Route Control

You use the Rout e control to show routing and status of a job wit hin its work order.
When you use the Route control in an ArchestrA symbol, you can associate the Button B ar control with it.
For more information, see Associating the Button Bar Control with Other Controls on page 68.

The operator can use the Route control to:

 Refresh the Route cont rol.
 Open the Help window.
 Start an external application.
 Start Internet Explorer.
 Switch the active user.
 Open or launch a form, if Path to form program system paramet er is set.

Version 6.0 175

MES .NET Controls Developer Guide Route Control

The Route control corresponds to the Route tab of the MES Operator application. For more information,
see the Route Tab section in the MES Operat or Guide or online help.

Properties of the Route Control

This section describes the properties of the Route control. For information about the common properties
shared by this control, see Common Properties on page 51.

RefreshEnabled Property
Use the Refre shEnabled property to determine whether this control can be refreshed. This cont rol is not
refres hed if a user is not logged on to any entity or MES database. This is an overridden property.

Data Type Read/Write Default Value

Boolean Read Only True

Methods of the Route Control

The Route Cont rol does not contain any unique methods. For information about the common methods
shared by this control, see Common Methods on page 55.

176 Version 6.0

 MES .NET Controls Developer Guide

C HAPTER 23
Sample Viewer Control
In This Chapter
Introduction to the Sample Viewer Cont rol .................................................................................... 177
Configuring the Sample Viewer Control ........................................................................................ 177
Using the Sample Viewer Control................................................................................................. 178
Properties of the Sample Viewer Cont rol ...................................................................................... 190
Methods of the Sample Viewer Control ......................................................................................... 196
E vents of the Sample Viewer Cont rol ........................................................................................... 198

Introduction to the Sample Viewer Control

You can use the Sample Viewer control to display the current, past, and the fut ure samples and the
characteristics assigned to the samples. The Sample Viewer control also displays the results collected
for the characteristics in the lower grid.
The Sample Viewer control allows you to modify the existing results, add new results to the
characteristics which are associated with current and past samples, and cancel samples.
The Sample Viewer also launches the SPC Chart control to display the results of measurements taken
for a particular characteristic associated with a set of samples.

Configuring the Sample Viewer Control

When you use the Sample Viewer control in an ArchestrA symbol, you can link it with a Button Bar
control. For more information, see Associating the Button Bar Control with Other Cont rols on page 68.

Version 6.0 177

MES .NET Controls Developer Guide Sample Viewer Control

In addition to viewing the current, past, and future samples, an operat or can perform the following tasks
using the buttons in the button bar, listed by buttons from left to right:
 Edit a sample's lot number, sublot number, segment requirement ID, segment response ID, or
priority.
 Specify that a sample has been pulled.
 Specify that a sample that had been previously pulled but for which no results were entered is no
longer considered to be pulled.
 Indicate whether a sample is considered to be finalized.
 Enter new results or edit previously entered results for the characteristics that are associated with a
current or past sample.
 Launch the SPC Chart control to display the results of measurements taken for a particular
characteristic.
 Canc el a sample (this button is not shown above, as it is not included on the button bar by default)
 Filter the set of samples displayed.
 Open the MES online help, which includes MES Operator help topics.
 Refresh the Sample Viewer control contents.

Using the Sample Viewer Control

This section describes how to use the Sample Viewer control to work with the samples.

Logging on to the Sample Viewer

To use the Sample Viewer control, you must log on to a session.
If the RequireEntityLogon property is set to True and you are not logged in to one or more entities with
the Can Collect QM data capability, you must log in to at least one entity that has the Can Collect QM
data capability selected.
If you have a filter setting saved in the UI_Config table, it is fetched and used. The RequireEntityLogon
property is used to control the EntityFilterRestriction property settings and to display the past, current,
and future samples that match the filter criteria. The characteristics associated with the sample and the
results of the characteristics are also displayed.
If the RequireEnti tyLogon property is set to False, you do not need to login to an entity. The information
is displayed automatically from all the entities which have the Can Collect QM Data capability enabled.
The only filter properties that are saved in the UI_Config table are RequireEntityLogon and
Enti tyFilterRe striction. The other properties are run-time filters and are not saved between sessions.
You must set the filter properties for filtering the samples.

Viewing the Samples

The Sample Viewer displays the past, current, and future samples that match the filter criteria. The
characteristics associated with the sample and the results for the characteristics are also displayed.
Users can filter the samples that are display ed in the control. See Filtering the Samples Displayed in the
Sample Viewer Control on page 185.

178 Version 6.0

Sample Viewer Control MES .NET Controls Developer Guide

Sample Data Display

The top grid displays a list of samples that meet the specified filter conditions. You can select a sample
record to view the results in the lower grid, and expand it to view list of characteristics in it. Yo u can also
view and hide the columns in the sample table in the S ample Viewer. You can view the following columns
in the Sample Viewer:
 Sample name
 Entity
 Item
 Job information
o Work order
o Operation
o Sequence number
 Sample status
 Sample ID, generated by the system to uniquely identify the sample
 Cont ext information from the specification, which generated the sample
 Sample plan frequency
 S95 segment requirement and segment response
 Lot/Sublot
 Requested time
 Warning time
 Expiry time
 Pulled by operator and time

Version 6.0 179

MES .NET Controls Developer Guide Sample Viewer Control

 Finalized by operator, time, and flag

 Verified by operator
 Result state
 Priority
 Spare fields
 Last edit information
The overall sample status and each sample characteristic result are indicated by colors. These colors are
controlled by system parameters that are set in MES Client. For more information on sample status and
result color coding, see Setting Status Color Coding for Samples, Characteristics, and Res ults on page
187.

Characteristic Data Display

Each sample record in the top grid can be expanded to display the list of characteristics and some
additional information. A characteristic within a sample can be selected to display only the result for the
selected characteristic in the bottom grid. You can view the following columns in the characteristic list
subgrid of the Sample Viewer:
 The equipment column
 The characteristic name column
 The QM specification name column
 The QM specification version column
 The sample ID column
 The reasonable limits columns
 The specification limits columns
 The last edit comment, user, and time columns

Result Data Display

You can view and hide the following columns in the result table of the Sample Viewer:
 Sample name
 Characteristic name
 Value number
 Result value
 Sample size
 Created by operator, and created by time
 Superseded indic ator

Selecting Context
In the Sample Viewer, you can select a sample, the characteristics associated with a sample, and the
results for the characteristics. When a new sample or characteristic is selected, an event is raised by the
Sample Viewer to notify that the selected context has changed.

180 Version 6.0

Sample Viewer Control MES .NET Controls Developer Guide

Editing Sample Information

The Sample Viewer allows users to modify a selected sample's information, if they have the required
permission to do so.

Users click the Edit Sample button to open the Edi t Sample dialog box.

The following sample information can be modified:

 Lot
 Sublot
 Segment requirement ID
 Segment response ID
 Priority
Future samples, samples that are marked as Final, or samples that are marked as Missed cannot be
modified.

Pulling Samples
The Sample Viewer allows users to specify that a sample has been pulled, if they have the required
permission to modify the sample information.
A sample is said to be pulled when it is selected from the other samples for rec ording the time required
for measurement. It is not necessary to tell t he system that a sample was pulled to record measurements
for it. A sample can be pulled only if it is yet to be pulled and the sample status is Ready or Ready
Warning.

Version 6.0 181

MES .NET Controls Developer Guide Sample Viewer Control

Users click the Pull Sample button to mark the selected sample as Pulled. The Sample Pulled
Date dialog box appears.

The pulled date defaults to the current date and time. Users can manually change the date and time, or
click the Browse button to display the Enter a Date and Time dialog box.

Unpulling Samples
The Sample Viewer allows users to specify that a pulled sample is no longer pulled, if they have the
required permission t o modify the sample information. A sample can be unpulled only if it is pulled and no
results have been collected for the characteristics associated with the sample.

Users click the Unpull Sample button to mark the selected sample as no longer pulled.

Toggling the Sample Final Flag

The Sample Viewer allows users to mark a sample as Final or to remove the Final flag from a sample.
The characteristic result records cannot be modified if a sample has been marked as Final.

Users click the Toggle Sample Final Flag button to toggle the selected sample's Final flag on and
off.

Launching an SPC Chart

The Sample Viewer allows users to display an SPC chart for the selected characteristic of a sample. A
characteristic within a sample must be selected before SPC Chart button is enabled.

Users click the SPC Chart button to open the chart for the selected characteristic. For information
about implementing and using the SPC Chart control, see SPC Chart Control on page 199.

182 Version 6.0

Sample Viewer Control MES .NET Controls Developer Guide

Entering and Editing Sample Results

The Sample Viewer allows users to enter the results of the selected sample or the characteristic within
the sample. Users can also edit existing results for the characteristic.
Users must have the privileges to edit sample information to add new results or edit existing results.
Results cannot be entered or edited for samples with the following conditions:
 If the sample status is Future or Missed
 If the sample to which the characteristic is associated is marked as Final

Users click the Edit Results button to open the Edit Sample Results dialog box.

The Edit Sample Results dialog box allows users to navigat e through the grid such that it works best
when you enter the characteristic results.
The following tasks can be performed:
 From the list, select a characteristic for the sample.
 Find: Click Find to move focus within the grid to the column (or row if characteristics are displayed
as rows) that contains the selected characteristic. The cursor moves to the first available result
record for the selected characteristic.
 Enter in Data Editor moves to next...: Control the behavior of where the focus moves to next after
a result value is entered. Choose whether the Enter key moves the focus in the grid to the next
characteristic for the same result value or the next result value for the same characteristi c.
 Show Characteristics in the grid as...: Select whether characteristics are listed as columns or
rows. By default, the res ult number is shown as the first column in the grid and then the
characteristics are listed in the remaining columns. If Rows is selected, the characteristic names are
listed in rows in the first column of the table and the result numbers are listed in the remaining
columns.
 Navigate to the previous or next sample by clicking the Previous or Next buttons.
If the resulting characteristic is a variable type, the following tasks can be performed:
 Set the value for an existing result
 Add new res ults and set the value for the new res ults

Version 6.0 183

MES .NET Controls Developer Guide Sample Viewer Control

If the characteristic has a maximum sample size set, users can add the res ults until the total number of
results equals the maximum number of samples for the characteristic.
If the resulting characteristic is an attribute type, the following tasks can be performed:
 Set the count value for the attribute.
For counted attributes, the count value is the total number of defects in the entire sample. For binary
attributes, the count value is the number of defective units in the sample. This value cannot be larger
than the sample size.
 Set the sample size, if the sample size of the attribute characteristic is not fixed.
When a sample that contains both variable and attribute characteristics is edited, additional rows
available for the variable characteristics are disabled for all attribute characteristics.
If the characteristic has upper or lower reasonable values defined by a QM specification, these values
are enforced when the data is entered. Users can also record the equipment that is used to measure the
characteristic result data.
The following tasks must be performed after entering or editing the results:
 Save the characteristic result data.
 Check the dat a for rule violations before saving it. The user is prompted to verify the data if any rule
violations are found.
When entering data, any individual results outside the specification limits must be saved or cancelled. At
this point, the system only checks specification limits and not rule violations.

Verifying the Result Entries

If the Verify Write option of the sample plan associated to the sample was enabled, then the user must
enter their password prior to saving the result ent ries.

It is also possible for a user other than the user who entered the results (e.g., a supervisor) to enter their
username and password to verify the result entries.
The user information entered during this ve rific ation process is logged in the Verified By field of the
sample table.

How the Results Are Processed

The MES system does the following while updating and adding the results:
 Supersedes the specified result and creates a new entry for the res ult, by using the new value while
updating an existing result.
 Ensures that the maximum number of samples for the characterist ic has not exceeded, and then
assigns the next available value number to the result, while adding new result records to a
characteristic within a sample.
If the value number exceeds the minimum number of samples for all the characteristics, you must click
Save. The status of the sample changes to Complete. The status will be Complete if the current time is
before the sample expiration. The status will be Complet e Late, if the current time is after the sample
expiration.

184 Version 6.0

Sample Viewer Control MES .NET Controls Developer Guide

The run rules are tested (if the result that is added or updated meets the minimum sample size for
characteristic) and sample_result is updat ed if any violations occur.
The sample_result must be set as follows:
 Good: Indicates that the sample is in control and all the results are within spec ification limits.
 OOC: Indicat es the following:
o An entire sample is in or out of cont rol.
o No measurements entered for the sample are out of specification.
o No monitored characteristics are out of control.
 OOS: Indicates the following:
o At least one measurement entered is out of specification.
o No measurements entered for key or critical characteristics are out of specification and no key or
critical characteristics are out of control.
 OOC KEY: Indic ates the following:
o The sample is out of control and is for a key characteristic.
o No measurements entered for key characteristics are out of specification.
o No measurements entered for key or c ritical characteristics are out of specification and no critical
characteristics are out of control.
 OOS KEY: Indicates the following:
o At least one measurement entered is out of specification and is for a key characteristic.
o No measurements entered for critical characteristics are out of specification and no critical
characteristics are out of control.
 OOC CRITI CAL: Indicates the following:
o The sample is out of control for a critical characteristic.
o No measurements entered for critical characteristics are out of specification.
 OOS CRITICAL: Indicates at least one measurement entered is out of specification and is for a
critical characteristic.

Canceling a Sample
The Sample Viewer allows users to cancel a sample if all of the following conditions are true:
 They have permission to edit samples
 The sample does not have a status of Future or Canc eled
 The sample has not been finalized

Users click the Cancel button to cancel the selected sample.

The Cancel button is not included in the Sample Viewer button bar by default. The user can
right-click the button bar area and click Configure to open the Configure Bar Button dialog box and
add the Cancel button to the bar.

Filtering the Samples Displayed in the Sample Viewer Control

The Sample Viewer allows users to filter which samples are displayed in the control.

Version 6.0 185

MES .NET Controls Developer Guide Sample Viewer Control

Users click the Filter button to open the Set Filters dialog box.

The following filters are available:

Sample Name
Specifies the string that represents the name or part of the sample(s) to be displayed.
Start Time
Specifies date and time that repres ent the minimum request time of the sample to be displayed.
End Time
Specifies date and time that repres ent the maximum request time of the sample to be displayed.
Status
Specifies the set of check boxes that represents the status of the samples to be displayed. Each of
the following sample statuses has a Boolean value assigned to it:
o Future
o Ready
o Ready Warning
o Missed
o In Progress
o Late

186 Version 6.0

Sample Viewer Control MES .NET Controls Developer Guide

o Complete
o Complete Late
o Canc elled
Pulled By
Specifies the details of the user who has mark ed a sample as pulled.
Enti ty Cla ss or Entity
Specifies the entity class or the entity to which the samples to be displayed are assigned. This
depends on the setting of the EntityFilterRe striction property.
Item or Item Category
Specifies the item or the item category to whic h the samples to be displayed are assigned.
Work Order
Specifies the work order of the job that generated the sample.
Operation
Specifies the operation of the job that generated the sample.
Sequence Number
Specifies the sequence number of the job that generated the sample.
When the filter is applied, the Sample Viewer is refreshed using the new filters to display the samples.

Setting Status Color Coding for Samples, Characteristics, and Results

The Sample Viewer uses colors to indicate:
 The overall sample status, by the sample row color.
 Whether each characteristic of a sample is out of control, by the characteristic row color.
 Whether results are out of specification, by the color of the result row. If any of a characteristic's
results are out of specification, the cells for those specifications in the characteristic row are also
highlighted in this color.
These colors are defined by Sample system paramet ers in MES Client, in the Di splay group of the
General Parameters module.
To set the sample, characteristic, and result status color codes
 From the Ma ster Data Config group in MES Client, open the General Parameters module.
The Sample Result and Sample Status color code parameters are listed in the Di splay group.

Version 6.0 187

MES .NET Controls Developer Guide Sample Viewer Control

The following figure shows the relation bet ween some of the Sample parameter colors and their
appearance in an example list of samples in Sample Viewer.

Note that if you click a cell in a sample's characteristic row:

 The characteristic row is highlighted in light blue
 The background color of the selected cell is the color used to indicat e the characteristic's
out-of-control status or, for specification columns, the characteristic's out-of-specific ation status

The following table includes a description of each sample status and its default color.

188 Version 6.0

Sample Viewer Control MES .NET Controls Developer Guide

Sample Status Description Default Color

Future Requested for a future time White

Ready The current time is greater than or equal to the Light grey
requested time, less than or equal t o the ex piration
time, and the warning interval is not Null. If the
current time value is less than the sample
requested time and the warning interval, the
sample pulled time is NULL, and there are no
results.

Ready Warning The current time is less than or equal to the Dark grey
expiration time, the sample pulled time is Null, the
current time is greater than the sample requested
time and the warning interval, and there are no
results.

Missed The current time is greater than the sample Orange

expiration time, the sample pulled time is Null, and
there are no results.
In Progress The current time is greater than or equal to the Blue grey
requested time and less than or equal to the
expiration time, there are not enough results for at
least one characteristic, and either the sample
pulled time is not Null or there is at least one
result.

Late The current time is greater than the ex piration Purple

time, there are not enough results for every
characteristic, and either the sample pulled time is
not Null or there is at least one res ult.

Complete The time at which the minimum number of original Blue

results in the sample is recorded (using the
earliest created_at time for each value_no), is less
than or equal to the sample expiration time and
there are enough results for every characteristic.

Complete Late The time at which at least one original result in the Dark blue
sample at or below the minimum number is
recorded, is greater than the expiration time and
there are enough results for every characteristic.

Canc eled The user decided not to make measurem ents for Brown
this sample.

The following table includes a description of each characteristic status and its default color.

Characteristic
Status Description Default Color

Good No SPC run rule violations Green

Version 6.0 189

MES .NET Controls Developer Guide Sample Viewer Control

Characteristic
Status Description Default Color

OOC Out of control for non key characteristic Light yellow

OOC Key Out of control for key characteristic Yellow
OOC Critical Out of control for critical characteristic Dark yellow
None No data yet White
Pending Some variables and dat a are waiting to be Light grey
collected and all that have been collected are
within the normal range.

The following table includes a description of each result out -of-specification status and its default color.

Result Status Description Default Color

OOS Out of specification for non-key characteristic Light pink

OOS Key Out of specification for key characteristic Red

OOS Critical Out of specification for critical characteristic Crimson

Properties of the Sample Viewer Control

This section describes the properties of the Sample Viewer control. For information about the common
properties shared by this control, see Common Properties on page 51.

CancelSampleEnabled Property
Use the CancelSampleEnabled property to determine if a sample can be canc eled.
The Cancel button will be enabled if a sample is selected, the selected sample does not have a status of
Future or Canceled, the Final flag for the selected sample is not set, and the logged -in user has
permission to edit samples.

Data Type Read/Write Values

Boolean Read Only True if the Cancel button is

enabled.
False if the Cancel button is
not enabled.

EditResultsEnabled Property
Use the EditResul tsEnabled property to determine if sample results can be modified.
The selected result can be modified when the sample is not mark ed as Final, Missed, or Future. You
must also have the required permission to add and modify the sample information.

Data Type Read/Write Default Value

Boolean Read Only False

190 Version 6.0

Sample Viewer Control MES .NET Controls Developer Guide

EditSampleEnabled Property
Use the EditSampleEnabled property to determine whether samples can be modified.
You can modify a selected sample when it has not been marked as Final, Missed, or Future. You must
also have the required permission to modify the sample information.

Data Type Read/Write Default Value

Boolean Read Only False

EndTimeFilter Property
Use the EndTimeFilter property to filter the samples based on the sample request time being less than
or equal to this value. The filter method displays the samples that match the end time value of the s ample
request time, which is lesser than or equal to the time entered as the filtering criteria. This is a run -time
property.
You can set this property to Null.

Data Type Read/Write Default Value

DateTime R/W Null

EntityFilter Property
Use the EntityFilter property to filter the samples based on the entity or entity class with which they are
associated. The filter method displays the samples that have an entity and any of its descendants that
match the filtering criteria. The valid values for this property are determined by the
Enti tyFilterRe striction property. This is a run-time property.
You can set this property to Null if the EntityFilterRe striction property is set to None.

Data Type Read/Write Default Value

String R/W Null

EntityFilterRestriction Property
Use the EntityFilterRe stri ction property to determine the setting of the entity filter. This is a design-time
property.
If the RequireEntityLogon property is set to True, you can set this property to one of the following:
 Current entity (1)
 Current entity or storage entities (2)
 Logged on entities (3)
 Logged on entities or storage entities (4)
If the RequireEnti tyLogon property is set to False, the EntityFilterRe striction property must be set to
None (0). If the RequireEntityLogon property is set to True, this property cannot be set to None.

Version 6.0 191

MES .NET Controls Developer Guide Sample Viewer Control

Data Type Read/Write Default Value

Enumeration R/W None

FilterEnabled Property
Use the FilterEnabled property to specify whether the filtering option is enabled for the samples.
This option will be disabled if the control is not in A vailable state.

Data Type Read/Write Default Value

Boolean Read Only False

ItemCategoryNameFilter Property
Use the ItemCategoryNameFilter property to filter the samples bas ed on the item category with which it
is associated. The filter displays the samples with item ID whose item category exactly matches the
filtering criteria. This is a run-time property.
You can set this property to Null.

Data Type Read/Write Default Value

String R/W Null

ItemFilter Property
Use the ItemFilter property to filter the samples based on the item ID with which it is associated. The
filter met hod displays the sample that exactly matches the filtering criteria. This is a run -time property.
You can set this property to Null.

Data Type Read/Write Default Value

String R/W Null

LaunchSpcChartEnabled Property
Use the LaunchSpcChartEnabled property to determine whether or not the LaunchSpcChart
command is enabled. This command is enabled when a characteristic is selected.

Data Type Read/Write Default Value

Boolean R/W False

192 Version 6.0

Sample Viewer Control MES .NET Controls Developer Guide

OperationFilter Property
Use the OperationFilter property to filter the samples based on the job which generates the samples in
the viewer. The filter contains the string filt er to match any operation that matches the string entered for
the filter. It is possible to search for operation IDs that contain specified characters. For example, to
return all samples for operations that contain the letters Op1, you must provide the string Op1% for the
value.
You can set this property to Null.

Data Type Read/Write Default Value

String R/W Null

PullSampleEnabled Property
Use the PullSampleEnabled property to determine whether the PullSample command is enabled.
A sample can be pulled when the sample status is Ready or Ready Warning and the sample is yet to be
pulled. You must have the required permission to edit the sample information to pull a sample.

Data Type Read/Write Default Value

Boolean Read Only False

RequireEntityLogon Property
Use the RequireEntityLogon property to specify whether an entity logon is required for the Sample
Viewer control. This is a design-time property.

Data Type Read/Write Default Value

Boolean R/W False

RefreshRate Property
Use the Refre shRate property to specify the polling rat e, in minutes, to check the MES database for new
data. You can disable this property by setting the value of the polling rate to 0. This is a design-time and
a run-time property. When a new filt er is applied, the current refresh rate value will be used to set up the
rate at which the grid is refreshed; changing the value of the Refre shRate property will only take effect
after applying a new filter.
You cannot set this property to Null.

Data Type Read/Write Default Value

Int32 R/W 5 minutes

Version 6.0 193

MES .NET Controls Developer Guide Sample Viewer Control

SampleNameFilter Property
Use the SampleNameFilter property to filter the samples shown in the Sample Viewer control. The filter
method displays the samples that match the sample name entered as the filt ering criteria. This is a
run-time property. It is possible to search for sample names that contain spec ified characters. For
example, for SQL Server to return all samples that start with the letters Blender, you must provide the
string Blender% for the value.

Data Type Read/Write Default Value

String R/W Null

SpcChartEnabled Property
Use the SpcChartEnabled property to check if the SPC chart button is enabled or not. This property
returns a value True if LaunchSpcChart() method is enabled.

Data Type Read/Write Default Value

Boolean Read Only False

StartTimeFilter Property
Use the StartTimeFilter property to filter the samples based on the sample request time being greater
than or equal to this value. The filter method displays the samples that match the start time value of the
sample request time, which is greater than or equal to the time entered as the filtering criteria. This is a
run-time property.
You can set this property to Null.

Data Type Read/Write Default Value

DateTime R/W Null

StatusFilter Property
Use the StatusFilter property to filter the samples based on the following values:
 Future (0)
 Ready (1)
 Ready Warning (2)
 Missed (3)
 In Progress (4)
 Late (5)
 Complete (6)
 Complete Late (7)
 Canc elled (8)
The filter supports selection of multiple values. This is a run-time property.

194 Version 6.0

Sample Viewer Control MES .NET Controls Developer Guide

You can set this property to Null.

Data Type Read/Write Default Value

Enumeration R/W Null

ToggleSampleFinalFlagEnabled Property
Use the ToggleSampleFinalFlagEnabled property to determine whether the ToggleSampleFinalFlag
command is enabled.
This command is enabled if a past sample is selected and you have the required permission to modify
the final state of the sample.

Data Type Read/Write Default Value

Boolean Read Only False

UnpullSampleEnabled Property
Use the UnpullSampleEnabled property to determine whether the UnpullSample command is
enabled.
This command is enabled when the sample has been pulled and no results have been generated for any
of the characteristics associated with the sample. You must have the required permission to edit the
sample information to unpull a sample.

Data Type Read/Write Default Value

Boolean Read Only False

UserFilter Property
Use the UserFilter property to filter the samples based on t he details of the user who marked the s ample
as pulled. The filter method displays the user details value that is an exact match of the filtering criteria.
This is a run-time property.
You can set this property to Null.

Data Type Read/Write Default Value

String R/W Null

WorkOrderFilter Property
Use the WorkOrderFilter to filter the samples based on the job that generates the samples in the viewer.
The filter contains the string filter to match any work order that matches the string entered for the filter. It
is possible to search for work order IDs that contain specified characters. For example, to return all
samples with work order IDs having ABC as the ending letters, you must provide the string %ABC for the
value.
You can set this property to Null.

Version 6.0 195

MES .NET Controls Developer Guide Sample Viewer Control

Data Type Read/Write Default Value

String R/W Null

Methods of the Sample Viewer Control

This section describes the met hods of the Sample Viewer control. For information about the common
methods shared by this control, see Common Methods on page 55.

CancelSample() Method
Use the CancelSample() method to cancel the currently selected sample. The CancelSampleEnabled
property must be set to True for this method to be successful.
The Sample Viewer calls the Cancel() method in the Sample class in the Stateless API to cancel the
sample. If the API met hod returns an error, the error is displayed to the user after it has been translated
into the user’s language. If the AP I method successfully cancels the sample, the Sample Viewer updates
the display.
Syntax
CancelSample();

EditSampleInfo() Method
Use the EditSampleInfo() method to open the Edi t Sample dialog box for editing the currently selected
sample. The EditSampleEnabled property must be set to True for this method to be successful.
Syntax
EditSampleInfo();

EditSampleResults() Method
Use the EditSampleResults() method to open the Edit Sample Results dialog box for modifying the
results of the currently selected sample or characteristic. The Edi tRe sultsEnabled property must be set
to True for this method to be successful.
Syntax
EditSampleResults();

Filter() Method
Use the Filter() met hod to enable the filter editing mode in the Sample Viewer. The FilterEnabled
property must be set to True for this method to be successful.
Syntax
Filter();

LaunchSpcChart() Method
Use the LaunchSpcChart() method to dis play an SPC chart of the characteristic selected within a
sample. The SP C chart uses the language of the user c urrently logged in to the Sample Viewer control.
The total number of samples and the number of points per page displayed in the chart are based on the
QM specification setting linked to the selected characteristic. If there is no setting for the total numb er of
points, all points meeting the filt er criterion are displayed. If there is no setting for the number of points
per page, then 18 points are display ed by default.

196 Version 6.0

Sample Viewer Control MES .NET Controls Developer Guide

The type of chart displayed on the SPC chart control, when called by the Sample Viewer c ontrol, is the
default chart of the selected characteristic. Based on the filter flags of the selected characteristic, the
information set on the Sample Viewer’s Filter dialog is sent to the SPC Chart control. These filters, sent
from the Sample Viewer to the SP C Chart control, contain the following information:
 Entity
 Item
 Work order
 Operation
These filt ers are a subset of the filters that are used by the SPC Chart control.
For this method to be successful, you must set the LaunchSpcChartEnabled property to True.
Syntax
LaunchSpcChart();

PullSample() Method
Use the isPullSample parameter of the PullSample() method to set the user who pulled the sample and
the sample pull time in a date and time edit or. By default, the current date and time is set as the sample
pull time and the currently logged on user as the user who pulled the sample. The PullSampleEnabled
property must be set to True for this method to be successful.
When the isPullSample parameter is set to True, a dialog box is displayed for the user to modify the date.
This method is useful when you monitor the screen. The sample pulled with the current dat e and time is
not marked automatically.
If the sample is already pulled, the sample will be set as not pulled as long as no results have been
collected for the sample. The isPullSample parameter must be set to False to unpull the sample. If it is
set to True and the sample is already pulled, then this method will ret urn doing nothing.
Syntax
PullSample(isPullSample);

SelectRowByKey() Method
Use the SelectRowByKey() method to search for the specified sample ID in the grid. If the sample ID is
found, the row is selected. If the sample ID is not found and the SelectFirstRowAs Default parameter is
set to True, the first row is selected; otherwise the row selection is not changed. This method returns a
Boolean value that is True if the sample ID is found; otherwise it returns False.
Syntax
result = bool SelectRowByKey(int sampleId);
Parameter
sampleId
An integer that indicates the sample ID of a row in the sample table.
Return Value
result
A Boolean value that is True, if a match is found; otherwise it returns False.

ToggleFinalFlag() Method
Use the ToggleFinalFlag() method to mark a sample as final or to clear the final flag.
If the selected sample is not marked as Final, this method sets the final flag against the sample. On
setting the final flag, the res ults and characteristics associated with the sample cannot be edited.

Version 6.0 197

MES .NET Controls Developer Guide Sample Viewer Control

If the selected sample is marked as Final, the method clears the final flag and enables editing of the
results and characteristics associated with the sample.
This method updates the database information immediately. You do not have to save the information.
The ToggleSampleFinalFlagEnabled property must be set to True for this method to be successful.
Syntax
ToggleFinalFlag();

ValidEntityFilter() Method
Use the ValidEntityFilter() method to validate the entity specified against the EntityFilterRestriction
parameter to determine if it is within the restriction type. If the entity is not within the Entity Filter
restriction or cannot collect quality data, an error message appears and the method returns False. If the
entity is within the Entity Filter restriction, it returns True.
Syntax
bool ValidEntityFilter(int entId, EntityFilterRestrictionType
entityFilterRestriction);
Parameters
entId
An integer value that indicates the ID of the entity to be validated.
entityFilterRestriction
An enumeration value that indicates the filter restriction to be validated against.

Events of the Sample Viewer Control

This section describes the events of the Sample Viewer control.

SelectedRowChanged Event
The SelectedRowChanged event is raised by the Sample Viewer control on startup of the control and
when a different sample row or characteristic row in the top grid is selected by a user. The event is not
raised when selecting a result in the bottom grid. This event indicates which sample and, if applicable,
which characteristic has been selected.
The SelectedRowChanged event has two read-only properties, SampleID and CharacteristicID.
 When a different sample row is selected, the SampleID property is set to the sample ID of the newly
selected row, and the Characteri sticI D property is set to -1.
 When a different characteristic row is selected, the SampleID and Characteri sticI D properties are
set to the sample ID and characteristic ID of the newly selected row.

StatusChanged Event
The StatusChanged event is raised by the Sample Viewer control when a sample status changes to
Ready or to Ready Warning. The eve nt indicates the change in the status of a sample.

Note: The StatusChanged event is not currently implemented.

198 Version 6.0

 MES .NET Controls Developer Guide

C HAPTER 24
SPC Chart Control
In This Chapter
Introduction to the SPC Chart Cont rol .......................................................................................... 199
Using the SPC Chart Control ....................................................................................................... 200
Runtime Interaction with the Chart ............................................................................................... 205
Properties of the SPC Chart Control ............................................................................................. 211
Methods of the SPC Chart Control ............................................................................................... 241

Introduction to the SPC Chart Control

You can use the Statistical Process Control (SPC) charts to monitor characteristics associated with the
product and the process. The SPC charts are important decision aids for MES Quality Management
because they provide statistical information that is indicative of the actual process.

The SPC charts display the following data:

 Graphical represent ation of the data associated with product and process characteristics
 Cont rol limits and a cent er line, which is either a fixed line or a line drawn based on the plotted data
 Cont rol rule violations indicated on the chart

Version 6.0 199

MES .NET Controls Developer Guide SPC Chart Control

 Cont extual data and chart title

 Summary data, including notes and alarms
To monitor process performance, you can check the relationship of t he plotted data with the cont rol limits
and the cent er line. You can either integrate the SPC charts with the Sample Viewer control or generate
them independently.
To use the SPC Chart control, the operator need not log on to the control. The SP C Chart control does
not support the Button Bar control.

Using the SPC Chart Control

This section describes how to use the SP C Chart control to do the following:
 Retrieve data to be plotted
 Display data
 Display control rule violations

Retrieving Data
When the Di splayChart() method is called, the SPC Chart control ret rieves the specified characteristic's
sample results that match the specified filter criteria. The retrieved data is sorted by the
requested_time_utc column of the sample table.
The SPC Chart control checks the MES database for new samples at an interval defined in the
Refre shRate property.
If one or more results are added to any samples that match the filter criteria since the last check, the SPC
Chart is updated. If the number of points on the chart is equal to the configured value of the
NumberOfPointsFilter property, the control does the following:
 Delet es the first point
 Adds the new point
 Replots the chart

200 Version 6.0

SPC Chart Control MES .NET Controls Developer Guide

If new results are added to an existing sample, the control recalculates the point and replots the chart.

The chart is also updated when other events relat ed to chart data occur, such as sample data being
updated, marking a data point to be ignored or as a control move, or adding a note to a data point.

Displaying Data
The SPC Chart control generally plots one point for each sample. You can also use the control to plot a
chart (IX + MR chart, MA & MR chart, or MA & MS chart) for samples where each result produces a new
point. For samples with more than one res ult, the average is calculated and plotted. Each point in the
chart is connected to the next with a line. If the PrimaryPlotMeasurementValues property is set, the
measurement values for each point are represented with a different shape on the y -axis.

Version 6.0 201

MES .NET Controls Developer Guide SPC Chart Control

The sample request time is plotted on the x-axis and the sample value is plotted on the y-axis. If the
plotted points do not fit on a single page, a scroll bar appears at the bottom of the control. You can plot
two types of charts for the samples — primary charts and secondary charts. The histograms, if displayed,
appear to the left of the chart.

Chart Types
The SPC Chart control supports displaying characteristics of all types. The following is the list of chart
types support ed for specific characteristic type:
 A Binary Attribute characteristic can be displayed as a PercentDefective (p) chart or
NumberDefective (np) chart.
 A Counted Attribute characteristic can be displayed as a NumberOfDefects (c) chart, DefectsPerUnit
(u) chart, or DefectsPerMillionOpportunities (DPMO) chart.
 A Variable characteristic can be displayed as a XB arRange (XB arR) chart, XBarSigma (XB arS )
chart, MovingA verageMovingRange (MA Range) chart, MovingA verageSigma (MASigma) chart, or
XIndividualRange (Ix Ir) chart.
Depending on the chart type and configuration of the variable characteristic, the following are the
additional limitations:
PercentDefective (p) and DefectsPerUnit (u)
The p and u charts are ratio charts that can have a variable sample size in the denominator. As such,
it is recommended to set control limits with either standard values or auto-calculated.
If preset limits are used, the chart requires the "single point outside control limits" rule to be enabled
so that the fixed control limits are applied to the chart. If the QM specification does not have this rule
enabled, the SP C Chart control will enable the rule on the chart only. The rule checking within the
MES databas e will not use the single point outside control limits rule, unless the QM Specification
has this rule enabled. However, the chart will, which can lead to inconsistencies in what is recorded
in the MES database and what is shown in the SPC Chart.
X Bar
This chart plots samples that have multiple results per sample. If all the samples for the characteristic
have only one reading per sample, a blank chart is displayed.

202 Version 6.0

SPC Chart Control MES .NET Controls Developer Guide

X Bar Range
This chart is designed for fixed sample sizes. However, the chart does support plotting samples
where the number of results in the sample is less than or greater than the standard sample size.
Because the sample size is artificially the same, all samples will have the same control limits applied
to them. When using fix ed control limits, the chart supports asymmetric upper and lower limits. When
using standard values or auto-calculated control limits, the chart will have symmetric upper and lower
limits.
X Bar Sigma
This chart does support variable sample sizes so the c ontrol limits can change from point to point. To
accomplish this, the chart sets limits based on a center line and standard mean ( Use standard values
option). If the characteristic being plotted has fixed limits, these limits are trans ferred into a center
line and a standard mean value for the upper control limit and for the lower control limit. The chart
supports asymmetric upper and lower control limits.
Moving Average
This chart starts plotting with the first result received and adjusts the control limits accordingly until
the number of points plotted is equal to the number of results used in the moving average calculation.
If two or more samples to be plotted have the same sample request time, then one second is added
to the times for each plotted point after the first.
Determining and Displaying Control Limits
 For all variable characteristic chart types, the control limits are calculated by the chart based on the
center line and standard deviation.
 An upper and lower sigma are support ed, so fixed limits can be unbalanc ed. The upper sigma is
calculated by subtracting the mean from the upper control limit and dividing by 3. The lower sigma is
calculated by subtracting the lower control limit from the mean and dividing by 3. The normal sample
size does not factor into this equation. If either the upper control limit, lower control limit, or mean are
missing, the control limits are automatically calculated from the data.
 When the characteristic definition has single -side cont rol limits, the control rule violations displayed
in the chart might not reflect the control rules calculated by the MES system [recorded in the MES
database and reported to the Sample Recording Object (SRO) if one exists].
 When calculating the lower control limit for an attribute or range chart, a negative calculated value is
not displayed and does not factor into calculated control rule violations.

Displaying Control Rule Violations

The SPC Chart control does the following to display control rule violations:
 Identify the cont rol rules to be applied based on the QM specification of the latest filtered sample
 Ignore any control rule that is not applicable to the characteristic or to the chart type
 Enable rule checking for the identified control rules
The following table describes the cont rol rules that the SPC Chart control supports:

Rule ID Description Alarm Text

0 1 outside cont rol limits H/L

1 2 of 3 outside of 2 standard deviations H/L

2 3 of 7 outside of 2 standard deviations H/L

3 4 of 10 outside of 2 standard deviations H/L

Version 6.0 203

MES .NET Controls Developer Guide SPC Chart Control

Rule ID Description Alarm Text

4 4 of 5 outside of 1 standard deviation H/L

5 7 of 7 on one side of center line H/L

6 8 of 8 on one side of center line H/L

7 8 of 8 beyond 1 standard deviation* B

8 9 of 9 on one side of center line H/L

9 10 of 11 on one side of center line H/L

10 12 of 14 on one side of center line H/L

11 6 of 6 inc reasing or decreasing T

12 7 of 7 inc reasing or decreasing T

*This control rule is the only one not based on a trend (T) that can be violated by a combination of points on either side of the center
line. All the other control rules require the specif ied number of points on the same side of the center line.

The control rules are evaluated bas ed on the priority order specified in the Spc_Rule table. The chart
displays control lines for the enabled control rules as defined below:
 If rule IDs 1,2, or 3 are enabled, control lines are drawn at two standard deviat ions from the center
line.
 If rule IDs 4 or 7 are enabled, control lines are drawn at one standard deviation from the center line.
 Rule IDs 5, 6, 8, 9, 10, 11, and 12 have no effect on the control lines.

Note: The control limits (at +/- 3 standard deviations) are always displayed on the chart.

The alarm text is used to indicate control rule violations as defined below:
 H, if the violation occurs above the center line
 L, if the violation occurs below the cent er line
 B, if the violation occurs on both sides of the center line

204 Version 6.0

SPC Chart Control MES .NET Controls Developer Guide

 T, if t he violation is a trend and is not dependent on t he position of the points relative to the center line

Runtime Interaction with the Chart

You can interact with the chart at run time. When a chart is displaying data, you can do the following:
 Toggle areas of the chart window on and off.
 Zoom on a chart.
 Move the mouse pointer over a sample to see the value of the point.
 Use the scroll bar t o move to newer/older data, when the plotted points do not fit on the display. After
you stop scrolling, the control waits for a second or two to refresh and redraws the chart.
 Click either of the two alarm indicators in the Alarm row to see the cont rol rule violation description.
There is a separate indicat or for the top chart (first) and bottom chart (second).
You can also assign a cause to a sample point, add notes to a sample point, mark a sample point as a
control move, and mark a sample point to be ignored in sample calculations. These operations are
described in the following topics.

Version 6.0 205

MES .NET Controls Developer Guide SPC Chart Control

Toggling Areas of the Chart Window On and Off

If the EnableCollapsibleToggles property has been set to True, toggle buttons will appear on the chart.
They allow users to hide areas of the chart and toggle them back on again.

The toggle buttons can hide the following areas:

 N = Notes
 T = Time
 A = Alarm
 C = Chart Data
 M = Measurements
 P = Primary Chart
 S = Secondary Chart

206 Version 6.0

SPC Chart Control MES .NET Controls Developer Guide

In the following example, all of the chart areas except for the Primary chart have been toggled off using
the buttons.

Zooming on a Chart
If the EnableCollapsibleToggles property has been set to True, a Zoom (Z) toggle button will appear at
the lower right corner of the chart window. Clicking the Z toggle button causes a zoom window to replace
the horizontal scrollbar. A user can then scroll a zoomed area of the charts by dragging the transparent
blue zoom window.

Version 6.0 207

MES .NET Controls Developer Guide SPC Chart Control

The zoomed area can be increased or decreased by dragging the left or right edge of the zoom window.
If the number of points in the display exceeds the initial setup value for the number of data points, the
table is temporarily removed to prevent overlap of the table columns. If the number of data points is
reduced to the initial number of points or less than the initial number, the table will reappear.

Assigning a Cause to a Sample Point

Caus es can be assigned to characteristic sample points.
Caus es are organized into related caus e groups, and cause groups are then linked to characteristics
through categories. The cause groups that are linked to a characteristic will be the cause groups that are
presented when you choose to assign a cause to a sample point. Causes, cause groups, and links
between cause groups and characteristics are configured using MES Client.
To assign a cause to a sample point in the chart
1. Right -click the sample point and click Assign Cause.
The Cause Picker dialog box appears.

2. Select the appropriat e cause group and cause, and then click OK.
The selected cause is assigned to the sample res ult, which is indicated by an open parenthesis
character that appears below the sample point.

To unassign a cause from a sample point in the chart

 Right -click the sample point and click Unassign Cause.
The cause is removed from the sample point and the open parentheses character no longer appears
below the sample point

208 Version 6.0

SPC Chart Control MES .NET Controls Developer Guide

Adding a Note to a Sample Point

To add a note to a sample point in the chart or edit an existing note
1. Right -click the sample point and click Edit Notes.
The Edit Note s dialog box appears.

2. Enter the note and click OK.

The note is saved to the database and associated with the sample result.
To view a sample point’s note
 Do one of the following:
 Click the sample point.
The note displays above the sample point along with the sample value.

 Click N or Y in the column of the Note s row directly above the sample point in the chart.
The note displays above the N or Y value.

Version 6.0 209

MES .NET Controls Developer Guide SPC Chart Control

To remove a sample point’s note

1. Right -click the sample point and click Edit Notes.
The Edit Note s dialog box appears.
2. Delet e the note entry and click OK.
The note is removed from the sample result.

Marking a Sample Point as a Control Move

You can mark a sample point as a control move so that it resets the counter for consecutive control rule
checks.
To mark a sample point in the chart as a control move
 Right -click the sample point and click Toggle Control Move.
The sample point is marked as a control move, which is indicated by a slash character (/) that
appears below the sample point.

To unmark a sample point as a control move

 Right -click the sample point and click Toggle Control Move.
The control move designation is removed and the slash character no longer appears below the
sample point.

Marking a Sample Point to Be Ignored in Sample Calculations

To mark a sample point in the chart to be ignored in sample calculations
 Right -click the sample point and click Toggle Ignore Sample.

210 Version 6.0

SPC Chart Control MES .NET Controls Developer Guide

The sample point is removed from the chart and a question mark (?) annotation appears at the
sample position at the top of the chart. The chart will rescale if the chart MinY and MaxY properties
have not been set to a specific value. The ignored sample point will not be evaluated in control limit
testing or in auto-calculations for control limits and y-axis range.

To remove the ignore sample designation

 Right -click the question mark annotation for the sample point and click Toggle Ignore Sample.
The sample will now be included in sample calculations and the sample point will be shown again in
the chart.

Properties of the SPC Chart Control

The SPC Chart control properties allow you to control what is displayed in the SPC Chart and how its
components are displayed. You can filter the samples based on entity or item category by using name or
ID filter properties.
If the samples are filtered based on entity and item category, you must use the same type of filter
properties, name or ID, for both criteria.
The SPC Chart control does not share any common properties with the other controls.

AlarmPointColor Property
Use the AlarmPointColor property to specify the color used for sample points that violate a control rule.

Version 6.0 211

MES .NET Controls Developer Guide SPC Chart Control

The following figure highlights an ex ample alarm point in red.

This is a design-time and a run-time property. However, changing the value will not update the chart until
the next time the chart is refres hed or the Di splayChart() method is called.
The symbol used to plot an alarm data point in the chart is controlled by the OutOfLimitsPointS ymbol
property. If the alarm highlighting for chart symbols is turned on (the default; see ColorPointsInAlarm
Property on page 214), the color of a sample point that violates a control rule will change to the color
defined by this property.
You cannot set this property to Null.

Data Type Read/Write Default Value

Color R/W Red (255, 0, 0)

CharacteristicNameFilter Property
Use the Characteri sticNameFilter property to specify the characteristic for which the chart is to be
plotted. This property filters samples with characteristic that match the specified criteria. This is a
design-time and a run-time property.
The following figure highlights the selected ch aracteristic as shown in the chart header area.

The Characteri sticNameFilter property is the only required property of the control. If all the other filters
are Null, and the chart is refreshed or the Di splayChart() method is called, the system reads the filter
settings from the MES database.
If you set this property to Null, you cannot display the chart.

Data Type Read/Write Default Value

String R/W Null

ChartTitle Property
Use the ChartTi tle property to specify a title for the chart. This is a design-time and a run-time property.

212 Version 6.0

SPC Chart Control MES .NET Controls Developer Guide

The following figure highlights the title as shown in the chart header area.

If you set this property to Null, the SPC chart is untitled. If there is no title, the title space is collapsed,
allowing more vertical space for the other displayed chart elements.

Data Type Read/Write Default Value

String R/W Null

ChartType Property
Use the ChartType property to specify the type of chart for plotting the data points or set the chart type to
Default to use the chart configured in MES database for the characteristic or the characteristic/QM
Specification link if the characteristic setting has been overridden. You can set the chart type to a valid
value that is listed along with the ChartType enumeration.
For variable sample sizes, you can use the following chart types:
 XBarR (Mean and Range, 2)
 XBarSigma (Mean and Sigma, 3)
 IxIr (Individual X and Moving Range, 5)
 MARange (Moving A verage and Range, 7)
 MASigma (Moving A verage and Sigma, 8)
For binary attribute characteristics, you can use the following chart types:
 Percent Defective (p, 16)
 NumberDefective (np, 17)
For counted attribute characteristics, you can use the following chart types:
 NumberofDefectives (c, 19)
 DefectsperUnit (u, 18)
 DefectsperMillionOpport unities (DPMO, 20)

Version 6.0 213

MES .NET Controls Developer Guide SPC Chart Control

The following figure highlights the selected chart type as shown in the chart header area.

You must ensure that the values assigned to chart types match the values in the default_chart column of
the characteristic table. The Default chart type is assigned a value of 0. This is a design -time and a
run-time property.
Example code for setting this property is:
SpcChartControl1.ChartType = FactMES.Controls.ChartType.PercentDefective;
You cannot set this property to Null.

Data Type Read/Write Default Value

Chart Type R/W Default

ColorPointsInAlarm Property
Use the ColorPointsInAlarm property to specify whether or not the chart should display a sample point
that has violated a cont rol rule using the alarm color. The alarm color is determined by the
AlarmPointColor properties (see AlarmP ointColor P ropert y on page 211).
This is a design-time and a run-time property. However, changing the value will not update the chart until
the next time the chart is refres hed or the Di splayChart() method is called.
You cannot set this property to Null.

Data Type Read/Write Default Value

Boolean R/W True

DataPointColor Property
Use the DataPointColor property to specify the color used for sample points in the chart graph. This is a
design-time and run-time property. However, changing the value will not update the chart until the next
time the chart is refreshed or the Di splayChart() method is called.
The following figure highlights an ex ample data point in green.

214 Version 6.0

SPC Chart Control MES .NET Controls Developer Guide

You cannot set this property to Null.

Data Type Read/Write Default Value

Color R/W Green (0, 128, 0)

DisplayChartEnabled Property
Use the Di splayChartEnabled property to determine whether or not the Di splayChart() method is
enabled. This property is set to True if a characteristic is passed to the control. Otherwise, it is set to
False. This is a run-time property.
You cannot set this property to Null.

Data Type Read/Write Default Value

Boolean Read Only False

DisplayXaxisLabelChanges Property
Use the Di splayXaxisLabelChanges property to specify whether or not to display labels along the
x-axis of the chart whenever the sample value changes. For example, if the XaxisLabel property is set to
WorkOrderID, each time there is a change in the work order ID, an x -axis label will be displayed.
The following figure shows an example of x-axis labels being applied on selected dates when the s ample
value changed.

This is a design-time and a run-time property. However, changing the value will not update the chart until
the next time the chart is refres hed or the Di splayChart() method is called.
This property works with t he Di splayXaxisLabelFrequency property to det ermine how frequently labels
are displayed along the x-axis.
 If t he Di splayXaxisLabelChanges property is False, x-axis labels are displayed at the s ample value
frequency specified by the Di splayXaxisLabelFrequency property.
 If the Di splayXaxisLabelChanges property is True, x-axis labels are displayed whenever the x-axis
sample value changes and at the sample value frequency specified by the
Di splayXaxisLabelFrequency property.
You cannot set this property to Null.

Data Type Read/Write Default Value

Boolean R/W True

Version 6.0 215

MES .NET Controls Developer Guide SPC Chart Control

DisplayXaxisLabelFrequency Property
Use the Di splayXaxisLabelFrequency property to specify the sample value frequency at which labels
are displayed along the x-axis of the chart. For ex ample, the default value 5 means that every fifth
sample plotted in the SPC Chart will have a label along the x -axis.
The following figure shows an example of x-axis labels being applied at a frequency of every 5 samples.

This is a design-time and a run-time property. However, changing the value will not update the chart until
the next time the chart is refres hed or the Di splayChart() method is called.
This property works with the Di splayXaxisLabelChanges property to determine how frequently labels
are displayed along the x-axis.
 If t he Di splayXaxisLabelChanges property is False, x-axis labels are displayed at the s ample value
frequency specified by the Di splayXaxisLabelFrequency property.
 If the Di splayXaxisLabelChanges property is True, x-axis labels are displayed whenever the x-axis
sample value changes and at the sample value frequency specified by the
Di splayXaxisLabelFrequency property.
You cannot set this property to Null.

Data Type Read/Write Default Value

Int32 R/W 5

EnableCollapsibleToggles Property
Use the EnableCollapsibleToggles property to have collapsible toggle buttons and a zoom toggle
button appear on the chart. The collapsible toggle buttons allow users to hide areas of the chart and
toggle t hem back on again. See Toggling A reas of the Chart Window On and Off on page 206. The zoom
toggle button allows users zoom on a chart. See Zooming on a Chart on page 207.
This is a design-time and a run-time property. However, changing the value will not update the chart until
the next time the chart is refres hed or the Di splayChart() method is called.
You cannot set this property to Null.

Data Type Read/Write Default Value

Boolean R/W False

EndTimeFilter Property
Use the EndTimeFilter property to filter samples with request time less than or equal to the specified
criteria. This property converts the local date/time to UTC standard time. This is a run-time property.
You can set this property to Null.

216 Version 6.0

SPC Chart Control MES .NET Controls Developer Guide

Data Type Read/Write Default Value

Nullable of R/W Null

DateTime

EntityIdFilter Property
Use the EntityIdFilter property to filter samples with entity ID that match the specified criteria. This
property will be ignored if the SiteNameFilter property or EntityNameFilter property are specified. This
is a run-time property.
You can set this property to Null.

Data Type Read/Write Default Value

Nullable of R/W Null

Integer

EntityNameFilter Property
Use the EntityNameFilter property along with the SiteNameFilter property to determine an entity. This
property filters samples with entity ID that match the specified criteria. This is a run -time property.
The following figure highlights the specified entity as shown in the chart header area.

You can set this property to Null.

Data Type Read/Write Default Value

String R/W Null

Graph Position Properties

Use the graph position properties to specify settings, as a factor of the total control widt h or height, that
define the left, right, and bottom margins of the SP C Cont rol chart graphic within t he control. If the table is
shown, it will also adjust based on these position properties. These are design -time and run-time
properties.
You can use thes e properties to reduce white space in the chart display. For ex ample, if the chart does
not include frequency histograms on the left (by default, they take up about 20% of the available chart
width), you may want to adjust the location of the start (left side) of the graph to be closer to the edge of
the control. (For information about not including the histograms, see ShowP rimaryHistogram Propert y on
page 232 and ShowSecondaryHistogram Property on page 234.)

Version 6.0 217

MES .NET Controls Developer Guide SPC Chart Control

You cannot set these properties to Null.

The available graph position properties are described in the following table. Al l graph position properties
have a range of 0 to 1

Read/ Default
Graph Posi tion Property Description Data Type Write Value

GraphBottomP os The position of the bottom of the Double R/W 0.9

graph, relative to the height of
the control.
GraphStartPos X The start position (left side) of Double R/W 0.125
the graph, relative to the width
of the control.
GraphStopPos X The stop position (right side) of Double R/W 0.85
the graph, relative to the width
of the control.

The following figure indicates to what edges of the graph the position properties apply.

Note that the sides of the graph are considered to begin and end with the grid, and do not take into
account labels that might display outside of the graph grid. Therefore, use care when adjusting these
settings:
 Too small a value for GraphStartX will cause the chart to overlap with the histogram or will cause the
values in the table to overlap with the labels.
 Too large a value for GraphStopPosX will cause the control line labels to be lost off the right-side of
the control.

218 Version 6.0

SPC Chart Control MES .NET Controls Developer Guide

 Too large a value for GraphBottomPos will cause the x-axis labels to be lost off the bottom of the
control.

HeaderLevel Property
Use the HeaderLevel property to specify how much information is included in the chart header. This is a
design-time and a run-time property. However, changing the value will not update the chart until the next
time the chart is refreshed or the Di splayChart() method is called.
The available levels are:
None
Do not include header information in the chart.
Minimal
Includes the dat e, characteristic, chart type, and item.
Most
Includes the Minimal information, plus item description, operation, entity, operator, and test
equipment.
All
Includes the Most information, plus specification limits, units of measure, and gage.
The following figure shows an example of the header level set to Most.

You cannot set this property to Null.

Data Type Read/Write Default Value

ChartHeaderLevel R/W Most

ItemCategoryIdFilter Property
Use the ItemCategoryIdFilter property to filter samples wit h item ID whose item category ID matches
the specified criteria. This property will be ignored if the ItemCategoryNameFilter property is specified.
This is a run-time property.
You can set this property to Null.

Data Type Read/Write Default Value

Integer R/W Null

Version 6.0 219

MES .NET Controls Developer Guide SPC Chart Control

ItemCategoryNameFilter Property
Use the ItemCategoryNameFilter property to filter samples with item ID whose item category matches
the specified criteria. This is a run-time property.
You can set this property to Null.

Data Type Read/Write Default Value

String R/W Null

ItemIdFilter Property
Use the ItemIdFilter property to filter samples with item ID that match the specified criteria. This is a
run-time property.
The following figure highlights the specified item as shown in the chart header area.

You can set this property to Null.

Data Type Read/Write Default Value

String R/W Null

LanguageStrings Property
Use the LanguageStrings property to provide the SPC Chart control with an object for translating
strings. You must use this property to provide the translation object because there is no user logged on to
the control. This is a run-time property.
You can pass the translation object to the SPC Chart cont rol in the following ways.
If your InTouch application is using ot her MES controls that require a user login, use the following script
to use the logged in user’s translation object:
dim clienSession as aaFactMES.aaClientSession;
dim result as aaFactMES.Result;

result = aaFactMES.ClientSession.GetInstance();
if (result.Exception <> null) then
‘ Log or display an error
else
clientSession = result.Value;
if (clientSession.curUser <> null) then
spcChartControl.LanguageStrings =
clientSession.curUser.LangStrings;

220 Version 6.0

SPC Chart Control MES .NET Controls Developer Guide

else
spcChartControl.LanguageStrings = null;
endif;
endif;
If your InTouch application is not using other MES controls, use the following script to get a language
translation object:
dim clientsession as aaFactMES.aaClientSession;
dim result as aaFactMES.result;
dim languageId as integer;
dim langStrings as aaFactMES.aaLangStrings;

‘ Set the language ID to your user’s language. This must be a valid language ID
in the MES database.
languageId=1000;
result=aaFactMES.aaclientsession.GetInstance();
if (result.Exception<>null) then
LogMessage(result.Exception.Message);
else
clientsession=result.value;
result = clientsession.GetLangStringsObject(languageId);
if (result.Exception<>null) then
LogMessage(result.Exception.Message);
else
langStrings = result.Value;
SpcChartControl1.LanguageStrings=langStrings.ClientAPIClass;
endif;
endif;
This script must be called before calling the Di splayChart() method. If you want to change the language
after calling the Di splayChart() method, then you will have to call Di splayChart() again before you will
see the language change.
You can set this property to Null. If the LanguageStrings property is set to Null, the strings are not
translated. Instead, the strings are displayed in the language used by the developer.

Data Type Read/Write Default Value

ILanguageStrings R/W Null

LineAttributeColor Property
Use the LineAttributeColor property to specify the color used for plot lines in the graph. This is a
design-time and run-time property. However, changing the value will not update the chart until the next
time the chart is refreshed or the Di splayChart() method is called.
The following figure highlights a plot line.

You cannot set this property to Null.

Version 6.0 221

MES .NET Controls Developer Guide SPC Chart Control

Data Type Read/Write Default Value

Color R/W Green (0, 128, 0)

NumberOfPointsFilter Property
Use the NumberOfPointsFilter property to specify the maximum number of data points that can be
plotted on the chart. If the PointsPerPage property value is less than the NumberOfPointsFilter value,
a scroll bar appears below the chart to indicate that there are additional points to plot. This is a run -time
property.
The following figure shows a scroll bar appearing in the control, indic ating that the number of po ints per
page is less than the number of total points in the chart.

You can set this property to Null.

Data Type Read/Write Default Value

Nullable of Integer R/W Null

OperationIdFilter Property
Use the OperationIdFilter property to filter samples with operation ID that match the specified criteria.
This property must be used in conjunction with t he Proce ssIDFilter property. This is a run-time property.
The following figure highlights the specified operation as shown in the chart header area.

You can set this property to Null.

Data Type Read/Write Default Value

String R/W Null

222 Version 6.0

SPC Chart Control MES .NET Controls Developer Guide

OutOfLimitsPointSymbol Property
Use the OutOfLimitsPointSymbol property to specify the shape to be used for sample points that
violat e a control rule. To specify the size of the shape, see OutOfLimitsPointSymbolSize Property on
page 224.
The following figure points to an example alarm point using a star shape.

Valid shape values are:

 Circle
 Cross
 Diamond
 DownTriangle
 Horiz ontalBar
 Line
 Plus
 Square
 Star
 UpTriangle
 VerticalBar
This is a design-time and a run-time property. However, changing the value will not update the chart until
the next time the chart is refres hed or the Di splayChart() method is called.
The symbol used to plot a data point in the chart is a fixed color circle. If the alarm highlighting for chart
symbols is turned on (the default; see ColorP ointsInAlarm Property on page 214), the shape of a sample
point that violates a control rule will change to the shape defined by this property.
Example code for setting this property is:
SpcChartControl1.OutOfLimitsPointSymbol = FactMES.Controls.SymbolType.Star;

Version 6.0 223

MES .NET Controls Developer Guide SPC Chart Control

You cannot set this property to Null.

Data Type Read/Write Default Value

SymbolType R/W Circle

OutOfLimitsPointSymbolSize Property
Use the OutOfLimitsPointSymbolSize property to specify the size of the shape (in points) to be used
for sample points that violate a control rule. To specify the shape to use, see OutOfLimitsPointSymbol
Property on page 223.
Reas onable shape sizes range from 1 to 50.
This is a design-time and a run-time property. However, changing the value will not update the chart until
the next time the chart is refres hed or the Di splayChart() method is called.
The size used to plot a data point in the chart is fixed at 10 pixels. If the alarm highlighting for chart
symbols is turned on (t he default; see ColorP ointsInAlarm Property on page 214), the size of a sample
point that violates a control rule will change to the size defined by this property.
You cannot set this property to Null.

Data Type Read/Write Default Value

Int R/W 10

PlotPrimaryMeasurementValues Property
Use the PlotPrimaryMeasurementValues property to specify whet her or not to display the
measurement values for each point, along with the average value point, on the primary chart. This
property affects only the charts that display an average of multiple measurements within a sample such
as an XB ar Range chart. This is a design -time and a run-time property.
The following figure shows measurement values displayed as blue Xs.

You cannot set this property to Null.

Data Type Read/Write Default Value

Boolean R/W False

224 Version 6.0

SPC Chart Control MES .NET Controls Developer Guide

PointsPerPage Property
Use the PointsPerPage property to specify the number of points that can be displayed on the graph at a
given time. If the PointsPerPage value is less than the NumberOfPointsFilter value, a scroll bar
appears below the chart to indicate that there are additional points to plot. This is a design-time and a
run-time property.
The following figure shows a scroll bar appearing in the control, indic ating that the number of points per
page (20) is less than the number of total points in the chart.

You cannot set this property to Null.

Data Type Read/Write Default Value

Int32 R/W 18

Note that the number of decimals that have been set in MES Client for a characteristic's results can
cause the dat a displayed in the table to overlap, depending on the number of points per page that has
been set. If this is occurring, either reduce the number of decimals or reduce the number of points per
page.

PrimaryChartMinY and PrimaryChartMaxY Properties

Use the PrimaryChartMinY and PrimaryChartMaxY properties to set the scale of the y-axis on the
primary chart. These are design-time and run-time properties. However, changing the values will not
update the chart until the next time the chart is refreshed or the Di splayChart() method is called.
The following figure shows the minimum and maximum values set at 4 and 7.

If no value is supplied for one or both of these properties, the values will be calculated from the sample
result data.
You can set this property to Null.

Data Type Read/Write Default Value

Nullable of Integer R/W Null

Version 6.0 225

MES .NET Controls Developer Guide SPC Chart Control

ProcessIdFilter Property
Use the Proce ssIdFilter property to filter samples with process ID that match the specified criteria. This
property should be used in conjunction with the OperationIDFilter property. This is a run-time property.
You can set this property to Null.

Data Type Read/Write Default Value

String R/W Null

RefreshRate Property
Use the Refre shRate property to specify the polling rat e, in minutes, to check the MES database for new
data. You can dis able this property by setting the value of the polling rate to zero. This is a design -time
and a run-time property. However, changing the value will not update the chart refresh rate until the next
time the Di splayChart() method is called.
You cannot set this property to Null.

Data Type Read/Write Default Value

Int32 R/W 5 minutes

ResetFiltersEnabled Property
Use the Re setFiltersEnabled property to determine whether or not the filter properties can be reset.
This property is set to True if a characteristic is passed to the control. Otherwise, it is set to False. This is
a run-time property.
You cannot set this property to Null.

Data Type Read/Write Default Value

Boolean Read Only False

SecondaryChartMinY and SecondaryChartMaxY Properties

Use the SecondaryChartMinY and SecondaryChartMaxY properties to set the scale of the y-axis on
the secondary chart. These are design-time and run-time properties. However, changing the values will
not update the chart until the next time the chart is refreshed or the Di splayChart() method is called.
The following figure shows the minimum and maximum values set at 0.0 and 2.0.

If no value is supplied for one or both of these properties, the values will be calculated from the sample
result data.

226 Version 6.0

SPC Chart Control MES .NET Controls Developer Guide

You can set this property to Null.

Data Type Read/Write Default Value

Nullable of Integer R/W Null

SegmentRequirementIdFilter Property
Use the SegmentRequirementIdFilter property to filter samples that contain the specified string in the
segment requirement ID. This is a run -time property.
You can set this property to Null.

Data Type Read/Write Default Value

String R/W Null

SegmentResponseIdFilter Property
Use the SegmentResponseIdFilter property to filter samples that contain the specified string in the
segment response ID. This is a run-time property.
You can set this property to Null.

Data Type Read/Write Default Value

String R/W Null

ShowAlarmIndicators Property
Use the ShowAlarmIndicators property to specify whether or not the chart should show the alarm
indicators row in the table. This is a design -time and a run-time property. However, changing the value
will not updat e the chart until the next time the chart is refreshed or the Di splayChart() method is called.
If set, an alarm indicator row will be added to the table that includes one or two of the following i ndicators
above each sample point in the chart. When two indicators are used, the first is for the primary chart and
the second is for the secondary chart.
 -, if no control rule violation occurred.
 H, if the violation occurred above the center line
 L, if the violation occurred below the center line
 B, if the violation occurred on both sides of the center line
 T, if t he violation is a trend and is not dependent on t he position of the points relative to the center line

Version 6.0 227

MES .NET Controls Developer Guide SPC Chart Control

The following figure highlights indicators in the Alarm row of the table:

You cannot set this property to Null.

Data Type Read/Write Default Value

Boolean R/W True

ShowCalculatedValues Property
Use the ShowCalculatedValues property to specify whether or not to show the upper and lower chart
plotted value rows in the table. The names of the rows will change depending on the type of chart being
plotted. For example, the top chart row label will be MA when plotting a Moving A verage chart. X Bar
charts will also include a SUM row.
This is a design-time and a run-time property. However, changing the value will not update the chart until
the next time the chart is refres hed or the Di splayChart() method is called.
The following figure shows an example of calculated values rows in a table.

You cannot set this property to Null.

Data Type Read/Write Default Value

Boolean R/W True

228 Version 6.0

SPC Chart Control MES .NET Controls Developer Guide

ShowControlMove Property
Use the ShowControlMove property to specify whether or not to display the Toggle Control Move
menu option in the sample point context menu (see the figure below and Mark ing a Sample Point as a
Cont rol Move on page 210). This is a design-time and a run-time property.

This property will be ignored if the UserId property is set to any value except Null. If the UserId property
is set, then the availability of the Toggle Control Move menu item will depend on the user’s privilege
settings. See UserId Property on page 239.
You cannot set this property to Null.

Data Type Read/Write Default Value

Boolean R/W True

ShowCpkValues Property
Use the ShowCpkValues property to specify whether or not to display the Cpk row in the table. This is a
design-time and a run-time property. However, changing the value will not update the chart until the next
time the chart is refreshed or the Di splayChart() method is called.
For Cpk values to be calculated, the characteristic must have upper and lower specification limits.
You cannot set this property to Null.

Data Type Read/Write Default Value

Boolean R/W False

ShowCpValues Property
Use the ShowCpValues property to specify whether or not to display the Cp row in the table. This is a
design-time and a run-time property. However, changing the value will not update the chart until the next
time the chart is refreshed or the Di splayChart() method is called.
The following figure shows the Cp row included in the table.

For Cp values to be calculated, the characteristic must have upper and lower specification limits.

Version 6.0 229

MES .NET Controls Developer Guide SPC Chart Control

You cannot set this property to Null.

Data Type Read/Write Default Value

Boolean R/W False

ShowIgnoreSample Property
Use the ShowIgnoreSample property to specify whether or not to display the Toggle Ignore Sample
menu option in the sample point context menu (see the figure below and Mark ing a Sample Point to Be
Ignored in Sample Calculations on page 210). This is a design-time and a run-time property.

This property will be ignored if the UserId property is set to any value except null. If the UserId property
is set, then the availability of the Toggle Ignore Sample menu item will depend on the us er’s privilege
settings. See UserId Property on page 239.
You cannot set this property to Null.

Data Type Read/Write Default Value

Boolean R/W True

ShowNotesIndicators Property
Use the ShowNote sIndicators property to specify whether or not to display the notes indicator row in
the table. This is a design-time and a run-time property. However, changing the value will not updat e the
chart until the next time the chart is refreshed or the Di splayChart() method is called.
The Notes row will display Y if the sample point has a note and N if it does not have a note. Notes can be
either entered by a user (see Adding a Note to a Sample Point on page 209) or because a cause has
been assigned to the sample point (the cause description is displayed as a note).
The following figure shows the Notes row included in the table.

You cannot set this property to Null.

230 Version 6.0

SPC Chart Control MES .NET Controls Developer Guide

Data Type Read/Write Default Value

Boolean R/W True

ShowPpkValues Property
Use the ShowPpkValues property to specify whether or not to display the Ppk row in the table. This is a
design-time and a run-time property. However, changing the value will not update the chart until the next
time the chart is refreshed or the Di splayChart() method is called.
For Ppk values to be calculated, the characteristic must have upper and lower specification limits.
You cannot set this property to Null.

Data Type Read/Write Default Value

Boolean R/W False

ShowPpValues Property
Use the ShowPpValues property to specify whether or not to display the Pp row in the table. This is a
design-time and a run-time property. However, changing the value will not update the chart until the next
time the chart is refreshed or the Di splayChart() method is called.
The following figure shows the Pp row included in the table.

For Pp values to be calculated, the characteristic must have upper and lower specification limits.
You cannot set this property to Null.

Data Type Read/Write Default Value

Boolean R/W False

ShowPrimaryChart Property
Use the ShowPrimaryChart property to specify whether or not to display the primary chart. This is a
design-time and a run-time property. The following table summarizes the chart types and the
corresponding primary charts:

Chart Type Chart

X-B ar R Mean

X-B ar Sigma Mean

Version 6.0 231

MES .NET Controls Developer Guide SPC Chart Control

Chart Type Chart

IX & MR Individual

MA & MR Moving A verage

MA & MS Moving A verage

p-chart Fraction Defective

np-chart Number Defective

c-chart Number of Defects

u-chart Number of Defects Per Unit

DPMO Number of Defects Per Million

Opportunities

You cannot set this property to Null.

Data Type Read/Write Default Value

Boolean R/W True

ShowPrimaryHistogram Property
Use the ShowPrimaryHi stogram property to specify whether or not to display the primary histogram
beside the primary chart. The primary histogram is displayed only if the ShowPrimaryChart property is
set to True. This is a design-time and a run-time property.
The following figure highlights the primary histogram included with the primary chart.

You cannot set this property to Null.

Data Type Read/Write Default Value

Boolean R/W True

ShowResultValues Property
Use the ShowRe sultValues property to specify whether or not to dis play one or more result values rows
in the table. For example, an X B ar R chart with five individual results per plot point would show five
additional rows labeled Sample #x above the calculated values rows. This is a design-time and a
run-time property. However, changing the value will not update the chart until the next time the chart is
refres hed or the Di splayChart() method is called.

232 Version 6.0

SPC Chart Control MES .NET Controls Developer Guide

The following figure shows example result value rows in the table.

You cannot set this property to Null.

Data Type Read/Write Default Value

Boolean R/W False

ShowSampleSizes Property
Use the ShowSampleSizes property to specify whether or not to display the sample sizes rows in the
table. This is a design-time and a run-time property. However, changing the value will not update the
chart until the next time the chart is refreshed or the Di splayChart() method is called.
The following figure shows an example sample size row in the table.

You cannot set this property to Null.

Data Type Read/Write Default Value

Boolean R/W False

ShowSecondaryChart Property
Use the ShowSecondaryChart property to specify whether or not to display the secondary chart. This is
a design-time and a run-time property. The following table summarizes the chart types and the
corresponding secondary charts:

Chart Ty pe Chart

Version 6.0 233

MES .NET Controls Developer Guide SPC Chart Control

Chart Ty pe Chart

X-B ar R Range

X-B ar Sigma Sigma

IX & MR Moving Range

MA & MR Moving Range

MA & MS Moving Sigma

p-chart N/A

np-chart N/A

c-chart N/A

u-chart N/A

DPMO N/A

You cannot set this property to Null.

Data Type Read/Write Default Value

Boolean R/W True

ShowSecondaryHistogram Property
Use the ShowSecondaryHi stogram property to specify whether or not to display the secondary
histogram beside the secondary chart. The secondary histogram is displayed only if the
ShowSecondaryChart property is set to True. This is a design -time and a run-time property.
The following figure highlights the secondary histogram included with the secondary chart.

You cannot set this property to Null.

Data Type Read/Write Default Value

Boolean R/W True

234 Version 6.0

SPC Chart Control MES .NET Controls Developer Guide

ShowTable Property
Use the ShowTable property to specify whether or not to display the table in the chart. This is a
design-time and a run-time property. However, changing the value will not update the chart until the next
time the chart is refreshed or the Di splayChart() method is called.
When this property is set to false, the following rows will not be shown in the data table above the chart
graph:
 All Header rows
 Time row
 Individual result row
 Calculat ed Values row
 Sample Size row
However, if the following properties are enabled, their rows will still be shown in the table even if the
ShowTable property is set to False:
 Notes
 Alarm
You cannot set this property to Null.

Data Type Read/Write Default Value

Boolean R/W True

ShowTimes Property
Use the ShowTimes property to specify whether or not to display the sample request time row in the
table. This is a design-time and a run-time property. However, changing the value will not update the
chart until the next time the chart is refreshed or the Di splayChart() method is called.
The following figure shows the Time row included in the table.

You cannot set this property to Null.

Data Type Read/Write Default Value

Boolean R/W True

Version 6.0 235

MES .NET Controls Developer Guide SPC Chart Control

ShowZones Property
Use the ShowZone s property to have the chart color coded into three zones corresponding to the
number of standard deviations from the center line.
 The inner zone between +1 and –1 standard deviation shows in green and is enabled whenever a
rule is enabled that uses the 1 standard deviation limit.
 The second zone is bet ween +1 and +2 standard deviations and between –1 and –2 standard
deviations and shows in yellow. It is enabled when there is a rule enabled that uses the 2 standard
deviation limit (often referred to as the warning limit).
 The final outer zone is between +2 and +3 standard deviations and between –2 and –3 standard
deviations and shows in red. This zone is enabled when the out -of-control rule is enabled.

If one or more of the zones are not enabled, the next level zone will fill in the missing zone's area. For
example, if the out-of-cont rol limit rule is the only rule applied to a chart and ShowZones is enabled, the
entire area bet ween the cont rol limits will be colored red.
This is a design-time and a run-time property. However, changing the value will not update the chart until
the next time the chart is refres hed or the Di splayChart() method is called.
You cannot set this property to Null.

Data Type Read/Write Default Value

Boolean R/W False

SiteNameFilter Property
Use the SiteNameFilter property along with the EntityNameFilter property to determine an entity. This
property filters samples with entity ID that match the specified criteria. This is a run -time property.
You can set this property to Null, only if sites are not used.

236 Version 6.0

SPC Chart Control MES .NET Controls Developer Guide

Data Type Read/Write Default Value

String R/W Null

SpareNFilter Properties
Use the Spare1Filter through Spare4Filter properties to filter samples that contain the specified string in
the spare1 through spare4 columns of the sample table. These are run-time properties.
You can set these properties to Null.

Data Type Read/Write Default Value

String R/W Null

StartTimeFilter Property
Use the S tartTimeFilter property to filter samples with request time greater than or equal to the specified
criteria. This property converts the local date/time to UTC standard time. This is a run-time property.
You can set this property to Null.

Data Type Read/Write Default Value

Nullable of R/W Null

DateTime

TableAlarmEmphasis Property
Use the TableAlarmEmpha si s property to specify how to display alarm indicators in t he table for s ample
points that violate a control rule. This is a design-time and a run-time property. However, changing the
value will not update the chart until the next time the chart is refreshed or the Di splayChart() method is
called.
The possible alarm highlight values are:
None
Alarm conditions are not indicat ed in the table.
Text
The text appears in the alarm color.
Outline
The cells in the table are outlined in the alarm color.
Bar
The cells in the table are filled in with the alarm color.
The alarm color is determined by the AlarmPointColor property; see AlarmPointColor Property on page
211.

Version 6.0 237

MES .NET Controls Developer Guide SPC Chart Control

The following figures shows the table alarm emphasis for the outline and bar highlight types.

You cannot set this property to Null.

Data Type Read/Write Default Value

AlarmHighlight R/W None

TableBackgroundColor Property
Use the TableBackgroundColor property to specify the color used for the table background. This is a
design-time and a run-time property.
You cannot set this property to Null.

Data Type Read/Write Default Value

Color R/W White (255, 255, 255)

TableStripeColor Properties
Use the TableStripeColor properties to specify the color used for alternating rows in the table. The color
for the other rows will be the table background color. This is a design-time and a run-time property.
The following figure shows the table stripes set to cyan. The table background color is set to white.

You cannot set this property to Null.

238 Version 6.0

SPC Chart Control MES .NET Controls Developer Guide

Data Type Read/Write Default Value

Color R/W Cyan (0, 255, 204)

UserId Property
Use the UserId property to specify the MES user. The user’s privileges will determine if the sample point
context menu will enable the us er to mark samples as a control move or to be ignored in calculations.
This is a design-time and a run-time property.
If this property is set to Null, access to privileged actions will either be controlled by other properties (see
ShowControlMove Property on page 229 and ShowIgnoreSample Property on page 230) or access will
be denied. If a non-existent user is supplied, access to privileged actions will be denied.

Data Type Read/Write Default Value

String R/W Null

WorkOrderIdFilter Property
Use the WorkOrderIdFilter property to filter samples that contain the specified string in the work order
ID. This is a run-time property.
You can set this property to Null.

Data Type Read/Write Default Value

String R/W Null

XAxisLabel Property
Use the XAxi sLabel property to specify the text label to use for the sample points on the x -axis of the
chart graph. This is a design-time and a run-time property. However, changing the value will not update
the chart until the next time the chart is refreshed or the Di splayChart() method is called.
The possible values for this property are:
 Date
 DateTime
 EntityName
 Equipment
 FrequencyName
 Item
 LotNumber
 OperationId
 PlanName
 PulledBy
 PulledByDate

Version 6.0 239

MES .NET Controls Developer Guide SPC Chart Control

 QMSpecificationName
 SampleName
 SampleNumber (Default value)
 SampleS pare1
 SampleS pare2
 SampleS pare3
 SampleS pare4
 SegmentRequirementId
 SegmentRes ponseId
 SubLotNumber
 Time
 VerifiedBy
 WorkOrderId
The following figure shows the label set to Dat e.

You cannot set this property to Null.

Data Type Read/Write Default Value

Chart XAxisLabel R/W SampleNumber

XAxisLabelRotation Property
Use the XAxi sLabelRotation property to specify the angle of rot ation value (in degrees) that should be
applied to x-axis labels. This is a design-time and a run-time property. However, changing the value will
not update the chart until the next time the chart is refreshed or the Di splayChart() method is called.
Valid values behave as follows:
 Null results in the label being at 0° (horizontal text with a direction from left to right) unless the labels
will overlap, in which case the appropriate angle will be calculated automatically.
 0 results in fixed horizontal text. Labels will not be rot ated if they overlap.
 Posi tive values rotate the labels counterclockwise. For example, 90 results in vertical text turned
90° counterclockwise (text direction is bottom to top).
 Negative values rot ate the labels clockwise. For example, -90 results in vertical text turned 90°
clockwise (text direction is top to bottom).

240 Version 6.0

SPC Chart Control MES .NET Controls Developer Guide

The following figure shows the label rotated using a value of 45 (t hat is, 45° counterclockwise).

Data Type Read/Write Default Value

Int32 R/W Null

Methods of the SPC Chart Control

This section describes the methods of the SPC Chart control. The SPC Chart control does not share any
common met hods with the other controls.

ClearFilters() Method
Use the ClearFilters() method to clear the dat a on the chart and to set the value of the following filter
properties to Null:
 SiteNameFilter
 Enti tyNameFilter
 Enti tyIdFilter
 ItemIdFilter
 ItemCategoryIdFilter
 ItemCategoryNameFilter
 WorkOrderIdFilter
 OperationIdFilter
 ProcessIdFilter
 SegmentRequirementIdFilter
 SegmentResponseIdFilter
 StartTimeFilter
 EndTimeFilter
 NumberOfPointsFilter
 Spare1Filter
 Spare2Filter
 Spare3Filter
 Spare4Filter
Syntax
SPCChartControl1.ClearFilters();

Version 6.0 241

MES .NET Controls Developer Guide SPC Chart Control

DisplayChart() Method
Use the Di splayChart() method to fetch the filtered data and display the chart. If this method is called
without passing a characteristic, the control displays an appropriate error message.
Syntax
SPCChartControl1.DisplayChart();

ResetFilters() Method
Use the Re setFilters() method to set the value of the following filt er properties to the most recent sample
result of the characteristic:
 Enti tyIdFilter
 ItemIdFilter
 WorkOrderIdFilter
 OperationIdFilter
 ProcessIdFilter
 SegmentRequirementIdFilter
 SegmentResponseIdFilter
 Spare1Filter
 Spare2Filter
 Spare3Filter
 Spare4Filter
This method also sets the value of the following filter properties to Null:
 SiteNameFilter
 Enti tyNameFilter
 StartTimeFilter
 EndTimeFilter
 NumberOfPointsFilter
 ItemCategoryNameFilter
 ItemCategoryIDFilter
Syntax
SPCChartControl1.ResetFilters();

242 Version 6.0

 MES .NET Controls Developer Guide

C HAPTER 25
Spec Control
In This Chapter
Introduction to the Spec Control ................................................................................................... 243
Configuring the Spec Control ....................................................................................................... 243
Properties of the Spec Control ..................................................................................................... 243
Methods of the Spec Control ....................................................................................................... 245

Introduction to the Spec Control

The Spec control shows the current job and a grid of the individual specifications for this job within the
selected specification group. When you use the Spec control in an ArchestrA symbol, you can associate
the Button Bar cont rol with the Spec control.

Configuring the Spec Control

The Spec control shows the specifications assigned to the active job, but not assigned to any particular
step. You can do the following:
 View and modify the minimum, maximum, and set point values.
 View and modify attached files or comments or instructions.
 View the actual value for the active job.
 Change the specification guidelines, for a specified job or for subsequent jobs.
When you use the Spec control in an ArchestrA symbol, you can associate the Button Bar control with it.
For more information, see Associating the Button Bar Control with Other Controls on page 68.

This control corresponds to the Specs tab of the MES Operator application. For more information, see
the Specs Tab section in the MES Operator Guide or online help.

Properties of the Spec Control

This section describes the properties of the Spec control. For information about the common properties
shared by this control, see Common Properties on page 51.

EditSpecificationsEnabled Property
Use the EditSpecificationsEnabled property to get whether specifications can be edited.

Version 6.0 243

MES .NET Controls Developer Guide Spec Control

Data Type Read/Write Default Value

Boolean Read Only False

RefreshEnabled Property
Use the Refre shEnabled property to get whether this control can be refreshed or not. This control
cannot be refreshed if the user has not logged into MES, or the user has not logged on to any entity.

Data Type Read/Write Default Value

Boolean Read Only False

UpdateJobSpecsEnabled Property
Use the UpdateJobSpecsEnabled property to get whether job specs can be updated.

Data Type Read/Write Default Value

Boolean Read Only False

UpdateTemplateSpecsEnabled Property
Use the UpdateTemplateSpecsEnabled property to get whether template specs can be updated.

Data Type Read/Write Default Value

Boolean Read Only False

ViewSpecDocumentEnabled Property
Use the ViewSpecDocumentEnabled property to set or get whether specification documents can be
viewed.

Data Type Read/Write Default Value

Boolean Read Only False

Xceed.Grid.RowSelectedJobSpecGroupRow Property
Use the Xceed.Grid.RowSelectedJobSpecGroupRow property to get the currently selected job spec
group row from the grid. This property is set to Null if there are no rows in the grid or if none of the rows in
the grid are selected. It returns the first selected row from the grid if more than 1 row is s elected.

Data Type Read/Write Default Value

Xceed.Grid.Row Read Only Null

244 Version 6.0

Spec Control MES .NET Controls Developer Guide

Methods of the Spec Control

This section describes the met hods of the Spec control. For information about the common methods
shared by this control, see Common Methods on page 55.

PopUpEditSpecDlg() Method
Use the PopUpEditSpecDlg() method to open the Edit Specification dialog box and edit specification
details. If the current user does not have privileges, then a list of alternate users is shown to edit
specification details.
Syntax
PopUpEditSpecDlg();

SelectRowByKey(Int32,String) Method
Use the SelectRowByKey(Int32,String) method to select a row in the grid using the specified
parameters. If a row for the specified paramet er is not found in the grid, then the row selection is
unchanged.
Syntax
result = SelectRowByKey(StepNo, SpecId);
Parameters
StepNo
An integer value that represents a step_no value from the job_spec table.
SpecId
A string value that represents a spec_id value from the job_s pec table.
Return Value
result
A Boolean value that is True, if a match is found; otherwise it returns False.

SelectRowByKey(Int32,String,Boolean) Method
Use the SelectRowByKey(Int32,String,Boolean) method to select a row in the grid using the specified
parameters. If a row for the specified paramet er is found and the selectFirstRowAsDef ault parameter is
set to True, the first row in the grid is selected. Otherwise the previous row selection is not c hanged.
Syntax
result = SelectRowByKey(StepNo, SpecId, SelectFirstRowAsDefault);
Parameters
StepNo
An integer value that represents a step_no value from the job_spec table.
SpecId
A string value that represents a spec_id value from the job_s pec table.
SelectFirstRowAsDefault
A Boolean value that indicates whether the first row in the grid should be selected, if the specified
parameters does not exist in the grid. This paramet er should be s et to False if the row selection is not
changed in a case when the specified paramet ers are not found in the grid.
Return Value
result
A Boolean value that is True, if a match is found; otherwise it returns False.

Version 6.0 245

MES .NET Controls Developer Guide Spec Control

UpdateSpecValues() Method
Use the UpdateSpecValues() method to update job spec values or template spec values.
Syntax
result = UpdateSpecValues(buttonClicked);
Parameters
buttonClick ed
A button set that updates the job spec values.

246 Version 6.0

 MES .NET Controls Developer Guide

C HAPTER 26
Steps Control
In This Chapter
Introduction to the Steps Control .................................................................................................. 247
Configuring the Steps Cont rol ...................................................................................................... 247
Properties of the Steps Control .................................................................................................... 248
Methods of the Steps Control ...................................................................................................... 250

Introduction to the Steps Control

The Steps control shows the steps of the currently running job as a proc edure guide.

Configuring the Steps Control

When you use the Steps control in an ArchestrA symbol, you c an associate the B utton Bar cont rol with it.
For more information, see Associating the Button Bar Control with Other Controls on page 68.

The operator can use the Steps control to:

 Log on to the selected step.
 Log off from the selected step.
 List all users currently logged on to the selected step.
 View a document that is associated with the selected step.
 Initiate the action defined for the selected step.
 Sign-off the selected step.
 Refresh the Steps control.
 Mark the state of the active step to "completed".
 Mark the state of the active step as "bypassed".

Version 6.0 247

MES .NET Controls Developer Guide Steps Control

 Show the Job Event Log dialog box.

 Mark the state of any completed step as requiring rework.
 Open or launch a form, if the Path to Form Program system parameter is set.
The Steps control corres ponds to the Steps tab of the MES Operator application. For more information,
see the Steps Tab section in the MES Operator Guide or online help.

Properties of the Steps Control

This section describes the properties of the Steps control. For information about the common properties
shared by this control, see Common Properties on page 51.

ActionEnabled Property
Use the ActionEnabled property to specify whether the Action function is enabled.

Data Type Read/Write Default Value

Boolean Read Only False

AuthorizeEnabled Property
Use the AuthorizeEnabled property to specify whether the Authorize function is enabled.

Data Type Read/Write Default Value

Boolean Read Only False

BypassEnabled Property
Use the Bypa ssEnabled property to specify whether the Bypass function is enabled.

Data Type Read/Write Default Value

Boolean Read Only False

CompleteEnabled Property
Use the CompleteEnabled property to specify whether the Complete function is enabled.

Data Type Read/Write Default Value

Boolean Read Only False

EventEnabled Property
Use the EventEnabled property to specify whether the Job E vents function is enabled.

248 Version 6.0

Steps Control MES .NET Controls Developer Guide

Data Type Read/Write Default Value

Boolean Read Only False

LoginEnabled Property
Use the LoginEnabled property to specify whether the Login function is enabled.

Data Type Read/Write Default Value

Boolean Read Only False

LogoutEnabled Property
Use the LogoutEnabled property to specify whether the Logout function is enabled.

Data Type Read/Write Default Value

Boolean Read Only False

ReworkEnabled Property
Use the ReworkEnabled property to specify whether the Rework function is enabled.

Data Type Read/Write Default Value

Boolean Read Only False

SetLotDataEnabled Property
Use the SetLotDataEnabled property to specify whether the Set Lot Data function is enabled.

Data Type Read/Write Default Value

Boolean Read Only False

ShowListEnabled Property
Use the ShowLi stEnabled property to specify whether the Show Operator List function is enabled.

Data Type Read/Write Default Value

Boolean Read Only False

ViewEnabled Property
Use the ViewEnabled property to specify whether the View Doc ument function is enabled.

Version 6.0 249

MES .NET Controls Developer Guide Steps Control

Data Type Read/Write Default Value

Boolean Read Only False

Methods of the Steps Control

This section describes the met hods of the Steps control. For information about the common methods
shared by this control, see Common Methods on page 55.

Authorize() Method
Use the Authorize() method to allow a certification for sign-off.
Syntax
Authorize();

DisplayJobEventDialog() Method
Use the Di splayJobEventDialog() method to open the dialog box that allows entry of user-defined job
events.
Predefined job events cannot be entered via this dialog box.
Syntax
DisplayJobEventDialog();

ExecuteStepAction() Method
Use the ExecuteStepAction () method to perform the action associated wit h the currently selected step.
Syntax
ExecuteStepAction();

LaunchCurrentStepDocument () Method
Use the LaunchCurrentS tepDocument() method to launch the step document displayed in the
selected grid row.
Syntax
LaunchCurrentStepDocument();

LogoutCurrentStep() Method
Use the LogoutCurrentStep() method to log out of the selected step.
Syntax
LogoutCurrentStep();

OnLotNoChanged() Method
Use the OnLotNoChanged() method to trigger the LotNoChanged event by invoking the relevant
delegates.
Syntax
result = OnLotNoChanged(e);
Parameter
e
An event argument that is used to determine if a Save or a Save As Default is done.

250 Version 6.0

Steps Control MES .NET Controls Developer Guide

OnStepDataEntered() Method
Use the OnS tepDataEntered() method to trigger the StepDataEntered event by invoking the relevant
delegates.
Syntax
result = OnStepDataEntered(e);
Parameter
e
An event argument that is used to determine if a Save or a Save As Default is done.

OnStepGroupChanged() Method
Use the OnS tepGroupChanged() method to trigger the StepGroupChanged event by invoking the
relevant delegates.
Syntax
result = OnStepGroupChanged(e);
Parameter
e
An event argument that is used to determine if a Save or a Save As Default is done.

OnStepStateChanged() Method
Use the OnS tepStateChanged() method to trigger the S tepStateChanged event by invoking the
relevant delegates.
Syntax
result = OnStepStateChanged(e);
Parameter
e
An event argument that is used to determine if a Save or a Save As Default is done.

PopupAnalogEntry() Method
Use the PopupAnalogEntry() method to open an analog entry dialog box.
Syntax
PopupAnalogEntry(Control, minValue, maxValue, minValueUsed, maxValueUsed,
limitWarning);
Parameters
Cont rol
A control that contains a reference to the cont rol into which the analog value (possibly blank) is
placed.
minValue
A Decimal minimum allowed value.
maxV alue
A Decimal maximum allowed value.
minValueUsed
A Boolean value that if set to False, the minimum allowed value is ignored.
maxV alueUsed
A Boolean value that if set to False, the maximum allowed value is ignored.

Version 6.0 251

MES .NET Controls Developer Guide Steps Control

limitWarning
A Boolean value that if set to True, the user is warned if they enter a value outside t he allowed range.
They have the option to accept the value, even though the value is outside the range.

PopupRadioButtonEntry() Method
Use the PopupRadioButtonEntry() met hod to open a radio button selection dialog box.
Syntax
PopupRadioButtonEntry(Control, ds);
Parameters
Cont rol
A control that contains a reference to the cont rol into which the label associated with the selected
radio button is placed.
ds
A dataset, from the Job_Step_Choices table, that defines the set of radio buttons to display.

ProcessDataTypeForSelectedLot() Method
Note: This method is not intended for customer use; it is intended for MES internal use only.

This method updates the step data that is displayed in the specified grid row with the data value in the
specified row from the JobStep table.
Syntax
ProcessDataTypeForSelectedLot(gridRow, jobStepRow);

Rework() Method
Use the Rework() method to open the Steps to Rework dialog box, which allows rework for steps.
Syntax
Rework();

SetLotData() Method
Use the SetLotData() method to set the lot data for the current job. There must be a current user logged
into at least one entity, and the current entity must be running a job. The PopupSetProdLotDataDlg()
method is called, passing along the information about the current job. If the lot data is changed, the grid
is refreshed.
Syntax
SetLotData();

ShowOperatorsOnThisStep() Method
Use the ShowOperatorsOnThi sStep() method to show a list of all operat ors logged into the currently
selected step.
Syntax
ShowOperatorsOnThisStep();

StepBypass() Method
Use the StepBypa ss() method to bypass the currently selected step.
Syntax
StepBypass();

252 Version 6.0

Steps Control MES .NET Controls Developer Guide

StepComplete() Method
Use the StepComplete() met hod to complete the currently selected step .
Syntax
StepComplete();

StepLogin() Method
Use the StepLogin() method to log on to the currently selected step.
Syntax
StepLogin();

Version 6.0 253

 MES .NET Controls Developer Guide

C HAPTER 27
Utilization Control
In This Chapter
Introduction to the Utilization Control ............................................................................................ 255
Configuring the Utilization Control ................................................................................................ 255
Using the Utilization Control ........................................................................................................ 256
Properties of the Utilization Control .............................................................................................. 263
Methods of the Utilization Control................................................................................................. 268

Introduction to the Utilization Control

You can use the Utilization control to show the history of entity utilization and to change the utilization
state for an entity. You can edit the utilization events by using the split utilization functionality.

Configuring the Utilization Control

When you use the Utilization control in an Arc hestrA symbol, you can associate the Button Bar control
with it. For more information, see Associating the Button Bar Control with Other Controls on page 68.

The operator can use the Utilization control to:

 Enter a new mac hine reason for the selected machine.
 Refresh the utilization cont rol.
 Enter a final reason for the utilization record.
 Switch the active user.
 Start a data entry job.
 Split a utilization record.
 Open or launch a form, if the Path to Form Program system parameter is set.

Version 6.0 255

MES .NET Controls Developer Guide Utilization Control

This control corresponds to the Util/OEE tab of the MES Operator application. For more information, see
the Util/OEE Tab section in the MES Operator Guide or online help.

Using the Utilization Control

The Utilization control displays entity utilization data (for example, downtime, idle time and running time),
allows the current utilization reason to be changed, and allows pending reasons to be set.
Fields are added to the text box section under the grid where OEE dat a is displayed for showing the good
and scrap quantities. If OEE is being displayed by shift, the quantities should be displayed by shift. If
OEE is being display ed by job, the quantities would be displayed by job. As with other fields on the
control, the visibility of these fields will be configurable at run time.

The Utilization control provides for four types of filtering: time-based, event state, minimum duration, and
status. Time-based filtering limits data bas ed on a specified period of time or number of events. E vent
State filtering limits data based on whet her the event was acknowledged, unacknowledged or it can be
set to both to not filter by event state. Minimum duration filtering limits data bas ed on a duration by only
showing those events that lasted as least as long as the minimum duration. Status filtering limits data
based on the utilization status (that is, run time or downtime). Any combination of these four types of
filters may be employed. A description of the current filter will be displayed in the control, so the user will
always know what filter criteria are being used. For further detail on filtering, see Configuring the Filters
on page 258.
The Multiple Selection for Reason Entry function is provided to allow the user to select multiple grid rows
in the Utilization cont rol which have a reas on pending and set the final reason for a series of pending
rows, or allow the user to select multiple grid rows in the Utilization which are non-pending and edit the
final reas on. For more information, see Multiple Selection for Reason Entry/Editing on page 259.
The comments of a selected reason or multiple selected reasons can be changed without chan ging
anything else about the reason by use the EditComments() method or t he Edit Comment button on the
button bar. Both calling the method and pus hing the button will bring up a dialog allowing the editing of
the comments associated wit h one or more reasons. For more information, see Methods of the Utilization
Cont rol on page 268 and Buttons on page 271.

256 Version 6.0

Utilization Control MES .NET Controls Developer Guide

Good or rejected production can be added for a selected reason using the AddProduction() method or
the AddProduction button o the button bar if the AddProduction button is enabled. Both will open a
dialog box that allows the user to enter the amount of production to be added. For more information, see
Methods of the Utilization Control on page 268 and Buttons on page 271.

Switching Entities
The utilization control displays entity utilization data for the current entity. The current entity can be
switched in one of three ways.
 Adding a Job Summary control to the symbol
 Through script
 By using the EntitySelect control that is part of the Utilization control. The EntitySelect control is a
combo box that lists all entities that the current user is logged onto. It also contains an entity logon
button that will allow the user to log onto or off of entities. The entity that is selected in the combo box
will become the new current entity.

Associating the Button Bar Control

At run time, the following features are available on the Button Bar when it is associated with the
Utilization Control.

Version 6.0 257

MES .NET Controls Developer Guide Utilization Control

Filter button
When clicked, the Utilization control's Filter() method is called to open the filter dialog. If the operator
sets a new filter, the Utilization cont rol is refreshed. If the Utilization controls FilterEnabled property
is False, this button is disabled.
Add Production button
When clicked, the Utilization control's AddProduction() method is called to open the add production
dialog box. This dialog box is used to add good or rejected quantities. The us er can enter a
production amount as well as set the item information, the reason code to associate wit h the
production, the lot, and the storage information. Any fields that have default values will be set to
these default values when the dialog is opened. Clicking Save will save the good or rejected
production.
Edit Comment button
When clicked, the Utilization control's EditComment() method is called to open the Edi t Comment
dialog box. The comments text box on the dialog box will contain the comments of the selected
reason or reasons if multiple reasons are selected and all have the same comments. If multiple
reasons are selected and the comments are not the same for each, the Comments text box will
contain <various> to let the user know that the comments are not the same for all selected
reasons. The operator can edit the comments of the selected reasons without editing anything else
about the reason by typing new comments into the Comments text box and clicking OK. The new
comments will be saved to each of the selected reasons as this point.

Configuring the Filters

Filter in the Utilization control is done through a filt er dialog box, allowing the us er to set time-based,
event state, minimum duration, and status filters. Any combination of these types of filters can be used.
Time-Based
The Time-Based filters are Last N E vents, This Shift, Last Shift, and Last N Hours. The time-based
filters det ermine what events are shown by limiting the events to those that occur within the time
frame set.
Event State
The E vent State filter can be eit her Unacknowledged, Acknowledged, or bot h.
Minimum Duration
The Minimum Duration filter specifies that only events that have duration at least as long as this filter
are shown. For example, a minimum duration of 15 will show only those events that lasted at least 15
seconds.
Status
The Status filter can be either Run Time, Downtime, Neither, or All. This filter is used to filter data by
utilization state. A description of the current filt er will be displayed in the cont rol, so the user will
always know what filter criteria are being used.
The filter dialog box can be opened either by calling the Filter() method or by clicking the Filter button on
the button bar associated with the Utilization cont rol. The values for each type of filter t hat is to be used to
filter the data displayed are then set using combo boxes to select valid values or entering integer values
for those filters based on a numeric value. Clicking OK applies the filter values to t he data displayed. The
filter values can be saved to the configuration or to the default configuration for the Utilization cont rol
through t he context menu of the Utilization control. The FilterDefaultsFromDB property must be True to
save the filter values to the default configuration.
Clicking OK on the filter dialog box will only apply the filters for the current display. They will not be saved
to the configuration unless saved through the cont ext menu command.

258 Version 6.0

Utilization Control MES .NET Controls Developer Guide

Multiple Selection for Reason Entry/Editing

Selecting multiple grid rows on the Utilization control is allowed for entering a final reason for multiple
reason-pending rows or for editing the final reason for multiple non -pending reason rows. If the user
selects multiple rows that have a final reason pending, the Set Past Rea son button will become
available. By clicking this button, the user will be presented with the reas on editing dialog box. If multiple
rows were selected on the Utilization grid, then the Since and Duration fields of the reason editing dialog
box will be blank. If the comments for all of the selected rows are the same, the comments will be
displayed in the Comments field. If at least one of the rows selected has comments that are different
from any other row, then <various> will be displayed in the Comments field of the reason editing
dialog box, to indicate to the user that they are editing a group of non-matching comments.
The user selects a reason group from the Rea son Group tree and a final reason, edits the comments,
and then clicks OK. The comments for each selected row will be set to whatever the user has entered in
the Comments field, regardless of their former contents. The final reas on for all rows will be set to the
final reas on selected.
A user can also edit the final reason of non -pending rows using multiple selections in muc h the same way
as setting the final reason of pending rows. When multiple non-pending rows are selected, the Edit Final
Reason button will become available on the button bar. If the user presses this button, they will be
presented with the same dialog as above. The editing dialog will not change the current reason code if
the current reason code is not in the list of reasons. If the current reason is in the list, the reason will be
selected. If it is not in the list, no reasons will be selected from the list. If the user saves without selecting
a reason, the original reason will be used. If a reas on is selected, all selected rows' final reasons will be
updated to the selected reason. The comments for all the rows will also be updated wit h any comment
changes if there were some made. If no comment changes were made, the rows will maint ain the
comments as they were.

Configuring Split Utilization Functionality

You can split a selected utilization event by using the split utilization functionality. You can also combine
and change the reason for the split events.
To configure the Utilization Split button
1. Log in to the MES Operator and select an entity.

Version 6.0 259

MES .NET Controls Developer Guide Utilization Control

2. Click the Util/OEE tab and select a row from the Utilization grid.

3. Right -click the Button Bar and click Configure. The Configure Button Bar window appears. You
can view the Utilization Split button in the Available Buttons pane.

4. Select the Utilization Split button and click Add.

5. Select a number in the Posi tion list to indicate the position of the button on the Button Bar.
6. Select the permission level required to split the selected event in the Execution Level list.
7. Click OK.

260 Version 6.0

Utilization Control MES .NET Controls Developer Guide

Using Split Utilization Functionality

You must select an event in the Utilization grid to enable the Utilization Split button. You can edit the
duration and shift information of the split events, based on the time boundaries and shift boundaries of
the selected event.
To split an utilization event
1. Log on to the MES Operator, select an entity and then click the Util/OEE tab.
2. Select a row from the Utilization grid and click Utilization Split. The Utilization Split window
appears. It contains four panes:
o Utilization Events: you can view the new events that are a result of splitting the selected event.
o Comments: you can add comments for the selected event.
o Utilization Reason: you can view the reason for the selected event.
o Selected Event: you can split the selected event by configuring the S tart Time and End Time
for the new events. For more information, refer to Splitting an Event on page 261.

3. Configure the Start Time and End Time for the new events.
4. Click Save. The new utilization events are added to the Utilization grid.

Splitting an Event
You can split the selected utilization event by using the following commands:
 Split Before: You can use this command to split the s elected event into two events, each having half
the duration of the selected event. After executing this command, the first half of the event becomes
the selected event. The Start Time and End Time for the new events are calculated as follows:

First New E vent Start Time: same as that of the selected event

Version 6.0 261

MES .NET Controls Developer Guide Utilization Control

End Time: Start Time + (duration of the selected

event/2)

Note: If the result of dividing the duration of the

selected event is a fractional value, round up the
number.

Second New E vent Start Time: Start time of the first new event +
(duration of the selected event/2)

Note: If the result of dividing the duration of the

selected event is a fractional value, round down the
number.

End Time: same as that of the selected event

All the other settings of the new events, except the start and end times, are the same as that of the
selected event.

Note: The Split Before command is disabled if the selected event cannot be edited.

 Split After: You can use this command to split the selected event into two events, each having half
the duration of the selected event. After executing this command, the second half of the event
becomes the selected event. The Start Time and End Time for the new events are calculated as
follows:

First New E vent Start Time: same as that of the selected event

End Time: Start Time + (duration of the selected

event/2)

Note: If the result of dividing the duration of the

selected event is a fractional value, round up the
number.

Second New E vent Start Time: Start time of the first new event +
(duration of the selected event/2)

Note: If the result of dividing the duration of the

selected event is a fractional value, round down the
number.

End Time: same as that of the selected event

All the other settings of the new events, except the start and end times, are the same as that of the
selected event.

Note: The Split After command is disabled if the selected event cannot be edit ed.

You can delete the selected utilization event by using the following commands:
 Delete Before: You can use this command to combine the selected event with the previous event.
After executing this command, the selected event is deleted and the previous event bec omes the
selected event. The duration of the deleted event is added to the duration of the selected event. The
Utilization Reason and Comments of the deleted event are retained by the selected event.

262 Version 6.0

Utilization Control MES .NET Controls Developer Guide

Note: The Delete Before command is disabled if the selected event cannot be edited or if it is the first
event that can be edited.

 Delete After: You can use this command to combine the selected event wit h the next event. After
executing this command, the selected event is deleted and the next event becomes the select ed
event. The start time of the deleted event becomes the start time of the selected event. The
Utilization Reason and Comments of the deleted event are retained by the selected event.

Note: The Delete Before command is disabled if the selected event cann ot be edited or if it is the last
event that can be edited.

Properties of the Utilization Control

This section shows the properties of the Utilization control. For information about the common properties
shared by this control, see Common Properties on page 51.

AddProductionEnabled Property
The AddProductionEnabled property indicat es whether the AddProduction() method may be called. If
it is set to False, the AddProduction() method may not be called. This property is set by the control
whenever the state of the control changes.

Data Type Read/Write Default Value

Boolean R/W False

AutoSelNewEvents Property
The AutoSelNewEvents property determines the behavior of the control when new events occur. If this
property is True, a newly added event is automatically selected in the control's grid. If it is False, the
event which currently selected will continue to be selected when new e vents occur.

Data Type Read/Write Default Value

Boolean R/W True

EditFinalReasonEnabled Property
Use the EditFinalReasonEnabled property to determine if the Edit Final Reason function is enabled.

Data Type Read/Write Default Value

Boolean Read Only False

EndJobEnabled Property
Use the EndJobEnabled property to determine if the End Job function is enabled.

Data Type Read/Write Default Value

Boolean Read Only False

Version 6.0 263

MES .NET Controls Developer Guide Utilization Control

FilterDefaultsFromDB Property
The FilterDefaultsFrom DB property controls whether the default filter settings(UtilTimeFilterType,
UtilStatusFilter, FilterLastNEvents, UtilizationFilter.FilterLastNHours, UtilFilterUnAck, and
UtilizationFilter.FilterMinDuration properties) are established during design time or if they will be
pulled in from the MES database during run time. If this property is set to False, the default filter settings
will not be loaded from the database. If the property is set to True, the default filter settings will be pulled
from the MES database during run time. In this case, the design-time settings of the properties are
disabled.

Data Type Read/Write Default Value

Boolean R/W True

FilterEnabled Property
The FilterEnabled property specifies if the Filter() method is available. This read-only property will work
in the same manner as the other function -enabled properties. That is, when the property is False, the
corresponding function (the filter dialog box in this case) will not be available.
This property is set by the cont rol whenever the state of the control changes. It will be set to False if there
is no MES session, no user, or no entity. At all other times, it should be set to True.

Data Type Read/Write Default Value

Boolean R/W False

SetPastReasonEnabled Property
Use the SetPastRea sonEnabled property to determine if the Set Past Reason function is enabled.

Data Type Read/Write Default Value

Boolean Read Only False

SetReasonEnabled Property
Use the SetReasonEnabled property to determine if the Set Reason function is enabled.

Data Type Read/Write Default Value

Boolean Read Only False

StartDEJobEnabled Property
Use the StartDEJobEnabled property to determine if the Start Data Entry Job function is enabled.

Data Type Read/Write Default Value

Boolean Read Only False

264 Version 6.0

Utilization Control MES .NET Controls Developer Guide

StartDEJobProdRateFieldVisible Property
Use the StartDEJobProdRateFieldVisible property to get or set the visibility of the Production Rate
box in the Start Job Data Entry dialog box. If set to False, the Production Rate box is not shown in the
dialog box.

Data Type Read/Write Default Value

Boolean R/W True

StartDEJobUOMFieldVisible Property
Use the StartDEJobUOMFieldVisible property to get or set the visibility of the Unit of Measure box in
the Start Job Data Entry dialog box. If set to False, the Unit of Measure box is not shown in the dialog
box.

Data Type Read/Write Default Value

Boolean R/W True

UtilRefreshEnabled Property
Use the UtilRefre shEnabled property to temporarily allow or prevent the operator from refreshing the
control. If set to False, the operator cannot refresh the cont rol and any refresh requests submitted to the
control are ignored.

Data Type Read/Write Default Value

Boolean R/W True

UtilizationFilter.FilterEndOffset Property
The UtilizationFilter.FilterEndOffset property specifies the end of the filter period relative to now. This
filter value is only legitimate when the UtilTimeFilterType property is set to Custom. If the
UtilTimeFilterType property is not set to Custom, this property is:
 Set to 0 if the type is ThisHour, LastNHours, LastNE vents, CurrentShift, Current Day, CurrentWeek,
or CurrentMonth.
 Set to 1 if the type is LastShift, Yesterday, LastWeek, or LastMonth.
The value of this property should always be less than the value of the UtilizationFilter.FilterStartOffset
property and greater than or equal to 0.

Data Type Read/Write Default Value

Integer R/W 0

Version 6.0 265

MES .NET Controls Developer Guide Utilization Control

UtilizationFilter.FilterLastNEvents Property
The UtilizationFilter.FilterLastNEvents property is only applicable if the UtilTimeFilterType property
is set to LastNEvents. It determines how many events will be included in the control when the data is
displayed.

Data Type Read/Write Default Value

Positive Integer R/W 10

UtilizationFilter.FilterLastNHours Property
The UtilizationFilter.FilterLastNHours property is only applicable if the UtilTimeFilterType property is
set to LastNHours. Only those events wh ose event time falls within the last N hours, where N is the value
of this property, will be included in the control when the data is displayed.

Data Type Read/Write Default Value

Positive Integer R/W 24

UtilizationFilter.FilterMinDuration Property
The UtilizationFilter.FilterMinDuration property specifies the amount of time that had to be spent in the
event in order to consider the event. Only events with a duration that is greater than or equal to the value
of this property will be included. This value must be greater than or equal to 0.

Data Type Read/Write Default Value

Integer R/W 0

UtilizationFilter.FilterStartOffset Property
The UtilizationFilter.FilterStartOffse t property specifies the start of the filter period relative to now. This
filter value is only legitimate when the UtilTimeFilterType property is set to Custom. If the
UtilTimeFilterType property is not set to Custom, this property is:
 Set to 1 if the type is ThisHour, CurrentShift, Current Day, CurrentWeek, or CurrentMonth
 Set to 2 if the type is LastShift, Yesterday, LastWeek, or LastMonth.
 Set to N if the type is set to LastNE vents or LastNHours.
The value of this property should always be greater than the value of the
UtilizationFilter.FilterEndOffset property and should always be great er than or equal 1.

Data Type Read/Write Default Value

Integer R/W 0

266 Version 6.0

Utilization Control MES .NET Controls Developer Guide

UtilizationFilter.FilterTime Property
The UtilizationFilter.FilterTime property specifies the time unit for a custom filter type. This filter value
is only legitimate when the UtilTimeFilterType is set to Custom. If the UtilTimeFilterType property is
not set to Custom, this property is set to the value that matches the type:
 Hour if type is ThisHour or LastNHours
 Shift if type is ThisShift or LastShift
 Day if type is CurrentDay or Yesterday
 Week if type is CurrentWeek or LastWeek
 Month if type is CurrentMonth or LastMont h
When this property is set to Hour, the results will include data for 0 or more entire hour periods, relative to
the current time. For all other settings (Shift, Day, Week, Month, or Year), the results will start at the
beginning of the time unit specified by the UtilizationFilter.FilterStartOffset property.

Data Type Read/Write Default Value

Enum {Hour=0, R/W Hour

Shift=1,
Day=2,
Week=3,
Month=4,
Year=5}

UtilizationFilter.UtilFilterUnAck Property
The UtilizationFilter.UtilFilterUnAck property specifies whether unacknowledged events,
acknowledged events, or both types of events should be shown.

Data Type Read/Write Default Value

Enum R/W Both

{Unacknowledged=0,
Acknowledged=1,
Both=2}

UtilizationFilter.UtilStatusFilter Property
The UtilizationFilter.UtilStatusFilter property determines what filtering, if any, will be performed based
on utilization status (that is, Run Time and Down Time).

Data Type Read/Write Default Value

Enum {Runtime=0, R/W All

Downtime= 1,
Neither=2,
All=3}

Version 6.0 267

MES .NET Controls Developer Guide Utilization Control

UtilizationFilter.UtilTimeFilterType Property
The UtilizationFilter.UtilTimeFilterType property determines what time-based filtering, if any, will be
performed on the data.

Data Type Read/Write Default Value

Enum R/W None

{LastNE vents = 0
ThisShift = 1
LastShift = 2
ThisHour = 3
LastNHours = 4
CurrentDay = 5
Yesterday = 6
CurrentWeek = 7
LastWeek = 8
CurrentMont h = 9
LastMonth = 10
Custom = 11
None = 12}

UtilizationSplitEnabled Property
The UtilizationSplitEnabled property determines whether or not UtilizationSplit command is enabled.
This property is set to True if the command is enabled. Otherwis e it is set to False.

Data Type Read/Write Default Value

Boolean Read Only False

Methods of the Utilization Control

This section describes Utilization control met hods. For information about the common methods shared
by this control, see Common Methods on page 55.

AddProduction() Method
The AddProduction() method can only be called when the AddProductionEnabled property is True.
Call this method to open a dialog box that allows for the entering either of good or rejected production.
The dialog box contains fields to set the amount of production to be added and to select the reason code
to associate with the production being added, the item that is being produced, the lot, and the storage
location for the produced item. If there are defaults for any of these fields, they will be filled in when the
dialog box is opened. Entering a quantity and clicking the Save button will add the good or rejected
production for the selected reason.

268 Version 6.0

Utilization Control MES .NET Controls Developer Guide

Syntax
AddProduction();

EditComment() Method
The EditComment() method can only be called when at least one row is selected on the Utilization
control's grid. Calling this method will open a dialog box that allows the edit ing of the comments for one or
more reasons without changing anything else about the reason. The dialog box will show the current
comments for the selected reas on or the selected reasons if multiple reasons are selected and the
comments are the same. If multiple reasons are selected and the comments are not the same for all, then
the Comments field will contain <various> to let the user know that the selected reasons do not all
have the same comments. The user can then edit the displayed comment and save it . If multiple reasons
are selected, the new comments will be saved to eac h even if the reasons did not have the same
comments initially.
Syntax
EditComment();

EditFinalReason() Method
Use the Edi tFinalReason() method to open the Edit Final Reason dialog box. The operator can edit the
final reas on of the currently selected grid row.
Syntax
EditFinalReason();

EndJob() Method
Use the EndJob() method to end the currently running job.
Syntax
EndJob();

Filter() Method
The Filter() method can only be called when the FilterEnabled property is set to True. Call this method
to open the same Filter dialog box that is used to set properties at design time.
Syntax
Filter();

GetButtonMenuItems() Method
Use the GetButtonMenuItem s() method to retrieve the button menu for the Utilization control. If no
Button Bar control is associated with the Utilization control, an empty button menu is returned.
Syntax
result = GetButtonMenuItems();
Parameter
result
The ButtonMenuArrayList for the Utilization control.

GetOEEExecData() Method
Use the GetOEEExecData() method to read the OEE Exec data for the specified entity. OEE Exec data
is the extra configuration data required for an entity which is capable of tracking OEE data.

Version 6.0 269

MES .NET Controls Developer Guide Utilization Control

Syntax
result = GetOEEExecData(entID);
Parameters
entID
The entity whose OEE Exec data is to be retrieved.
result
A dataset containing dat a for the specified entity from the OEE_Exec table.

SetPastReason() Method
Use the SetPastRea son() method to open the Set Past Reason dialog box. The operator can set the
reason and an optional comment for the currently selected reason-pending row in the grid.
Syntax
SetPastReason();

SetReason() Method
Use the SetReason() method to open the Set Reason dialog box. The operator can change the current
reason on the current entity.
Syntax
SetReason();

StartDEJob() Method
Use the StartDEJob() met hod to open the dialog box for starting a data ent ry job.
Syntax
StartDEJob();

UtilizationSplit() Method
Use the UtilizationSplit() method to open the Utilization Split dialog box. You can split the selected
utilization reason and/or change the comments and reason code.
Syntax
UtilizationSplit();

270 Version 6.0

 MES .NET Controls Developer Guide

A PPENDIX A
Buttons
In This Appendix
Introduction to Buttons ................................................................................................................ 272
Action ........................................................................................................................................ 273
Accept Job ................................................................................................................................. 273
Add Consumption ....................................................................................................................... 273
Add Production ........................................................................................................................... 273
Authorize.................................................................................................................................... 274
Add/Assign SNo's ....................................................................................................................... 274
BOM Preview ............................................................................................................................. 274
Bypass....................................................................................................................................... 274
Copy Row .................................................................................................................................. 275
Complete ................................................................................................................................... 275
Create Work Order ..................................................................................................................... 275
Delet e Lot and Sublots ................................................................................................................ 276
Delet e Rows ............................................................................................................................... 276
Edit ............................................................................................................................................ 276
EditComment ............................................................................................................................. 276
Edit Reason ............................................................................................................................... 277
Edit Results ................................................................................................................................ 277
Edit Row .................................................................................................................................... 277
Edit Sample................................................................................................................................ 278
Edit Specs.................................................................................................................................. 278
End Job ..................................................................................................................................... 278
Entity Logon ............................................................................................................................... 278
E vent ......................................................................................................................................... 279
Execute...................................................................................................................................... 279
File Filter .................................................................................................................................... 279
Filter .......................................................................................................................................... 279
Help ........................................................................................................................................... 280
Insert Entity Usage Row .............................................................................................................. 280
Insert Job Detail Row .................................................................................................................. 280
Insert Lot or Sublot ..................................................................................................................... 280
Insert New Row .......................................................................................................................... 281
Job Attributes ............................................................................................................................. 281
Job Logoff .................................................................................................................................. 281
Launch Browser.......................................................................................................................... 281
Link Jobs.................................................................................................................................... 282
Log In ........................................................................................................................................ 282
Log Out ...................................................................................................................................... 282
Login ......................................................................................................................................... 282
Logout ....................................................................................................................................... 283
Lot Attributes .............................................................................................................................. 283
New Row ................................................................................................................................... 283
Notes ......................................................................................................................................... 283
Open/Launch Form ..................................................................................................................... 284
Pause Job .................................................................................................................................. 284
Print ........................................................................................................................................... 284

Version 6.0 271

MES .NET Controls Developer Guide Buttons

Process...................................................................................................................................... 285
Pull Sample ................................................................................................................................ 285
Receive Inventory ....................................................................................................................... 285
Reclassify .................................................................................................................................. 285
Reduce Consumption.................................................................................................................. 286
Reduce Production ..................................................................................................................... 286
Refresh ...................................................................................................................................... 286
Rejects....................................................................................................................................... 286
Remove ..................................................................................................................................... 287
Rename Lot or Sublot ................................................................................................................. 287
Rework ...................................................................................................................................... 287
Save Row .................................................................................................................................. 287
Scrap ......................................................................................................................................... 288
Set Lot Data ............................................................................................................................... 288
Set Past Reason......................................................................................................................... 288
Set Reason ................................................................................................................................ 288
Show List ................................................................................................................................... 289
SPC Chart .................................................................................................................................. 289
Split Job ..................................................................................................................................... 289
Split Lot...................................................................................................................................... 289
Start Job .................................................................................................................................... 290
Start Some ................................................................................................................................. 290
Switch User ................................................................................................................................ 290
Toggle Chart .............................................................................................................................. 291
Toggle Sample Final Flag............................................................................................................ 291
Trans fer In.................................................................................................................................. 291
Trans fer Out ............................................................................................................................... 291
Trans fer Serial Numbers ............................................................................................................. 292
UnPull Sample............................................................................................................................ 292
Update Job Spec. Values ............................................................................................................ 292
Update Template Spec. Values ................................................................................................... 292
Utilization Split ............................................................................................................................ 293
View .......................................................................................................................................... 293
View Flow Diagram ..................................................................................................................... 293
View Item Attributes .................................................................................................................... 293
Waste ........................................................................................................................................ 294

Introduction to Buttons
The buttons that are available to be used with .NE T control methods are listed and described here.
The description includes:
 The button ID
 The language ID
 The button's tooltip
 The language ID of the button's tooltip
 Which controls can use the button
The tooltip shown for each button is the tooltip for the default language, English. The tooltip text can be
replaced by setting up a new language and configuring the button bar.
Look in the Ui_Button database table for ID, language string, and tooltip information.

272 Version 6.0

Buttons MES .NET Controls Developer Guide

Action
The Action button executes the step action.

Button ID 251

Language ID 702

Tooltip Execute step action

Tooltip Language ID 4932

Cont rol Usage Steps

Accept Job
The Accept Job button marks a job as ready to run.

Button ID 40

Language ID 4473

Tooltip Accept the selected job as ready to run

Tooltip Language ID 4872

Cont rol Usage Queue

Add Consumption
The Add Consumption button opens the dialog box for adding consumption.

Button ID 82

Language ID 3675

Tooltip Add consumption quantity

Tooltip Language ID 4893

Cont rol Usage Cons umption

Add Production
The Add Production button opens a dialog box that allows for the entering either of good or rejected
production. The dialog box contains fields to set the amount of production to be added and to select the
reason code to associate with the production being added, the item t hat is being produc ed, the lot, and
the storage location for the produc ed item. If there are defaults for any of these fields, they will be filled in
when the dialog box is opened. Entering a quantity and clicking the Save button will add the good or
rejected production for the reason.

Button ID 60

Language ID 3674

Version 6.0 273

MES .NET Controls Developer Guide Buttons

Tooltip Add Production to the current job

Tooltip Language ID 4887

Cont rol Usage Production, Utilization

Authorize
The Authorize button opens the Inspector dialog box which allows to authenticate a user.

Button ID 224

Language ID 4483

Tooltip Authorize

Tooltip Language ID 4483

Cont rol Usage Audit, Steps

Add/Assign SNo's
The Add/Assign SNo’ s button opens the Add/Assign Serial Numbers dialog box for users to add
serial numbers and assign existing serial numbers to a job.

Button ID 316

Language ID 5357

Tooltip Add/Assign SNo's

Tooltip Language ID 5357

Cont rol Usage Production, Queue

BOM Preview
The BOM Preview button opens the BOM Preview dialog box to view the components needed for the
selected job and relevant information for each.

Button ID 238

Language ID 2967

Tooltip View BOM details

Tooltip Language ID 4883

Cont rol Usage Queue

Bypass
The Bypa ss button skips the step.

274 Version 6.0

Buttons MES .NET Controls Developer Guide

Button ID 254

Language ID 2047

Tooltip Step bypass

Tooltip Language ID 4923

Cont rol Usage Steps

Copy Row
The Copy Row button opens the Edit dialog box to create a new row. The new row is populated with the
data from the selected row.

Button ID 314

Language ID 5033

Tooltip Copy Row

Tooltip Language ID 5033

Cont rol Usage Entity Usage Editor, Item Production Editor,

Item Consumption Editor, Labor Usage Editor,
Job Step Dat a Editor

Complete
The Complete button accepts and completes the step.

Button ID 253

Language ID 705

Tooltip Step accept/complete

Tooltip Language ID 4922

Cont rol Usage Steps

Create Work Order

The Create Work Order button creates a new work order.

Button ID 49

Language ID 1755

Tooltip Create new work order against shortage

Tooltip Language ID 4880

Cont rol Usage Queue

Version 6.0 275

MES .NET Controls Developer Guide Buttons

Delete Lot and Sublots

The Delete Lot and Sublots button deletes the selected lot and sublots.

Button ID 323

Language ID 5375

Tooltip Delet e Lot and Sublots

Tooltip Language ID 5375

Cont rol Usage Item Lot Editor

Delete Rows
The Delete Rows button deletes one or more selected rows.

Button ID 313

Language ID 5028

Tooltip Delet e Rows

Tooltip Language ID 5028

Cont rol Usage Entity Usage Editor, Item Production Editor,

Item Consumption Editor, Job Step Data
Editor, Labor Usage Editor

Edit
The Edit button opens the editor to edit the selected file.

Button ID 265

Language ID 58

Tooltip Edit File

Tooltip Language ID 4871

Cont rol Usage Folders

EditComment
The EditComment button opens a dialog box that shows the current comments for the selected reason
or the selected reas ons if multiple reasons are selected and the comments are the same. If multiple
reasons are selected and the comments are not the same for all, then the comments field will contain
<various> to let the user k now that the selected reasons do not all have the same comments. The user
can then edit the displayed comment and save it. If multiple reasons are selected, the new comments will
be saved to each even if the reasons did not have the same comments initially.

Button ID 317

276 Version 6.0

Buttons MES .NET Controls Developer Guide

Language ID 1

Tooltip Edit Comment

Tooltip Language ID 5315

Cont rol Usage Utilization

Edit Reason
The Edit Reason button opens the Edit Final Reason dialog box to change the final reason for the
currently selected grid row.

Button ID 294

Language ID 4805

Tooltip Edit final reason for selected utilization record

Tooltip Language ID 4909

Cont rol Usage Utilization

Edit Results
The Edit Re sults button enables the editing mode for sample results.

Button ID 330

Language ID 7212

Tooltip Edit Results

Tooltip Language ID 7212

Cont rol Usage Sample Viewer

Edit Row
The Edit Row button opens the Edit dialog box for the selected row. For the Entity Usage Editor, this can
be a master (entity usage) row or a det ail (job) row.

Button ID 311

Language ID 5026

Tooltip Edit Row

Tooltip Language ID 5026

Cont rol Usage Entity Usage Editor, Item Production Editor,

Item Consumption Editor, Job Step Data
Editor, Labor Usage Editor

Version 6.0 277

MES .NET Controls Developer Guide Buttons

Edit Sample
The Edit Sample button enables the editing mode for sample information.

Button ID 326

Language ID 7208

Tooltip Edit Sample

Tooltip Language ID 7208

Cont rol Usage Sample Viewer

Edit Specs
The Edit Specs button enables the editing mode for specification det ails.

Button ID 291

Language ID 3953

Tooltip Edit specifications

Tooltip Language ID 4870

Cont rol Usage Spec

End Job
The End Job button ends a job.
For the Queue control, the End Job button ends the selected job.
For the Utilization control, the End Job button ends the current job.

Button ID 42

Language ID 370

Tooltip Stop the selected job

Tooltip Language ID 4874

Cont rol Usage Utilization, Queue

Entity Logon
The Entity Logon allows the operator to log in to another machine.

Button ID 161

Language ID 4480

Tooltip Log in to another machine

Tooltip Language ID 4927

278 Version 6.0

Buttons MES .NET Controls Developer Guide

Cont rol Usage Labor Us age Editor

Event
The Event button opens a dialog box for entering a job event.

Button ID 255

Language ID 4176

Tooltip Enter event

Tooltip Language ID 4924

Cont rol Usage Steps

Execute
The Execute button starts a program which is specified in the us er data for the button.

Button ID 12

Language ID 2095

Tooltip Launch an external application

Tooltip Language ID 4855

Cont rol Usage General

File Filter
The File Filter button opens a dialog box to enter file filter for the folders tree.

Button ID 262

Language ID 3600

Tooltip Enter file filter

Tooltip Language ID 4939

Cont rol Usage Folders

Filter
The Filter button opens a filter dialog box to filter the data shown on the control.

Button ID 24

Language ID 3122

Tooltip Enter filter criteria

Tooltip Language ID 4864

Version 6.0 279

MES .NET Controls Developer Guide Buttons

Cont rol Usage Utilization, Sample Viewer

Help
The Help button opens the help file.

Button ID 4

Language ID 62

Tooltip Open a help file

Tooltip Language ID 4847

Cont rol Usage General

Insert Entity Usage Row

The Insert Entity Usage Row button opens the Edit dialog box for entering a new master (entity usage)
row.

Button ID 319

Language ID 5389

Tooltip Insert Entity Usage Row

Tooltip Language ID 5389

Cont rol Usage Entity Usage Editor

Insert Job Detail Row

The Insert Job Detail Row button opens the Edit dialog box for entering a new detail (job) row.

Button ID 320

Language ID 5390

Tooltip Insert Job Detail Row

Tooltip Language ID 5390

Cont rol Usage Entity Usage Editor

Insert Lot or Sublot

The Insert Lot or Sublot button allows to insert lot or sublot.

Button ID 321

Language ID 5373

Tooltip Insert Lot or Sublot

280 Version 6.0

Buttons MES .NET Controls Developer Guide

Tooltip Language ID 5373

Cont rol Usage Item Lot Editor

Insert New Row

The Insert New Row button opens the Edit dialog box for entering a new row.

Button ID 312

Language ID 5027

Tooltip Insert New Row

Tooltip Language ID 5027

Cont rol Usage Item Production Edit or, Item Consumption

Editor, Job Step Data Editor, Labor Usage
Editor

Job Attributes
The Job Attribute s button opens the Job Attribute s dialog box for viewing, editing, and deleting job
attributes for the selected job.

Button ID 239

Language ID 2515

Tooltip View job attributes

Tooltip Language ID 4884

Cont rol Usage Queue

Job Logoff
The Job Logoff button logs the operator off the current dialog box.

Button ID 325

Language ID 5436

Tooltip Log User Off of the Job

Tooltip Language ID 5437

Cont rol Usage Queue, Labor Usage Editor

Launch Browser
The Launch Brow ser button opens the web page specified in the user data of the button.

Button ID 245

Version 6.0 281

MES .NET Controls Developer Guide Buttons

Language ID 4489

Tooltip Launch the browser

Tooltip Language ID 4856

Cont rol Usage General

Link Jobs
The Link Jobs button opens the Select Jobs to Batch dialog box to select jobs to link together into a
batch.

Button ID 268

Language ID 4207

Tooltip Link jobs together in a batch

Tooltip Language ID 4886

Cont rol Usage Queue

Log In
The Login button allows another operator to log on.

Button ID 6

Language ID 4468

Tooltip Log in another operator

Tooltip Language ID 4849

Cont rol Usage Labor Us age Editor

Log Out
The Log Out button allows the operat or to log off.

Button ID 7

Language ID 4469

Tooltip Log Off operator

Tooltip Language ID 4850

Cont rol Usage Labor Us age Editor

Login
The Login button allows operat or to log on to the step.

282 Version 6.0

Buttons MES .NET Controls Developer Guide

Button ID 225

Language ID 1253

Tooltip Login to step

Tooltip Language ID 4920

Cont rol Usage Steps

Logout
The Logout button logs the operator off the step.

Button ID 226

Language ID 4484

Tooltip Logout from step

Tooltip Language ID 4921

Cont rol Usage Steps

Lot Attributes
The Lot Attribute s button displays lot attribut es.

Button ID 250

Language ID 2056

Tooltip View lot attribut es

Tooltip Language ID 4903

Cont rol Usage Inventory

New Row
The New Row button opens a dialog box to add a row for the new set of data log samples.

Button ID 220

Language ID 4481

Tooltip Add new DataLog row

Tooltip Language ID 4915

Cont rol Usage Data Log

Notes
The Note s button opens a read-only dialog box for viewing the job, work order, or item notes for the
selected job and item it produces.

Version 6.0 283

MES .NET Controls Developer Guide Buttons

Button ID 227

Language ID 600

Tooltip View not es

Tooltip Language ID 4882

Cont rol Usage Queue

Open/Launch Form
The Open/Launch Form button opens the form specified in the user data. This button is only available
when the system parameter Path to form program is set.

Button ID 27

Language ID 4472

Tooltip Open/Launch form

Tooltip Language ID 4869

Cont rol Usage General

Pause Job
The Pause Job button pauses the selected job.

Button ID 43

Language ID 3993

Tooltip Pause the selected job

Tooltip Language ID 4875

Cont rol Usage Queue

Print
The Print button prints the selected file.

Button ID 201

Language ID 4

Tooltip Print document

Tooltip Language ID 4911

Cont rol Usage Folders

284 Version 6.0

Buttons MES .NET Controls Developer Guide

Process
The Proce ss button marks the selected production record as processed.

Button ID 62

Language ID 604

Tooltip Mark a production lot as processed

Tooltip Language ID 4889

Cont rol Usage Production

Pull Sample
The Pull Sample button opens a dialog box to modify the sample pull time.

Button ID 327

Language ID 7209

Tooltip Pull Sample

Tooltip Language ID 7209

Cont rol Usage Sample Viewer

Receive Inventory
The Receive Inventory button enables receiving inventory from an external location.

Button ID 309

Language ID 5021

Tooltip Receive Inventory

Tooltip Language ID 5021

Cont rol Usage Inventory

Reclassify
The Recla ssify button opens a dialog box to change the grade and status of the selected lot.

Button ID 102

Language ID 1832

Tooltip Reclassify the grade or status

Tooltip Language ID 4900

Cont rol Usage Inventory

Version 6.0 285

MES .NET Controls Developer Guide Buttons

Reduce Consumption
The Reduce Consumption button reduces the consumption for the selected row.

Button ID 241

Language ID 4488

Tooltip Reduce the cons umption for selected row

Tooltip Language ID 4897

Cont rol Usage Cons umption

Reduce Production
The Reduce Production button opens the Reduce Production dialog box to reduce the amount of
production reported in the selected production record.

Button ID 240

Language ID 4487

Tooltip Reduce the production for current job

Tooltip Language ID 4890

Cont rol Usage Production

Refresh
The Refre sh button refreshes the control’s data.

Button ID 21

Language ID 945

Tooltip Refresh the screen

Tooltip Language ID 4861

Cont rol Usage General

Rejects
The Rejects button opens the Reclassi fy Production dialog box for rejecting some or all of the selected
production records.

Button ID 61

Language ID 1070

Tooltip Add rejected production to the current job

Tooltip Language ID 4888

286 Version 6.0

Buttons MES .NET Controls Developer Guide

Cont rol Usage Production

Remove
The Remove button deletes the selected Data Log row.

Button ID 101

Language ID 717

Tooltip Delet e Datalog row

Tooltip Language ID 4899

Cont rol Usage Data Log

Rename Lot or Sublot

The Rename Lot or Sublot button renames the lot or sublot.

Button ID 324

Language ID 5376

Tooltip Rename Lot or Sublot

Tooltip Language ID 5376

Cont rol Usage Item Lot Editor

Rework
The Rework button opens the Rework dialog box, which allows rework for steps.

Button ID 264

Language ID 1818

Tooltip Step rework

Tooltip Language ID 4925

Cont rol Usage Steps

Save Row
The Save Row button saves the Data Log row.

Button ID 221

Language ID 4482

Tooltip Save DataLog row

Tooltip Language ID 4916

Version 6.0 287

MES .NET Controls Developer Guide Buttons

Cont rol Usage Data Log

Scrap
The Scrap button removes all or some of the items from the inventory of the selected storage location.

Button ID 104

Language ID 4427

Tooltip Scrap invent ory

Tooltip Language ID 4902

Cont rol Usage Inventory

Set Lot Data

The Set Lot Data button opens the Set Lot Data dialog box for setting the current lot number, production
code, and storage location.

Button ID 84

Language ID 4288

Tooltip Set new lot information

Tooltip Language ID 4895

Cont rol Usage Production, Consumptions, Steps

Set Past Reason

The Set Past Reason button opens the Set Past Reason dialog box, which allows the reason for the
currently selected reason-pending row in the grid to be set.

Button ID 124

Language ID 4479

Tooltip Enter reason-required for selected utilization

record

Tooltip Language ID 4908

Cont rol Usage Utilization

Set Reason
The Set Reason button opens the Set Reason dialog box, which allows the current reason on the
current entity to be changed.

Button ID 122

Language ID 4477

288 Version 6.0

Buttons MES .NET Controls Developer Guide

Tooltip Enter a reason for selected machine

Tooltip Language ID 4906

Cont rol Usage Utilization

Show List
The Show List button displays the list of operators logged int o step.

Button ID 222

Language ID 3515

Tooltip List Operators logged into step

Tooltip Language ID 4919

Cont rol Usage Steps

SPC Chart
The SPC Chart button displays an SPC chart.

Button ID 331

Language ID 7213

Tooltip SPC Chart

Tooltip Language ID 7213

Cont rol Usage Sample Viewer

Split Job
The Split Job button opens the Split Job dialog box for splitting the selected job into two jobs.

Button ID 267

Language ID 1770

Tooltip Split the current job

Tooltip Language ID 4885

Cont rol Usage Queue

Split Lot
The Split Lot button splits items from the selected row into another lot.

Button ID 105

Language ID 4560

Version 6.0 289

MES .NET Controls Developer Guide Buttons

Tooltip Split items from the selected row into

another lot

Tooltip Language ID 4904

Cont rol Usage Inventory

Start Job
The Start Job button starts a job.
For the Queue control, the Start Job button starts the selected job.
For the Utilization control, the Start Job button opens the Start Data Entry Job dialog box.

Button ID 41

Language ID 3992

Tooltip Start the selected job

Tooltip Language ID 4873

Cont rol Usage Utilization, Queue

Start Some
The Start Some button allows for the splitting off of required production quantity into a new job that is
then started on the active entity.

Button ID 310

Language ID 5022

Tooltip Start Some

Tooltip Language ID 5022

Cont rol Usage Queue

Switch User
The Switch User button opens the Switch User dialog box to allow:
 Switching between operators
 Logging on new operators
 Logging off existing operators
 Changing the password of selected operators

Button ID 9

Language ID 1377

Tooltip Switch to another operator's session

Tooltip Language ID 4852

290 Version 6.0

Buttons MES .NET Controls Developer Guide

Cont rol Usage General

Toggle Chart
The Toggle Chart button switches between grid display and chart display.

Button ID 228

Language ID 4485

Tooltip Toggle chart

Tooltip Language ID 4917

Cont rol Usage Data Log

Toggle Sample Final Flag

The Toggle Sample Final Flag button marks a sample as final or clears the final flag.

Button ID 329

Language ID 7211

Tooltip Toggle Sample Final Flag

Tooltip Language ID 7211

Cont rol Usage Sample Viewer

Transfer In
The Transfer In button transfers inventory from another entity to the selected storage location.

Button ID 100

Language ID 1863

Tooltip Receive inventory to a storage location

Tooltip Language ID 4898

Cont rol Usage Inventory

Transfer Out
The Transfer Out button trans fers inventory from the selected entity to another storage location.

Button ID 103

Language ID 1826

Tooltip Trans fer out inventory to another

location

Version 6.0 291

MES .NET Controls Developer Guide Buttons

Tooltip Language ID 4901

Cont rol Usage Inventory

Transfer Serial Numbers

The Transfer Serial Number button opens the Select and Transfer WIP Inventory dialog box for
transferring serialized parts between inventory locations.

Button ID 318

Language ID 5372

Tooltip Trans fer Serial Numbers

Tooltip Language ID 5372

Cont rol Usage Production, Queue, Inventory

UnPull Sample
The UnPull Sample button sets the sample pull time and pulled by fields for the selected sample to Null.

Button ID 328

Language ID 7210

Tooltip UnPull Sample

Tooltip Language ID 7210

Cont rol Usage Sample Viewer

Update Job Spec. Values

The Update Job Spec. Values button opens a dialog box to edit job specification values.

Button ID 292

Language ID 3991

Tooltip Update Job Spec. Values

Tooltip Language ID 3991

Cont rol Usage Spec

Update Template Spec. Values

The Update Template Spec. Values button opens a dialog box to edit templat e specification values.

Button ID 293

Language ID 3997

292 Version 6.0

Buttons MES .NET Controls Developer Guide

Tooltip Update Template Spec. Values

Tooltip Language ID 3997

Cont rol Usage Spec

Utilization Split
The Utilization Split button opens the Utilization Split dialog box for editing the duration and shift
information of the split events.

Button ID 332

Language ID 7380

Tooltip Utilization Split

Tooltip Language ID 7380

Cont rol Usage Utilization

View
The View button displays the document.

Button ID 200

Language ID 3126

Tooltip View doc ument

Tooltip Language ID 4910

Cont rol Usage Folders, Steps

View Flow Diagram

The View Flow Diagram button opens the Job Diagram dialog box to show the job route diagram.

Button ID 223

Language ID 1006

Tooltip View job flow diagram

Tooltip Language ID 4881

Cont rol Usage Queue

View Item Attributes

The View Item Attribute s button opens the Item Attribute s dialog box to view, add, modify, and delete
item attributes.
For the Queue control, the item produc ed by the selected job is used.

Version 6.0 293

MES .NET Controls Developer Guide Buttons

For the Production control, the item produced by the current job is used.

Button ID 229

Language ID 4497

Tooltip View Item Attributes

Tooltip Language ID 4497

Cont rol Usage Production, Queue

Waste
The Waste button opens the dialog box for ent ering waste consumption for the selected item.

Button ID 83

Language ID 1071

Tooltip Enter waste for the selected item

Tooltip Language ID 4894

Cont rol Usage Cons umption

294 Version 6.0

 MES .NET Controls Developer Guide

Index
. A
.NET controls
Accept Job button • 273
animating • 47 Action button • 273
Application Server scripts, using properties ActionEnabled property (Steps control) • 248
in • 37 Add Consumption button • 273
ArchestrA symbol, docking in • 37 Add Production button • 273
Add/Assign SNo's button • 274
ArchestrA symbols, using in • 32
AddAssignSerialNumbers() method (Production
ArchestrA, exporting from • 26
control) • 146
ArchestrA, importing into • 22, 23 AddAssignSerialNumbersEnabled property
assemblies, viewing • 43 (Production cont rol) • 144
class name, viewing • 44 AddConsEnabled property (Consumption
control) • 80
common met hods • 55
AddConsumption() met hod (Consumption
common properties • 51 control) • 81
common properties, using • 37 AddNewRow() method (Dat a Log control) • 96
configuring event scripts • 27 AddProdEnabled property (Production control) •
entitiies, logging on automatically • 39 144
AddProduction() method (Production control) •
InTouch, using in • 32
146
introduction • 21, 22 AddProduction() method (Utilization control) •
logging on automatically • 38 268
MES Data Editor controls • 49 AddProductionEnabled property (Utilization
control) • 263
MES Operator cont rols • 47
AlarmPointColor property (SPC Chart control) •
miscellaneous controls • 49
211
objects referencing, viewing • 44 AllowConfiguration property (Button Bar control)
organizing • 22 • 69
properities, binding • 45 animations

properties, viewing and changing • 39 .NET types • 47

refres hing automatically • 39 binding .NE T controls to ArchestrA

attributes • 22
securing • 27
scripts, configuring for .NET control events •
symbols referencing, viewing • 44
22
vendor, viewing • 44 AppendSaveConfigName property (common
version, viewing • 44 properties) • 51
AppendSaveConfigName property (Entity
Usage Editor control) • 100

Version 6.0 295

MES .NET Controls Developer Guide Index

AppendSaveConfigName property (Item embedding • 67

Cons umption Editor cont rol) • 117
methods • 74
AppendSaveConfigName property (Item
properties • 69
Production Editor control) • 100
AppendSaveConfigName property (Job Step ButtonBarName property (common properties) •
52
Data Editor control) • 100
ButtonSize property (Button Bar control) • 70
AppendSaveConfigName property (Labor
Usage Editor control) • 100 Bypass button • 274
BypassEnabled property (Steps control) • 248
ApplyDefaultSortParameters() method (Queue
control) • 163
ApplyFilter() method (Folders control) • 103 C
AttributesEnabled property (Queue cont rol) • Canc elSample() method (Sample Viewer
158 control) • 196
Audit control Canc elSampleEnabled property (Sample
configuring • 63 Viewer control) • 190
introduction • 63 cause groups and sample points • 208
causes, assigning to a sample point • 208
methods • 64
CDKP IFilter.FilterEndOffset property
properties • 64
(Counts/Duration KPI control) • 85
Authorize button • 274 CDKP IFilter.FilterStartOffset property
Authorize() met hod (Steps control) • 250
(Counts/Duration KPI control) • 85
AuthorizeE nabled property (Audit control) • 64
CDKP IFilter.FilterTime property
AuthorizeE nabled property (Steps control) • 248 (Counts/Duration KPI control) • 85
AutoLoginUser property (common properties) •
CDKP IFilter. TypeFilter property
52
(Counts/Duration KPI control) • 86
AutoLogonEnt property (common properties) • CharacteristicNameFilter property (SPC Chart
52
control) • 212
AutoSelNewE vents property (Utilization control)
ChartBackColor property (Counts/Duration KP I
• 263 control) • 86
Chart Title property (SPC Chart control) • 212
B Chart Type property (SPC Chart control) • 213
BackColor property (Button Bar control) • 70 CheckAndSave() method (Data Log control) •
BatchJobBGColorOption property (Queue 96
control) • 159 ClearEntityTreeFilter() met hod (Inventory
BatchJobBGCustomColors property (Queue control) • 113
control) • 160 ClearFilters() method (SP C Chart cont rol) • 241
BatchSize property (Production Progress ClearInventoryFilter() method (Inventory
control) • 151 control) • 114
BeginInit() method (common methods ) • 55 client controls • 22
binding ArchestrA attributes • 34 ColorPointsInAlarm property (SPC Chart
BOM Preview button • 274 control) • 214
Button Bar control ColumnHeaderBackColor property (Queue
control) • 160
associating with other cont rols • 68
ColumnHeaderBackColorDifferentEnt property
configuring • 67
(Queue control) • 160
description • 67 ColumnHeaderForeColor property (Queue
docking • 68 control) • 160

296 Version 6.0

Index MES .NET Controls Developer Guide

CompareEnabled property (Folders control) • methods • 90

102
properties • 85
Complete button • 275
using • 83
CompleteEnabled property (Steps control) • 248
Cons umption control Create Work Order button • 275
CreateWO() method (Queue control) • 163
configuring • 79
curEnt property (Dat a Log control) • 94
methods • 81 CurrentValueType property (OEE KPI control) •
properties • 80 135
ConsWaste() method (Consumption control) • curUser property (Data Log control) • 94
81 custom properties • 34
ConsWasteEnabled property (Consumption
control) • 80
D
Cont rolInCharge property (Button Bar control) •
Data Editor controls
70
Cont rolLicensed property • 53 Item Consumption Editor • 49
controls Item Lot Editor • 49
Audit control • 47 Item Production Edit or • 49
automatic logon • 38 Job Step Dat a Editor • 49
binding element properties • 34 Labor Us age Editor • 49
custom properties • 34 Data Log cont rol

Data Log cont rol • 47 configuring • 93

docking within a symbol • 37 methods • 96

Inventory control • 47 properties • 94

Data. CurrentProduction property (Production
Job Summary control • 47
Progress control) • 151
Labor control • 47 Data. Deviation property (Production Progress
Production • 47 control) • 151
Queue control • 47 DataPointColor property (SPC Chart control) •
Rout e control • 47 214
DefaultButtonBackColor property (Button Bar
scripts • 34
control) • 70
Spec control • 47 DefaultButtonForeColor property (Button B ar
Steps control • 47 control) • 70
using with InTouch security • 36, 37 Delet e Lot and Sublots button • 276
Delet e Rows button • 276
Utilization control • 47
Delet eDataLogRow() method (Dat a Log control)
Cont rolStyle property (Counts/Duration KPI
control) • 86 • 96
DeviationfromPlannedFont property
Copy Row button • 275
(Production Progress control) • 152
Counts/Duration KP I control
DisplayChart() met hod (SPC Chart control) •
Button Bar control, associating to • 85
242
entities, switching • 84 DisplayChartEnabled property (SPC Chart
events • 91 control) • 215
introduction • 83 DisplayEntity property (Counts/Duration KPI
control) • 87
logging on • 84

Version 6.0 297

MES .NET Controls Developer Guide Index

DisplayEntity property (OEE KPI cont rol) • 87 EnableCollapsibleToggles property (SPC Chart
DisplayJobE ventDialog() method (Steps control) • 216
control) • 250 EnableDisableButtons() met hod (Queue
DisplayProjectedDetails property (Production control) • 164
Progress control) • 152 End Job button • 278
Display Titlebar property (Job Sumary control) • EndInit() method (common methods) • 55
128 EndJob() method (Queue control) • 164
Display XaxisLabelChanges property (SPC EndJob() method (Utilization control) • 269
Chart control) • 215 EndJobE nabled property (Queue control) • 160
Display XaxisLabelFrequency property (SPC EndJobE nabled property (Utilization control) •
Chart control) • 216 263
Dock property (Button Bar cont rol) • 71 EndTimeFilter property (Sample Viewer control)
DurationRefreshRate property • 191
(Counts/Duration KPI control) • 87 EndTimeFilter property (SPC Chart control) •
216
Entity Logon button • 278
E Entity Usage Editor cont rol
Edit button • 276
configuring • 99
Edit Reason button • 277
Edit Results button • 277 methods • 100
Edit Row button • 277 properties • 99
Edit Sample button • 278 EntityFilter property (Sample Viewer control) •
Edit Specs button • 278 191
Edit() method (Folders control) • 104 EntityFilterRestriction property (Sample Viewer
EditComment button • 276 control) • 191
EditComment() method (Utilization control) • EntityIdFilter property (SPC Chart control) • 217
269 EntityNameFilter property (SPC Chart control) •
EditEnabled property (Folders control) • 102 217
EditFinalReason() method (Utilization control) • E vent button • 279
269 event scripts
EditFinalReasonEnabled property (Utilization configuring • 27
control) • 263
configuring example • 31
editing results
pre- and post-button click events • 29
sample viewer, processing results • 184
selected row changed event • 28
sample viewer, verifying result entries • 184
selected row changed event, properties • 29
Verify Write option, sample plan • 184
E ventEnabled property (Steps control) • 248
EditResultsEnabled property (Sample Viewer
Execute button • 279
control) • 190
Execute() method (c ommon methods) • 55
EditSampleE nabled property (Sample Viewer
ExecuteButtonMenuCommand() method
control) • 191
(common methods) • 56
EditSampleInfo() method (Sample Viewer
ExecuteEnabled property (common properties )
control) • 196
• 53
EditSampleResults() method (Sample Viewer
ExecuteStepAction () method (Steps control) •
control) • 196
250
EditSpecificationsEnabled property (Spec
control) • 243
EnableButton() method (B utton Bar cont rol) • 74

298 Version 6.0

Index MES .NET Controls Developer Guide

F G
File Filter button • 279 GaugeBackColor property (OEE KPI control) •
FillSampleDataDuration() method 136
(Counts/Duration KPI control) • 90 GaugeBorderColor property (OEE KPI control) •
Filter button • 279 136
Filter() method (Counts/Duration KPI control) • GaugeBorderVisible property (OEE KPI control)
90 • 136
Filter() method (Folders control) • 104 GaugeFillColor property (OEE KPI cont rol) •
Filter() method (OEE KPI cont rol) • 141 136
Filter() method (Sample Viewer control) • 196 GaugeForeColor property (OEE KPI control) •
Filter() method (Utilization control) • 269 137
FilterDefaultsFromDB property GaugeGradientEnabled property (OEE KPI
(Counts/Duration KPI control) • 88 control) • 137
FilterDefaultsFromDB property (OEE KPI GaugeMarkerFont property (OEE KPI control) •
control) • 135 137
FilterDefaultsFromDB property (Utilization GaugeTextFont property (Production Progress
control) • 264 control) • 152
FilterDuration property (Counts/Duration KPI GaugeTitleFont property (OEE KPI control) •
control) • 88 137
FilterEnabled property (Consumption control) • GaugeTitleTextVisible property (OEE KPI
80 control) • 137
FilterEnabled property (Counts/Duration KPI GaugeValueTextVisible property (OEE KPI
control) • 88 control) • 138
FilterEnabled property (Folders control) • 102 Genealogy control
FilterEnabled property (OEE KPI control) • 135 configuring • 107
FilterEnabled property (Sample Viewer control)
methods • 108
• 192
properties • 108
FilterEnabled property (Utilization cont rol) • 264
GetButtonMenuItems() method (common
FirstZoneColor property (OEE KPI control) •
136 methods ) • 56
GetButtonMenuItems() method
FirstZoneColor property (Production Progress
(Counts/Duration KPI control) • 90
control) • 152
FirstZoneCut off (OEE KPI control) • 136 GetButtonMenuItems() method (Utilization
control) • 269
FirstZoneP ercent property (Production
GetOEEExecDat a() method (Utilization control)
Progress control) • 152
FlowDiagramEnabled property (Queue control) • 269
GetQuantityForDownstreamOperation()
• 161
method (Item Production Editor control) • 122
Folders control
Get TotalQuantityForOperation() method (Item
configuring • 101
Production Editor control) • 122
methods • 103 GraphBottomP os property (SPC Chart cont rol) •
properties • 102 217
Font property (common properties) • 53 GraphStart X property (SPC Chart control) • 217
Font property (Data Log control) • 94 GraphStopPos X property (SPC Chart control) •
Font property (Queue control) • 161 217
ForeColor property (Button Bar control) • 71

Version 6.0 299

MES .NET Controls Developer Guide Index

GraphType property (Counts/Duration KPI Item Lot Editor control

control) • 87 changing the parent of a lot • 119
configuring • 119
H deleting an existing lot or sublot • 119
HeaderLevel property (SPC Chart control) • 219 inserting a new lot or sublot • 119
HeadingFont property (common properties) • 53
methods • 120
Help button • 280
Help() method (common methods) • 56 properties • 120
Horiz ontalBoundary property (Button Bar refres hing records • 119
control) • 71 renaming a lot or sublot • 119
Horiz ontalSeparation property (Button Bar Item Production Edit or control
control) • 71 configuring • 121
methods • 122
I properties • 121
IgnoreRefres hE vents property (common ItemAttribut es() met hod (Production control) •
properties) • 53 146
InitEntitySelect() method (Job Sumary control) • ItemAttribut esEnabled property (Consumption
128 control) • 80
InitializeS uperclass() method (c ommon ItemAttribut esEnabled property (Queue control)
methods ) • 56 • 161
Insert Entity Usage Row button • 280 ItemCategory IdFilter property (SPC Chart
Insert Job Detail Row button • 280 control) • 219
Insert Lot or Sublot button • 280 ItemCategory NameFilter property (Sample
Insert New Row button • 281 Viewer control) • 192
IntializeB arGraph() method (Counts/Duration ItemCategory NameFilter property (SPC Chart
KPI control) • 90 control) • 220
InTouch, binding tags to .NET controls • 34 ItemFilter property (Sample Viewer control) •
Inventory control 192
configuring • 111 ItemIdFilter property (SPC Chart control) • 220
methods • 113
properties • 113 J
selecting multiple rows • 112 Job Attributes button • 281
showing the storage entity status • 112 Job Logoff button • 281
Job Step Dat a Editor control
showing the tree of entities • 112
IsButtonEnabled() method (Button Bar cont rol) • configuring • 125
74 methods • 126
IsButtonMenuItemE nabled() method (c ommon properties • 125
methods ) • 57 Job Step Editor cont rol
IsPartOfBatch() method (Queue control) • 165
deleting records • 125
IsSaveNeeded property (Data Log control) • 94
refres hing records • 125
Item Consumption Editor control
Job Summary control
configuring • 117
configuring • 127
methods • 118
entities, switching • 128
properties • 117

300 Version 6.0

Index MES .NET Controls Developer Guide

methods • 128 Logout button • 283

LogoutCurrentStep() method (Steps control) •
properties • 128
250
using • 127
LogoutEnabled property (Steps control) • 249
JobLogOff() method (Queue control) • 165 Lot Attributes button • 283
LotNo property (Dat a Log control) • 94
K
KPIControlStyle property (OEE KPI control) • M
138
MaxValues property (Data Log control) • 95
KPIType property (OEE KPI control) • 138 MES controls
custom properties • 34
L logging on • 38
LabelFont property (Counts/Duration KPI
control) • 88
LabelFontColor property (Counts/Duration KP I
N
control) • 88 New Row button • 283
Labor Us age Editor control NewRowE nabled property (Data Log cont rol) •
95
configuring • 131
Notes button • 283
methods • 132
NotesEnabled property (Queue control) • 161
properties • 131 NumberOfBars property (Counts/Duration KPI
LanguageStrings property (SPC Chart control) • control) • 89
220 NumberOfPointsFilter property (SPC Chart
Launch Browser button • 281 control) • 222
LaunchBrowser() method (common methods) • NumButtonLines property (Button Bar control) •
57 71
LaunchCurrentStepDocument() method (Steps
control) • 250
LaunchSpcChart() met hod (Sample Viewer
O
control) • 196 objects
LaunchSpcChartEnabled property (Sample viewing from .NE T control • 44
Viewer control) • 192 OEE KPI control
LineAttributeColor property (SPC Chart control) Button Bar control, associating • 134
• 221 entities, switching • 134
Link Jobs button • 282
methods • 141
LoadConfigS ettings() method (Queue control) •
166 properties • 134
Log Out button • 282 using • 134
Login button • 282 OEEKPIFilter.FilterDuration property (OEE KPI
LoginEnabled property (Steps control) • 249 control) • 138
LoginUserID property (common properties) • 54 OEEKPIFilter.FilterEndOffset property (OEE
LoginUserPassword property (common KPI control) • 139
properties) • 54 OEEKPIFilter.FilterStartOffset property (OEE
LogOnEnt Name property (common properties) KPI control) • 139
• 54 OEEKPIFilter.FilterTimeUnit property (OEE KPI
LogOnSite property (common properties) • 54 control) • 139

Version 6.0 301

MES .NET Controls Developer Guide Index

OEEKPIFilter.FilterType property (OEE KPI PopupItemAttrsDlg() method (Queue cont rol) •

control) • 140 168
OEEStatusFilter property (Counts/Duration KPI PopupJobAttrsDlg() method (Queue control) •
control) • 89 168
OnClick() event (Counts/Duration KP I control) • PopupJobBOMDlg() method (Queue control) •
91 168
OnLotNoChanged() method (Steps control) • PopupJobLinksDlg() method (Queue control) •
250 169
OnStepDataE ntered() method (Steps control) • PopupJobSplit Dlg() method (Queue control) •
251 169
OnStepGroupChanged() method (Steps PopupNotesDlg() method (Queue control) • 169
control) • 251 PopupRadioB uttonEntry () method (Steps
OnStepStateChanged() method (Steps control) control) • 252
• 251 PopupStartSomeDlg() method (Queue control)
Open/Launch Form button • 284 • 170
OpenForm() method (common met hods) • 57 PopupTransferS erialNumbersDlg() method
OpenFormEnabled property (Consumption (Queue control) • 170
control) • 80 PreviewB omEnabled property (Queue control) •
OpenFormEnabled property (Genealogy 162
control) • 108 Primary ChartMaxY property (SPC Chart
OperationFilter property (Sample Viewer control) • 225
control) • 193 Primary ChartMinY propery (SP C Chart
OperationIdFilter property (SPC Chart control) • control) • 225
222 Print button • 284
OutOfLimitsPointSymbol property (SPC Chart Print() method (Folders cont rol) • 104
control) • 223 PrintEnabled property (Folders control) • 103
OutOfLimitsPointSymbolSize property (SPC Process button • 285
Chart control) • 224 Process() method (P roduction cont rol) • 146
ProcessDataTy peForSelectedLot() method
(Steps control) • 252
P
ProcessEnabled property (Production control) •
ParseConfigS ettings() method (Queue control)
144
• 166
ProcessIdFilt er property (SPC Chart control) •
Pause Job button • 284
226
PauseJob() met hod (Queue control) • 166
Production control
PauseJobE nabled property (Queue control) •
configuring • 143
162
PlotPrimaryMeasurementValues property (SPC methods • 145
Chart control) • 224 properties • 144
PointsPerPage property (SPC Chart control) • using • 144
225 Production Progress control
PopupAddAssignS erialNumbersDlg() method
entities, switching • 150
(Queue control) • 167
PopupAnalogEnt ry() method (St eps control) • events • 155
251 jobs, switching • 150
PopUpEditSpecDlg() method (S pec control) • logging on • 150
245
properties • 151

302 Version 6.0

Index MES .NET Controls Developer Guide

target values, setting • 151 ReduceCons umption() method (Genealogy

control) • 108
using • 149
ReduceProdEnabled property (Production
ProductionUnitOfMeasure property (Production
control) • 145
Progress control) • 153
ReduceProduction() method (Production
ProjectedP roduction property (Production
control) • 146
Progress control) • 153
Refresh button • 286
PromptForProdQtys() method (Queue control) •
RefreshData() method (common methods ) • 58
171
RefreshDisplay() method (Counts/Duration KPI
properties
control) • 90
binding to attributes or element references • RefreshEnabled property (Audit control) • 64
45
RefreshEnabled property (Route control) • 176
changing • 39 RefreshEnabled property (Spec control) • 244
viewing • 39 RefreshRate property (Sample Viewer control) •
Pull Sample button • 285 193
PullSample() method (Sample Viewer control) • RefreshRate property (SPC Chart control) • 226
197 RejectProduction() method (Production control)
PullSampleE nabled property (Sample Viewer • 147
control) • 193 Rejects button • 286
RejectsEnabled property (Production control) •
145
Q Remove button • 287
Queue control RemoveEnabled property (Dat a Log control) •
Button Bar control, associating • 158 95
configuring • 157 Rename Lot button • 287
entities, switching • 158 Rename Sublot button • 287
RequireEntityLogon property (Sample Viewer
methods • 163
control) • 193
properties • 158 ResetAllowConfiguration() method (B utton Bar
control) • 75
R ResetAllowMultipleSection() method (Inventory
ReadyJob() method (Queue control) • 171 control) • 114
ReadyJobEnabled property (Queue control) • ResetAppendSaveConfigName() method
162 (common methods) • 58
Reas onGroupColors property (Counts/Duration ResetAutoLoginUser() method (common
KPI control) • 89 methods ) • 58
Receive Inventory button • 285 ResetAutoLogonE nt() method (common
Reclassify button • 285 methods ) • 58
ReclassifyConsEnabled property (Genealogy ResetBackColor() method (B utton Bar control) •
control) • 108 75
ReclassifyConsumption() method (Genealogy ResetBatchJobB GCustomColors() method
control) • 108 (Queue control) • 171
Reduce Consumption button • 286 ResetBatchJobColorOptions() met hod (Queue
Reduce Production button • 286 control) • 171
ReduceConsEnabled property (Genealogy ResetButtonB arName() method (common
control) • 108 methods ) • 58

Version 6.0 303

MES .NET Controls Developer Guide Index

ResetButtonSize() met hod (Button Bar control) ResetUs eLargeTreeIcons() method (Folders
• 75 control) • 104
ResetControlInCharge() method (Button Bar ResetUs eLargeTreeIcons() method (Inventory
control) • 75 control) • 104
ResetDefaultButtonBackColor() method (Button ResetUs erButtonExecutionLevel() method
Bar control) • 75 (Button Bar control) • 77
ResetDefaultButtonForeColor() method (B utton ResetVerticalBoundary() method (Button Bar
Bar control) • 75 control) • 77
ResetDis play TitleBar() method (Job Sumary ResetVerticalSeparation() method (Button Bar
control) • 129 control) • 77
ResetDock() method (B utton Bar control) • 75 Rework button • 287
ResetFilters () method (SPC Chart control) • 242 ReworkEnabled property (Steps control) • 249
ResetFiltersEnabled property (SPC Chart Rout e control
control) • 226 configuring • 175
ResetForeColor() method (B utton Bar control) •
methods • 176
76
ResetHeadingFont() method (c ommon properties • 176
methods ) • 58
ResetHorizontalBoundary() method (B utton Bar S
control) • 76 sample points in SPC chart
ResetHorizontalSeparation() method (Button
adding a note to • 209
Bar control) • 76
Reset IgnoreRefreshE vents() method (common assigning a cause to • 208
methods ) • 59 marking as a control move • 210
ResetNumButtonLines() method (Button Bar marking to be ignored in sample
control) • 76 calculations • 210
ResetSaveConfigName() method (common Sample Viewer
methods ) • 59 context, selecting • 180
ResetScrollB uttonBackColor() met hod (Button
logging on to • 178
Bar control) • 76
ResetScrollB uttonForeColor() method (B utton result entries, editing • 183
Bar control) • 76 result entries, processing • 184
ResetScrollB uttonHeight() met hod (Button Bar result entries, verifying • 184
control) • 76 sample, marking as final • 182
ResetScrollB uttonWidth() method (Button Bar
samples, canceling • 185
control) • 76
ResetShowAllControlsButtons() method samples, color-c oding • 187
(Button Bar control) • 77 samples, displaying • 178
ResetShowE ntityTree() method (Inventory samples, editing • 181
control) • 114
samples, filtering • 185
ResetShowStorageStatusGrid() method
samples, pulling • 181
(Inventory control) • 114
ResetSize() method (Button Bar control) • 77 samples, unpulling • 182
ResetSpacerHeight() method (Button Bar SPC Chart, launching • 182
control) • 77 Verify Write option, sample plan • 184
ResetSpacerWidth() method (B utton Bar Sample Viewer control
control) • 77

304 Version 6.0

Index MES .NET Controls Developer Guide

configuring • 177 SegmentRequirementIdFilter property (SPC

Chart control) • 227
events • 196
SegmentRes ponseIdFilter property (SPC Chart
methods • 196
control) • 227
properties • 190 SelectedRowChanged event (S ample Viewer
using • 198 control) • 198
SampleNameFilter property (Sample Viewer SelectRowByKey() met hod (Consumption
control) • 194 control) • 81
Save Row button • 287 SelectRowByKey() met hod (Data Log control) •
SaveConfigName property • 55 97
SaveConfigName property (common SelectRowByKey() met hod (Folders control) •
properties) • 55 104
SaveConfigName property (Entity Usage Editor SelectRowByKey() met hod (Genealogy control)
control) • 100 • 109
SaveConfigName property (Item Cons umption SelectRowByKey() met hod (Inventory control) •
Editor control) • 117 115
SaveConfigName property (Item Production SelectRowByKey() met hod (Job Sumary
Editor control) • 100 control) • 129
SaveConfigName property (Job Step Data SelectRowByKey() met hod (Production control)
Editor control) • 100 • 147
SaveConfigName property (Labor Usage Editor SelectRowByKey() met hod (Queue control) •
control) • 100 172
SaveE nabled property (Data Log control) • 95 SelectRowByKey() met hod (Sample Viewer
SaveRows() method (Data Log control) • 97 control) • 197
Scrap button • 288 SelectRowByKey(Int32,String) method (Spec
scripts control) • 245
control events • 34 SelectRowByKey(Int32,String,Boolean) method
ScrollButtonBackColor property (Button Bar (Spec control) • 245
control) • 72 SerializeConfigSettings() method (Queue
ScrollButtonForeColor property (Button Bar control) • 172
control) • 72 Set Lot Data button • 288
ScrollButtonHeight property (Button Bar control) Set Past Reason button • 288
• 72 Set Reason button • 288
ScrollButtonWidth property (Button Bar control) SetButtonColor() method (Button Bar control) •
• 72 77
SecondaryChartMaxY property (SPC Chart SetCurrentConsLot Data() met hod
control) • 226 (Consumption control) • 81
SecondaryChartMinY property (SPC Chart SetEntityTreeFilter() method (Inventory control)
control) • 226 • 114
SecondZoneColor property (OEE KPI control) • SetFilterColumns() met hod (Queue control) •
140 172
SecondZoneColor property (Production SetGraphicSite() method • 59
Progress control) • 153 SetGroupByColumns() met hod (Queue control)
SecondZoneCutOff property (OEE KPI control) • 173
• 140 SetInventoryFilter() met hod (Inventory control) •
SecondZonePercent property (Production 115
Progress control) • 153 SetLotData() method (Production control) • 147

Version 6.0 305

MES .NET Controls Developer Guide Index

SetLotData() method (Steps control) • 252 ShowRes ultValues property (SPC Chart
SetLotDataEnabled property (Consumption control) • 232
control) • 81 ShowS ampleSizes property (SPC Chart
SetLotDataEnabled property (Production control) • 233
control) • 145 ShowS econdary Chart property (SPC Chart
SetLotDataEnabled property (Steps control) • control) • 233
249 ShowS econdary Histogram property (SP C Chart
SetPastReason() method (Utilization control) • control) • 234
270 ShowTable property (SPC Chart control) • 235
SetPastReasonEnabled property (Utilization ShowTimes property (SPC Chart control) • 235
control) • 264 ShowWOFlowDiagram() method (Queue
SetReas on() method (Utilization control) • 270 control) • 173
SetReas onEnabled property (Utilization control) ShowZones property (SPC Chart control) • 236
• 264 Signoff() method (Audit cont rol) • 64
SetSortColumns () method (Queue control) • SiteNameFilter property (SPC Chart control) •
173 236
Show List button • 289 Size property (Button Bar control) • 73
Show_BOMStep_Filter_Dialog() method SpacerHeight property (Button Bar control) • 73
(Consumption control) • 81 SpacerWidth property (Button Bar cont rol) • 73
ShowAlarmIndicators property (SPC Chart SpareNFilter properties (SPC Chart control) •
control) • 227 237
ShowAllControlB uttons property (Button Bar SPC Chart
control) • 72 cause, assigning to a sample point • 208
ShowCalculatedV alues property (SPC Chart
chart types • 202
control) • 228
ShowControlMove property (SPC Chart control) colored zones for standard deviations • 236
• 229 control rule violations, displaying • 203
ShowCpkValues property (SPC Chart control) • data, displaying • 201
229 data, retrieving • 200
ShowCpV alues property (SPC Chart control) •
hiding and showing areas • 206
229
ShowIgnoreS ample property (SPC Chart note, adding to a sample point • 209
control) • 230 sample point, marking as a control move •
ShowListEnabled property (Steps control) • 249 210
ShowNot esIndicators property (SPC Chart sample point, marking to be ignored in
control) • 230 sample calculations • 210
ShowOperat orsOnThisStep() method (Steps zooming on • 207
control) • 252
SPC Chart button • 289
ShowP pkValues property (SPC Chart control) •
SPC Chart control
231
methods • 241
ShowP pValues property (SPC Chart control) •
231 properties • 211
ShowP rimaryChart property (SPC Chart runtime interaction • 205
control) • 231 using • 200
ShowP rimaryHistogram property (SPC Chart SpcChartEnabled property (Sample Viewer
control) • 232 control) • 194
Spec control

306 Version 6.0

Index MES .NET Controls Developer Guide

configuring • 243
methods • 245 T
properties • 243 TableAlarmEmphasis property (SPC Chart
Split Job button • 289 control) • 237
Split Lot button • 289 TableB ackgroundColor property (SPC Chart
split utilization control) • 238
deleting after • 261 TableStripeColor properties (SPC Chart control)
• 238
deleting before • 261
TargetBarColor property (Production Progress
splitting after • 261 control) • 153
splitting before • 261 TargetQuantity property (Production Progress
Start Job button • 290 control) • 154
Start Some button • 290 TargetQuantityChanged event (Production
StartDEJob() method (Utilization cont rol) • 270 Progress control) • 156
StartDEJobE nabled property (Utilization TargetRate property (Production Progress
control) • 264 control) • 154
StartDEJobP rodRat eFieldVisible property TargetRateChanged event (Production
(Utilization cont rol) • 265 Progress control) • 156
StartDEJobUOMFieldVisible property TargetRateFromDB property (Production
(Utilization cont rol) • 265 Progress control) • 154
StartJob() method (Queue control) • 173 TargetUnreachable property (Production
StartJobEnabled property (Queue control) • 163 Progress control) • 154
StartSomeEnabled property (Queue control) • TargetValue property (OEE KPI control) • 140
163 ThirdZoneColor property (OEE KPI control) •
StartTimeFilter property (Sample Viewer 141
control) • 194 ThirdZoneColor property (Production Progress
StartTimeFilter property (SPC Chart control) • control) • 155
237 Toggle Chart button • 291
StatusChanged event (S ample Viewer cont rol) • Toggle Sample Final Flag button • 291
198 ToggleChartEnabled property (Data Log
StatusFilter property (Sample Viewer control) • control) • 96
194 ToggleFinalFlag() method (Sample Viewer
StepBypass() method (Steps control) • 252 control) • 197
StepComplet e() method (Steps control) • 253 ToggleSampleFinalFlagEnabled property
StepLogin() method (Steps control) • 253 (Sample Viewer cont rol) • 195
StepNo property (Data Log control) • 95 Trans fer In button • 291
Steps control Trans fer Out button • 291
configuring • 247 Trans fer Serial Number button • 292
methods • 250 Trans ferSerialNumbers() method (Production
control) • 147
properties • 248
Trans ferSerialNumbersEnabled property
storage entity status • 112
(Production cont rol) • 145
SublotNo property (Data Log control) • 95
Translat eColumnHeadings() method (common
Switch User button • 290
methods ) • 59
SwitchUser() method (common methods) • 59
symbols, referencing .NE T cont rols • 44

Version 6.0 307

MES .NET Controls Developer Guide Index

UtilizationFilter.FilterMinDuration property
(Utilization cont rol) • 266
U UtilizationFilter.FilterStartOffset property
UnPull Sample button • 292
(Utilization cont rol) • 266
UnpullSampleEnabled property (Sample
UtilizationFilter.FilterTime property (Utilization
Viewer control) • 195
control) • 267
UnregisterControl() met hod (B utton Bar control)
UtilizationFilter. UtilFilterUnAck property
• 78
(Utilization cont rol) • 267
Update Job Spec. Values button • 292
UtilizationFilter. UtilStatusFilter property
Update Template Spec. Values button • 292
(Utilization cont rol) • 267
UpdateDisplay() method (Counts/Duration KP I
UtilizationFilter. UtilTimeFilterType property
control) • 90
(Utilization cont rol) • 268
UpdateJobSpecsEnabled property (Spec
UtilizationSplit() method (Utilization control) •
control) • 244
270
UpdateSpecValues() method (S pec control) •
UtilizationSplitEnabled property (Utilization
246
control) • 268
UpdateTemplat eSpecsEnabled property (Spec
UtilRefreshEnabled property (Utilization control)
control) • 244
• 265
UseLargeTreeIcons property (Folders control) •
103
UserButtonExecutionLevel property (Button Bar V
control) • 73 ValidEntityFilter() method (Sample Viewer
UserFilter property (Sample Viewer control) • control) • 198
195 ValueFont property (Counts/Duration KPI
UserId property (SPC Chart control) • 239 control) • 89
Utilization control ValueFontColor property (Counts/Duration KPI
Button Bar control, associating • 257 control) • 90
ValueLegendLabelFont property (Production
configuring • 255
Progress control) • 155
entities, switching • 257
ValueLegendValueBackColor property
events, splitting • 261 (Production Progress control) • 155
filtering records • 258 ValueLegendValueColor property (Production
methods • 268 Progress control) • 155
ValueLegendValueFont property (Production
properties • 263
Progress control) • 155
reasons, mutliple selections • 259 VerticalBoundary property (Button Bar control) •
split functionality, configuring • 259 73
split functionality, using • 261 VerticalSeparation property (Button Bar control)
• 74
using • 256
Utilization Split button • 293 View button • 293
View Flow Diagram button • 293
UtilizationFilter.FilterEndOffset property
View Item Attributes button • 293
(Utilization cont rol) • 265
UtilizationFilter.FilterLastNE vents property View() method (Folders control) • 105
ViewEnabled property (Folders cont rol) • 103
(Utilization cont rol) • 266
ViewEnabled property (Steps control) • 249
UtilizationFilter.FilterLastNHours property
(Utilization cont rol) • 266 ViewItemAttribut esEnabled property
(Production cont rol) • 145

308 Version 6.0

Index MES .NET Controls Developer Guide

ViewSpecDocumentEnabled property (Spec

control) • 244

W
Waste button • 294
WorkOrderFilter to filter (Sample Viewer
control) • 195
WorkOrderIdFilt er property (SPC Chart control)
• 239

X
XAxisLabel property (SPC Chart control) • 239
XAxisLabelRotation property (SPC Chart
control) • 240
Xceed.Grid.RowSelectedJobSpecGroupRow
property (Spec control) • 244

Version 6.0 309