FactoryTalk Batch Technical Reference Guide - Literature Library

FactoryTalk Batch Technical Reference Guide - Literature Library
INTEGRATED PRODUCTION & PERFORMANCE SUITE
Production Management
Batch
TECHNICAL REFERENCE GUIDE
VOLUME 2
PUBLICATION BATCH-RM211B-EN-P–November 2014
Supersedes Publication BATCH-RM211A-EN-E
Contact Rockwell
Customer Support Telephone — 1.440.646.3434
Online Support — http://www.rockwellautomation.com/support/
Copyright Notice
В© 2014 Rockwell Automation, Inc. All rights reserved. Printed in USA.
This document and any accompanying Rockwell Software products are copyrighted by Rockwell
Automation, Inc. Any reproduction and/or distribution without prior written consent from Rockwell
Automation, Inc. is strictly prohibited. Please refer to the license agreement for details.
Trademark Notices
FactoryTalk, Rockwell Automation, Rockwell Software, RSBizWare, and RSBizWare MaterialTrack are
trademarks of Rockwell Automation, Inc.
Any Rockwell Automation software or hardware not mentioned here is also a trademark, registered or
otherwise, of Rockwell Automation, Inc.
Other Trademarks
Warranty
ActiveX, Microsoft, Microsoft Access, SQL Server, Visual Basic, Visual C++, Visual SourceSafe,
Windows, Windows Server-, Windows XP and Windows 7 are either registered trademarks or
trademarks of Microsoft Corporation in the United States and/or other countries.
Adobe, Acrobat, and Reader are either registered trademarks or trademarks of Adobe Systems
Incorporated in the United States and/or other countries.
All other trademarks are the property of their respective holders and are hereby acknowledged.
This product is warranted in accordance with the product license. The product’s performance may be
affected by system configuration, the application being performed, operator control, maintenance, and
other related factors. Rockwell Automation is not responsible for these intervening factors. The
instructions in this document do not cover all the details or variations in the equipment, procedure, or
process described, nor do they provide directions for meeting every possible contingency during
installation, operation, or maintenance. This product’s implementation may vary among users.
This document is current as of the time of release of the product; however, the accompanying software
may have changed since the release. Rockwell Automation, Inc. reserves the right to change any
information contained in this document or the software at anytime without prior notice. It is your
responsibility to obtain the most current information available from Rockwell when installing or using
this product.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Table of Contents
ActiveX Controls
Library Reference
Chapter 1
Introducing the FactoryTalk
Batch ActiveX Controls
Document organization ...................................................................................... 17
Introducing the ActiveX Controls Library ...................................................... 17
Properties, methods and events .......................................................................... 18
ControlRecipeList control .................................................................................. 18
PromptsList control ............................................................................................. 19
SignatureList control ........................................................................................... 20
ProcedureView control ........................................................................................ 21
TimerView control ............................................................................................... 22
Available events ..................................................................................................... 22
Available methods ................................................................................................ 23
Available properties .............................................................................................. 25
Chapter 2
Methods
AbortControlRecipe ............................................................................................ 37
Acknowledge ......................................................................................................... 37
AcknowledgeUI .................................................................................................... 38
ActionIDIsValid ................................................................................................... 39
ActionUI ................................................................................................................ 39
BindUI .................................................................................................................... 40
ClearFailuresOnControl Recipe........................................................................ 41
CommandControlRecipe ................................................................................... 41
CommandCurrentStep ....................................................................................... 43
CommentControlRecipe .................................................................................... 43
CommentSelectedControl RecipeUI ............................................................... 44
CommentUI .......................................................................................................... 44
CreateControlRecipe........................................................................................... 45
DisplayCurrentStep ............................................................................................. 45
DisplayParentStep ................................................................................................ 46
Execute.................................................................................................................... 47
FitToWindow ....................................................................................................... 47
GetColumnText ................................................................................................... 48
GetColumnWidth ............................................................................................... 48
GetFilterPattern.................................................................................................... 49
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
GetItem .................................................................................................................. 50
GetShowColumn.................................................................................................. 51
HideColumn ......................................................................................................... 51
HoldControlRecipe ............................................................................................. 52
Login ....................................................................................................................... 53
LoginUI .................................................................................................................. 53
PauseControlRecipe............................................................................................. 54
PromptIDIsValid .................................................................................................. 54
Refresh .................................................................................................................... 55
RefreshSecurityToken ......................................................................................... 55
RemoveControlRecipe ........................................................................................ 56
RestartControlRecipe .......................................................................................... 56
ResumeControlRecipe......................................................................................... 57
SelectControlRecipe ............................................................................................ 58
SelectPrompt ......................................................................................................... 58
SelectSignature ...................................................................................................... 59
SetColumnText .................................................................................................... 59
SetColumnWidth................................................................................................. 60
SetControlRecipeMode ...................................................................................... 61
SetFilterPattern ..................................................................................................... 61
SetShowColumn ................................................................................................... 63
ShowAboutBox ..................................................................................................... 63
ShowColumn ........................................................................................................ 64
ShowPropertiesDialog ......................................................................................... 64
SignatureIDIsValid .............................................................................................. 65
SignatureUI ........................................................................................................... 65
SignoffIsValid ........................................................................................................ 66
StartControlRecipe .............................................................................................. 67
StepChangeCancel ............................................................................................... 67
StepChangeCommit ............................................................................................ 68
StepChangeStart ................................................................................................... 68
StopControlRecipe .............................................................................................. 69
Chapter 3
Properties
ActionIDColumnText ........................................................................................ 71
ActionIDColumnWidth .................................................................................... 72
ActionIDFilterPattern......................................................................................... 72
ActionIDShowColumn....................................................................................... 73
ActiveUnit ............................................................................................................. 74
ActiveUnitProcedure Number .......................................................................... 75
Appearance ............................................................................................................ 76
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
AreaColumnText ................................................................................................. 77
AreaColumnWidth.............................................................................................. 77
AreaFilterPattern .................................................................................................. 78
Arrange ................................................................................................................... 79
AutoArrange.......................................................................................................... 80
AutoSizeColumns ................................................................................................ 81
BackColor .............................................................................................................. 82
BatchIDColumnText .......................................................................................... 83
BatchIDColumnWidth ...................................................................................... 83
BatchIDEditable ................................................................................................... 84
BatchIDFilterPattern........................................................................................... 85
BatchIDShowColumn......................................................................................... 86
BatchVersionCompatible ................................................................................... 87
BorderStyle ............................................................................................................ 87
CallTimeout .......................................................................................................... 88
CanAbort ............................................................................................................... 89
CanAcknowledge.................................................................................................. 90
CanBind ................................................................................................................. 91
CanBindAcknowledge......................................................................................... 92
CanChangeActiveStep ........................................................................................ 93
CanClearFailures .................................................................................................. 94
CanComment ....................................................................................................... 95
CanCreateControlRecipe ................................................................................... 96
CanDisconnect ..................................................................................................... 97
CanHold ................................................................................................................ 98
CanPause ................................................................................................................ 99
CanRemove ......................................................................................................... 100
CanRestart ........................................................................................................... 101
CanResume .......................................................................................................... 102
CanSetAutomatic ............................................................................................... 103
CanSetManual .................................................................................................... 104
CanSetSemiAuto ................................................................................................ 105
CanStart ............................................................................................................... 106
CanStop................................................................................................................ 107
ChartDrawWidth .............................................................................................. 108
ChartFont ............................................................................................................ 109
ChartFontBold ................................................................................................... 110
ChartFontItalic ................................................................................................... 110
ChartFontName ................................................................................................. 111
ChartFontSize ..................................................................................................... 112
ChartFontStrikethru ......................................................................................... 112
ChartFontUnderline ......................................................................................... 113
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
CommunicationStatus ...................................................................................... 114
Connection .......................................................................................................... 115
ConnectTimeout ................................................................................................ 116
ControlRecipes ................................................................................................... 117
CreateIDColumnText ...................................................................................... 118
CreateIDColumnWidth ................................................................................... 119
CreateIDFilterPattern ....................................................................................... 119
CurrentProcedureAbstract ............................................................................... 121
CurrentProcedureAuthor ................................................................................. 121
CurrentProcedureDate...................................................................................... 122
CurrentProcedure Description ........................................................................ 122
CurrentProcedureID ......................................................................................... 123
CurrentProcedureProduct Code ..................................................................... 123
CurrentProcedureVersion ................................................................................ 124
DefaultBatchID .................................................................................................. 124
DefaultScale ......................................................................................................... 125
DescriptionColumnText .................................................................................. 126
DescriptionColumnWidth............................................................................... 127
DescriptionFilterPattern ................................................................................... 127
DialogFontBold .................................................................................................. 129
DialogFontItalic.................................................................................................. 129
DialogFontName ................................................................................................ 130
DialogFontSize .................................................................................................... 130
DialogFontStrikethru ........................................................................................ 131
DialogFontUnderline ........................................................................................ 132
DisplayedParameters .......................................................................................... 133
DisplayLimits ...................................................................................................... 133
DisplayNonIncomplete ..................................................................................... 134
Domains ............................................................................................................... 135
DoubleClickNavigation .................................................................................... 135
ElapsedTimeColumnText ................................................................................ 136
ElapsedTimeColumnWidth ............................................................................ 136
ElapsedTimeFilterPattern ................................................................................. 137
Enabled ................................................................................................................. 138
EUColumnText.................................................................................................. 139
EUColumnWidth .............................................................................................. 140
EUFilterPattern .................................................................................................. 140
FailureColumnText ........................................................................................... 141
FailureColumnWidth........................................................................................ 142
FailureFilterPattern ............................................................................................ 143
FilteredControlRecipeCount........................................................................... 144
FilteredPromptCount........................................................................................ 145
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
FilterOnBatchID ................................................................................................ 145
FilterOnRecipePath ........................................................................................... 146
FilterOnUnitName ............................................................................................ 146
FilterPattern ........................................................................................................ 147
Font ....................................................................................................................... 148
ForeColor ............................................................................................................. 148
HideColumnHeaders ........................................................................................ 149
IncompleteSignatureCount .............................................................................. 150
Interval.................................................................................................................. 151
InvocationProgID .............................................................................................. 151
IsFiltered............................................................................................................... 152
LabelWrap ........................................................................................................... 153
ListSeparator........................................................................................................ 154
MatchBackColor ................................................................................................ 154
MatchFont ........................................................................................................... 155
MatchForeColor ................................................................................................. 156
ModeColumnText ............................................................................................. 157
ModeColumnWidth ......................................................................................... 158
ModeFilterPattern.............................................................................................. 158
MouseIcon ........................................................................................................... 159
MousePointer ...................................................................................................... 160
Node...................................................................................................................... 162
PersistLogins ........................................................................................................ 162
PhaseColumnText.............................................................................................. 163
PhaseColumnWidth .......................................................................................... 164
PhaseFilterPattern .............................................................................................. 164
PhasesColumnText ............................................................................................ 165
PhasesColumnWidth ........................................................................................ 166
PhasesFilterPattern............................................................................................. 167
ProcedureIDColumnText ................................................................................ 168
ProcedureIDColumnWidth ............................................................................ 169
ProcedureIDFilterPattern ................................................................................. 169
ProcedureIDShowColumn............................................................................... 170
ProcessCellColumnText ................................................................................... 171
ProcessCellColumnWidth ............................................................................... 172
ProcessCellFilterPattern ................................................................................... 172
PromptIDColumnText..................................................................................... 173
PromptIDColumnWidth ................................................................................. 174
PromptIDFilterPattern ..................................................................................... 175
Prompts ................................................................................................................ 176
PromptTypeColumnText ................................................................................ 177
PromptTypeColumnWidth ............................................................................. 177
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
PromptTypeFilterPattern ................................................................................. 178
RecipeColumnText ............................................................................................ 179
RecipeColumnWidth ........................................................................................ 180
RecipeFilterPattern ............................................................................................ 181
RetryPeriod .......................................................................................................... 182
SecurityApplicationID ...................................................................................... 182
SecurityEnabled .................................................................................................. 183
SelectedControlRecipe ...................................................................................... 183
SelectedPrompt ................................................................................................... 187
SelectedSignature ................................................................................................ 189
SelectedStepBatchID ......................................................................................... 195
SelectedStepClass ............................................................................................... 195
SelectedStepCommandSet................................................................................ 196
SelectedStepControl .......................................................................................... 197
SelectedStepEquipment Name......................................................................... 197
SelectedStepEquipment Path ........................................................................... 198
SelectedStepFailure ............................................................................................ 199
SelectedStepID .................................................................................................... 199
SelectedStepIndex ............................................................................................... 200
SelectedStepIsFailed ........................................................................................... 201
SelectedStepKeyName ....................................................................................... 201
SelectedStepKeyVal ............................................................................................ 202
SelectedStepMessage .......................................................................................... 203
SelectedStepMode .............................................................................................. 203
SelectedStepName .............................................................................................. 204
SelectedStepParallelism ..................................................................................... 204
SelectedStepParameters ..................................................................................... 205
SelectedStepParameters2 ................................................................................... 206
SelectedStepReports ........................................................................................... 207
SelectedStepReports2 ........................................................................................ 208
SelectedStepRequest........................................................................................... 208
SelectedStepResourceID ................................................................................... 209
SelectedStepState ................................................................................................ 210
SelectedStepStateNum ...................................................................................... 211
SelectedStepString#............................................................................................ 212
SelectedStepType................................................................................................ 212
SelectedStepUnit ................................................................................................ 213
SelectedTransition Acquiring .......................................................................... 214
SelectedTransition Condition ......................................................................... 215
SelectedTransition Evaluation ......................................................................... 215
SelectedTransitionFailure ................................................................................. 216
SelectedTransitionState..................................................................................... 217
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
SelectedTransitionState Num .......................................................................... 217
ShowConditions ................................................................................................. 218
ShowCustomMenuItems .................................................................................. 219
ShowDisconnectedMessage .............................................................................. 220
ShowElapsedTime .............................................................................................. 221
ShowFilter ............................................................................................................ 221
ShowMenu ........................................................................................................... 222
ShowRecipeLimits .............................................................................................. 222
ShowRemainingTime ........................................................................................ 223
ShowReportLimits ............................................................................................. 224
ShowSetPoint ...................................................................................................... 224
ShowState............................................................................................................. 225
ShowStatusBar .................................................................................................... 225
ShowStepIndices ................................................................................................. 226
ShowStepInstance .............................................................................................. 227
ShowType ............................................................................................................ 227
ShowUnit ............................................................................................................. 228
ShowUnitsOfTime ............................................................................................ 228
SignatureContextColumn Text....................................................................... 229
SignatureContextColumn Width ................................................................... 230
SignatureContextFilter Pattern ....................................................................... 230
SignatureContextShow Column ..................................................................... 232
Signatures ............................................................................................................. 232
SignoffMeaningColumn Text .......................................................................... 233
SignoffMeaningColumn Width ...................................................................... 233
SignoffMeaningFilter Pattern .......................................................................... 234
SignoffMeaningShow Column ........................................................................ 235
SignoffSecurityColumnText ............................................................................ 236
SignoffSecurityColumn Width........................................................................ 236
SignoffSecurityFilter Pattern ............................................................................ 237
SignoffSecurityShow Column .......................................................................... 238
Sorted .................................................................................................................... 239
SortKey ................................................................................................................. 240
SortOrder ............................................................................................................. 240
StartTimeColumnText ..................................................................................... 241
StartTimeColumnWidth ................................................................................. 242
StartTimeFilterPattern ...................................................................................... 243
StateColumnText ............................................................................................... 244
StateColumnWidth ........................................................................................... 245
StateFilterPattern ............................................................................................... 246
StateShowColumn ............................................................................................. 247
TextFont .............................................................................................................. 248
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
TimeColumnText .............................................................................................. 248
TimeColumnWidth .......................................................................................... 249
TimeFilterPattern............................................................................................... 250
TimeOutPeriod .................................................................................................. 251
TimeShowColumn ............................................................................................ 252
TopProcedureID ................................................................................................ 253
TypeColumnText .............................................................................................. 254
TypeColumnWidth ........................................................................................... 255
TypeFilterPattern ............................................................................................... 255
TypeShowColumn ............................................................................................. 257
UnitColumnText ............................................................................................... 257
UnitColumnWidth ........................................................................................... 258
UnitFilterPattern................................................................................................ 258
UnitsColumnText ............................................................................................. 260
UnitsColumnWidth .......................................................................................... 260
UnitsFilterPattern .............................................................................................. 261
UseExternalBatchSec ......................................................................................... 262
User ....................................................................................................................... 262
UserContext ........................................................................................................ 263
ValueColumnText ............................................................................................. 263
ValueColumnWidth .......................................................................................... 264
ValueFilterPattern .............................................................................................. 265
View ...................................................................................................................... 266
Visible ................................................................................................................... 267
Zoom..................................................................................................................... 268
Chapter 4
Events
ActiveStepChangeBegin.................................................................................... 269
ActiveStepChangeEnd ...................................................................................... 269
Change .................................................................................................................. 270
Click ...................................................................................................................... 271
CommunicationStatus Change ....................................................................... 271
DblClick ............................................................................................................... 272
DblClickControlRecipe .................................................................................... 272
InitDblClick ........................................................................................................ 273
KeyDown ............................................................................................................. 273
KeyPress................................................................................................................ 274
KeyUp ................................................................................................................... 275
MouseDown ........................................................................................................ 275
MouseMove ......................................................................................................... 276
MouseUp.............................................................................................................. 277
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
NewCurrentProcedure ...................................................................................... 278
NewTopProcedure ............................................................................................. 279
OnIncompleteSignature CountChange......................................................... 279
OnSelChange ...................................................................................................... 280
OnSignatureUpdate ........................................................................................... 281
OnUpdate ............................................................................................................ 281
SimpleOnSelChange .......................................................................................... 282
StepClick .............................................................................................................. 282
StepDblClick ....................................................................................................... 283
TransitionClick .................................................................................................. 284
TransitionDblClick ........................................................................................... 284
Chapter 5
Enumerations
ControlRecipeList Command Enumerations ............................................... 287
ControlRecipeMode Enumerations................................................................ 287
EquipmentTypes Enumerations ...................................................................... 287
ParamDataType Enumerations ....................................................................... 288
ParamResponseType Enumerations ............................................................... 288
ProcedureView BorderStyle Enumerations ................................................... 288
ProcedureView Command Enumerations ..................................................... 288
ProcedureView Parallelism Enumerations ..................................................... 289
ProcedureView States Enumerations .............................................................. 289
ProcedureView View Enumerations ............................................................... 289
SignatureList CommentControls Enumerations ......................................... 290
SignatureList DeviationTypes Enumerations ............................................... 290
SignatureList SignatureStates Enumerations ................................................ 290
SignatureList SignatureTypes Enumerations ................................................ 290
SignatureList SignoffStates Enumerations..................................................... 291
Appendix A
Creating an ActiveX control
application
ActiveX controls example interface................................................................. 293
ControlRecipeList control ................................................................................ 293
PromptsList Control.......................................................................................... 294
ProcedureView Control .................................................................................... 294
SignatureList Control ........................................................................................ 295
TimerView Control ........................................................................................... 296
Configuring TimerView properties ......................................................... 296
Using Properties, Methods and Events........................................................... 298
ControlRecipeList ....................................................................................... 299
PromptsList .................................................................................................. 299
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
ProcedureView ............................................................................................. 299
SignatureList................................................................................................. 300
Toolbar Command Buttons ...................................................................... 300
Toolbar Mode Buttons ............................................................................... 302
Appendix B
Default Column Labels
ControlRecipeList .............................................................................................. 305
PromptsList ......................................................................................................... 305
ProcedureView .................................................................................................... 306
SignatureList ........................................................................................................ 306
TimerViewList .................................................................................................... 306
PC-Based Phase Programmer’s
Technical Reference
Chapter 1
Introducing PC-based phases
Document organization .................................................................................... 311
PC-based phase overview .................................................................................. 311
PC-based phases .................................................................................................. 312
Execution of a PC-based phase.................................................................. 313
Chapter 2
Creating a PC-based phase
Adding the phase execution control to a Visual Basic project .................... 315
Placing the phase execution control on a form....................................... 315
Setting the PC-based phase properties .................................................... 316
Programming the PC-based phase............................................................ 317
Methods ........................................................................................................ 317
Events............................................................................................................. 318
Creating the executable .............................................................................. 319
Adding the phase execution control to a Visual C++ project .................... 319
Creating a new project ................................................................................ 319
Adding the control to the project ............................................................. 319
Adding the control to the dialog............................................................... 319
Accessing control properties from Visual C++ ..................................... 320
Configuring the BaseTagName property ................................................ 320
Adding control events................................................................................. 320
Adding a member variable derived from the Phase Control Class ..... 320
Adding phase logic to event handlers ....................................................... 321
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Adding a general usage Signature Request ..................................................... 321
Using parameter and report parameter limits ............................................... 321
Distributing PC-based phase applications ..................................................... 322
Chapter 3
Using a PC-based phase
Updating the area model ................................................................................... 323
Modifying Visual Basic phase instances ................................................... 324
Set tag items to default name ..................................................................... 326
Adding the new phase to a recipe..................................................................... 326
Running a recipe with a PC-based phase ........................................................ 326
Appendix A
Properties, methods, and
events
Properties ............................................................................................................. 329
Summary ....................................................................................................... 329
Descriptions.................................................................................................. 330
Methods................................................................................................................ 334
Summary ....................................................................................................... 334
Descriptions.................................................................................................. 334
Events .................................................................................................................... 336
Appendix B
Application notes and
example phase
Application notes................................................................................................ 337
PC-based phase example.................................................................................... 338
Creating a new PC-based phase ................................................................ 341
FactoryTalk Batch Equipment Editor ..................................................... 341
PC-based phase example ............................................................................ 342
Using limit tags on a PC-based phase ...................................................... 344
PC-based phase limit tag example ............................................................ 345
Index
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
INTEGRATED PRODUCTION & PERFORMANCE SUITE
Production Management
Batch
ACTIVEX CONTROLS LIBRARY REFERENCE GUIDE
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Chapter 1
Introducing the FactoryTalk Batch ActiveX
Controls
This reference guide was developed to provide information and procedural
instructions for the FactoryTalkВ® Batch ActiveX Custom Controls.
Document organization
The following subjects are presented:
•
Introduction to the ActiveX controls
•
Methods, properties, and events
•
Enumerations
•
Creating an application
Important:
Introducing the ActiveX
Controls Library
FactoryTalk Batch 12.0 ActiveX Controls Library requires you to rebuild applications that were built
against earlier versions of the ActiveX Controls Library.
The FactoryTalk Batch ActiveX Controls Library is a set of custom ActiveX
controls that you can use to create a dynamic picture of batch automation system
data and a custom look for your interface. The ActiveX Controls Library is
designed especially for the manufacturing and process control industry.
Configuring the ActiveX controls is accomplished by setting their properties, and
does not require you to write any code.
The ActiveX Controls Library contains five controls that make up the
FactoryTalk Batch View components:
• ControlRecipeList
• PromptsList
• SignatureList
• ProcedureView
• TimerView
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Each control equates to a window in FactoryTalk Batch View.
•
The ControlRecipeList control equates to the Batch List window.
•
The PromptsList control equates to the Unacknowledged Prompts
window.
•
The SignatureList control equates to the Signature List window.
•
The ProcedureView control equates to both the View as SFC and View as
Table windows.
The TimerView control is the exception; it does not equate to a specific window.
It displays all the Timer steps in batches currently on the batch list that satisfy the
filter criteria for the control.
Properties, methods
and events
Properties, methods and events apply to objects. An object is a combination of
code that can be treated as a unit, such as a control, form, or application. Each
object is defined by a class. There are four object classes provided in the
FactoryTalk Batch ActiveX control libraries: ControlRecipeList, PromptsList,
SignatureList, and ProcedureView. Each of these objects has associated
properties, methods and events.
A property is a named attribute of a control, form, application or other object.
Properties define object characteristics such as size, color, and screen location, or
they can define the state of an object (for example: enabled or disabled).
A method is a procedure that acts on an object.
An event is an action recognized by an object (such as clicking the mouse or
pressing a key) for which you can write code to respond. Events can occur as a
result of a user action or program code, or can be triggered by the control.
Properties, methods and events apply to the ActiveX controls. Use these
properties, methods and events to customize the objects created by the ActiveX
controls to meet your needs. The common properties, events and methods for the
ActiveX controls are described in this manual.
ControlRecipeList control
The ControlRecipeList control provides the mechanism to create, command, or
remove a control recipe. The operator can select an existing control recipe from
the control recipe list or create a new control recipe by using the Create Control
Recipe menu option.
Once a control recipe has been created it can be commanded by the operator using
the ControlRecipeList menu.
The control recipe list contains all the created control recipes, but not yet
removed. Information specific to each control recipe is displayed in this control.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Specify what data to display in this list, and configure how it is displayed, using the
control’s properties, methods and events. Items can be arranged into columns with
or without column headings, as well as display accompanying icons and text.
With a ControlRecipeList control, control recipes can be organized into one of
four different views:
•
Large Icons
•
Small Icons
•
List
•
Report
The View property determines which view the control uses to display the items in
the list. The LabelWrap property is used to control whether the labels associated
with listed items wrap to more than one line, as well as managing how items in the
list are sorted.
Use the HideColumnHeaders property to display column headings in the
ControlRecipeList control.
Tip:
PromptsList control
The ControlRecipeList control is part of an ActiveX controls group found in the BATCHV01.OCX file. When
distributing the application, you may install the BATCHV01.OCX file in any directory, as long as the control is
properly registered. (Refer to the MSDN Visual Basic Programmer’s Guide for more information on how to add
ActiveX controls to a Visual Basic project.)
While a control recipe is running, it may occasionally generate messages called
prompts, which require operator input. For instance, the control recipe may
require the operator to enter a value for a parameter or to specify a unit to which a
unit procedure in the control recipe should be bound. The Prompts property
allows access to information regarding each prompt in the list. The Count method
associated with the Prompts property indicates the number of prompts requiring
operator input.
Prompts are removed from the list when they are acknowledged and the control
recipe successfully completes the acknowledgment. To respond, the operator
selects the appropriate prompt. When only one prompt displays in the list, it is
automatically selected.
Entries are made to the event journal when the control recipe generates the
prompt and when acknowledgment is completed successfully. The UserContext
property supplies the operator’s computer name and user ID to the event journal.
Prompts list items can be arranged into columns with or without column headings
as well as display accompanying icons and text.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
With a PromptsList control, prompts can be organized into one of four different
views:
•
Large Icons
•
Small Icons
•
List
•
Report
The View property determines which view the control uses to display the listed
items. The LabelWrap property controls whether the labels associated with items
in the list wrap to more than one line as well as, how items in the list are sorted.
Use the HideColumnHeaders property to display column headings in the
PromptsList control.
Tip:
SignatureList control
The PromptsList control is part of an ActiveX controls group found in the BATCHV01.OCX file. When distributing
the application, you may install the BATCHV01.OCX file in any directory, as long as the control is properly
registered. (Refer to the MSDN Visual Basic Programmer’s Guide for more information on how to add ActiveX
controls to a Visual Basic project.)
While a control recipe is running, it may occasionally generate messages called
signatures which require operator input. For instance, the control recipe may
require the user to enter up to three valid user IDs, passwords and comments
before allowing a command to execute or a batch to start. When a batch or phase
command is attempted that requires a signature, that command will be put into a
pending state, and a signature will be placed on the signature list. When the
signature is validated, the command executes. The exception is the ABORT
command which executes regardless of the signature state. The Signatures
property allows access to information regarding each signature in the list. The
Count method associated with the Signatures property indicates the number of
signatures requiring operator input.
Signatures are removed from the list when the Batch they are associated with is
removed from the Batch List. To respond, select the signature from the Signature
List. When only one signature displays in the list, it is automatically selected.
Entries are made to the event journal when the control recipe generates the
signature, when an acknowledgment completes successfully/unsuccessfully, or the
signature is canceled. The UserContext property supplies the operator’s computer
name and user ID to the event journal.
Use the SignatureList control, sort and filter column names to organize items in
the Signature List. Use the HideColumnHeaders property to hide or display
column headings in the SignatureList control.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Tip:
The SignatureList control is an ActiveX control found in the SignatureListOCX.ocx file. When distributing the
application, you may install the SignatureListOCX.ocx file in any directory, as long as the control is properly
registered. (Refer to the MSDN Visual Basic Programmer’s Guide for more information on how to add ActiveX
controls to a Visual Basic project.)
The ProcedureView control allows the operator to view and navigate a graphical
representation of a control recipe that has been added to the Batch List, from the
highest to the lowest recipe levels. The control also provides the mechanism to
command control recipes, view and edit recipe step properties, perform active step
changes, and perform manual binding.
ProcedureView control
Although the ProcedureView control allows the operator to navigate through
different procedural levels of a control recipe, only one control recipe can be
viewed at a time. In order to view a control recipe, the ProcedureView’s
TopProcedureID property must reference the Create ID of a valid control recipe.
This can be done by setting the TopProcedureID property value to the value of a
control recipe’s CreateID property in the ControlRecipeList control. Once this
property has been set, the procedure can then be viewed at different levels within
the ProcedureView control.
Each recipe step within a procedure has associated properties, including
configured phase parameters and report parameters. These parameters can be
viewed and edited using the Properties dialog box provided with the ActiveX
control. To call the dialog box, use the ShowPropertiesDialog method. When
called, the dialog box displays information associated with the currently selected
recipe step or recipe transition.
With a ProcedureView control, control recipes can be viewed by the operator in
two different views:
•
SFC View
•
Table View
The View property determines which view the control uses to display control
recipes. When the View property is set to the SFC View, the Zoom property is
used to increase or decrease the size of the SFC diagram within the ProcedureView
control’s window. When the View property is set to the Table View, use the
LabelWrap property to control whether the labels associated with items in the
table wrap to more than one line.
Tip:
The ProcedureView control is found in the BATCHV02.OCX file. When distributing the application, you may install the
BATCHV02.OCX file in any directory, as long as the control is properly registered. (Refer to the MSDN Visual Basic
Programmer’s Guide for more information on how to add ActiveX controls to a Visual Basic project.)
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
TimerView control
The TimerView control provides an interface to view all the Timer steps in
batches currently on the batch list. You can configure filter criteria for the
TimerView control. You can also configure the behavior of the TimerView
control through the control’s property pages during design time. During run time
you will have the ability to change the setpoint value for COUNT_DOWN
timers. If enabled, you can also change the filtering of the TimerView ActiveX
control.
Available events
The following table lists each of the events available in the ActiveX Controls
Library.
Event Name
ControlRecipeList
PromptsList SignatureList
ProcedureView
ActiveStepChangeBegin (on page 269)
X
ActiveStepChangeEnd (on page 269)
X
Change (on page 270)
X
Click (on page 271)
X
X
X
CommunicationStatusChange (on page 271)
X
X
DblClick (on page 272)
X
DblClickControlRecipe (on page 272)
X
InitDblClick (on page 273)
X
KeyDown (on page 273)
X
X
X
X
KeyPress (on page 274)
X
X
X
X
KeyUp (on page 275)
X
X
X
X
MouseDown (on page 275)
X
X
X
X
MouseMove (on page 276)
X
X
X
X
MouseUp (on page 277)
X
X
X
X
NewCurrentProcedure (on page 278)
X
NewTopProcedure (on page 279)
X
OnIncompleteSignatureCountChange (on page 279)
OnSelChange (on page 280)
X
X
X
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
X
TimerView
X
Event Name
ControlRecipeList
PromptsList SignatureList
OnSignatureUpdate (on page 281)
ProcedureView
TimerView
X
OnUpdate (on page 281)
X
X
SimpleOnSelChange (on page 282)
X
X
X
StepClick (on page 282)
X
StepDblClick (on page 283)
X
TransitionClick (on page 284)
X
TransitionDblClick (on page 284)
X
The following table lists each of the methods available in the ActiveX Controls
Library.
Available methods
Method Name
ControlRecipeList
AbortControlRecipe (on page 37)
PromptsList SignatureList
ProcedureView
X
Acknowledge (on page 37)
X
AcknowledgeUI (on page 38)
X
ActionIDIsValid (on page 39)
X
ActionUI (on page 39)
X
BindUI (on page 40)
X
ClearFailuresOnControlRecipe (on page 41)
X
CommandControlRecipe (on page 41)
X
CommandCurrentStep (on page 43)
X
CommentControlRecipe (on page 43)
X
CommentSelectedControlRecipeUI (on page 44)
X
CommentUI (on page 44)
X
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
TimerView
Method Name
ControlRecipeList
CreateControlRecipe (on page 45)
PromptsList SignatureList
ProcedureView
TimerView
X
DisplayCurrentStep (on page 45)
X
DisplayParentStep (on page 46)
X
Execute (on page 47)
X
FitToWindow (on page 47)
X
GetColumnText (on page 48)
X
X
X
GetColumnWidth (on page 48)
X
X
X
GetFilterPattern (on page 49)
X
X
X
GetItem (on page 50)
X
GetShowColumn (on page 51)
X
X
X
HideColumn (on page 51)
X
HoldControlRecipe (on page 52)
X
Login (on page 53)
X
X
X
X
X
LoginUI (on page 53)
X
X
X
X
X
PauseControlRecipe (on page 54)
X
PromptIDIsValid (on page 54)
X
Refresh (on page 55)
X
X
RefreshSecurityToken (on page 55)
X
X
RemoveControlRecipe (on page 56)
X
RestartControlRecipe (on page 56)
X
ResumeControlRecipe (on page 57)
X
SelectControlRecipe (on page 58)
X
SelectPrompt (on page 58)
X
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
X
X
X
X
Method Name
ControlRecipeList
PromptsList SignatureList
SelectSignature (on page 59)
ProcedureView
X
SetColumnText (on page 59)
X
X
X
SetColumnWidth (on page 60)
X
X
X
SetControlRecipeMode (on page 61)
X
SetFilterPattern (on page 61)
X
X
X
SetShowColumn (on page 63)
X
ShowAboutBox (on page 63)
X
X
X
X
ShowColumn (on page 64)
X
ShowPropertiesDialog (on page 64)
X
SignatureIDIsValid (on page 65)
X
SignatureUI (on page 65)
X
SignoffIsValid (on page 66)
X
StartControlRecipe (on page 67)
X
StepChangeCancel (on page 67)
X
StepChangeCommit (on page 68)
X
StepChangeStart (on page 68)
X
StopControlRecipe (on page 69)
Available properties
TimerView
X
The following table lists each of the properties available in the ActiveX Controls
Library.
Property Name
ControlRecipeList
PromptsList SignatureList
ActionIDColumnText (on page 71)
X
ActionIDColumnWidth (on page 72)
X
ActionIDFilterPattern (on page 72)
X
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
ProcedureView
TimerView
Property Name
ControlRecipeList
PromptsList SignatureList
ActionIDShowColumn (on page 73)
ProcedureView
X
ActiveUnit (on page 74)
X
ActiveUnitProcedureNumber (on page 75)
X
Appearance (on page 76)
X
X
AreaColumnText (on page 77)
X
AreaColumnWidth (on page 77)
X
AreaFilterPattern (on page 78)
X
Arrange (on page 79)
TimerView
X
X
X
AutoArrange (on page 80)
X
AutoSizeColumns (on page 81)
X
X
X
X
X
BackColor (on page 82)
X
X
X
X
X
BatchIDColumnText (on page 83)
X
X
X
BatchIDColumnWidth (on page 83)
X
X
X
BatchIDFilterPattern (on page 85)
X
X
X
X
BatchIDShowColumn (on page 86)
X
BatchVersionCompatible (on page 87)
X
X
X
X
BorderStyle (on page 87)
X
X
X
X
CallTimeout (on page 88)
X
X
X
X
CanAbort (on page 89)
X
CanAcknowledge (on page 90)
X
X
CanBind (on page 91)
X
CanBindAcknowledge (on page 92)
X
CanChangeActiveStep (on page 93)
CanClearFailures (on page 94)
X
X
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
X
X
Property Name
ControlRecipeList
CanComment (on page 95)
X
CanCreateControlRecipe (on page 96)
X
PromptsList SignatureList
ProcedureView
TimerView
X
CanDisconnect (on page 97)
X
CanHold (on page 98)
X
X
CanPause (on page 99)
X
X
CanRemove (on page 100)
X
CanRestart (on page 101)
X
X
CanResume (on page 102)
X
X
CanSetAutomatic (on page 103)
X
X
CanSetManual (on page 104)
X
X
CanSetSemiAuto (on page 105)
X
X
CanStart (on page 106)
X
X
CanStop (on page 107)
X
X
ChartDrawWidth (on page 108)
X
ChartFont (on page 109)
X
ChartFontBold (on page 110)
X
ChartFontItalic (on page 110)
X
ChartFontName (on page 111)
X
ChartFontSize (on page 112)
X
ChartFontStrikethru (on page 112)
X
ChartFontUnderline (on page 113)
X
CommunicationStatus (on page 114)
X
Connection (on page 115)
X
X
ConnectTimeout (on page 116)
X
X
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
X
X
X
Property Name
ControlRecipeList
ControlRecipes (on page 117)
X
CreateIDColumnText (on page 118)
X
CreateIDColumnWidth (on page 119)
X
CreateIDFilterPattern (on page 119)
X
PromptsList SignatureList
ProcedureView
CurrentProcedureAbstract (on page 121)
X
CurrentProcedureAuthor (on page 121)
X
CurrentProcedureDate (on page 122)
X
CurrentProcedureDescription (on page 122)
X
CurrentProcedureID (on page 123)
X
CurrentProcedureProductCode (on page 123)
X
CurrentProcedureVersion (on page 124)
X
DefaultBatchID (on page 124)
X
DefaultScale (on page 125)
X
DescriptionColumnText (on page 126)
X
X
DescriptionColumnWidth (on page 127)
X
X
DescriptionFilterPattern (on page 127)
X
X
DialogFontBold (on page 129)
X
DialogFontItalic (on page 129)
X
DialogFontName (on page 130)
X
DialogFontSize (on page 130)
X
DialogFontStrikethru (on page 131)
X
DialogFontUnderline (on page 132)
X
DisplayedParameters (on page 133)
X
DisplayLimits (on page 133)
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
X
TimerView
Property Name
ControlRecipeList
PromptsList SignatureList
DisplayNonIncomplete (on page 134)
X
Domains (on page 135)
X
DoubleClickNavigation (on page 135)
ProcedureView
TimerView
X
ElapsedTimeColumnText (on page 136)
X
ElapsedTimeColumnWidth (on page 136)
X
ElapsedTimeFilterPattern (on page 137)
X
Enabled (on page 138)
X
X
EUColumnText (on page 139)
X
EUColumnWidth (on page 140)
X
EUFilterPattern (on page 140)
X
FailureColumnText (on page 141)
X
FailureColumnWidth (on page 142)
X
FailureFilterPattern (on page 143)
X
FilteredControlRecipeCount (on page 144)
X
FilteredPromptCount (on page 145)
X
X
X
FilterOnBatchID (on page 145)
X
FilterOnRecipePath (on page 146)
X
FilterOnUnitName (on page 146)
X
FilterPattern (on page 147)
X
Font (on page 148)
X
X
X
ForeColor (on page 148)
X
X
X
HideColumnHeaders (on page 149)
X
X
X
IncompleteSignatureCount (on page 150)
Interval (on page 151)
X
X
X
X
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
X
X
X
Property Name
ControlRecipeList
InvocationProgID (on page 151)
X
PromptsList SignatureList
X
IsFiltered (on page 152)
ProcedureView
TimerView
X
X
LabelWrap (on page 153)
X
X
ListSeparator (on page 154)
X
X
X
X
MatchBackColor (on page 154)
X
X
X
X
MatchFont (on page 155)
X
X
X
X
MatchForeColor (on page 156)
X
X
X
ModeColumnText (on page 157)
X
ModeColumnWidth (on page 158)
X
ModeFilterPattern (on page 158)
X
MouseIcon (on page 159)
X
X
X
X
MousePointer (on page 160)
X
X
X
X
Node (on page 162)
X
X
X
X
X
PersistLogins (on page 162)
X
X
X
X
PhaseColumnText (on page 163)
X
PhaseColumnWidth (on page 166)
X
PhaseFilterPattern (on page 167)
X
PhasesColumnText (on page 163)
X
PhasesColumnWidth (on page 166)
X
PhasesFilterPattern (on page 167)
X
ProcedureIDColumnText (on page 168)
X
ProcedureIDColumnWidth (on page 169)
X
ProcedureIDFilterPattern (on page 169)
X
ProcedureIDShowColumn (on page 170)
X
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
X
Property Name
ControlRecipeList
PromptsList SignatureList
ProcessCellColumnText (on page 171)
X
X
ProcessCellColumnWidth (on page 172)
X
X
ProcessCellFilterPattern (on page 172)
X
X
PromptIDColumnText (on page 173)
X
PromptIDColumnWidth (on page 174)
X
PromptIDFilterPattern (on page 175)
X
Prompts (on page 176)
X
PromptTypeColumnText (on page 177)
X
PromptTypeColumnWidth (on page 177)
X
PromptTypeFilterPattern (on page 178)
X
RecipeColumnText (on page 179)
X
X
RecipeColumnWidth (on page 180)
X
X
RecipeFilterPattern (on page 181)
X
X
RetryPeriod (on page 182)
X
X
SecurityEnabled (on page 183)
SelectedControlRecipe (on page 183)
SelectedPrompt (on page 187)
X
ProcedureView
X
X
X
X
SelectedSignature (on page 189)
X
SelectedStepBatchID (on page 195)
X
SelectedStepClass (on page 195)
X
SelectedStepCommandSet (on page 196)
X
SelectedStepControl (on page 197)
X
SelectedStepEquipmentName (on page 197)
X
SelectedStepEquipmentPath (on page 198)
X
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
TimerView
X
Property Name
ControlRecipeList
PromptsList SignatureList
ProcedureView
SelectedStepFailure (on page 199)
X
SelectedStepID (on page 199)
X
SelectedStepIndex (on page 200)
X
SelectedStepIsFailed (on page 201)
X
SelectedStepKeyName (on page 201)
X
SelectedStepKeyVal (on page 202)
X
SelectedStepMessage (on page 203)
X
SelectedStepMode (on page 203)
X
SelectedStepName (on page 204)
X
SelectedStepParallelism (on page 204)
X
SelectedStepParameters (on page 205)
X
SelectedStepParameters2 (on page 206)
X
SelectedStepReports (on page 207)
X
SelectedStepReports2 (on page 208)
X
SelectedStepRequest (on page 208)
X
SelectedStepResourceID (on page 209)
X
SelectedStepState (on page 210)
X
SelectedStepStateNum (on page 211)
X
SelectedStepString# (on page 212)
(where # is 1 - 5)
X
SelectedStepType (on page 212)
X
SelectedStepUnit (on page 213)
X
SelectedTransitionAcquiring (on page 214)
X
SelectedTransitionCondition (on page 215)
X
SelectedTransitionEvaluation (on page 215)
X
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
TimerView
Property Name
ControlRecipeList
PromptsList SignatureList
ProcedureView
SelectedTransitionFailure (on page 216)
X
SelectedTransitionState (on page 217)
X
SelectedTransitionStateNum (on page 217)
X
ShowConditions (on page 218)
X
ShowCustomMenuItems (on page 219)
X
X
ShowDisconnectedMessage (on page 220)
TimerView
X
X
ShowElapsedTime (on page 221)
X
ShowFilter (on page 221)
X
ShowMenu (on page 222)
X
X
X
ShowRecipeLimits (on page 222)
X
X
ShowRemainingTime (on page 223)
X
ShowReportLimits (on page 224)
X
ShowSetPoint (on page 224)
X
ShowState (on page 225)
X
ShowStatusBar (on page 225)
X
ShowStepIndices (on page 226)
X
ShowStepInstance (on page 227)
X
ShowType (on page 227)
X
ShowUnit (on page 228)
X
ShowUnitsOfTime (on page 228)
X
SignatureContextColumnText (on page 229)
X
SignatureContextColumnWidth (on page 230)
X
SignatureContextFilterPattern (on page 230)
X
SignatureContextShowColumn (on page 232)
X
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Property Name
ControlRecipeList
PromptsList SignatureList
Signatures (on page 232)
X
SignoffMeaningColumnText (on page 233)
X
SignoffMeaningColumnWidth (on page 233)
X
SignoffMeaningFilterPattern (on page 234)
X
SignoffMeaningShowColumn (on page 235)
X
SignoffSecurityColumnText (on page 236)
X
SignoffSecurityColumnWidth (on page 236)
X
SignoffSecurityFilterPattern (on page 237)
X
SignoffSecurityShowColumn (on page 238)
X
Sorted (on page 239)
X
X
X
SortKey (on page 240)
X
X
X
SortOrder (on page 240)
X
X
X
StartTimeColumnText (on page 241)
X
StartTimeColumnWidth (on page 242)
X
StartTimeFilterPattern (on page 243)
X
StateColumnText (on page 244)
X
X
StateFilterPattern (on page 246)
X
X
StateShowColumn (on page 247)
ProcedureView
TimerView
X
TextFont (on page 248)
X
TimeColumnText (on page 248)
X
X
TimeColumnWidth (on page 249)
X
X
TimeFilterPattern (on page 250)
X
X
TimeOutPeriod (on page 251)
X
X
TimeShowColumn (on page 252)
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
X
X
X
Property Name
ControlRecipeList
PromptsList SignatureList
TopProcedureID (on page 253)
ProcedureView
TimerView
X
TypeColumnText (on page 254)
X
TypeColumnWidth (on page 255)
X
TypeFilterPattern (on page 255)
X
TypeShowColumn (on page 257)
X
UnitColumnText (on page 257)
X
UnitColumnWidth (on page 258)
X
UnitFilterPattern (on page 258)
X
UnitsColumnText (on page 260)
X
UnitsColumnWidth (on page 260)
X
UnitsFilterPattern (on page 261)
X
User (on page 262)
X
X
X
X
X
UserContext (on page 263)
X
X
X
X
X
ValueColumnText (on page 263)
X
ValueColumnWidth (on page 264)
X
ValueFilterPattern (on page 265)
X
View (on page 266)
X
X
Visible (on page 267)
X
X
Zoom (on page 268)
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
X
X
X
X
X
X
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Chapter 2
Methods
A method is a procedure that acts on an object. The following methods are
available with the Batch ActiveX controls.
AbortControlRecipe
Applies To
ControlRecipeList Control
Description
Aborts the indicated control recipe.
Syntax
object.AbortControlRecipe ID
The AbortControlRecipe method syntax has these parts:
Part
Description
object
Object expression that evaluates to an object in the Applies To list.
ID
Required. Integer representing the create ID of the control recipe to abort.
Remarks
If the ID argument identifies a control recipe that does not exist, this method
raises an error.
Acknowledge
Applies To
PromptsList Control
Description
Acknowledges a prompt.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Syntax
[result =] object.Acknowledge ID, value
The Acknowledge method syntax has these parts:
Part
Description
result
Boolean value indicating the success (True) or failure (False) of the Acknowledge method.
object
Object expression that evaluates to an object in the Applies To list.
ID
Prompt ID of the prompt to be acknowledged (of type long).
value
Value with which the prompt is to be acknowledged (a variant).
Remarks
If the prompt is a unit binding, the value supplied should be the unit ID to which
the unit procedure is to be bound, as configured in the Equipment Editor. If the
ID argument identifies a prompt that does not exist or the value argument is of the
wrong type, this method raises an error and result will be False.
AcknowledgeUI
Applies To
PromptsList Control
Description
Displays either the Acknowledge or Binding dialog box, based on the prompt
type identified by the given Prompt ID, allowing the user an opportunity to
acknowledge the prompt.
Syntax
[result =] object.AcknowledgeUI ID
The AcknowledgeUI method syntax has these parts:
Part
Description
result
Boolean value indicating the success (True) or failure (False) of the Acknowledge dialog box’s
display or Binding dialog box (based on the type of the prompt).
object
Object expression that evaluates to an object in the Applies To list.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Part
Description
ID
Prompt ID of the prompt to which the resulting dialog box should be specific (of type long).
Remarks
If the ID argument identifies a prompt that does not exist, no dialog box displays
and result is False.
ActionIDIsValid
Applies To
SignatureList Control
Description
Determines if the given ActionID corresponds to an action with one or more
signatures.
Syntax
[result =] object.ActionIDIsValid ID
The ActionIDIsValid method syntax has these parts:
Part
Description
result
Boolean value indicating if the action is or is not valid.
object
Object expression that evaluates to a SignatureList control.
ID
Action ID to be validated.
Remarks
A value of True indicates that the Action ID corresponds to an action with one or
more signatures. A value of False indicates that it does not.
ActionUI
Applies To
SignatureList Control
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Description
Displays either the Signature dialog box (if the Action ID represents one
signature) or Generated Signatures dialog box (if the Action ID represents more
than one signature) for the given Action ID, or if data for the given Action ID is
not yet available, queues the Action ID for display when the data in the Signature
List control is updated. If data for the given Action ID is not received by the
signature list control within 5 seconds of the method being called, no dialog box
displays.
Syntax
[result =] object.ActionUI ID
The ActionUI method syntax has these parts:
Part
Description
result
Boolean value indicating the display’s success (True) or failure (False) of the signature dialog,
generated signature dialog, or the Action ID queueing for display when the signature list
control data is updated.
object
Object expression that evaluates to a SignatureList control.
ID
Action ID for which a dialog is to be displayed.
Remarks
If the ID argument identifies an action that either does not exist or does not
represent any signatures, no dialog box displays, and result is False.
BindUI
Applies To
ProcedureView Control
Description
Displays the unit binding dialog box.
Syntax
object.BindUI
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
The BindUI method syntax has one part:
ClearFailuresOnControl
Recipe
Part
Description
object
Object expression that evaluates to an object in the Applies To list.
Applies To
ControlRecipeList Control
Description
Clears any failures on the indicated control recipe.
Syntax
object.ClearFailuresOnControlRecipe ID
The ClearFailuresOnControlRecipe method syntax has these parts:
Part
Description
object
Object expression that evaluates to an object in the Applies To list.
ID
Required. Integer representing the control recipe’s create ID to clear failures on (Long).
Remarks
If the ID argument identifies a control recipe that does not exist, this method
raises an error.
CommandControlRecipe
Applies To
ControlRecipeList Control
Description
This method provides a means for sending a command to a control recipe.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Syntax
object.CommandControlRecipe ID, command
The CommandControlRecipe method syntax has these parts:
Part
Description
object
Object expression that evaluates to an object in the Applies To list.
ID
Required. Integer representing the control recipe’s create ID to command (Long).
command
Required. Integer or enumeration specifying the command, as described in Settings.
Settings
The settings for command are:
Enumeration
Value
Description
crCommandCreateControlRecipe 1
4
Create the control recipe.
crCommandStart
24
Start the control recipe.
crCommandRestart
21
Restart the control recipe.
crCommandHold
11
Hold the control recipe.
crCommandAbort
1
Abort the control recipe.
crCommandStop
26
Stop the control recipe.
crCommandResume
22
Resume the control recipe.
crCommandClearFailures
8
Clear failures on the control recipe.
crCommandRemove
17
Remove the control recipe.
28
Add a comment to the control recipe’s electronic batch
record.
14
Pauses the control recipe.
crCommandComment
2
crCommandPause 3
Remarks
If the ID argument identifies a control recipe that does not exist, this method
raises an error. If the currently logged-in user does not have permission to carry out
the command identified by the command argument, the method runs without
error, but has no effect.
While this constant still exists in the control, the command is no longer valid in
conjunction with control recipes. The constant was left in the control to allow for a
smooth upgrade path.
1,2,3
2 While this constant still exists in the control, the command is no longer valid i n conjun ction with control recipes. The co nstant was left in the control to allow for a smooth upgrade path.
3 While this constant still exists in the control, the command is no longer valid i n conjun ction with control recipes. The co nstant was left in the control to allow for a smooth upgrade path.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
CommandCurrentStep
Applies To
ProcedureView Control
Description
Sends a command to the indicated procedure.
Syntax
object.CommandCurrentStep(command As CommandsEnum [, data As String])
The CommandCurrentStep method syntax has these parts:
Part
Description
object
Object expression that evaluates to an object in the Applies To list.
command
Enumeration (integer) that identifies which command to send to the current procedure.
data
String containing arguments specific to the command.
Settings
The members of the ProcedureView Command enumerations constitute the
allowable values for the command argument to this method. (Refer to the section
on “ProcedureView Command Enumerations (on page 288)”.)
Remarks
The second, optional parameter to this method is a string argument that is only
used in combination with pvwcmdBind and pvwcmdComment command values.
For a binding, this optional argument should be the unit ID to which the selected
step is bound. For a comment, this optional argument should be the comment
added to the event journal for the control recipe containing the currently selected
step.
CommentControlRecipe
Applies To
ControlRecipeList Control
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Description
This method provides a means for recording a comment in the selected batch’s
event journal.
Syntax
object.CommentControlRecipe ID, comment
The CommentControlRecipe method syntax has these parts:
CommentSelectedControl
RecipeUI
Part
Description
object
Object expression that evaluates to an object in the Applies To list.
ID
Required. Integer representing the control recipe’s create ID to which the comment is added
(Long).
comment
String representing the comment added to the event journal for the indicated batch.
Applies To
ControlRecipeList Control
Description
Displays a dialog that allows the user to record a comment against one or more
control recipes.
Syntax
object.CommentSelectedControlRecipeUI
The CommentSelectedControlRecipeUI method syntax has one part:
CommentUI
Part
Description
object
Object expression that evaluates to an object in the Applies To list.
Applies To
ProcedureView Control
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Description
Displays the Comment dialog box.
Syntax
object.CommentUI
The CommentUI method syntax has one part:
CreateControlRecipe
Part
Description
object
Object expression that evaluates to an object in the Applies To list.
Applies To
ControlRecipeList Control
Description
Tip:
While the method still exists in the control, the Pause command is no longer supported. The method
was left in the interface to allow for a smooth upgrade path.
Displays the Master Recipe List dialog box, allowing the operator to choose a
master recipe, and proceed to the Create Control Recipe Wizard.
Syntax
[result =] object.CreateControlRecipe
The CreateControlRecipe method syntax has these parts:
DisplayCurrentStep
Part
Description
result
Boolean value indicating if the current user does (True) or does not (False) possess permission
to create a control recipe.
object
Object expression that evaluates to an object in the Applies To list.
Applies To
ProcedureView Control
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Description
Causes the control to depict the procedure corresponding to the currently selected
procedure’s step if a step is selected that does not represent a phase.
Syntax
object.DisplayCurrentStep
The DisplayCurrentStep method syntax has these parts:
Part
Description
object
Object expression that evaluates to an object in the Applies To list.
Remarks
This is the equivalent of double-clicking the currently selected step in the
procedure depicted (Navigate Down). If the currently depicted procedure is an
operation, this method has no effect.
DisplayParentStep
Applies To
ProcedureView Control
Description
Causes the control to depict the procedure that is the parent of the currently
depicted procedure.
Syntax
object.DisplayParentStep
The DisplayParentStep method syntax has these parts:
Part
Description
object
Object expression that evaluates to an object in the Applies To list.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Remarks
This is the equivalent of double-clicking the initial step in the procedure depicted
(Navigate Up). If the currently depicted procedure is a control recipe, this method
has no effect.
Execute
Applies To
ProcedureView Control, TimerView Control
Description
Directly requests the FactoryTalk Batch Server to which the control is specified to
perform the indicated command and returns the string result of that command as
reported by the FactoryTalk Batch Server.
Syntax
[response =] object.Execute command
The Execute method syntax has these parts:
Part
Description
response
Data returned by the FactoryTalk Batch Server as a result of the command executed.
object
Object expression that evaluates to an object in the Applies To list.
command
String identifying the command to execute and any arguments required by that command.
Remarks
The format of the command argument is defined in the FactoryTalk Batch Server
API Communications Language Reference.
FitToWindow
Applies To
ProcedureView Control
Description
Causes the control to adjust the Zoom property value to the maximum that
guarantees the entire procedure is visible (no scrolling required).
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Syntax
object.FitToWindow
The FitToWindow method syntax has these parts:
Part
Description
object
Object expression that evaluates to an object in the Applies To list.
Remarks
The FitToWindow method only applies to the SFC view.
GetColumnText
Applies To
ControlRecipeList Control, PromptsList Control, SignatureList Control
Description
Returns the column header text for the specified column in the control.
Syntax
[result =] object.GetColumnText index
The GetColumnText method syntax has these parts:
Part
Description
result
String that is assigned the column header text of the specified column.
object
Object expression that evaluates to an object in the Applies To list.
index
Required. Integer identifying the column whose header text is returned. Columns are indexed
from left to right, with the first column having an index of one. (See “Default Column Labels (on
page 305)” for more information.)
Remarks
If the index argument is less than one or greater than the number of columns (12),
this method raises an error.
GetColumnWidth
Applies To
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Description
Returns the width of the specified column in the control.
Syntax
[result =] object.GetColumnWidth index
The GetColumnWidth method syntax has these parts:
Part
Description
result
Integer that is assigned the width of the specified column.
object
Object expression that evaluates to an object in the Applies To list.
index
Required. Integer identifying the column whose width is returned. Columns are indexed from
left to right, with the left-most column having an index of one. (See “Default Column Labels
(on page 305)” for more information.)
Remarks
If the index argument is less than one or greater than the number of columns (12),
this method raises an error. Column widths are specified in units of twips 4.
GetFilterPattern
Applies To
ControlRecipeList Control, PromptsList Control, SignatureList Control
Description
Returns the filter pattern for the specified column in the control.
Syntax
[pattern =] object.GetFilterPattern index
The GetFilterPattern method syntax has these parts:
4
Part
Description
pattern
String that is assigned the filter pattern for the specified column.
object
Object expression that evaluates to an object in the Applies To list.
A twip is a unit of measurement implemented as 1/20 of a point or 1/1440 of an inch.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Part
Description
index
Required. Integer identifying the column whose filter pattern is returned. (See “Default
Column Labels (on page 305)” for more information.)
Remarks
This filter shows only control recipes that match all filter patterns in the recipe
list. If you do not want the column to be filtered, leave the default of �*’.
Characters in pattern
Matches in string
?
Any single character.
*
Zero or more characters.
#
Any single digit (0–9).
[charlist]
Any single character in charlist.
[!charlist]
Any single character not in charlist.
A group of one or more characters (charlist) enclosed in brackets ([ ]) can be used
to match any single character in a string and can consist of almost any character
code, including digits.
Tip:
To match the special characters left bracket ( [ ), question mark ( ? ), number sign ( # ), and asterisk ( * ),
enclose them in brackets. The right bracket ( ] ) can’t be used within a group to match itself, but it can be used
outside a group as an individual character.
By using a hyphen (–) to separate the upper and lower bounds of the range,
charlist can specify a range of characters. For example, [A-Z] results in a match if
the corresponding character position in a string contains any uppercase letters in
the range A–Z. Multiple ranges are included within the brackets without
delimiters. If the index argument is less than one or greater than the number of
columns (12), this method raises an error.
GetItem
Applies To
ProcedureView Control, TimerView Control
Description
Allows data retrieval directly from the FactoryTalk Batch Server to which the
control is directed using the FactoryTalk Batch Server API Communications
Language Reference procedures.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Syntax
[response =] object.GetItem itemspec
The GetItem method syntax has these parts:
Part
Description
response
The data returned by the FactoryTalk Batch Server for the requested item.
object
Object expression that evaluates to an object in the Applies To list.
itemspec
String specification of the item to retrieve.
Remarks
The format of the itemspec argument is defined in the FactoryTalk Batch Server
API Communications Language Reference.
GetShowColumn
Applies To
SignatureList Control
Description
Returns the "show column" flag for the specified column.
Syntax
[flag =] object.GetShowColumn index
The GetShowColumn method syntax has these parts:
HideColumn
Part
Description
flag
Boolean value indicating if the specified column is displayed or not.
object
Object expression that evaluates to a SignatureList control.
index
Integer identifying the column whose "show column" flag is returned.
Applies To
ProcedureView Control, TimerView Control
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Description
Hides a column in the Table view indicated by number.
Syntax
object.HideColumn colnumber
The HideColumn method syntax has these parts:
Part
Description
object
Object expression that evaluates to an object in the Applies To list.
colnumber
Integer value representing the number of the column to hide. (See “Default Column Labels (on
page 305)” for more information.)
Remarks
Columns are numbered consecutively from left to right, beginning with zero.
When a column is hidden, its width is effectively set to zero. Hidden columns are
not affected by the AutoSizeColumns property value. To show a column, use the
ShowColumn method. This method applies only to the Table view.
HoldControlRecipe
Applies To
ControlRecipeList Control
Description
Puts the indicated control recipe into hold.
Syntax
object.HoldControlRecipe ID
The HoldControlRecipe method syntax has these parts:
Part
Description
object
Object expression that evaluates to an object in the Applies To list.
ID
Required. Integer representing the create ID of the control recipe to hold.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Remarks
If the ID argument identifies a control recipe that does not exist, this method
raises an error.
Login
Applies To
ControlRecipeList Control, PromptsList Control, ProcedureView Control,
SignatureList Control, TimerView Control
Description
Logs on the specified user.
Syntax
[result =] object.Login (user, password)
The Login method syntax has these parts:
LoginUI
Part
Description
result
Boolean value indicates the success (True) or failure (False) of the log on attempt.
object
Object expression that evaluates to an object in the Applies To list.
user
Required. String representing the user name to log on.
password
Required. String representing the user password to log on.
Applies To
ControlRecipeList Control, PromptsList Control, ProcedureView Control,
SignatureList Control, TimerView Control
Description
Displays the login dialog box in modal fashion, providing the operator with an
opportunity to log on.
Syntax
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
The LoginUI method syntax has these parts:
PauseControlRecipe
Part
Description
result
Boolean value indicates the success (True) or failure (False) of the log on attempt.
object
Object expression that evaluates to an object in the Applies To list.
Applies To
ControlRecipeList Control
Description
Pauses the indicated control recipe.
Tip:
While the method still exists in the control, the Pause command is no longer supported. The method was left
in the interface to allow for a smooth upgrade path.
Syntax
object.PauseControlRecipe ID
The PauseControlRecipe method syntax has these parts:
Part
Description
object
Object expression that evaluates to an object in the Applies To list.
ID
Required. Integer representing the control recipe’s create ID to pause.
Remarks
If the ID argument identifies a control recipe that does not exist, this method
raises an error.
PromptIDIsValid
Applies To
PromptsList Control
Description
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Syntax
[result =] object.PromptIDIsValid ID
The PromptIDIsValid method syntax has these parts:
Refresh
Part
Description
result
Boolean value indicating that the ID does (True) or does not (False) correspond to an existing
prompt.
object
Object expression that evaluates to an object in the Applies To list.
ID
Required. Integer representing the prompt ID of the prompt to be verified as valid.
Applies To
ControlRecipeList Control, PromptsList Control, ProcedureView Control
Description
Forces a complete repaint of a control.
Syntax
object.Refresh
The Refresh method syntax has these parts:
RefreshSecurityToken
Part
Description
object
Object expression that evaluates to an object in the Applies To list.
Applies To
ControlRecipeList Control, PromptsList Control, ProcedureView Control,
SignatureList Control, TimerView Control
Description
Forces the control to use the log on features of the container in which it is hosted.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Syntax
object.RefreshSecurityToken
The RefreshSecurityToken method syntax has these parts:
Part
Description
object
Object expression that evaluates to an object in the Applies To list.
Remarks
If a FactoryTalk Batch ActiveX Control is hosted in FactoryTalk View SE then
this method can be used to synchronize the user logged on to the control with the
user logged on to the FactoryTalk View SE application.
RemoveControlRecipe
Applies To
ControlRecipeList Control
Description
Removes the indicated control recipe.
Syntax
object.RemoveControlRecipe ID
The RemoveControlRecipe method syntax has these parts:
Part
Description
object
Object expression that evaluates to an object in the Applies To list.
ID
Required. Integer representing the control recipe’s create ID to remove.
Remarks
If the ID argument identifies a control recipe that does not exist, this method
raises an error.
RestartControlRecipe
Applies To
ControlRecipeList Control
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Description
Restarts the indicated control recipe.
Syntax
object.RestartControlRecipe ID
The RestartControlRecipe method syntax has these parts:
Part
Description
object
Object expression that evaluates to an object in the Applies To list.
ID
Required. Integer representing the control recipe’s create ID to restart.
Remarks
If the ID argument identifies a control recipe that does not exist, this method
raises an error.
ResumeControlRecipe
Applies To
ControlRecipeList Control
Description
Resumes the indicated control recipe.
Syntax
object.ResumeControlRecipe ID
The ResumeControlRecipe method syntax has these parts:
Part
Description
object
Object expression that evaluates to an object in the Applies To list.
ID
Required. Integer representing the control recipe’s create ID to resume.
Remarks
If the ID argument identifies a control recipe that does not exist, this method
raises an error.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
SelectControlRecipe
Applies To
ControlRecipeList Control
Description
Selects the indicated control recipe.
Syntax
object.SelectControlRecipe ID
The SelectControlRecipe method syntax has these parts:
Part
Description
object
Object expression that evaluates to an object in the Applies To list.
ID
Required. Integer representing the control recipe’s create ID to select.
Remarks
If the ID argument identifies a control recipe that does not exist, this method has
no effect. Calling this method causes the OnSelChange event to fire.
SelectPrompt
Applies To
PromptsList Control
Description
Selects the indicated prompt.
Syntax
object.SelectPrompt ID
The SelectPrompt method syntax has these parts:
Part
Description
object
Object expression that evaluates to an object in the Applies To list.
ID
Required. Integer representing the prompt ID of the prompt to select.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Remarks
If the ID argument identifies a prompt that does not exist, this method will not
change which prompt is selected. Calling this method causes the OnSelChange
event to fire.
SelectSignature
Applies To
SignatureList Control
Description
Selects the indicated signature.
Syntax
object.SelectSignature ID
The SelectSignature method syntax has these parts:
Part
Description
object
An object expression that evaluates to a SignatureList control.
ID
Signature ID of the signature to be selected.
Remarks
If the ID argument identifies a signature not displayed in the SignatureList
Control, this method has no effect. Calling this method causes the OnSelChange
and SimpleOnSelChange event to fire.
SetColumnText
Applies To
ControlRecipeList Control, PromptsList Control, SignatureList Control
Description
Sets the text for the specified column in the control.
Syntax
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
The SetColumnText method syntax has these parts:
Part
Description
object
Object expression that evaluates to an object in the Applies To list.
index
Required. Integer representing the column to set text on. (See “Default Column Labels (on page
305)” for more information.)
text
Required. String containing new column header text.
Remarks
If the index argument is less than on, greater than the number of columns (12), or
the text argument is Null, this method raises an error.
SetColumnWidth
Applies To
ControlRecipeList Control, PromptsList Control, SignatureList Control
Description
Sets the width, in twips 5, for the specified column in the control.
Syntax
object.SetColumnWidth index, width
The SetColumnWidth method syntax has these parts:
Part
Description
object
Object expression that evaluates to an object in the Applies To list.
index
Required. Integer representing the column to set width on. (See “Default Column Labels (on
page 305)” for more information.)
width
Required. Integer representing the new column width.
Remarks
If the index argument is less than one, greater than the number of columns (12), or
the width argument is less than zero, this method raises an error.
5
A twip is a unit of measurement implemented as 1/20 of a point or 1/1440 of an inch.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
SetControlRecipeMode
Applies To
ControlRecipeList Control
Description
Sets the indicated control recipe’s mode.
Syntax
object.SetControlRecipeMode ID, mode
The SetControlRecipeMode method syntax has these parts:
Part
Description
object
Object expression that evaluates to an object in the Applies To list.
ID
Required. Integer representing the create ID of the control recipe to command.
mode
Required. Integer or enumeration specifying the mode, as described in Settings.
Settings
The settings for mode are:
Enumeration
Value
Description
crModeManual
12
Put the control recipe into manual.
crModeAuto
5
Put the control recipe into automatic.
crModeSemiAuto
27
Put the control recipe into semiautomatic.
Remarks
If the ID argument identifies a control recipe that does not exist, this method
raises an error.
If the currently logged-in user does not have permission to change the mode of a
control recipe, this method will have no effect.
SetFilterPattern
Applies To
ControlRecipeList Control, PromptsList Control, SignatureList Control
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Description
Sets the filter pattern for the specified column in the control.
Syntax
object.SetFilterPattern index, pattern
The SetFilterPattern method syntax has these parts:
Part
Description
object
Object expression that evaluates to an object in the Applies To list.
index
Required. Integer representing the column to get filter pattern from. (See “Default Column
Labels (on page 305)” for more information.)
pattern
Required. String representing the new filter pattern. The default value is �*’.
Remarks
This filter shows only control recipes that match all filter patterns in the recipe
list. If you do not want the column to be filtered, leave the default of �*’.
Characters in pattern
Matches in string
?
Any single character.
*
Zero or more characters.
#
Any single digit (0–9).
[charlist]
Any single character in charlist.
[!charlist]
Any single character not in charlist.
A group of one or more characters (charlist) enclosed in brackets ([ ]) can be used
to match any single character in a string and can consist of almost any character
code, including digits.
Tip:
To match the special characters left bracket ( [ ), question mark ( ? ), number sign ( # ), and asterisk ( * ),
enclose them in parentheses. The right bracket ( ] ) can’t be used within a group to match itself, but it can be
used outside a group as an individual character.
By using a hyphen (–) to separate the upper and lower bounds of the range,
charlist can specify a range of characters. For example, [A-Z] results in a match if
the corresponding character position in a string contains any uppercase letters in
the range A–Z. Multiple ranges are included within the brackets without
delimiters. If the index argument is less than one or greater than the number of
columns (12) or the pattern argument is Null, this method raises an error.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
SetShowColumn
Applies To
SignatureList Control
Description
Sets the "show column" flag for the specified column.
Syntax
object.SetShowColumn index [=flag]
The SetShowColumn method syntax has these parts:
ShowAboutBox
Part
Description
flag
Boolean value indicating if the specified column is displayed or not.
object
An object expression that evaluates to a SignatureList control.
index
Integer identifying the column whose "show column" flag is returned.
Applies To
ControlRecipeList Control, PromptsList Control, ProcedureView Control,
SignatureList Control
Description
Displays the About box for this control.
Syntax
object.ShowAboutBox
The ShowAboutBox method syntax has these parts:
Part
Description
object
Object expression that evaluates to an object in the Applies To list.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
ShowColumn
Applies To
ProcedureView Control, TimerView Control
Description
Shows a column in the Table view specified by number that has been hidden with
the HideColumn method.
Syntax
object.ShowColumn colnumber
The ShowColumn method syntax has these parts:
Part
Description
object
Object expression that evaluates to an object in the Applies To list.
colnumber
Integer value representing the number of the column to show. (See “Default Column Labels (on
page 305)” for more information.)
Remarks
Columns are numbered consecutively from left to right, beginning with zero. To
hide a column, use the HideColumn method. This method applies only to the
Table view.
ShowPropertiesDialog
Applies To
ProcedureView Control
Description
Displays the Properties dialog box relative to the currently selected recipe
element.
Syntax
object.ShowPropertiesDialog
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
The ShowPropertiesDialog method syntax has these parts:
Part
Description
object
Object expression that evaluates to an object in the Applies To list.
Remarks
If there is no currently selected recipe element, then the Properties dialog box that
is displayed is relative to the currently depicted procedure.
SignatureIDIsValid
Applies To
SignatureList Control
Description
Determines if the given Signature ID corresponds to a Signature on the Signature
List.
Syntax
[result=] object.SignatureIDIsValid ID
The SignatureIDIsValid method syntax has these parts:
Part
Description
result
Boolean value indicating if the action is or is not valid.
object
An object expression that evaluates to a SignatureList control.
ID
Signature ID to be validated.
Remarks
A value of True indicates that the Signature ID does correspond to a Signature on
the Signature List. A value of False indicates that it does not.
SignatureUI
Applies To
SignatureList Control
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Description
Displays the Signature dialog for the given Signature ID.
Syntax
[result=] object.SignatureUI ID
The SignatureUI method syntax has these parts:
Part
Description
result
Boolean value indicating the display’s success (True) or failure (False) of the signature dialog.
object
An object expression that evaluates to a SignatureList control.
ID
SignatureID for which a dialog is displayed.
Remarks
If the ID argument identifies a signature that does not exist, no dialog box displays
and result is False.
SignoffIsValid
Applies To
SignatureList Control
Description
Determines if the given Signature ID and SignoffNumber correspond to a signoff
in a signature.
Syntax
[result=] object.SignoffIsValid SignatureID, SignoffNumber
The SignoffIsValid method syntax has these parts:
Part
Description
result
Boolean value indicating if the signature ID and signoff number are valid.
object
An object expression that evaluates to a SignatureList control.
SignatureID
SignatureID to be validated.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Part
Description
SignoffNumber
Signoff Number to be validated. The first signoff in a signature has a signoff number of 1, the
second has a signoff number of 2, etc.
Remarks
A value of True indicates that the Signature ID and Signoff Number correspond
to a signoff in a signature. A value of False indicates that they do not.
StartControlRecipe
Applies To
ControlRecipeList Control
Description
Starts the indicated control recipe.
Syntax
object.StartControlRecipe ID
The StartControlRecipe method syntax has these parts:
Part
Description
object
Object expression that evaluates to an object in the Applies To list.
ID
Required. Integer representing the control recipe’s create ID to start.
Remarks
If the ID argument identifies a control recipe that does not exist, this method
raises an error.
StepChangeCancel
Applies To
ProcedureView Control
Description
Terminates the Active Step Change operation in progress.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Syntax
object.StepChangeCancel
The StepChangeCancel method syntax has one part:
StepChangeCommit
Part
Description
object
Object expression that evaluates to an object in the Applies To list.
Applies To
ProcedureView Control
Description
Commits the Active Step Change operation in progress.
Syntax
object.StepChangeCommit
The StepChangeCommit method syntax has these parts:
StepChangeStart
Part
Description
object
Object expression that evaluates to an object in the Applies To list.
Applies To
ProcedureView Control
Description
Initiates an Active Step Change operation.
Syntax
object.StepChangeStart
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
The StepChangeStart method syntax has these parts:
StopControlRecipe
Part
Description
object
Object expression that evaluates to an object in the Applies To list.
Applies To
ControlRecipeList Control
Description
Stops the indicated control recipe.
Syntax
object.StopControlRecipe ID
The StopControlRecipe method syntax has these parts:
Part
Description
object
Object expression that evaluates to an object in the Applies To list.
ID
Required. Integer representing the control recipe’s create ID to stop.
Remarks
If the ID argument identifies a control recipe that does not exist, this method
raises an error.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Chapter 3
Properties
A property is a named attribute of a control, form, application or other object.
Properties define object characteristics such as size, color, and screen location, or
they can define the state of an object (for example, enabled, disabled).
Do not modify the following Batch ActiveX Control Properties – they are intended for internal use only and
must not be modified in any way:
• BatchVersionCompatible
• UseExternalBatchSec
• SecurityApplicationID
ActionIDColumnText
Applies To
SignatureList Control
Description
Returns or sets a value that determines the text displayed in the Action ID’s
column header of the list.
Syntax
object.ActionIDColumnText [= text]
The ActionIDColumnText property syntax has these parts:
Part
Description
object
An object expression that evaluates to a SignatureList control.
text
A string to be displayed as the column header text for the ActionID column.
(Default = Action ID)
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Remarks
Setting this property to a zero-length string ("") will cause the column header to be
displayed without text. Setting this property to Null will raise an error.
ActionIDColumnWidth
Applies To
SignatureList Control
Description
Returns or sets a value that determines the Action ID’s column width in the list.
Syntax
object.ActionIDColumnWidth [= value]
The ActionIDColumnWidth property syntax has these parts:
Part
Description
object
An object expression that evaluates to a SignatureList control.
value
An integer that determines the width of the column. (Default = 1440)
Remarks
Setting this property to a value less than zero will raise an error. The width of a
column is measured in units of twips 6. The minimum value is 1, the maximum
value is 32,767.
ActionIDFilterPattern
Applies To
SignatureList Control
Description
Returns or sets a filter pattern for the Action ID column.
6
A twip is a unit of measurement implemented as 1/20 of a point or 1/1440 of an inch.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Syntax
object.ActionIDFilterPattern [= pattern]
The ActionIDFilterPattern property has these parts:
Part
Description
object
An object expression that evaluates to a SignatureList control.
pattern
A string that determines the filter pattern for the Action ID column. (Default = *)
Remarks
Setting this property to Null will raise an error. A filter pattern is a string that
determines the string characteristics to be included in a particular column. For
example, if the ActionID of a particular signature in the signature list does not
match the ActionIDFilterPattern, that signature is not included in the signature
list. Filter patterns are defined as follows:
ActionIDShowColumn
Kind of match
Pattern
Match (returns True)
No match (returns False)
Multiple characters
a*a
aa, aBa, aBBBa
aBC
*ab*
abc, AABB, Xab
aZb, bac
Special character
a[*]a
a*a
aaa
Multiple characters
ab*
abcdefg, abc
cab, aab
Single character
a?a
aaa, a3a, aBa
aBBBa
Single digit
a#a
a0a, a1a, a2a
aaa, a10a
Range of characters
[a-z]
f, p, j
2, &
Outside a range
[!a-z]
9, &, %
b, a
Not a digit
[!0-9]
A, a, &, ~
0, 1, 9
Combined
a[!b-m]#
An9, az0, a99
abc, aj0
Applies To
SignatureList Control
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Description
Returns or sets a flag that determines if the Action ID column is displayed.
Syntax
object.ActionIDShowColumn [= flag]
The ActionIDShowColumn property has these parts:
Part
Description
object
An object expression that evaluates to a SignatureList control.
flag
A boolean value that determines if the Action ID column is displayed or not.
(Default = True)
Remarks
A value of True indicates that the column displays. A value of False indicates that
the column will not display.
ActiveUnit
Applies To
ProcedureView Control
Description
Returns or sets the unit ID or unit name to which the control is bound.
Syntax
object.ActiveUnit [= text]
The ActiveUnit property syntax has these parts:
Part
Description
object
An object expression that evaluates to an object in the Applies To list.
text
String that holds the ID or unit name to which the control is bound.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Remarks
When a value is assigned to the control’s ActiveUnit property, the
TopProcedureID value changes dynamically so that the control always depicts a
procedure (unit procedure if one exists, operation if there is no unit procedure
executing against the specified unit, or blank otherwise) that is currently executing
against the unit specified by the ActiveUnit property or waiting to execute against
this unit, based on the ActiveUnitProcedure Number property value. When a
value is assigned to the TopProcedureID property programmatically, the
ActiveUnit property changes to a zero-length string, indicating that the control is
not unit bound. While the control is unit bound, the user can navigate the
depicted procedure (via the GUI or programmatically), and consequently modify
the CurrentProcedureID property value, but the control continues to monitor
the unit and may change the TopProcedureID value itself adjusting to a change
in which procedure is currently executing against the specified unit.
ActiveUnitProcedure
Number
Applies To
ProcedureView Control
Description
Returns or sets which owner/requestor for the ActiveUnit is depicted by the
control.
Syntax
object.ActiveUnitProcedureNumber [= value]
The ActiveUnitProcedureNumber property syntax has these parts:
Part
Description
object
An object expression that evaluates to an object in the Applies To list.
value
The owner or requestor for the ActiveUnit whose procedure is depicted by the control.
Remarks
When the ActiveUnit property receives a value that is not a zero-length string, the
current owner and requestor(s) of the ActiveUnit and the
ActiveUnitProcedureNumber value determine the procedure depicted by the
control. A unit may have only one owner at any time, but many requestors waiting
for ownership. A 0 (zero) value for the ActiveUnitProcedureNumber property
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
causes the control to depict the procedure that corresponds to the ActiveUnit
owner. A value of 1 causes the control to depict the procedure that corresponds to
the first requester in the list of requesters for the ActiveUnit. A value of 2 causes
the control to depict the procedure corresponding to the second requester in the
requester list for the ActiveUnit, and so on. If the ActiveUnitProcedureNumber
property value exceeds the number of requesters in the requester list for the
ActiveUnit, the control will be blank. Changes to the
ActiveUnitProcedureNumber value have no effect when the ActiveUnit
property is a zero-length string.
Appearance
Applies To
ControlRecipeList Control, PromptsList Control, SignatureList Control
Description
Read-only at run time. Returns or sets the paint style of controls at design time.
Syntax
object.Appearance [= value]
The Appearance property syntax has these parts:
Part
Description
object
An object expression that evaluates to an object in the Applies To list.
value
An integer specifying the control’s appearance as described in Settings.
Settings
The settings for value are:
Enumeration
Value
Description
ccFlat
0
Flat. Paints controls and forms without visual effects.
cc3D
1
3D. Paints controls with three-dimensional effects (Default).
Remarks
If set to 1 at design time, the Appearance property draws controls with threedimensional effects. If the form’s BorderStyle property is set to Fixed Double
(vbFixedDouble or 3), the caption and border of the form are also painted with
three-dimensional effects. Setting the Appearance property to 1 also causes the
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
form and its controls to have their BackColor property set to the color selected
for Button Face in the Color option of the operating system’s Control Panel.
AreaColumnText
Applies To
PromptsList Control
Description
Returns or sets a value that determines the text displayed in the header of the Area
column in the list.
Syntax
object.AreaColumnText [= text]
The AreaColumnText property syntax has these parts:
Part
Description
object
An object expression that evaluates to an object in the Applies To list.
text
String to be displayed as the column header text for the Area column.
(Default = Area)
Remarks
Setting this property to a zero-length string ("") causes the column header to
display without text (empty). Setting this property to Null will raise an error.
AreaColumnWidth
Applies To
PromptsList Control
Description
Returns or sets a value that determines the Area column width in the list.
Syntax
object.AreaColumnWidth [= value]
The AreaColumnWidth property syntax has these parts:
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Part
Description
object
An object expression that evaluates to an object in the Applies To list.
value
An integer or enumeration that determines the Area column width.
(Default = 1440)
Remarks
Setting this property to a value less than zero will raise an error. The column width
is measured in units of twips 7.
AreaFilterPattern
Applies To
PromptsList Control
Description
Returns or sets the filter pattern for the Area column.
Syntax
object.AreaFilterPattern [= pattern]
The AreaFilterPattern property syntax has these parts:
Part
Description
object
An object expression that evaluates to an object in the Applies To list.
pattern
A string that determines the filter pattern for the Area column.
(Default = *)
Remarks
Setting this property to Null will raise an error.
A filter pattern is a string that determines the string characteristics to be included
in a particular column. For example, if the Area of a particular prompt in the
prompts list does not match the AreaFilterPattern, that prompt is not included
in the prompts list. Filter patterns are defined as follows:
7
A twip is a unit of measurement implemented as 1/20 of a point or 1/1440 of an inch.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Arrange
Kind of match
Pattern
Match (returns True)
No match (returns False)
Multiple characters
a*a
aa, aBa, aBBBa
aBC
*ab*
abc, AABB, Xab
aZb, bac
Special character
a[*]a
a*a
aaa
Multiple characters
ab*
abcdefg, abc
cab, aab
Single character
a?a
aaa, a3a, aBa
aBBBa
Single digit
a#a
a0a, a1a, a2a
aaa, a10a
Range of characters [a-z]
f, p, j
2, &
Outside a range
[!a-z]
9, &, %
b, a
Not a digit
[!0-9]
A, a, &, ~
0, 1, 9
Combined
a[!b-m]#
An9, az0, a99
abc, aj0
Applies To
ControlRecipeList Control, PromptsList Control
Description
Returns or sets a value that determines how the icons in a ControlRecipeList
control’s Icon or Small Icon view are arranged.
Syntax
object.Arrange [= value]
The Arrange property syntax has these parts:
Part
Description
object
An object expression that evaluates to an object in the Applies To list.
value
An integer or enumeration that determines how the icons or small icons are arranged as
described in Settings.
Settings
The settings for value are:
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Enumeration
Value
Description
lvwNone
0
None.
lvwAutoLeft
1
Left. Items are aligned automatically along the left side of the control.
(Default)
lvwAutoTop
2
Top. Items are aligned automatically along the top of the control.
Remarks
Setting this property to a value other than the valid Enumerations defined above
will raise an error.
AutoArrange
Applies To
ProcedureView Control
Description
Returns or sets a flag that determines if the scrolling and zooming of the currently
depicted procedure are (True) or are not (False) automatically adjusted to
guarantee that all active steps and transitions within the depicted procedure are
visible. The default setting is False.
Syntax
arrange = object.AutoArrange
The AutoArrange property syntax has these parts:
Part
Description
arrange
Boolean that determines if scrolling and zooming occur automatically, to ensure that all active
steps and transitions in the current procedure are visible.
object
An object expression that evaluates to an object in the Applies To list.
Remarks
If the control’s AutoArrange property is True, every time the Change event fires
the depicted procedure will be scrolled, then zoomed (if necessary) to ensure that
all active steps and transitions are visible. First, the contents are scrolled such that
the top of the highest (vertically) active step or transition is at the top of the
control (with a slight gap), while remaining visible, and that the left side of the
left-most (horizontally) active step or transition is as close to the left edge of the
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
control as possible (with a slight gap), while remaining visible. Then, if necessary,
the Zoom property value is reduced until the right side of the right most
(horizontally) active step or transition is visible, and the bottom of the lowest
(vertically) active step or transition is visible. No scrolling or zooming will occur if,
after a Change event, all active steps and transitions are already visible. When the
control is in Table view, zooming has no effect, so only vertical scrolling occurs.
If the AutoArrange property is True, scrolling performed by the user and changes
to the Zoom property value might not be retained after the next time the Change
event fires.
AutoSizeColumns
Applies To
ControlRecipeList Control, PromptsList Control, ProcedureView Control
(Table View), SignatureList Control, TimerView Control
Description
Sets all column widths to automatically adjust to the largest column entry,
including the header.
Syntax
object.AutoSizeColumns [= value]
The AutoSizeColumns property syntax has these parts:
Part
Description
object
An object expression that evaluates to an object in the Applies To list.
value
Boolean expression specifying whether the columns are auto-sized or not.
Settings
The settings for value are:
Setting
Description
True
Columns are auto-sized. (Default for ControlRecipeList, SignatureList, and TimerView
Controls)
False
Columns are not auto-sized (Default for ProcedureView Control and PromptsList Control)
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Remarks
If the ProcedureView control’s AutoSizeColumns property is set to True, then
every time the Change event fires the control’s new contents will be evaluated,
and the control’s columns will adjust in width to display the widest element in
each column. This property applies only to the Table view of the ProcedureView
control.
BackColor
Applies To
ControlRecipeList Control, PromptsList Control, ProcedureView Control,
SignatureList Control, TimerView Control
Description
Returns or sets an object’s background color.
Syntax
object.BackColor [= color]
The BackColor properties syntax has these parts:
Part
Description
object
An object expression that evaluates to an object in the Applies To list.
color
A value or enumeration that determines an object’s background or foreground color as
described below.
(Default = Windows Background)
Remarks
The valid range for a normal RGB color is 0 to 16,777,215 (&HFFFFFF). The
high byte of a number in this range equals 0; the lower 3 bytes, from least to most
significant, determine the amount of red, green, and blue, respectively. The red,
green, and blue components are each represented by a number between 0 and 255
(&HFF). If the high byte is not 0, system colors are used.
To display text in the Windows operating environment, both the text and
background colors must be solid. If the text or background colors you have
selected are not displayed, one of the selected colors may be dithered — that is,
comprised of up to three different-colored pixels. If you choose a dithered color
for either the text or background, the nearest solid color will be substituted.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Setting either of these properties to a value outside the allowable range (0 to
&HFFFFFF) will raise an error.
Tip:
BatchIDColumnText
If the control’s MatchBackColor property is True, the control’s BackColor property value will be overwritten any
time the container’s BackColor changes.
Applies To
ControlRecipeList Control, PromptsList Control, SignatureList Control
Description
Returns or sets a value that determines the text displayed in the header of the
Batch ID column in the list.
Syntax
object.BatchIDColumnText [= text]
The BatchIDColumnText property syntax has these parts:
Part
Description
object
An object expression that evaluates to an object in the Applies To list.
text
A string to be displayed as the column header text for the Batch ID column.
(Default = Batch ID)
Remarks
Setting this property to a zero-length string ("") will cause the column header to be
displayed without text (empty). Setting this property to Null will raise an error.
BatchIDColumnWidth
Applies To
ControlRecipeList Control, PromptsList Control, SignatureList Control
Description
Returns or sets a value that determines the Batch ID column’s width in the list.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Syntax
object.BatchIDColumnWidth [= value]
The BatchIDColumnWidth property syntax has these parts:
Part
Description
object
An object expression that evaluates to an object in the Applies To list.
value
An integer or enumeration that determines the Batch ID column width.
(Default = 1440)
Remarks
Setting this property to a value less than zero will raise an error. The width of a
column is measured in units of twips 8.
BatchIDEditable
Applies To
ControlRecipeList Control
Description
Specifies whether a batch ID can be edited when creating a new control recipe.
Syntax
object.BatchIDEditable [= value]
The BatchIDEditable property syntax has these parts:
Part
Description
object
An object expression that evaluates to an object in the Applies To list.
value
Boolean value indicating whether or not the batch ID can be edited when creating a new
control recipe.
Settings
The settings for value are:
8
A twip is a unit of measurement implemented as 1/20 of a point or 1/1440 of an inch.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Value
Description
True
The batch ID can be edited when creating a new control recipe.
False
The batch ID cannot be edited when creating a new control recipe.
Remarks
Use the BatchIDEditable property to enable or disable batch ID editing when
creating a new control recipe. When the batch ID is not editable, it appears
dimmed. In certain circumstances, this property’s value may be overridden, for
example, if the AutoBatchID_Info execute times out or if a batch ID containing
invalid characters is returned from the AutoBatchID_Info execute. (See the
FactoryTalk Batch Administrator’s Guide for more information on customizing
batch IDs.)
BatchIDFilterPattern
Applies To
ControlRecipeList Control, PromptsList Control, SignatureList Control
Description
Returns or sets the filter pattern for the Batch ID column.
Syntax
object.BatchIDFilterPattern [= pattern]
The BatchIDFilterPattern property syntax has these parts:
Part
Description
object
An object expression that evaluates to an object in the Applies To list.
pattern
A string that determines the filter pattern for the Batch ID column.
(Default = *)
Remarks
Setting this property to Null will raise an error.
A filter pattern is a string that determines the string characteristics to be included
in a particular column. For example, if the batch ID of a particular control recipe
in the control recipe list does not match the BatchIDFilterPattern, that control
recipe is not included in the control recipe list. Filter patterns are defined as
follows:
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
BatchIDShowColumn
Kind of match
Pattern
Match (returns True)
No match (returns False)
Multiple characters
a*a
aa, aBa, aBBBa
aBC
*ab*
abc, AABB, Xab
aZb, bac
Special character
a[*]a
a*a
aaa
Multiple characters
ab*
abcdefg, abc
cab, aab
Single character
a?a
aaa, a3a, aBa
aBBBa
Single digit
a#a
a0a, a1a, a2a
aaa, a10a
Range of characters
[a-z]
f, p, j
2, &
Outside a range
[!a-z]
9, &, %
b, a
Not a digit
[!0-9]
A, a, &, ~
0, 1, 9
Combined
a[!b-m]#
An9, az0, a99
abc, aj0
Applies To
SignatureList Control
Description
Returns or sets a flag that determines if the Batch ID column is displayed.
Syntax
object.BatchIDShowColumn [= flag]
The BatchIDShowColumn property has these parts:
Part
Description
object
An object expression that evaluates to a SignatureList control.
flag
A boolean value that determines if the Batch ID column is displayed or not.
((Default = True))
Remarks
A value of True indicates that the column will be displayed. A value of False
indicates that the column will not be displayed.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
BatchVersionCompatible
Applies To
ControlRecipeList Control, ProcedureView Control, PromptsList Control,
SignatureList Contro, TimerView Controll
Description
[Read-only] Returns a flag that indicates whether the FactoryTalk Batch Server
the control is connected to is a compatible version (True) or not (False) or
indeterminate (False). The default setting is False.
Syntax
compatible = object.BatchVersionCompatible
Remarks
The value defaults to False on instantiation of the control. If the control connects
to the FactoryTalk Batch Server and determines that the Server is compatible, the
value is set to True. If the connection to the Server is lost, the value is reset to
False. Upon reconnection to the Server the control sets the value appropriately.
Warning:
BorderStyle
Do NOT modify this property! It is intended for internal use only and must not be modified in any way.
Applies To
ControlRecipeList Control, PromptsList Control, ProcedureView Control,
SignatureList Control
Description
Returns or sets the border style for the control.
Syntax
object.BorderStyle [= value]
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
The BorderStyle property syntax has these parts:
Part
Description
object
An object expression that evaluates to an object in the Applies To list.
value
Integer or enumeration that determines the border style, as described in Settings.
Settings
The ControlRecipeList and PromptsList settings for value are:
Enumeration
Value
Description
ccNone
0
None (Default for ControlRecipeList)
ccFixedSingle
1
Fixed Single (Default for PromptsList)
The ProcedureView settings for value are:
Enumeration
Value
Description
pvwBorderStyle None
0
None
pvwBorderStyle
FixedSingle
1
Fixed Single (Default for ProcedureView)
The SignatureList settings for value are:
CallTimeout
Enumeration
Value
Description
sigNone
0
None (Default for SignatureList to be consistent)
sigFixedSingle
1
Fixed Single
Applies To
ControlRecipeList Control, PromptsList Control, ProcedureView Control,
SignatureList Control, TimerView Control
Description
Returns or sets a value which indicates the number of watchdog cycles.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Syntax
object.CallTimeout [= value]
The CallTimeout property syntax has these parts:
Part
Description
object
An object expression that evaluates to an object in the Applies To list.
value
A value that indicates the number of milliseconds that the control will wait for the Batch
Server service (specified by the Node property) to respond to a data request. If the request
time exceeds the number of milliseconds indicated by the CallTimeout property, the
control assumes that the FactoryTalk Batch Server is not running and displays a
Communication Lost message. The allowable range is 1 to 3,600,00 (one hour). The default
value is 90,000 (90 seconds).
Remarks
Setting this property to a value outside of the allowable range will raise an error.
CanAbort
Applies To
ControlRecipeList Control, ProcedureView Control
Description
The CanAbort property is not available at design time and is read-only at run
time.
Returns whether the indicated control recipe can be aborted.
Syntax
[result =] object.CanAbort ID
The CanAbort property syntax has these parts:
Part
Description
result
Boolean expression that specifies if the Abort command is valid for the specified control
recipe.
object
An object expression that evaluates to an object in the Applies To list.
ID
ControlRecipeList control only.
Required. Integer that evaluates to the unique create ID of a control recipe.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Settings
The settings for result are:
Setting
Description
True
Control recipe can be aborted.
False
Abort is not a valid command for the specified control recipe.
Remarks
The CanAbort property is True only when the currently logged-in user has
permission to abort control recipes, and the specified control recipe is in the
RUNNING, STOPPING, HOLDING, RESTARTING or HELD state. When
the object expression evaluates to the ProcedureView control, if a transition
recipe element is selected, the value of this property is False. If no step is selected,
this property is relative to the depicted procedure.
CanAcknowledge
Applies To
PromptsList Control
Description
The CanAcknowledge property is not available at design time and is read-only at
run time.
Signifies the current user’s right (or lack thereof) to acknowledge a prompt.
Syntax
[result =] object.CanAcknowledge
The CanAcknowledge property syntax has these parts:
Part
Description
result
Boolean expression indicating if the current user possesses the security clearance necessary to
acknowledge a prompt.
Object
An object expression that evaluates to an object in the Applies To list.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Settings
The settings for result are:
Setting
Description
True
The currently logged-in user has permission to acknowledge prompts.
False
The currently logged-in user does not have permission to acknowledge prompts.
Remarks
The CanAcknowledge property is True only when the currently logged-in user
has permission to acknowledge prompts.
CanBind
Applies To
ProcedureView Control
Description
Returns a value that identifies if the current user has permission to issue a Bind
command, and if the command applies to the currently selected regular step.
This property is not available at design time and is read-only at run time.
Syntax
[result =] object.CanBind
The CanBind property syntax has these parts:
Part
Description
result
Boolean expression indicating if the bind command can or cannot be issued for the selected
step.
object
An object expression that evaluates to an object in the Applies To list.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Settings
The settings for result are:
Setting
Description
True
The currently logged-in user can issue a bind command.
False
The currently logged-in user cannot issue a bind command.
Remarks
The Bind command only applies to regular step elements that are class-based
when created in the Recipe Editor. If a transition recipe element is selected, this
property is False. If there is no step selected, this property is relative to the depicted
procedure.
CanBindAcknowledge
Applies To
PromptsList Control
Description
Signifies the current user’s right (or lack thereof) to resolve a binding at run time
(acknowledge a binding prompt).
Syntax
[result =] object.CanBindAcknowledge
The CanBindAcknowledge property syntax has these parts:
Part
Description
result
Boolean expression indicating if the current user possesses the security clearance necessary
to acknowledge a binding prompt.
object
An object expression that evaluates to an object in the Applies To list.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Settings
The settings for result are:
Setting
Description
True
The currently logged-in user has permission to acknowledge binding prompts.
False
The currently logged-in user does not have permission to acknowledge binding prompts.
Remarks
The CanBindAcknowledge property is True only when the currently logged-in
user has permission to acknowledge binding prompts.
CanChangeActiveStep
Applies To
ProcedureView Control
Description
Returns a value that identifies if the current user has permission to perform an
Active Step Change operation.
This property is not available at design time and is read-only at run time.
Syntax
[result =] object.CanChangeActiveStep
The CanChangeActiveStep property syntax has these parts:
Part
Description
result
Boolean expression indicating if the current user does or does not have permission to
perform active step change operations.
object
An object expression that evaluates to an object in the Applies To list.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Settings
The settings for result are:
Setting
Description
True
The currently logged-in user does have permission to perform an active step change
operation.
False
The currently logged-in user does not have permission to perform an active step change
operation.
Remarks
An Active Step Change operation can only be performed on the depicted
procedure as a whole.
CanClearFailures
Applies To
ControlRecipeList Control, ProcedureView Control
Description
The CanClearFailures property is not available at design time and is read-only at
run time.
Returns whether the currently logged-in user has permission to clear failures on
control recipes.
Syntax
[result =] object.CanClearFailures ID
The CanClearFailures property syntax has these parts:
Part
Description
result
Boolean expression that specifies if the ClearFailures command is valid for the specified
control recipe, as described in Settings.
object
An object expression that evaluates to an object in the Applies To list.
ID
ControlRecipeList control only.
Required. Integer that evaluates to the unique create ID of a control recipe.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Settings
The settings for result are:
Setting
Description
True
Control recipe can have its failures cleared.
False
The currently logged-in user does not have permission to clear failures on control recipes.
Remarks
The CanClearFailures property is True only when the currently logged-in user
has permission to clear failures on control recipes. When the object expression
evaluates to the ProcedureView control, this command only applies to regular
step recipe elements (not to transitions). If a transition element is selected, this
property is False. If no step is selected, this property is relative to the depicted
procedure.
CanComment
Applies To
ControlRecipeList Control, ProcedureView Control
Description
The CanComment property is not available at design time and is read-only at run
time.
Returns whether the currently logged-in user has permission to add a comment to
the event log for the currently selected control recipe.
Syntax
[result =] object.CanComment ID
The CanComment property syntax has these parts:
Part
Description
result
Boolean expression that specifies if the currently logged in user can add a comment to a
control recipe.
object
An object expression that evaluates to an object in the Applies To list.
ID
ControlRecipeList control only.
Required. Integer that evaluates to the unique create ID of a control recipe.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Settings
The settings for result are:
Setting
Description
True
User has permission to add a comment to the event log of the selected control recipe.
False
User does not have permission to add a comment to the event log of the selected control
recipe.
Remarks
The CanComment property is True only when the currently logged-in user has
permission to add comments to control recipes.
CanCreateControlRecipe
Applies To
ControlRecipeList Control
Description
The CanCreateControlRecipe property is not available at design time and is
read-only at run time.
Returns whether the currently logged-in user has permission to create control
recipes.
Syntax
[result =] object.CanCreateControlRecipe
The CanCreateControlRecipe property syntax has these parts:
Part
Description
result
Boolean expression that specifies if the currently logged-in user has permission to create
control recipes.
object
An object expression that evaluates to an object in the Applies To list.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Settings
The settings for result are:
Setting
Description
True
The currently logged-in user has permission to create control recipes.
False
The currently logged-in user does not have permission to create control recipes.
Remarks
The CanCreateControlRecipe property is True only when the currently loggedin user has permission to create control recipes.
CanDisconnect
Applies To
ProcedureView Control
Description
Returns a flag that identifies if the current user has permission to issue a
Disconnect command and if the command applies to the currently selected regular
step.
This property is not available at design time and is read-only at run time.
Syntax
[result =] object.CanDisconnect
The CanDisconnect property syntax has these parts:
Part
Description
result
Boolean expression that specifies if the currently logged-in user has permission to issue the
Disconnect command.
object
An object expression that evaluates to an object in the Applies To list.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Settings
The settings for result are:
Setting
Description
True
The currently logged-in user has permission to issue the Disconnect command.
False
The currently logged-in user does not have permission to issue the Disconnect command
Remarks
The Disconnect command is only valid for a regular step that represents a phase
(S88 level) step. If a transition is selected, this property is False. If there is no step
selected, this property is relative to the depicted procedure. If the selected step
does not represent a phase, this property is False.
CanHold
Applies To
ControlRecipeList Control, ProcedureView Control
Description
The CanHold property is not available at design time and is read-only at run time.
Returns whether the indicated control recipe can be held.
Syntax
[result =] object.CanHold ID
The CanHold property syntax has these parts:
Part
Description
result
Boolean expression that specifies if the Hold command is valid for the specified control
recipe (ControlRecipeList) or the selected recipe step (ProcedureView).
object
An object expression that evaluates to an object in the Applies To list.
ID
ControlRecipeList control only.
Required. Integer that evaluates to the unique create ID of a control recipe.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Settings
The settings for result are:
Setting
Description
True
Control recipe or selected recipe step can be held.
False
HOLD is not a valid command for the control recipe or selected recipe step.
Remarks
The CanHold property is True only when the currently logged-in user has
permission to hold control recipes, and the specified control recipe is in the
RUNNING state.
When the object expression evaluates to the ProcedureView control, the Hold
command is only valid for a regular step when the state of that regular step is
RUNNING or RESTARTING. If a transition is selected, this property is False. If
nothing is selected, this property is relative to the depicted procedure.
CanPause
Applies To
ControlRecipeList Control, ProcedureView Control
Tip:
While the property still exists in the control, the Pause command is no longer supported. The property was left
in the interface to allow for a smooth upgrade path.
Description
The CanPause property is not available at design time and is read-only at run
time. It returns whether the indicated control recipe can be paused.
Syntax
[result =] object.CanPause ID
The CanPause property syntax has these parts:
Part
Description
result
Boolean expression that specifies if the Pause command is valid for the specified control
recipe (ControlRecipeList) or the selected recipe step (ProcedureView).
object
An object expression that evaluates to an object in the Applies To list.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Part
Description
ID
ControlRecipeList control only.
Required. Integer that evaluates to the unique create ID of a control recipe.
Settings
The settings for result are:
Setting
Description
True
Control recipe or selected recipe step can be paused.
False
Pause is not a valid command for the control recipe or selected recipe step.
Remarks
When the object expression evaluates to the ProcedureView control, the Pause
command is only valid for a regular step that represents a phase. If a transition is
selected, this property is False. If nothing is selected or if the selected step is not a
phase, this property is False.
CanRemove
Applies To
ControlRecipeList Control
Description
The CanRemove property is not available at design time and is read-only at run
time.
Returns whether the indicated control recipe can be removed.
Syntax
[result =] object.CanRemove ID
The CanRemove property syntax has these parts:
Part
Description
result
Boolean expression that specifies if the Remove command is valid for the specified control
recipe.
Object
An object expression that evaluates to an object in the Applies To list.
ID
Required. Integer that evaluates to the unique create ID of a control recipe.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Settings
The settings for result are:
Setting
Description
True
Control recipe can be removed.
False
Control recipe cannot be removed.
Remarks
The CanRemove property is True only when the currently logged-in user has
permission to remove control recipes, and the specified control recipe is in the
IDLE, ABORTED, STOPPED or COMPLETE state.
CanRestart
Applies To
ControlRecipeList Control, ProcedureView Control
Description
The CanRestart property is not available at design time and is read-only at run
time.
Returns whether the indicated control recipe can be restarted.
Syntax
[result =] object.CanRestart ID
The CanRestart property syntax has these parts:
Part
Description
result
Boolean expression that specifies if the Restart command is valid for the specified control
recipe (ControlRecipeList) or the selected recipe step (ProcedureView).
object
An object expression that evaluates to an object in the Applies To list.
ID
ControlRecipeList control only.
Required. Integer that evaluates to the unique create ID of a control recipe.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Settings
The settings for result are:
Setting
Description
True
Control recipe or selected recipe step can be restarted.
False
Restart is not a valid command for the control recipe or selected recipe step.
Remarks
The CanRestart property is True only when the currently logged-in user has
permission to restart control recipes, and the specified control recipe is in the
HELD state. When the object expression evaluates to the ProcedureView
control, the Restart command is only valid for a regular step when its state is
HELD. If a transition is selected, this property is False. If nothing is selected, this
property is relative to the depicted procedure.
CanResume
Applies To
ControlRecipeList Control, ProcedureView Control
Description
The CanResume property is not available at design time and is read-only at run
time.
Returns whether the indicated control recipe can be resumed.
Syntax
[result =] object.CanResume ID
The CanResume property syntax has these parts:
Part
Description
result
Boolean expression that specifies if the Resume command is valid for the specified control
recipe (ControlRecipeList) or the selected recipe step (ProcedureView).
object
An object expression that evaluates to an object in the Applies To list.
ID
ControlRecipeList control only.
Required. Integer that evaluates to the unique create ID of a control recipe.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Settings
The settings for result are:
Setting
Description
True
Control recipe or selected recipe step can be resumed.
False
Resume is not a valid command for the control recipe or selected recipe step.
Remarks
When the object expression evaluates to the ProcedureView control, the Resume
command is only valid for a step when its mode is Semi-Auto. If a transition is
selected, this property is False. If nothing is selected, this property is relative to the
depicted procedure.
CanSetAutomatic
Applies To
ControlRecipeList Control, ProcedureView Control
Description
The CanSetAutomatic property is not available at design time and is read-only at
run time.
Returns whether the indicated control recipe’s mode can be changed to
Automatic.
Syntax
[result =] object.CanSetAutomatic ID
The CanSetAutomatic property syntax has these parts:
Part
Description
result
Boolean expression that specifies if setting the specified control recipe’s mode to AUTO is
valid.
object
An object expression that evaluates to an object in the Applies To list.
ID
ControlRecipeList control only.
Required. Integer that evaluates to the unique create ID of a control recipe.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Settings
The settings for result are:
Setting
Description
True
Control recipe’s mode can be changed to Automatic.
False
Control recipe’s mode cannot be changed to Automatic.
Remarks
The CanSetAutomatic property is True only when the currently logged-in user
has permission to put control recipes in automatic mode and the specified control
recipe is not currently in AUTOMATIC mode.
When the object expression evaluates to the ProcedureView control, only steps
not currently in AUTOMATIC mode can be commanded to switch to
Automatic mode. If a transition is selected, this property is False. If nothing is
selected, this property is relative to the depicted procedure.
CanSetManual
Applies To
ControlRecipeList Control, ProcedureView Control
Description
The CanSetManual property is not available at design time and is read-only at
run time.
Returns whether the indicated control recipe’s mode can be changed to Manual.
Syntax
[result =] object.CanSetManual ID
The CanSetManual property syntax has these parts:
Part
Description
result
Boolean expression that specifies if setting the specified control recipe’s mode to MANUAL is
valid.
object
An object expression that evaluates to an object in the Applies To list.
ID
ControlRecipeList control only.
Required. Integer that evaluates to the unique create ID of a control recipe.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Settings
The settings for result are:
Setting
Description
True
Control recipe’s mode can be changed to Manual.
False
Control recipe’s mode cannot be changed to Manual.
Remarks
The CanSetManual property is True only when the currently logged-in user has
permission to put control recipes into manual mode and when the specified
control recipe is not already in MANUAL mode.
When the object expression evaluates to the ProcedureView control, only regular
steps not already in Manual mode can be commanded to switch to Manual mode.
If a transition is selected, this property is False. If nothing is selected, this property
is relative to the depicted procedure.
CanSetSemiAuto
Applies To
ControlRecipeList Control, ProcedureView Control
Description
The CanSetSemiAuto property is not available at design time and is read-only at
run time.
Returns whether the indicated control recipe’s mode can be changed to
semi-automatic.
Syntax
[result =] object.CanSetSemiAuto ID
The CanSetSemiAuto property syntax has these parts:
Part
Description
result
Boolean expression that specifies if setting the specified control recipe’s mode to SEMI-AUTO
is valid.
object
An object expression that evaluates to an object in the Applies To list.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Part
Description
ID
ControlRecipeList control only.
Required. Integer that evaluates to the unique create ID of a control recipe.
Settings
The settings for result are:
Setting
Description
True
Control recipe’s mode can be changed to Semi-Auto.
False
Control recipe’s mode cannot be changed to Semi-Auto.
Remarks
The CanSetSemiAuto property is True only when the currently logged-in user
has permission to put control recipes into semi-automatic mode and the mode of
the specified control recipe is not already SEMI-AUTO.
When the object expression evaluates to the ProcedureView control, only steps
not already in semi-automatic mode can be commanded to switch to this mode. If
a transition is selected, this property is False. If there is no step selected, this
property is relative to the depicted procedure.
CanStart
Applies To
ControlRecipeList Control, ProcedureView Control
Description
The CanStart property is not available at design time and is read-only at run time.
Returns whether the indicated control recipe or recipe step can be started.
Syntax
[result =] object.CanStart ID
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
The CanStart property syntax has these parts:
Part
Description
result
Boolean expression that specifies if the Start command is valid for the specified control
recipe (ControlRecipeList) or the selected recipe step (ProcedureView).
object
An object expression that evaluates to an object in the Applies To list.
ID
ControlRecipeList control only.
Required. Integer that evaluates to the unique create ID of a control recipe.
Settings
The settings for result are:
Setting
Description
True
Control recipe or selected recipe step can be started.
False
Start is not a valid command for the control recipe or selected recipe step.
Remarks
The CanStart property is True only when the currently logged-in user has
permission to start control recipes and the specified control recipe is in the IDLE
state.
When the object expression evaluates to the ProcedureView control, the Start
command is only valid for a step when its state is IDLE. If a transition is selected,
this property is False. If nothing is selected, this property is relative to the depicted
procedure.
CanStop
Applies To
ControlRecipeList Control, ProcedureView Control
Description
The CanStop property is not available at design time and is read-only at run time.
Returns whether the indicated control recipe can be stopped.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Syntax
[result =] object.CanStop ID
The CanStop property syntax has these parts:
Part
Description
result
Boolean expression that specifies if the Stop command is valid for the specified control
recipe (ControlRecipeList) or the selected recipe step (ProcedureView).
object
An object expression that evaluates to an object in the Applies To list.
ID
ControlRecipeList control only.
Required. Integer that evaluates to the unique create ID of a control recipe.
Settings
The settings for result are:
Setting
Description
True
Control recipe or selected recipe step can be stopped.
False
Stop is not a valid command for the control recipe or selected recipe step.
Remarks
The CanStop property is True only when the currently logged-in user has
permission to stop control recipes and the specified control recipe is in the
RUNNING, HOLDING, HELD or RESTARTING state.
When the object expression evaluates to the ProcedureView control, the Stop
command is only valid for a step when its state is RUNNING, HOLDING,
HELD, or RESTARTING. If a transition is selected, this property is False. If
nothing is selected, this property is relative to the depicted procedure.
ChartDrawWidth
Applies To
ProcedureView Control
Description
Returns or sets a value that determines the line width of the recipe elements
depicted in the control.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Syntax
object.ChartDrawWidth [= width]
The ChartDrawWidth property syntax has these parts:
Part
Description
object
An object expression that evaluates to an object in the Applies To list.
width
New width of the lines drawn in the control to depict the recipe elements.
(Default = 2)
Remarks
The ChartDrawWidth property is in units of pixels.
ChartFont
Applies To
ProcedureView Control
Description
Returns or sets the font used for the text of the recipe elements.
Syntax
[Set] object.ChartFont [= font]
The ChartFont property syntax has these parts:
Part
Description
object
An object expression that evaluates to an object in the Applies To list.
font
New font object to be used when depicting recipe elements.
(Default = Arial)
Remarks
The size of the ChartFont applies to a Zoom value of 100%. The actual size of the
text depicted in the recipe elements is (ChartFontSize * Zoom / 100). Changes to
the properties of this object property are not reflected in the control until its
interval next elapses.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
ChartFontBold
Applies To
ProcedureView Control
Description
Returns or sets the bold characteristic of the font used for the text of the recipe
elements.
Syntax
object.ChartFontBold [= bold]
The ChartFontBold property syntax has these parts:
Part
Description
object
An object expression that evaluates to an object in the Applies To list.
bold
Boolean expression that specifies if the chart font should or should not be bold.
Settings
The settings for bold are:
ChartFontItalic
Setting
Description
True
The chart font should be bold.
False
The chart font should not be bold (Default).
Applies To
ProcedureView Control
Description
Returns or sets the italics characteristic of the font used for the text of the recipe
elements.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Syntax
object.ChartFontItalic [= italic]
The ChartFontItalic property syntax has these parts:
Part
Description
object
An object expression that evaluates to an object in the Applies To list.
italic
Boolean expression that specifies if the chart font should or should not be italicized.
Settings
The settings for italic are:
ChartFontName
Setting
Description
True
The chart font should be italicized.
False
The chart font should not be italicized (Default).
Applies To
ProcedureView Control
Description
Returns or sets the name of the font used for the text of the recipe elements.
Syntax
object.ChartFontName [= name]
The ChartFontName property syntax has these parts:
Part
Description
object
An object expression that evaluates to an object in the Applies To list.
name
String that holds the name of the font to use for depicting recipe element text.
(Default = Arial)
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
ChartFontSize
Applies To
ProcedureView Control
Description
Returns or sets the size of the font used for the text of the recipe elements.
Syntax
object.ChartFontSize [= size]
The ChartFontSize property syntax has these parts:
Part
Description
object
An object expression that evaluates to an object in the Applies To list.
size
String that holds the size of the font to use for depicting recipe element text.
(Default = 9.75)
Remarks
The size of the ChartFont applies to a Zoom value of 100%. The actual size of the
text depicted in the recipe elements is (ChartFontSize * Zoom / 100).
ChartFontStrikethru
Applies To
ProcedureView Control
Description
Returns or sets the font strikethru characteristic used for the recipe element text.
Syntax
object.ChartFontStrikethru [= strikethru]
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
The ChartFontStrikethru property syntax has these parts:
Part
Description
object
An object expression that evaluates to an object in the Applies To list.
strikethru
Boolean expression that specifies if the chart font should or should not be struck through
(crossed out).
Settings
The settings for strikethru are:
ChartFontUnderline
Setting
Description
True
The chart font should be struck through (crossed out).
False
The chart font should not be struck through (crossed out). (Default)
Applies To
ProcedureView Control
Description
Returns or sets the font underline characteristic used for the recipe element text.
Syntax
object.ChartFontUnderline [= underline]
The ChartFontUnderline property syntax has these parts:
Part
Description
object
An object expression that evaluates to an object in the Applies To list.
underline
Boolean expression that specifies if the chart font should or should not be underlined.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Settings
The settings for underline are:
CommunicationStatus
Setting
Description
True
The chart font should be underlined.
False
The chart font should not be underlined. (Default)
Applies To
ProcedureView Control
Description
Returns the status of the communication between the control and the
FactoryTalk Batch Server service identified by the Node property.
Syntax
[status =] object.CommunicationStatus
The CommunicationStatus property syntax has these parts:
Part
Description
status
A Boolean expression that represents the status of the communication between the control
and the FactoryTalk Batch Server service identified by the Node property.
object
An object expression that evaluates to an object in the Applies To list.
Settings
The settings for status are:
Setting
Description
True
Communication status between the control and the FactoryTalk Batch Server is okay.
False
Communication status between the control and the FactoryTalk Batch Server is not okay.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Remarks
The property is read-only at run time.
Connection
Applies To
ControlRecipeList Control, PromptsList Control, TimerView Control
Description
The Connection property is not available at design time and is read-only at run
time.
Returns a reference to the connection object associated with the communication
between the ControlRecipeList control, the PromptsList control, or the
TimerView Control and the FactoryTalk Batch Server.
Syntax
[Set con =] object.Connection
The Connection property syntax has these parts:
Part
Description
con
An object reference that refers to the connection object associated with the communication
between the control and the FactoryTalk Batch Server.
object
An object expression that evaluates to an object in the Applies To list.
Remarks
The Connection property has two methods (Execute, GetData) and six
properties (Status, Node, ServerLost, TimeoutPeriod, RetryPeriod, CallTimeout,
and ConnectTimeout):
•
The Execute method has one argument, a string, which is a command string
to be sent to the FactoryTalk Batch Server. (Refer to the Server API
Communications Language Reference for the proper format and contents of
this command string argument.)
•
The GetData method has one argument, a string, sent to the FactoryTalk
Batch Server as a COM or DCOM data request. (Refer to the Server API
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Communications Language Reference for the proper format and contents of
this string argument.)
ConnectTimeout
•
The Status property, of type string, is read-only and only available at run
time. It either has the value OK, indicating that the connection is good, or
its value is a string describing the problem with the connection.
•
The Node property contains either the IP address or the name of the
computer running the FactoryTalk Batch Server with which the control
should communicate. If the Node property is a zero length string, the
control will attempt to communicate with an instance of the FactoryTalk
Batch Server running on the same (local) computer.
•
The ServerLost property is read-only and only available at run time. It has a
Boolean value; True, indicating that the connection is good or False,
indicating that the connection has failed.
•
The TimeoutPeriod property is of type long. It indicates the number of
milliseconds that the FactoryTalk Batch Server with which the control is
communicating will wait before assuming that it cannot respond to the
current request. Setting this property to a value less than 1 (one) or greater
than 2147483647 will cause an error.
•
The RetryPeriod property is of type long. It indicates the period of time in
seconds that the FactoryTalk Batch Client waits before it retries connecting
to the Batch Server if communication with the Server is lost.
•
The CallTimeout property is of type long. It is only available at run time. It
indicates the number of milliseconds that the control will wait for the
FactoryTalk Batch Server to respond to a data request before assuming that
communication with the Server has been lost.
•
The ConnectTimeout property is of type long. It is only available at run
time. It indicates the number of milliseconds that the control will wait for
the FactoryTalk Batch Server to acknowledge a connection before assuming
that communication with the Server cannot be established.
Applies To
ControlRecipeList Control, PromptsList Control, ProcedureView Control,
TimerView Control
Description
Returns or sets the number of seconds the FactoryTalk Batch Server waits for a
command handshake before issuing a timeout.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Syntax
object.ConnectTimeout [= value]
The ConnectTimeout property syntax has these parts:
Part
Description
object
An object expression that evaluates to an object in the Applies To list.
value
A value that indicates the number of milliseconds that the control will wait to establish a
connection with the FactoryTalk Batch Server service (specified by the Node property). If the
amount of time exceeds the number of milliseconds indicated by the ConnectTimeout
property, the control will assume that the FactoryTalk Batch Server is not running and will
display a Communication Lost message. The allowable range is 1 to 3,600,000 (one hour).
The default value is 90,000 (90 seconds).
Remarks
Setting this property to a value outside of the allowable range will raise an error.
ControlRecipes
Applies To
ControlRecipeList Control
Description
Returns a reference to the control recipe collection in the FactoryTalk Batch
Server. The ControlRecipes property is not available at design time and is readonly at run time.
Syntax
[Set col =] object.ControlRecipes
The ControlRecipes property syntax has these parts:
Part
Description
col
An object reference that refers to the ControlRecipes collection object associated with the
FactoryTalk Batch Server.
object
An object expression that evaluates to an object in the Applies To list.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Remarks
The ControlRecipes collection has two methods, Count and Item:
•
The Count method returns a long, signifying the number of control recipes
in the collection, and therefore executing in the FactoryTalk Batch Server.
•
The Item method allows individual access to the control recipes in the
collection. It has one argument, the Index of the desired control recipe
within the collection, and returns a reference to the control recipe indicated
by the Index argument.
The reference returned has 14 properties. (Refer to the “SelectedControlRecipe
(on page 183)” property for a description of the properties available for each item
in the control recipe collection.)
CreateIDColumnText
Applies To
ControlRecipeList Control
Description
Returns or sets a value that determines the text displayed in the Create ID column
header of the list.
Syntax
object.CreateIDColumnText [= text]
The CreateIDColumnText property syntax has these parts:
Part
Description
object
An object expression that evaluates to an object in the Applies To list.
text
A string to be displayed as the column header text for the Create ID column.
(Default = Create ID)
Remarks
Setting this property to a zero-length string ("") will cause the column header to
display without text (empty). Setting this property to Null will raise an error.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
CreateIDColumnWidth
Applies To
ControlRecipeList Control
Description
Returns or sets a value that determines the Create ID column width in the control
recipe list.
Syntax
object.CreateIDColumnWidth [= value]
The CreateIDColumnWidth property syntax has these parts:
Part
Description
object
An object expression that evaluates to an object in the Applies To list.
value
An integer or enumeration that determines the width of the Create ID column.
(Default = 1440)
Remarks
The column width measured in units of twips 9. Setting this property to Null will
raise an error.
CreateIDFilterPattern
Applies To
ControlRecipeList Control
Description
Returns or sets the filter pattern for the Create ID column.
Syntax
object.CreateIDFilterPattern [= pattern]
9
A twip is a unit of measurement implemented as 1/20 of a point or 1/1440 of an inch.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
The CreateIDFilterPattern property syntax has these parts:
Part
Description
object
An object expression that evaluates to an object in the Applies To list.
pattern
A string that determines the filter pattern for the Create ID column.
(Default = *)
Remarks
Setting this property to Null will raise an error.
A filter pattern is a string that determines the string characteristics to be included
in a particular column. For example, if the Create ID of a particular control recipe
in the control recipe list does not match the CreateIDFilterPattern, that control
recipe is not included in the control recipe list. Filter patterns are defined as
follows:
Kind of match
Pattern
Match (returns True)
No match (returns False)
Multiple characters
a*a
aa, aBa, aBBBa
aBC
*ab*
abc, AABB, Xab
aZb, bac
Special character
a[*]a
a*a
aaa
Multiple characters
ab*
abcdefg, abc
cab, aab
Single character
a?a
aaa, a3a, aBa
aBBBa
Single digit
a#a
a0a, a1a, a2a
aaa, a10a
Range of characters
[a-z]
f, p, j
2, &
Outside a range
[!a-z]
9, &, %
b, a
Not a digit
[!0-9]
A, a, &, ~
0, 1, 9
Combined
a[!b-m]#
An9, az0, a99
abc, aj0
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
CurrentProcedureAbstract
Applies To
ProcedureView Control
Description
Returns the abstract header data of the procedure depicted in the control.
This property is not available at design time and is read-only at run time.
Syntax
[abstract =] object.CurrentProcedureAbstract
The CurrentProcedureAbstract property syntax has these parts:
CurrentProcedureAuthor
Part
Description
abstract
A string that holds the header abstract of the procedure currently depicted by the control.
object
An object expression that evaluates to an object in the Applies To list.
Applies To
ProcedureView Control
Description
Returns the procedure’s author header data depicted in the control.
This property is not available at design time and is read-only at run time.
Syntax
[author =] object.CurrentProcedureAuthor
The CurrentProcedureAuthor property syntax has these parts:
Part
Description
author
A string that holds the procedure’s header author of the procedure currently depicted by the
control.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
CurrentProcedureDate
Part
Description
object
An object expression that evaluates to an object in the Applies To list.
Applies To
ProcedureView Control
Description
Returns the procedure’s date header data depicted in the control.
This property is not available at design time and is read-only at run time.
Syntax
[date =] object.CurrentProcedureDate
The CurrentProcedureDate property syntax has these parts:
CurrentProcedure
Description
Part
Description
date
A string that holds the procedure’s header date currently depicted by the control.
object
An object expression that evaluates to an object in the Applies To list.
Applies To
ProcedureView Control
Description
Returns the procedure’s description header data depicted in the control.
This property is not available at design time and is read-only at run time.
Syntax
[desc =] object.CurrentProcedureDescription
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
The CurrentProcedureDescription property syntax has these parts:
CurrentProcedureID
Part
Description
desc
String that holds the procedure’s header description currently depicted by the control.
object
An object expression that evaluates to an object in the Applies To list.
Applies To
ProcedureView Control
Description
Returns the procedure’s ID depicted in the control.
This property is not available at design time but can be read or written to at run
time.
Syntax
[procID =] object.CurrentProcedureID
The CurrentProcedureID property syntax has these parts:
Part
Description
procID
String that holds the procedure’s ID currently depicted by the control.
object
An object expression that evaluates to an object in the Applies To list.
Remarks
Refer to the Server API Communications Language Reference for information on
the ProcedureID ASCII-String return format.
CurrentProcedureProduct
Code
Applies To
ProcedureView Control
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Description
Returns the code header data of the procedure depicted in the control.
This property is not available at design time and is read-only at run time.
Syntax
[code =] object.CurrentProcedureProductCode
The CurrentProcedureProductCode property syntax has these parts:
CurrentProcedureVersion
Part
Description
code
A string that holds the header code of the procedure currently depicted by the control.
object
An object expression that evaluates to an object in the Applies To list.
Applies To
ProcedureView Control
Description
Returns the version header data of the procedure depicted in the control.
This property is not available at design time and is read-only at run time.
Syntax
[version =] object.CurrentProcedureVersion
The CurrentProcedureVersion property syntax has these parts:
DefaultBatchID
Part
Description
version
A string that holds the header version of the procedure currently depicted by the control.
object
An object expression that evaluates to an object in the Applies To list.
Applies To
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Description
Returns or sets the default batch ID used when creating a new control recipe. Only
used when a timeout occurs on the AutoBatchID_Info execute.
Syntax
object.DefaultBatchID [= text]
The DefaultBatchID property syntax has these parts:
Part
Description
object
An object expression that evaluates to an object in the Applies To list.
text
A string that determines the batch ID to be used as the default when creating a new control
recipe.
(Default = BATCH_ID)
Remarks
Changes to the DefaultBatchID property at run time must be made prior to the
invocation of the Create Control Recipe command. Once this command has been
invoked, and the Master Recipe List dialog box has been displayed, changes to the
DefaultBatchID property will not take effect until the current execution of the
Create Control Recipe command is completed (the Master Recipe List dialog
box and Create Control Recipe wizard forms are no longer displayed).
Setting this property to a zero-length string ("") or Null will raise an error.
Only used when a timeout occurs on the AutoBatchID_Info execute.
(See the FactoryTalk Batch Administrator’s Guide for more information on
customizing batch IDs.)
DefaultScale
Applies To
ControlRecipeList Control
Description
Returns or sets the default control recipe scale used when creating a new control
recipe. The DefaultScale is interpreted as a percentage of the master recipe output.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Syntax
object.DefaultScale [= value]
The DefaultScale property syntax has these parts:
Part
Description
object
An object expression that evaluates to an object in the Applies To list.
value
A string that determines the scale to be used as default when creating a new control recipe.
(Default = 100)
Remarks
Changes to the DefaultScale property at run time must be made prior to the
invocation of the Create Control Recipe command. Once this command has
been invoked, and the Master Recipe List dialog box has been displayed, changes
to the DefaultScale property will not take effect until the current execution of
Create Control Recipe command is completed (the Master Recipe List dialog
box and Create Control Recipe wizard forms are no longer displayed).
Setting this property to a zero-length string (""), to Null, or to a string that cannot
be converted to a number will raise an error.
DescriptionColumnText
Applies To
ControlRecipeList Control, PromptsList Control
Description
Returns or sets a value that determines the text displayed in the header of the
Description column in the list.
Syntax
object.DescriptionColumnText [= text]
The DescriptionColumnText property syntax has these parts:
Part
Description
object
An object expression that evaluates to an object in the Applies To list.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
text
A string to be displayed as the column header text for the Description column.
(Default = Description)
Remarks
Setting this property to a zero-length string ("") will cause the column header to
display without text (empty). Setting this property to Null will raise an error.
DescriptionColumnWidth
Applies To
ControlRecipeList Control, PromptsList Control
Description
Returns or sets a value that determines the Description column width in the list.
Syntax
object.DescriptionColumnWidth [= value]
The DescriptionColumnWidth property syntax has these parts:
Part
Description
object
An object expression that evaluates to an object in the Applies To list.
value
An integer or enumeration that determines the Description column width.
(Default = 1440)
Remarks
Setting this property to a value less than zero will raise an error. The column width
is measured in units of twips 10.
DescriptionFilterPattern
Applies To
ControlRecipeList Control, PromptsList Control
10
A twip is a unit of measurement implemented as 1/20 of a point or 1/1440 of an inch.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Description
Returns or sets the filter pattern for the Description column.
Syntax
object.DescriptionFilterPattern [= pattern]
The DescriptionFilterPattern property syntax has these parts:
Part
Description
object
An object expression that evaluates to an object in the Applies To list.
pattern
A string that determines the filter pattern for the Description column.
(Default = *)
Remarks
Setting this property to Null will raise an error.
A filter pattern is a string that determines the string characteristics to be included
in a particular column. For example, if the Description of a particular prompt in
the prompts list does not match the DescriptionFilterPattern, that prompt is not
included in the prompts list. Filter patterns are defined as follows:
Kind of match
Pattern
Match (returns True)
No match (returns False)
Multiple characters
a*a
aa, aBa, aBBBa
aBC
*ab*
abc, AABB, Xab
aZb, bac
Special character
a[*]a
a*a
aaa
Multiple characters
ab*
abcdefg, abc
cab, aab
Single character
a?a
aaa, a3a, aBa
aBBBa
Single digit
a#a
a0a, a1a, a2a
aaa, a10a
Range of characters
[a-z]
f, p, j
2, &
Outside a range
[!a-z]
9, &, %
b, a
Not a digit
[!0-9]
A, a, &, ~
0, 1, 9
Combined
a[!b-m]#
An9, az0, a99
abc, aj0
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
DialogFontBold
Applies To
ProcedureView Control
Description
Returns or sets the font bold characteristic used for the dialog box text associated
with the control.
Syntax
object.DialogFontBold [= bold]
The DialogFontBold property syntax has these parts:
Part
Description
object
An object expression that evaluates to an object in the Applies To list.
bold
A Boolean expression that specifies if the font should or should not be bold.
Settings
The settings for bold are:
DialogFontItalic
Setting
Description
True
The font should be bold.
False
The font should not be bold. (Default)
Applies To
ProcedureView Control
Description
Returns or sets the font italics characteristic used for the dialog box text associated
with the control.
Syntax
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
The DialogFontItalic property syntax has these parts:
Part
Description
object
An object expression that evaluates to an object in the Applies To list.
italic
A Boolean expression that specifies if the font should or should not be italicized.
Settings
The settings for italic are:
DialogFontName
Setting
Description
True
The font should be italicized.
False
The font should not be italicized. (Default)
Applies To
ProcedureView Control
Description
Returns or sets the font name used for the dialog box text associated with the
control.
Syntax
object.DialogFontName [= name]
The DialogFontName property syntax has these parts:
DialogFontSize
Part
Description
object
An object expression that evaluates to an object in the Applies To list.
name
A string that holds the font name to use for the dialog box text associated with the control.
(Default = Arial)
Applies To
ProcedureView Control
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Description
Returns or sets the font size used for the dialog box text associated with the
control.
Syntax
object.DialogFontSize [= size]
The DialogFontSize property syntax has these parts:
DialogFontStrikethru
Part
Description
object
An object expression that evaluates to an object in the Applies To list.
size
A single value that holds the font size to use for the dialog box text associated with the
control.
Applies To
ProcedureView Control
Description
Returns or sets the font strikethru characteristic used for the dialog box text
associated with the control.
Syntax
object.DialogFontStrikethru [= strikethru]
The DialogFontStrikethru property syntax has these parts:
Part
Description
object
An object expression that evaluates to an object in the Applies To list.
strikethru
A Boolean expression that specifies if the font should or should not be struck through (crossed
out).
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Settings
The settings for strikethru are:
DialogFontUnderline
Setting
Description
True
The font should be struck through (crossed out).
False
The font should not be struck through (crossed out) (Default).
Applies To
ProcedureView Control
Description
Returns or sets the font underline characteristic used for the dialog box text
associated with the control.
Syntax
object.DialogFontUnderline [= underline]
The DialogFontUnderline property syntax has these parts:
Part
Description
object
An object expression that evaluates to an object in the Applies To list.
underline
A Boolean expression that specifies if the font should or should not be underlined.
Settings
The settings for underline are:
Setting
Description
True
The font should be underlined.
False
The font should not be underlined. (Default)
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
DisplayedParameters
Applies To
ProcedureView Control
Description
Returns or sets the number of parameters displayed at-a-glance for each regular
step.
Syntax
[num =] object.DisplayedParameters
The DisplayedParameters property syntax has these parts:
Part
Description
num
An integer value that holds the number of parameters to display
at-a-glance.
object
An object expression that evaluates to an object in the Applies To list.
Remarks
In Table view, the step’s key parameter is displayed in column 1. The SFC view
always displays one parameter. The default value of DisplayedParameters is 1.
DisplayLimits
Applies To
SignatureList Control
Description
Returns or sets a flag that determines if recipe and report parameter limits are
displayed in their respective deviation signature dialogs.
Syntax
object.DisplayLimits [=flag]
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
The DisplayLimits property syntax has these parts:
Part
Description
object
An object expression that evaluates to a SignatureList control.
flag
A boolean value that determines if recipe and report parameter limits are displayed in their
deviation signature dialogs.
((Default = True))
Remarks
A value of True indicates that the limits will be displayed. A value of False
indicates that the limits will not be displayed.
DisplayNonIncomplete
Applies To
SignatureList Control
Description
Returns or sets a flag that determines if signatures in non-incomplete signatures
are listed in the control.
Syntax
object.DisplayNonIncomplete [=flag]
The DisplayNonIncomplete property syntax has these parts:
Part
Description
object
An object expression that evaluates to a SignatureList control.
flag
A boolean value that determines if non-incomplete signatures are listed in the control.
((Default = True))
Remarks
A value or True indicates that non-incomplete signatures will be displayed. A
value of False indicates that non-incomplete signatures will not be displayed.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Domains
Applies To
SignatureList Control
Description
Returns an array of domains for use with the SignoffSignature method.
Syntax
[domains=]object.Domains
The Domains property syntax has these parts:
Part
Description
object
An object expression that evaluates to a SignatureList control.
domains
A variant variable used to hold the array of domains returned by the object.
Remarks
The domain list originates in the FactoryTalk Batch Server’s Domains item. (See
the FactoryTalk Batch Server API Technical Reference for more information.)
DoubleClickNavigation
Applies To
ProcedureView Control
Description
Returns or sets a value that determines if the control allows the user to navigate
the depicted procedure by double-clicking a regular step or initial step.
Syntax
object.DoubleClickNavigation [= navigate]
The DoubleClickNavigation property syntax has these parts:
Part
Description
object
An object expression that evaluates to an object in the Applies To list.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Settings
The settings for navigate are:
ElapsedTimeColumnText
Setting
Description
True
The user can navigate the depicted procedure by double-clicking. (Default)
False
The user cannot navigate the depicted procedure by double-clicking.
Applies To
ControlRecipeList Control
Description
Returns or sets a value that determines the text displayed in the Elapsed Time
column header of the list.
Syntax
object.ElapsedTimeColumnText [= text]
The ElapsedTimeColumnText property syntax has these parts:
Part
Description
object
An object expression that evaluates to an object in the Applies To list.
text
A string to be displayed as the column header text for the Elapsed Time column.
(Default = Elapsed Time)
Remarks
Setting this property to a zero-length string ("") will cause the column header to
display without text (empty). Setting this property to Null will raise an error.
ElapsedTimeColumnWidth
Applies To
ControlRecipeList Control
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Description
Returns or sets a value that determines the Elapsed Time column width in the
control recipe list.
Syntax
object.ElapsedTimeColumnWidth [= value]
The ElapsedTimeColumnWidth property syntax has these parts:
Part
Description
object
An object expression that evaluates to an object in the Applies To list.
value
An integer or enumeration that determines the Elapsed Time column width.
(Default = 1440)
Remarks
Setting this property to a value less than zero will raise an error. The column width
is measured in units of twips 11.
ElapsedTimeFilterPattern
Applies To
ControlRecipeList Control
Description
Returns or sets the filter pattern for the Elapsed Time column.
Syntax
object.ElapsedTimeFilterPattern [= pattern]
The ElapsedTimeFilterPattern property syntax has these parts:
Part
Description
pattern
A string that determines the filter pattern for the Elapsed Time column.
object
An object expression that evaluates to an object in the Applies To list.
(Default = *)
11
A twip is a unit of measurement implemented as 1/20 of a point or 1/1440 of an inch.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Remarks
Setting this property to Null will raise an error.
A filter pattern is a string that determines the string characteristics to be included
in a particular column. For example, if the Elapsed Time of a particular control
recipe in the control recipe list does not match the ElapsedTimeFilterPattern,
that control recipe is not included in the control recipe list. Filter patterns are
defined as follows:
Enabled
Kind of match
Pattern
Match (returns True)
No match (returns False)
Multiple characters
a*a
aa, aBa, aBBBa
aBC
*ab*
abc, AABB, Xab
aZb, bac
Special character
a[*]a
a*a
aaa
Multiple characters
ab*
abcdefg, abc
cab, aab
Single character
a?a
aaa, a3a, aBa
aBBBa
Single digit
a#a
a0a, a1a, a2a
aaa, a10a
Range of characters
[a-z]
f, p, j
2, &
Outside a range
[!a-z]
9, &, %
b, a
Not a digit
[!0-9]
A, a, &, ~
0, 1, 9
Combined
a[!b-m]#
An9, az0, a99
abc, aj0
Applies To
ControlRecipeList Control, PromptsList Control, ProcedureView Control,
SignatureList Control
Description
Specifies whether a control can receive the focus and respond to user-generated
events.
Syntax
object.Enabled [= value]
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
The Enabled property syntax has these parts:
Part
Description
object
An object expression that evaluates to an object in the Applies To list.
value
Optional. Boolean value indicating whether or not the object can respond to user-generated
events, as described in Settings.
Settings
The settings for value are:
Value
Description
True
The control can receive the focus and respond to user-generated events, and is accessible
through code. (Default)
False
The user cannot interact with the control by using the mouse, keystrokes, accelerators, or
hotkeys. The control is still accessible through code.
Remarks
Use the Enabled property to enable and disable controls. A disabled control
appears dimmed, while an enabled control does not.
EUColumnText
Applies To
PromptsList Control
Description
Returns or sets a value that determines the text displayed in the engineering units
(EU) column header of the list.
Syntax
object.EUColumnText [= text]
The EUColumnText property syntax has these parts:
Part
Description
object
An object expression that evaluates to an object in the Applies To list.
text
A string to be displayed as the column header text for the EU column.
(Default = EU)
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Remarks
Setting this property to a zero-length string ("") will cause the column header to
display without text (empty). Setting this property to Null will raise an error.
EUColumnWidth
Applies To
PromptsList Control
Description
Returns or sets a value that determines the engineering units (EU) column width
in the prompts list.
Syntax
object.EUColumnWidth [= value]
The EUColumnWidth property syntax has these parts:
Part
Description
object
An object expression that evaluates to an object in the Applies To list.
value
An integer or enumeration that determines the EU column width.
(Default = 1440)
Remarks
Setting this property to a value less than zero will raise an error. The width of a
column is measured in units of twips 12.
EUFilterPattern
Applies To
PromptsList Control
Description
Returns or sets the filter pattern for the engineering units (EU) column.
12
A twip is a unit of measurement implemented as 1/20 of a point or 1/1440 of an inch.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Syntax
object.EUFilterPattern [= pattern]
The EUFilterPattern property syntax has these parts:
Part
Description
object
An object expression that evaluates to an object in the Applies To list.
pattern
A string that determines the filter pattern for the EU column.
(Default = *)
Remarks
Setting this property to Null will raise an error.
A filter pattern is a string that determines the string characteristics to be included
in a particular column. For example, if the engineering units of a particular prompt
in the prompts list does not match the EUFilterPattern, that prompt is not
included in the prompts list. Filter patterns are defined as follows:
FailureColumnText
Kind of match
Pattern
Match (returns True)
No match (returns False)
Multiple characters
a*a
aa, aBa, aBBBa
aBC
*ab*
abc, AABB, Xab
aZb, bac
Special character
a[*]a
a*a
aaa
Multiple characters
ab*
abcdefg, abc
cab, aab
Single character
a?a
aaa, a3a, aBa
aBBBa
Single digit
a#a
a0a, a1a, a2a
aaa, a10a
Range of characters
[a-z]
f, p, j
2, &
Outside a range
[!a-z]
9, &, %
b, a
Not a digit
[!0-9]
A, a, &, ~
0, 1, 9
Combined
a[!b-m]#
An9, az0, a99
abc, aj0
Applies To
ControlRecipeList Control
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Description
Returns or sets a value that determines the text displayed in the header of the
Failure column in the list.
Syntax
object.FailureColumnText [= text]
The FailureColumnText property syntax has these parts:
Part
Description
object
An object expression that evaluates to an object in the Applies To list.
text(
A string to be displayed as the column header text for the Failure column.
(Default = Failure)
Remarks
Setting this property to a zero-length string ("") will cause the column header to
display without text (empty). Setting this property to Null will raise an error.
FailureColumnWidth
Applies To
ControlRecipeList Control
Description
Returns or sets a value that determines the Failure column width in the control
recipe list.
Syntax
object.FailureColumnWidth [= value]
The FailureColumnWidth property syntax has these parts:
Part
Description
object
An object expression that evaluates to an object in the Applies To list.
value
An integer or enumeration that determines the Failure column width.
(Default = 1440)
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Remarks
Setting this property to a value less than zero will raise an error. The column width
is measured in units of twips 13.
FailureFilterPattern
Applies To
ControlRecipeList Control
Description
Returns or sets the filter pattern for the Failure column.
Syntax
object.FailureFilterPattern [= pattern]
The FailureFilterPattern property syntax has these parts:
Part
Description
object
An object expression that evaluates to an object in the Applies To list.
pattern
A string that determines the filter pattern for the Failure column.
(Default = *)
Remarks
Setting this property to Null will raise an error.
A filter pattern is a string that determines the string characteristics to be included
in a particular column. For example, if the Failure of a particular control recipe in
the control recipe list does not match the FailureFilterPattern, that control
recipe is not included in the control recipe list. Filter patterns are defined as
follows:
Kind of match
Pattern
Match (returns True)
No match (returns False)
Multiple characters
a*a
aa, aBa, aBBBa
aBC
*ab*
abc, AABB, Xab
aZb, bac
a[*]a
a*a
aaa
Special character
13
A twip is a unit of measurement implemented as 1/20 of a point or 1/1440 of an inch.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Kind of match
Pattern
Match (returns True)
No match (returns False)
Multiple characters
ab*
abcdefg, abc
cab, aab
Single character
a?a
aaa, a3a, aBa
aBBBa
Single digit
a#a
a0a, a1a, a2a
aaa, a10a
Range of characters
[a-z]
f, p, j
2, &
Outside a range
[!a-z]
9, &, %
b, a
Not a digit
[!0-9]
A, a, &, ~
0, 1, 9
Combined
a[!b-m]#
An9, az0, a99
abc, aj0
FilteredControlRecipeCount Applies To
ControlRecipeList Control
Description
Returns the number of control recipes that match the filter patterns for the
control recipes’ properties.
This property is not available at design time and is read-only at run time.
Syntax
[result =] object.FilteredControlRecipeCount
The FilteredControlRecipeCount property syntax has these parts:
Part
Description
result
A string that holds the number of control recipes that match the current filter patterns for
every column.
object
An object expression that evaluates to an object in the Applies To list.
Remarks
If all of the filter patterns for the ControlRecipeList control are "*" (the default),
then the FilteredControlRecipeCount property has the same value as the
ControlRecipes.Count property.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
FilteredPromptCount
Applies To
PromptsList Control
Description
Returns the number of prompts that match the filter patterns for the prompts’
properties.
This property is not available at design time and is read-only at run time.
Syntax
[result =] object.FilteredPromptCount
The FilteredPromptCount property syntax has these parts:
Part
Description
result
A string that holds the number of prompts that match the current filter patterns for every
column.
object
An object expression that evaluates to an object in the Applies To list.
Remarks
If all of the filter patterns for the PromptsList control are "*" (the default), then
the FilteredPromptCount property has the same value as the Prompts.Count
property.
FilterOnBatchID
Applies To
TimerView Control
Description
Returns a boolean value that indicates if the timer list is currently filtered on the
BatchID.
Syntax
[value=]object.FilterOnBatchID
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
The FilterOnBatchID property syntax has these parts:
Part
Description
object
An object expression that evaluates to a TimerStepList control.
value
A boolean indicating if filtering on BatchID.
Remarks
If more than one of the Filter Properties is set to True, the first True encountered
is selected. The control sets the Filter Properties in the following order:
FilterOnUnitName, FilterOnBatchID, and then FilterOnRecipePath.
FilterOnRecipePath
Applies To
TimerView Control
Description
Returns a boolean value that indicates if the timer list is currently filtered on the
Recipe Path of the batches on the batch list.
Syntax
[value=]object.FilterOnRecipePath
The FilterOnRecipePath property syntax has these parts:
Part
Description
object
An object expression that evaluates to a TimerStepList control.
value
A boolean indicating if filtering on batch recipe path.
Remarks
If more than one of the Filter Properties is set to True, the first True encountered
is selected. The control sets the Filter Properties in the following order:
FilterOnUnitName, FilterOnBatchID, and then FilterOnRecipePath.
FilterOnUnitName
Applies To
TimerView Control
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Description
Returns a boolean value that indicates if the timer list is currently filtered on the
area model Unit Name.
Syntax
[value=]object.FilterOnUnitName
The FilterOnUnitName property syntax has these parts:
Part
Description
object
An object expression that evaluates to a TimerStepList control.
value
A boolean indicating if filtering on area model unit name.
Remarks
If more than one of the Filter Properties is set to True, the first True encountered
is selected. The control sets the Filter Properties in the following order:
FilterOnUnitName, FilterOnBatchID, and then FilterOnRecipePath.
FilterPattern
Applies To
TimerView Control
Description
Returns a string value representing the current filter pattern used to filter the
timer list.
Syntax
[value=]object.FilterPattern
The FilterPattern property syntax has these parts:
Part
Description
object
An object expression that evaluates to a TimerStepList control.
value
A string representing the filter pattern currently being used to filter the timer list.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Font
Applies To
ControlRecipeList Control, PromptsList Control, SignatureList Control
Description
Returns or sets the font of the specified object.
Syntax
[Set objFont =] object.Font
The Font property syntax has these parts:
Part
Description
objFont
A reference to a font object.
object
An object expression that evaluates to an object in the Applies To list.
Remarks
Use the Font property of an object to identify a specific Font object whose
properties you want to use. For example, the following code changes the Bold
property setting of a Font object identified by the Font property of a
ControlRecipeList object:
ControlRecipeList1.Font.Bold = True
ForeColor
Applies To
ControlRecipeList Control, PromptsList Control, ProcedureView9 Control,
SignatureList Control
Description
Returns or sets the foreground color used to display text and graphics in an object.
Syntax
object.ForeColor [= color]
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
The ForeColor properties syntax has these parts:
Part
Description
object
An object expression that evaluates to an object in the Applies To list.
color
A value or enumeration that determines an object’s background or foreground color as described
below.
(Default = Windows Background)
Remarks
The valid range for a normal RGB color is 0 to 16,777,215 (&HFFFFFF). The
high byte of a number in this range equals 0; the lower 3 bytes, from least to most
significant, determine the amount of red, green, and blue, respectively. The red,
green, and blue components are each represented by a number between 0 and 255
(&HFF). If the high byte is not 0, system colors are used.
To display text in the Windows operating environment, both the text and
background colors must be solid. If the text or background colors you have
selected are not displayed, one of the selected colors may be dithered — that is,
comprised of up to three different-colored pixels. If you choose a dithered color
for either the text or background, the nearest solid color will be substituted.
Setting either of these properties to a value outside of the allowable range (0 to
&HFFFFFF) will raise an error.
HideColumnHeaders
Applies To
ControlRecipeList Control, PromptsList Control, ProcedureView Control,
SignatureList Control
Description
Returns or sets whether the column headers in a control are hidden.
Syntax
object.HideColumnHeaders [= value]
The HideColumnHeaders property syntax has these parts:
Part
Description
object
An object expression that evaluates to an object in the Applies To list.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Part
Description
value
Boolean expression that specifies if the column headers are visible in Report view, as
described in Settings.
Settings
The settings for value are:
Setting
Description
True
The column headers are not visible.
False
The column headers are visible. (Default)
Remarks
When the object expression evaluates to the ProcedureView control, this
property applies only to the Table view and the default is True.
IncompleteSignatureCount Applies To
SignatureList Control
Description
Returns the number of incomplete signatures currently in the FactoryTalk Batch
Server.
Syntax
[count=]object.IncompleteSignatureCount
The IncompleteSignatureCount property syntax has these parts:
Part
Description
object
An object expression that evaluates to a SignatureList control.
count
A long integer value representing the number of incomplete signatures currently in the
FactoryTalk Batch Server.
Remarks
The value is unaffected by changing the filter pattern of the various columns.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Interval
Applies To
ControlRecipeList Control, PromptsList Control, ProcedureView Control,
SignatureList Control, TimerView Control
Description
Returns or sets the number of milliseconds between data updates.
Syntax
object.Interval [= value]
The Interval property syntax has these parts:
Part
Description
object
An object expression that evaluates to an object in the Applies To list.
value
A numeric expression specifying the number of milliseconds, as described in Settings.
Settings
The settings for value are:
Setting
Description
0
Disables updates.
1 to 65,535
Sets an interval (in milliseconds). For example, a value of 10,000 milliseconds equals 10
seconds. The maximum, 65,535 milliseconds, is just over one minute.
Defaults:
ProcedureView = 1000
ControlRecipeList = 5000
PromptsList = 5000
SignatureList = 1000
TimerView Control = 1000
Remarks
Setting this property to a value outside of the allowable range will raise an error.
InvocationProgID
Applies To
ControlRecipeList Control, ProcedureView Control, PromptsList Control
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Description
Returns or sets the object’s ProgID that the control creates and to which the
control passes cross invocation data.
Syntax
object.InvocationProgID [= text]
The InvocationProgID property syntax has these parts:
Part
Description
object
An object expression that evaluates to an object in the Applies To list.
text
A string that evaluates to the automation server’s Prog ID to which invocation requests are
directed.
Remarks
By default, this property is a zero-length string. Data is passed to the automation
server specified by this property via the Execute method as a string argument.
IsFiltered
Applies To
SignatureList Control
Description
Returns a Boolean value that indicates if the signature list is currently being
filtered.
Syntax
[value=]object.IsFiltered
The IsFiltered property syntax has these parts:
Part
Description
object
An object expression that evaluates to a SignatureList control.
value
A Boolean indication of the control’s filtered status.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Remarks
A value of True indicates that the list is filtered. A value of False indicates that the
list is not filtered.
True will be returned if any of the columns’ ColumnNameFilterPattern properties
contain something other than an empty string or *.
LabelWrap
Applies To
ControlRecipeList Control, PromptsList Control
Description
Returns or sets a value that determines whether or not labels are wrapped when a
list control is in Icon view.
Syntax
object.LabelWrap [= value]
The LabelWrap property syntax has these parts:
Part
Description
object
An object expression that evaluates to an object in the Applies To list.
value
Boolean expression specifying if the labels wrap, as described in Settings.
Settings
The settings for value are:
Setting
Description
True
The labels wrap. (Default)
False
The labels do not wrap.
Remarks
The label length is determined by setting the icon spacing in the Display
Properties dialog box in Windows. To access the Display Properties dialog box,
right-click the Desktop and select Properties from the shortcut menu. Click the
Appearance tab. Select Icon Spacing (Horizontal) or Icon Spacing (Vertical)
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
from the Item pull-down list. Enter the desired Icon Spacing in the Size box.
Click OK to close the dialog box.
ListSeparator
Applies To
ControlRecipeList Control, PromptsList Control, ProcedureView Control,
SignatureList Control, TimerView Control
Description
Returns the text representing the list separator. It is read-only, and can only be
read at run time.
Syntax
[text =] object.ListSeparator
The ListSeparator property syntax has these parts:
Part
Description
object
An object expression that evaluates to an object in the Applies To list.
text
A string specifying the list separator. The default value is locale-dependant.
Remarks
This property sets and retrieves the text used as the list separator. This list
separator is used in communication with the FactoryTalk Batch Server and also in
representing lists in the GUI. The ListSeparator value property is retrieved from
the FactoryTalk Batch Server service.
Setting this property to a zero-length string ("") or Null will raise an error.
MatchBackColor
Applies To
ControlRecipeList Control, PromptsList Control, ProcedureView Control,
SignatureList Control
Description
Returns or sets whether the control’s BackColor property should match the
container’s ambient BackColor property.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Syntax
object.MatchBackColor [= value]
The MatchBackColor property syntax has these parts:
Part
Description
object
An object expression that evaluates to an object in the Applies To list.
value
Boolean expression that specifies if the background color of the control will always match
the container’s background color.
Settings
The settings for value are:
Setting
Description
True
The background color will match the container.
(Default for ControlRecipeList, PromptsList and SignatureList)
False
The background color will not necessarily match the container.
(Default for ProcedureView)
Remarks
If this property is True, when the control is placed in the container or the
container’s background color changes, the control’s background color will change
to match the container’s background color.
MatchFont
Applies To
ControlRecipeList Control, PromptsList Control, ProcedureView Control,
SignatureList Control
Description
Returns or sets whether the control’s Font property should match the container’s
ambient Font property.
Syntax
object.MatchFont [= value]
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
The MatchFont property syntax has these parts:
Part
Description
object
An object expression that evaluates to an object in the Applies To list.
value
Boolean expression that specifies if the control’s font will always match the container’s font.
Settings
The settings for value are:
Setting
Description
True
The font will match the container
(Default for ControlRecipeList, PromptsList and SignatureList)
False
The font will not necessarily match the container.
(Default for ProcedureView)
Remarks
If this property is True, when the control is placed in the container or the
container’s font changes, the control’s font changes to match the container’s font.
MatchForeColor
Applies To
ControlRecipeList Control, PromptsList Control, SignatureList Control
Description
Returns or sets whether the control’s ForeColor property should match the
container’s ambient ForeColor property.
Syntax
object.MatchForeColor [= value]
The MatchForeColor property syntax has these parts:
Part
Description
object
An object expression that evaluates to an object in the Applies To list.
value
Boolean expression that specifies if the control’s foreground color will always match the
container’s foreground color.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Settings
The settings for value are:
Setting
Description
True
The foreground color will match the container. (Default)
False
The foreground color will not necessarily match the container.
Remarks
If this property is True, when the control is placed in the container or the
container’s foreground color changes, the control’s foreground color changes to
match the container’s foreground color.
ModeColumnText
Applies To
ControlRecipeList Control
Description
Returns or sets a value that determines the text displayed in the Mode column
header of the list.
Syntax
object.ModeColumnText [= text]
The ModeColumnText property syntax has these parts:
Part
Description
object
An object expression that evaluates to an object in the Applies To list.
text
String to be displayed as the column header text for the Mode column.
(Default = Mode)
Remarks
Setting this property to a zero-length string ("") will cause the column header to
display without text (empty). Setting this property to Null will raise an error.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
ModeColumnWidth
Applies To
ControlRecipeList Control
Description
Returns or sets a value that determines the Mode column width in the control
recipe list.
Syntax
object.ModeColumnWidth [= value]
The ModeColumnWidth property syntax has these parts:
Part
Description
object
An object expression that evaluates to an object in the Applies To list.
value
An integer or enumeration that determines the Mode column width.
(Default = 1440)
Remarks
Setting this property to a value less than zero will raise an error. The width of a
column is measured in units of twips 14.
ModeFilterPattern
Applies To
ControlRecipeList Control
Description
Returns or sets the filter pattern for the Mode column.
Syntax
object.ModeFilterPattern [= pattern]
14
A twip is a unit of measurement implemented as 1/20 of a point or 1/1440 of an inch.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
The ModeFilterPattern property syntax has these parts:
Part
Description
object
An object expression that evaluates to an object in the Applies To list.
pattern
A string that determines the filter pattern for the Mode column.
(Default = *)
Remarks
Setting this property to Null will raise an error.
A filter pattern is a string that determines the string characteristics to be included
in a particular column. For example, if the Mode of a particular control recipe in
the control recipe list does not match the ModeFilterPattern, that control recipe
is not included in the control recipe list. Filter patterns are defined as follows:
MouseIcon
Kind of match
Pattern
Match (returns True)
No match (returns False)
Multiple characters
a*a
aa, aBa, aBBBa
aBC
*ab*
abc, AABB, Xab
aZb, bac
Special character
a[*]a
a*a
aaa
Multiple characters
ab*
abcdefg, abc
cab, aab
Single character
a?a
aaa, a3a, aBa
aBBBa
Single digit
a#a
a0a, a1a, a2a
aaa, a10a
Range of characters
[a-z]
f, p, j
2, &
Outside a range
[!a-z]
9, &, %
b, a
Not a digit
[!0-9]
A, a, &, ~
0, 1, 9
Combined
a[!b-m]#
An9, az0, a99
abc, aj0
Applies To
ControlRecipeList Control, PromptsList Control, ProcedureView Control,
SignatureList Control
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Description
Returns or sets a custom mouse icon.
Syntax
object.MouseIcon = LoadPicture pathname
object.MouseIcon [= picture]
The MouseIcon property syntax has these parts:
Part
Description
object
An object expression that evaluates to an object in the Applies To list.
pathname
A string expression specifying the file’s path and filename containing the custom icon.
picture
The Picture property of a Form object, PictureBox control, or Image control.
Remarks
The MouseIcon property provides a custom icon that is used when the
MousePointer property is set to 99. You can use the MouseIcon property to load
either cursor or icon files. Color cursor files are displayed in black and white. To
display a color cursor, use a color icon file (.ico). The MouseIcon property
provides your program easy access to custom cursors of any size, with any desired
hot-spot location.
MousePointer
Applies To
ControlRecipeList Control, PromptsList Control, ProcedureView Control,
SignatureList Control
Description
Returns or sets a value indicating the type of mouse pointer displayed when the
mouse is over a particular part of an object at run time.
Syntax
object.MousePointer [= value]
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
The MousePointer property syntax has these parts:
Part
Description
object
An object expression that evaluates to an object in the Applies To list.
value
An integer specifying the type of mouse pointer displayed, as described in Settings.
Settings
The settings for value are:
Setting
Enumeration
Meaning
0
vbDefault
Shape determined by the object. (Default)
1
vbArrow
Arrow.
2
vbCrosshair
Cross (crosshair pointer).
3
vbIbeam
I beam.
4
vbIconPointer
Icon (small square within a square).
5
vbSizePointer
Size (four-pointed arrow pointing north, south, east, and west).
6
vbSizeNESW
Size NE SW (double arrow pointing northeast and southwest).
7
vbSizeNS
Size N S (double arrow pointing north and south).
8
vbSizeNWSE
Size NW SE (double arrow pointing northwest and southeast).
9
vbSizeWE
Size W E (double arrow pointing west and east).
10
vbUpArrow
Up Arrow.
11
vbHourglass
Hourglass (wait).
12
vbNoDrop
No Drop.
13
vbArrowHourglass
Arrow and hourglass.
14
vbArrowQuestion
Arrow and question mark.
15
vbSizeAll
Size all.
99
vbCustom
Custom icon specified by the MouseIcon property.
Remarks
You can use this property when you want to indicate changes in functionality as
the mouse pointer passes over the controls. The Hourglass setting (11) is useful for
indicating that the user should wait for a process or operation to finish.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Node
Applies To
ControlRecipeList Control, PromptsList Control, ProcedureView Control,
SignatureList Control, TimerView Control
Description
Returns or sets the node name of a specific computer.
Syntax
object.Node [= server]
The Node property syntax has these parts:
Part
Description
object
An object expression that evaluates to an object in the Applies To list.
server
A string expression specifying the node name or IP address of a specific computer on which
the FactoryTalk Batch Server service is running.
(Default = "" or nullstring)
Remarks
If the Node property is blank (a zero-length string), the control assumes that the
FactoryTalk Batch Server service with which it should communicate is running on
the same computer as the control’s container application.
PersistLogins
Applies To
ControlRecipeList Control, PromptsList Control, ProcedureView Control,
TimerView Control
Description
Returns or sets a flag that determines if logins performed as confirmation of a
command cause the currently-logged-in user to change.
Syntax
object.PersistLogins [= login]
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
The PersistLogins property syntax has these parts:
Part
Description
object
An object expression that evaluates to an object in the Applies To list.
login
A Boolean expression that indicates if the control’s security context changes to the user who
logs in when user confirmation is required to execute a command.
Settings
The settings for login are:
PhaseColumnText
Setting
Description
True
The control’s security context changes to the user who logs in when user confirmation is
required to execute the command.
False
The control’s security context is unchanged, regardless of the user who logs in the control.
(Default)
Applies To
PromptsList Control
Description
Returns or sets a value that determines the text displayed in the Phase column
header of the list.
Syntax
object.PhaseColumnText [= text]
The PhaseColumnText property syntax has these parts:
Part
Description
object
An object expression that evaluates to an object in the Applies To list.
text
A string to be displayed as the column header text for the Phase column.
(Default = Phase)
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Remarks
Setting this property to a zero-length string ("") will cause the column header to
display without text (empty). Setting this property to Null will raise an error.
PhaseColumnWidth
Applies To
PromptsList Control
Description
Returns or sets a value that determines the Phase column width in the prompts
list.
Syntax
object.PhaseColumnWidth [= value]
The PhaseColumnWidth property syntax has these parts:
Part
Description
object
An object expression that evaluates to an object in the Applies To list.
value
An integer or enumeration that determines the Phase column width.
(Default = 1440)
Remarks
Setting this property to a value less than zero will raise an error. The width of a
column is measured in units of twips 15.
PhaseFilterPattern
Applies To
PromptsList Control
Description
Returns or sets the filter pattern for the Phase column.
15
A twip is a unit of measurement implemented as 1/20 of a point or 1/1440 of an inch.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Syntax
object.PhaseFilterPattern [= pattern]
The PhaseFilterPattern property syntax has these parts:
Part
Description
object
An object expression that evaluates to an object in the Applies To list.
pattern
A string that determines the filter pattern for the Phase column.
(Default = *)
Remarks
Setting this property to Null will raise an error.
A filter pattern is a string that determines the string characteristics to be included
in a particular column. For example, if the Phase of a particular prompt in the
prompts list does not match the PhaseFilterPattern, that prompt is not included
in the prompts list. Filter patterns are defined as follows:
PhasesColumnText
Kind of match
Pattern
Match (returns True)
No match (returns False)
Multiple characters
a*a
aa, aBa, aBBBa
aBC
*ab*
abc, AABB, Xab
aZb, bac
Special character
a[*]a
a*a
aaa
Multiple characters
ab*
abcdefg, abc
cab, aab
Single character
a?a
aaa, a3a, aBa
aBBBa
Single digit
a#a
a0a, a1a, a2a
aaa, a10a
Range of characters
[a-z]
f, p, j
2, &
Outside a range
[!a-z]
9, &, %
b, a
Not a digit
[!0-9]
A, a, &, ~
0, 1, 9
Combined
a[!b-m]#
An9, az0, a99
abc, aj0
Applies To
ControlRecipeList Control
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Description
Returns or sets a value that determines the text displayed in the Phases column
header of the list.
Syntax
object.PhasesColumnText [= text]
The PhasesColumnText property syntax has these parts:
Part
Description
object
An object expression that evaluates to an object in the Applies To list.
text
A string to be displayed as the column header text for the Phases column.
(Default = Phases In Use)
Remarks
Setting this property to a zero-length string ("") will cause the column header to
display without text (empty). Setting this property to Null will raise an error.
PhasesColumnWidth
Applies To
ControlRecipeList Control
Description
Returns or sets a value that determines the Phases column width in the control
recipe list.
Syntax
object.PhasesColumnWidth [= value]
The PhasesColumnWidth property syntax has these parts:
Part
Description
object
An object expression that evaluates to an object in the Applies To list.
value
An integer or enumeration that determines the Phases column width.
(Default = 1440)
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Remarks
Setting this property to a value less than zero will raise an error. The column width
is measured in units of twips 16.
PhasesFilterPattern
Applies To
ControlRecipeList Control
Description
Returns or sets the filter pattern for the Phases column.
Syntax
object.PhasesFilterPattern [= pattern]
The PhasesFilterPattern property syntax has these parts:
Part
Description
object
An object expression that evaluates to an object in the Applies To list.
pattern
A string that determines the filter pattern for the Phases column.
(Default = *)
Remarks
Setting this property to Null will raise an error.
A filter pattern is a string that determines the string characteristics to be included
in a particular column. For example, if the Phases of a particular control recipe in
the control recipe list does not match the PhasesFilterPattern, that control recipe
is not included in the control recipe list. Filter patterns are defined as follows:
Kind of match
Pattern
Match (returns True)
No match (returns False)
Multiple characters
a*a
aa, aBa, aBBBa
aBC
*ab*
abc, AABB, Xab
aZb, bac
a[*]a
a*a
aaa
Special character
16
A twip is a unit of measurement implemented as 1/20 of a point or 1/1440 of an inch.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
ProcedureIDColumnText
Kind of match
Pattern
Match (returns True)
No match (returns False)
Multiple characters
ab*
abcdefg, abc
cab, aab
Single character
a?a
aaa, a3a, aBa
aBBBa
Single digit
a#a
a0a, a1a, a2a
aaa, a10a
Range of characters
[a-z]
f, p, j
2, &
Outside a range
[!a-z]
9, &, %
b, a
Not a digit
[!0-9]
A, a, &, ~
0, 1, 9
Combined
a[!b-m]#
An9, az0, a99
abc, aj0
Applies To
SignatureList Control
Description
Returns or sets a value that determines the text displayed in the Procedure ID
column header of the list.
Syntax
object.ProcedureIDColumnText [= text]
The ProcedureIDColumnText property syntax has these parts:
Part
Description
object
An object expression that evaluates to a SignatureList control.
text
A string to be displayed as the column header text for the Procedure ID column.
(Default = Procedure ID)
Remarks
Setting this property to a zero-length string ("") will cause the column header to
display without text (empty). Setting this property to Null will raise an error.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
ProcedureIDColumnWidth
Applies To
SignatureList Control
Description
Returns or sets a value that determines the Procedure ID column width in the list.
Syntax
object.ProcedureIDColumnWidth [= value]
The ProcedureIDColumnWidth property syntax has these parts:
Part
Description
object
An object expression that evaluates to a SignatureList control.
value
An integer that determines the column width.
(Default = 1440)
Remarks
Setting this property to a value less than zero will raise an error. The width of a
column is measured in units of twips 17. The minimum value is 1, the maximum
value is 32,767.
ProcedureIDFilterPattern
Applies To
SignatureList Control
Description
Returns or sets the filter pattern for the Procedure ID column.
Syntax
object.ProcedureIDFilterPattern [= pattern]
17
A twip is a unit of measurement implemented as 1/20 of a point or 1/1440 of an inch.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
The ProcedureIDFilterPattern property syntax has these parts:
Part
Description
object
An object expression that evaluates to a SignatureList control.
pattern
A string that determines the filter pattern for the Procedure ID column.
(Default = *)
Remarks
Setting this property to Null will raise an error.
A filter pattern is a string that determines the string characteristics to be included
in a particular column. For example, if the Procedure ID of a particular control
recipe in the control recipe list does not match the ProcedureIDFilterPattern,
that control recipe is not included in the control recipe list. Filter patterns are
defined as follows:
ProcedureIDShowColumn
Kind of match
Pattern
Match (returns True)
No match (returns False)
Multiple characters
a*a
aa, aBa, aBBBa
aBC
*ab*
abc, AABB, Xab
aZb, bac
Special character
a[*]a
a*a
aaa
Multiple characters
ab*
abcdefg, abc
cab, aab
Single character
a?a
aaa, a3a, aBa
aBBBa
Single digit
a#a
a0a, a1a, a2a
aaa, a10a
Range of characters
[a-z]
f, p, j
2, &
Outside a range
[!a-z]
9, &, %
b, a
Not a digit
[!0-9]
A, a, &, ~
0, 1, 9
Combined
a[!b-m]#
An9, az0, a99
abc, aj0
Applies To
SignatureList Control
Description
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Syntax
object.ProcedureIDShowColumn [=flag]
The ProcedureIDShowColumn property syntax has these parts:
Part
Description
object
An object expression that evaluates to a SignatureList control.
flag
A boolean value that determines if the Procedure ID column is displayed or not.
(Default = True)
Remarks
A value of True indicates that the column will be displayed. A value of False
indicates that the column will not be displayed.
ProcessCellColumnText
Applies To
ControlRecipeList Control, PromptsList Control
Description
Returns or sets a value that determines the text displayed in the Process Cell
column header of the list.
Syntax
object.ProcessCellColumnText [= text]
The ProcessCellColumnText property syntax has these parts:
Part
Description
object
An object expression that evaluates to an object in the Applies To list.
text
A string to be displayed as the column header text for the Process Cell column.
(Default = Process Cell)
Remarks
Setting this property to a zero-length string ("") will cause the column header to
display without text (empty). Setting this property to Null will raise an error.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
ProcessCellColumnWidth
Applies To
ControlRecipeList Control, PromptsList Control
Description
Returns or sets a value that determines the Process Cell column width in the list.
Syntax
object.ProcessCellColumnWidth [= value]
The ProcessCellColumnWidth property syntax has these parts:
Part
Description
object
An object expression that evaluates to an object in the Applies To list.
value
An integer or enumeration that determines the Process Cell column width.
(Default = 1440)
Remarks
Setting this property to a value less than zero will raise an error. The column width
is measured in units of twips 18.
ProcessCellFilterPattern
Applies To
ControlRecipeList Control, PromptsList Control
Description
Returns or sets the filter pattern for the Process Cell column.
Syntax
object.ProcessCellFilterPattern [= pattern]
18
A twip is a unit of measurement implemented as 1/20 of a point or 1/1440 of an inch.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
The ProcessCellFilterPattern property syntax has these parts:
Part
Description
object
An object expression that evaluates to an object in the Applies To list.
pattern
A string that determines the filter pattern for the Process Cell column.
(Default = *)
Remarks
Setting this property to Null will raise an error.
A filter pattern is a string that determines the string characteristics to be included
in a particular column. For example, if the Process Cell of a particular control
recipe in the control recipe list does not match the ProcessCellFilterPattern, that
control recipe is not included in the control recipe list. Filter patterns are defined
as follows:
PromptIDColumnText
Kind of match
Pattern
Match (returns True)
No match (returns False)
Multiple characters
a*a
aa, aBa, aBBBa
aBC
*ab*
abc, AABB, Xab
aZb, bac
Special character
a[*]a
a*a
aaa
Multiple characters
ab*
abcdefg, abc
cab, aab
Single character
a?a
aaa, a3a, aBa
aBBBa
Single digit
a#a
a0a, a1a, a2a
aaa, a10a
Range of characters
[a-z]
f, p, j
2, &
Outside a range
[!a-z]
9, &, %
b, a
Not a digit
[!0-9]
A, a, &, ~
0, 1, 9
Combined
a[!b-m]#
An9, az0, a99
abc, aj0
Applies To
PromptsList Control
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Description
Returns or sets a value that determines the text displayed in the Prompt ID
column header of the list.
Syntax
object.PromptIDColumnText [= text]
The PromptIDColumnText property syntax has these parts:
Part
Description
object
An object expression that evaluates to an object in the Applies To list.
text
A string to be displayed as the column header text for the Prompt ID column.
(Default = Prompt ID)
Remarks
Setting this property to a zero-length string ("") will cause the column header to
display without text (empty). Setting this property to Null will raise an error.
PromptIDColumnWidth
Applies To
PromptsList Control
Description
Returns or sets a value that determines the Prompt ID column width in the
prompts list.
Syntax
object.PromptIDColumnWidth [= value]
The PromptIDColumnWidth property syntax has these parts:
Part
Description
object
An object expression that evaluates to an object in the Applies To list.
value
An integer or enumeration that determines the Prompt ID column width.
(Default = 1440)
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Remarks
Setting this property to a value less than zero will raise an error. The column width
is measured in units of twips 19.
PromptIDFilterPattern
Applies To
PromptsList Control
Description
Returns or sets the filter pattern for the Prompt ID column.
Syntax
object.PromptIDFilterPattern [= pattern]
The PromptIDFilterPattern property syntax has these parts:
Part
Description
object
An object expression that evaluates to an object in the Applies To list.
pattern
A string that determines the filter pattern for the Prompt ID column.
(Default = *)
Remarks
Setting this property to Null will raise an error.
A filter pattern is a string that determines the string characteristics to be included
in a particular column. For example, if the Prompt ID of a particular prompt in
the prompts list does not match the PromptIDFilterPattern, that prompt is not
included in the prompts list. Filter patterns are defined as follows:
Kind of match
Pattern
Match (returns True)
No match (returns False)
Multiple characters
a*a
aa, aBa, aBBBa
aBC
*ab*
abc, AABB, Xab
aZb, bac
a[*]a
a*a
aaa
Special character
19
A twip is a unit of measurement implemented as 1/20 of a point or 1/1440 of an inch.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Prompts
Kind of match
Pattern
Match (returns True)
No match (returns False)
Multiple characters
ab*
abcdefg, abc
cab, aab
Single character
a?a
aaa, a3a, aBa
aBBBa
Single digit
a#a
a0a, a1a, a2a
aaa, a10a
Range of characters
[a-z]
f, p, j
2, &
Outside a range
[!a-z]
9, &, %
b, a
Not a digit
[!0-9]
A, a, &, ~
0, 1, 9
Combined
a[!b-m]#
An9, az0, a99
abc, aj0
Applies To
PromptsList Control
Description
Returns a reference to the collection of prompts in the FactoryTalk Batch Server.
The Prompts property is not available at design time and is read-only at run time.
Syntax
[Set col =] object.Prompts
The Prompts property syntax has these parts:
Part
Description
col
An object reference that refers to Prompts collection object associated with the FactoryTalk
Batch Server.
object
An object expression that evaluates to an object in the Applies To list.
Remarks
The Prompts collection has two methods, Count and Item.
•
The Count method returns a type long, signifying the number of prompts
in the collection, and therefore pending in the FactoryTalk Batch Server.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
•
The Item method allows individual access to the prompts in the collection.
It has one argument, the Index of the desired prompt within the collection,
and returns a reference to the prompt indicated by the Index argument.
The reference returned has several properties. (Refer to the “SelectedPrompt (on
page 187)” property for a description of the properties available for each item in
the collection of prompts.)
PromptTypeColumnText
Applies To
PromptsList Control
Description
Returns or sets a value that determines the text displayed in the Prompt Type
column header of the list.
Syntax
object.PromptTypeColumnText [= text]
The PromptTypeColumnText property syntax has these parts:
Part
Description
object
An object expression that evaluates to an object in the Applies To list.
text
A string to be displayed as the column header text for the Prompt Type column.
(Default = Type)
Remarks
Setting this property to a zero-length string ("") will cause the column header to
display without text (empty). Setting this property to Null will raise an error.
PromptTypeColumnWidth
Applies To
PromptsList Control
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Description
Returns or sets a value that determines the Prompt Type column width in the
prompts list.
Syntax
object.PromptTypeColumnWidth [= value]
The PromptTypeColumnWidth property syntax has these parts:
Part
Description
object
An object expression that evaluates to an object in the Applies To list.
value
An integer or enumeration that determines the Prompt Type column width.
(Default = 1440)
Remarks
Setting this property to a value less than zero will raise an error. The column width
is measured in units of twips 20.
PromptTypeFilterPattern
Applies To
PromptsList Control
Description
Returns or sets the filter pattern for the Prompt Type column.
Syntax
object.PromptTypeFilterPattern [= pattern]
The PromptTypeFilterPattern property syntax has these parts:
Part
Description
object
An object expression that evaluates to an object in the Applies To list.
pattern
A string that determines the filter pattern for the Prompt Type column.
(Default = *)
20
A twip is a unit of measurement implemented as 1/20 of a point or 1/1440 of an inch.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Remarks
Setting this property to Null will raise an error.
A filter pattern is a string that determines the string characteristics to be included
in a particular column. For example, if the Prompt Type of a particular prompt in
the prompts list does not match the PromptTypeFilterPattern, that prompt is
not included in the prompts list. Filter patterns are defined as follows:
RecipeColumnText
Kind of match
Pattern
Match (returns True)
No match (returns False)
Multiple characters
a*a
aa, aBa, aBBBa
aBC
*ab*
abc, AABB, Xab
aZb, bac
Special character
a[*]a
a*a
aaa
Multiple characters
ab*
abcdefg, abc
cab, aab
Single character
a?a
aaa, a3a, aBa
aBBBa
Single digit
a#a
a0a, a1a, a2a
aaa, a10a
Range of characters
[a-z]
f, p, j
2, &
Outside a range
[!a-z]
9, &, %
b, a
Not a digit
[!0-9]
A, a, &, ~
0, 1, 9
Combined
a[!b-m]#
An9, az0, a99
abc, aj0
Applies To
ControlRecipeList Control, PromptsList Control
Description
Returns or sets a value that determines the text displayed in the Recipe column
header of the list.
Syntax
object.RecipeColumnText [= text]
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
The RecipeColumnText property syntax has these parts:
Part
Description
object
An object expression that evaluates to an object in the Applies To list.
text
A string to be displayed as the column header text for the Recipe column.
Defaults:
ControlRecipeList = Recipe
PromptsList = Source Step
Remarks
Setting this property to a zero-length text ("") will cause the column header to
display without text (empty). Setting this property to Null will raise an error.
RecipeColumnWidth
Applies To
ControlRecipeList Control, PromptsList Control
Description
Returns or sets a value that determines the Recipe column width in the list.
Syntax
object.RecipeColumnWidth [= value]
The RecipeColumnWidth property syntax has these parts:
Part
Description
object
An object expression that evaluates to an object in the Applies To list.
value
An integer or enumeration that determines the Recipe column width.
(Default = 1440)
Remarks
Setting this property to a value less than zero will raise an error. The column width
is measured in units of twips 21.
21
A twip is a unit of measurement implemented as 1/20 of a point or 1/1440 of an inch.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
RecipeFilterPattern
Applies To
ControlRecipeList Control, PromptsList Control
Description
Returns or sets the filter pattern for the Recipe column.
Syntax
object.RecipeFilterPattern [= pattern]
The RecipeFilterPattern property syntax has these parts:
Part
Description
object
An object expression that evaluates to an object in the Applies To list.
pattern
A string that determines the filter pattern for the Recipe column.
(Default = *)
Remarks
Setting this property to Null will raise an error.
A filter pattern is a string that determines the string characteristics to be included
in a particular column. For example, if the Recipe of a particular prompt in the
prompts list does not match the RecipeFilterPattern, that prompt is not included
in the prompts list. Filter patterns are defined as follows:
Kind of match
Pattern
Match (returns True)
No match (returns False)
Multiple characters
a*a
aa, aBa, aBBBa
aBC
*ab*
abc, AABB, Xab
aZb, bac
Special character
a[*]a
a*a
aaa
Multiple characters
ab*
abcdefg, abc
cab, aab
Single character
a?a
aaa, a3a, aBa
aBBBa
Single digit
a#a
a0a, a1a, a2a
aaa, a10a
Range of characters
[a-z]
f, p, j
2, &
Outside a range
[!a-z]
9, &, %
b, a
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
RetryPeriod
Kind of match
Pattern
Match (returns True)
No match (returns False)
Not a digit
[!0-9]
A, a, &, ~
0, 1, 9
Combined
a[!b-m]#
An9, az0, a99
abc, aj0
Applies To
ControlRecipeList Control, PromptsList Control, ProcedureView Control,
SignatureList Control, TimerView Control
Description
Returns or sets the time period that the Client waits before it retries connecting to
the Batch Server, if communication with the FactoryTalk Batch Server is lost.
Syntax
object.RetryPeriod [= value]
The RetryPeriod property syntax has these parts:
Part
Description
object
An object expression that evaluates to an object in the Applies To list.
value
The period of time in seconds that the FactoryTalk Batch Client waits before it retries
connecting to the FactoryTalk Batch Server if communication with the Server is lost.
Remarks
If this property is set to a value of -1, the FactoryTalk Batch Client never
reconnects until the application is reloaded or refreshed. The default value of the
property is 60 seconds. The maximum value is 2,147,483,647.
SecurityApplicationID
Warning:
Do NOT modify this property! It is intended for internal use only and must not be modified in any
way.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
SecurityEnabled
Applies To
SignatureList Control
Description
Returns or sets a flag that determines if the control checks security permission to
view the control.
Syntax
object.SecurityEnabled [=flag]
The SecurityEnabled property syntax has these parts:
Part
Description
object
An object expression that evaluates to a SignatureList control.
flag
A boolean value that determines if the control checks security permission to view the
control.
(Default = True)
Remarks
A value of True indicates that the control will check security permissions.
Applications that do not perform their own security checks will set the value to
False.
SelectedControlRecipe
Applies To
ControlRecipeList Control
Description
Returns a reference to the currently selected control recipe in the control recipe
list.
This property is read-only at run time.
Syntax
[rcp =] object.SelectedControlRecipe
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
The SelectedControlRecipe property syntax has these parts:
Part
Description
rcp
A reference to the currently selected control recipe in the control recipe list.
object
An expression that evaluates to an object in the Applies To list.
Remarks
The reference to the currently selected control recipe has the following properties:
Property
Type
Description
Area
String
The area of the control recipe.
BatchID
String
The batch ID of the control recipe.
BatchType
Integer
1 = A batch that is created from a master recipe.
2 = A batch created with manual phase control.
CommandMask
Long
The Command mask of the control recipe. Each of the command mask’s 16
bits signifies the validity of a particular action that could be taken against
the control recipe. If the bit is set, it signifies that the command is valid.
(Refer to Command Mask Bits below for an explanation of the command
associated with each bit.)
CreateID
String
The Create ID of the control recipe.
CrossInvocation
String#
String
Where # is an integer from 1 to 5. Returns the appropriately numbered cross
invocation string associated with the currently selected control recipe. If the
string is configured with square brackets, those brackets will be included in
the string returned by this property. *
Description
String
The Description of the control recipe.
ElapsedTime
String
The Elapsed Time of the control recipe.
EquipmentClass
String
Name of the equipment resource’s class to which the selected control recipe
corresponds. *
EquipmentName
String
Name of the equipment resource to which the selected control recipe
corresponds. *
EquipmentType
Enumeration
Type of the equipment resource to which the selected control recipe
corresponds. *
Possible values are as follows:
ValueEnumeration
0 crlEquipTypeNull
1 crlEquipTypeProcessCell
2 crlEquipTypeUnit
3 crlEquipTypePhase
Failure
String
The Failure of the control recipe. If the control recipe is currently
experiencing a failure, this string property will describe the failure.
Mode
String
The Mode of the control recipe.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Property
Type
Description
Phases
Collection
The Phases collection owned by the control recipe. (Refer to Phases
Collection below for a description of the collection.)
ProcessCells
Collection
The Process Cells collection in which the control recipe is executing. (Refer
to Process Cells Collection below for a description of the collection.)
Recipe
String
The Master Recipe name from which the control recipe was derived.
ResourceID
Long
The equipment resource’s Resource ID to which the selected control recipe
corresponds. *
ScaleFactor
String
The scale factor of the selected control recipe.
StartTime
String
The Start Time of the control recipe.
State
String
The State of the control recipe.
Units
Collection
The Units collection owned by the control recipe. (Refer to Units Collection
below for a description of the collection.)
Command Mask Bits
Each set bit signifies that the corresponding command is valid if the bit is set,
where bit 0 is the least significant bit, and bit 18 is the most significant bit.
Bit
Description
0
Determines the validity of the Abort command.
1
Determines the validity of the Hold command.
2
Determines the validity of the Stop command.
3
Determines the validity of the Reset command.
4
Determines the validity of the Pause command.*
5
Determines the validity of the SemiAuto command.
6
Determines the validity of the Download command.
7
Determines the validity of the Resume command.
8
Determines the validity of the Restart command.
9
Determines the validity of the Start command.
10
Determines the validity of the Automatic mode command.
11
Determines the validity of the Manual mode command.
12
Determines the validity of the Step command.
13
Determines the validity of the Clear Failures command.
14
Determines the validity of the Remove command.
15
Determines the validity of the Bind command.
16
Determines the validity of the Disconnect command.
17
Determines the validity of the Connect command.
18
Determines the validity of the Bindphase command.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Process Cells Collection
The ProcessCells collection property returns a reference to the process cell
collection for the given control recipe. The ProcessCells property is not available
at design time and is read-only at run time. The ProcessCells property has two
methods, Count and Item.
•
The Count method returns a long value for the number of process cells in
the collection. The Item method of the ProcessCells collection property is
the default method for that object.
•
The Item method has one argument, an integer called Index, which
specifies an individual process cell within the collection. The Item method
returns a reference to the process cell indicated by the Index argument.
•
The reference to the process cell that is returned has two properties, ID and
Name.
•
The ID property is a string that represents the process cell’s ID.
•
The Name property is a string that provides the process cell’s name.
Units Collection
The Units collection property returns a reference to the unit collection for the
given control recipe. The Units property is not available at design time and is readonly at run time. The Units property has two methods, Count and Item.
•
The Count method returns a long value for the number of units in the
collection.
•
The Item method of the Units collection property is the default method
for that object. The Item method has one argument, an integer called Index,
which specifies an individual unit within the collection. The Item method
returns a reference to the unit indicated by the Index argument.
The reference to the unit that is returned has three properties, Class, ID
and Name.
•
The Class property is a string that provides the class name to which the unit
belongs.
•
The ID property is a string that represents the unit ID as defined in the area
model against which the FactoryTalk Batch Server is executing.
•
The Name property is a string that provides the unit name as defined in the
area model against which the FactoryTalk Batch Server is executing.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Phases Collection
The Phases collection property returns a reference to the collection of phases for
the given control recipe. The Phases property is not available at design time and is
read-only at run time. The Phases property has two methods, Count and Item.
•
The Count method returns a long value for the number of phases in the
collection. The Item method of the Phases collection property is the
default method for that object.
•
The Item method has one argument, an integer called Index, which specifies
an individual phase within the collection. The Item method returns a
reference to the phases indicated by the Index argument.
The reference to the phase that is returned has three properties, Class, ID
and Name.
SelectedPrompt
•
The Class property is a string that provides the class name to which the
phase belongs.
•
The ID property is a string that represents the phase ID as defined in the
area model against which the FactoryTalk Batch Server is executing.
•
The Name property is a string that provides the phase name as defined in
the area model against which the FactoryTalk Batch Server is executing.
Applies To
PromptsList Control
Description
Returns a reference to the currently selected prompt in the prompts list.
Syntax
[Set pmt =] object.SelectedPrompt
The SelectedPrompt property syntax has these parts:
Part
Description
pmt
A reference to the currently selected prompt in the prompts list.
object
An object expression that evaluates to an object in the Applies To list.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Remarks
The reference to the currently selected prompt has the following properties:
Property
Type
Description
Area
String
The area of the prompt.
BatchID
String
The batch ID of the prompt.
CrossInvocationString#
String
Where # is an integer from 1 to 5. Returns the appropriately numbered cross
invocation string associated with the currently selected prompt. If the string is
configured with square brackets, those brackets will be included in the string
returned by this property. *
Default
String
The default response value for the prompt.
Description
String
The description of the prompt.
EU
String
The engineering units of the response to the prompt.
High
String
The high limit of the response to this prompt.
HighLimit
String
The recipe parameter High Limit.
HighHighLimit
String
The recipe parameter High High Limit.
HighHighHighLimit
String
The recipe parameter High High High Limit.
Low
String
The low limit of the response to this prompt.
LowLimit
String
The recipe parameter Low Limit.
LowLowLimit
String
The recipe parameter Low Low Limit.
LowLowLowLimit
String
The recipe parameter Low Low Low Limit.
Phase
String
The phase that generated this prompt.
ProcessCell
String
The process cell from which this prompt was generated.
PromptID
Long
The unique ID of the prompt.
PromptType
String
The Type of the prompt. (See "Prompt Types" for more information.)
Recipe
String
The name of the master recipe from which the control recipe that generated this
prompt was derived.
ResourceID
Long
Resource ID of the equipment phase to which the selected prompt corresponds. *
ResponseType
Long
The response type of the prompt. (See "Response Types" for more information.)
Time
String
The time that the prompt occurred.
Unit
String
The unit to which this prompt pertains.
Value
String
The current response value to this prompt.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Prompt Types
The PromptType property is a string that identifies the type of the prompt, as
follows:
Value
Description
Prompt
A prompt to provide a value for a parameter or a unit for a unit binding.
Response Types
The ResponseType property identifies the variable type of the response to a
prompt that is expected, as follows:
SelectedSignature
Value
Description
1
The prompt requires a response of type real.
2
The prompt requires a response of type long.
3
The prompt requires a response of type string.
5
The response to the prompt should be a member of a defined enumeration set.
10
The prompt is a binding, whose response should be the unit ID that is to be bound to the step alias identified
in the prompt.
11
The prompt is a binding when the Material Server is not available, whose response should be the unit ID that is
to be bound to the step alias identified in the prompt.
20
This is a material phase binding prompt. The response should be <equipment module>-<container><capacity>-<engineering units>-<lot name>-<label>.
For example:
EP_ADDEGG_M1-COOLER\EGG_PALLET2-50-KG-GOLDEN_EGGS_SEPT_18-CARTON_9
21
This is a material phase binding prompt when the Material Server is unavailable. The response should be
<equipment module>-<container>-<capacity>-<engineering units>-<lot name>-<label>.
For example:
EP_ADDEGG_M1-COOLER\EGG_PALLET2-50-KG-GOLDEN_EGGS_SEPT_18-CARTON_9
Applies To
SignatureList Control
Description
Returns a reference to the currently selected signature in the control.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Syntax
[Set sig =] object.SelectedSignature
The SelectedSignature property syntax has these parts:
Part
Description
object
An object expression that evaluates to a SignatureList control.
sig
A reference to the currently selected signature in the control. Defined as a Signature object.
Remarks
A Signature object is defined as the following:
Property
Type
Description
SignatureID
Long
The Signature ID of the Signature.
ActionID
Long
The Action ID of the signature. Action ID is used to associate multiple signatures
that were generated from a single action.
CreateID
Long
Unique Create ID of batch with which signature is associated.
SigState
SignatureStates
The state of the signature. See the section on “Enumerations (on page 287)” for
definition of type.
SigCreateTime
String
The time at which the signature request was created.
SigEndTime
String
The time at which the signature was completed or cancelled. If the signature
state is "Incomplete", this property is an empty string.
SigCancelable
Boolean
True = signature cancelable, False = signature not cancelable.
SigType
SignatureTypes
The type of signature. See the section on “Enumerations (on page 287)” for
definition of type.
SigContext
Variant
The context of the selected signature. Type depends on SigType. See below for
definitions of possible types.
LastSignoff
Integer
1 based ordinal of the Signoff that must be the last completed Signoff. If no
signoff must be last, value is 0.
Signoffs
Collection
Signoff objects collection which represents the signoffs in the signature. The
index of each Signoff object in the collection is the signoff’s Signoff Number, as
used in the SignoffSignature method. See below for the definition of a Signoff
object.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Signature Context Types
Command Context Object
Property
Type
Description
ProcedureID
String
Hierarchical path name to the procedure, unit procedure, operation, or phase
associated with the signature.
Command
Integer
The value of the signature’s command queued pending collection.
GeneralUsageContext Object
Property
Type
Description
ProcedureID
String
Hierarchical path name to the procedure, unit procedure, operation, or phase
associated with the signature.
StepIndex
Integer
The Step Index of the equipment phase for which the signature was generated.
ParamDeviationContext Object
Property
Type
Description
ProcedureID
String
Hierarchical path name to the procedure, unit procedure, operation, or phase
associated with the signature.
ParameterName
String
Name of the parameter associated with the deviation.
NewValue
String
The new value of the parameter.
CurrentValue
String
The current value of the parameter.
DeviationType
DeviationTypes
The deviation type that generated the signature. See Enumerations section for
type definition.
LLimit
String
Parameter low limit.
HLimit
String
Parameter high limit.
LLLimit
String
Parameter low low limit.
HHLimit
String
Parameter high high limit.
LLLLimit
String
Parameter low low low limit.
HHHLimit
String
Parameter high high high limit.
ParamValueAckContext Object
Property
Type
Description
ProcedureID
String
Hierarchical path name to the procedure, unit procedure, operation, or phase
associated with the signature.
ParameterName
String
Name of the parameter being set.
NewValue
String
The new value of the parameter.
DefaultValue
String
The default value of the parameter.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
ReportDeviationContext Object
Property
Type
Description
ProcedureID
String
Hierarchical path name to the procedure, unit procedure, operation, or phase
associated with the signature.
ReportName
String
The report parameter name associated with the deviation.
UploadedValue
String
The valued that was uploaded for the report parameter that caused the
deviation.
TargetParamName
String
The parameter name from which the report parameter deviation limits are
calculated.
TargetParamValue
String
The parameter value from which the report parameter deviation limits are
calculated (at the time the deviation was detected).
DeviationType
DeviationTypes
The type of deviation that generated the signature. See Enumerations section
for definition of type.
LLimit
String
Report low limit.
HLimit
String
Report high limit.
LLLimit
String
Report low low limit.
HHLimit
String
Report high high limit.
LLLLimit
String
Report low low low limit.
HHHLimit
String
Report high high high limit.
UnitBindContext Object
Property
Type
Description
UnitID
Long
The Unit resource ID specified by a Bind Unit execute.
ProcedureList
Array
Array of procedure IDs associated with the unit bind.
UnitBindAckContext Object
Property
Type
Description
UnitID
Long
The Unit resource ID specified by a Bind Unit execute.
ProcedureList
Array
Array of procedure ID’s associated with the unit bind.
PhaseBindContext Object
Property
Type
Description
ProcedureID
String
Hierarchical path name to the procedure, unit procedure, operation, or phase
associated with the signature.
EquipmentPhaseI
D
Long
The equipment phase resource ID specified by a Bind Recipe Phase execute.
ContainerName
String
The Container specified by a Bind Phase Recipe execute.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
MaterialName
String
The Material specified by a Bind Phase or Bind Phase Ack execute.
Lot
String
The Lot specified by a Bind Phase Recipe execute.
Label
String
The Label specified by a Bind Phase Recipe execute.
PhaseBindAckContext Object
Property
Type
Description
ProcedureID
String
Hierarchical path name to the procedure, unit procedure, operation, or phase
associated with the signature.
EquipmentPhaseID
Long
The equipment phase resource ID specified by a Bind Recipe Phase execute.
ContainerName
String
The Container specified by a Bind Phase Recipe execute.
MaterialName
String
The Material specified by a Bind Phase or Bind Phase Ack execute.
Lot
String
The Lot specified by a Bind Phase Recipe execute.
Label
String
The Label specified by a Bind Phase Recipe execute.
RemoveContext Object
Property
Type
Description
ProcedureID
String
Hierarchical path name to the procedure, unit procedure, operation, or phase
associated with the signature.
Property
Type
Description
ProcedureID
String
Hierarchical path name to the procedure, unit procedure, operation, or phase
associated with the signature.
ActivatedStepList
Array
Array of step names that will be activated if the active step change succeeds.
DeactiveatedStep
List
Array
Array of step names that will be deactivated if the active step change succeeds.
ASCContext Object
AddEventContext Object
Property
Type
Description
ProcedureID
String
Hierarchical path name to the procedure, unit procedure, operation, or phase
associated with the signature.
EventType
String
The "Type" field passed in the AddEvent, AddEvent_CI, or AddEvent_Phase
execute.
Description
String
The "Description" field passed in the AddEvent, AddEvent_CI, or
AddEvent_Phase execute.
Value
String
The "Value" field passed in the AddEvent, AddEvent_CI, or AddEvent_Phase
execute.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
SetParmContext Object
Property
Type
Description
ProcedureID
String
Hierarchical path name to the procedure, unit procedure, operation, or phase
associated with the signature.
ParameterName
String
The name of the parameter being set.
NewValue
String
The new value of the parameter.
CurrentValue
String
The current value of the parameter.
SetAllLabelContext Object
Property
Type
Description
ProcedureID
String
Hierarchical path name to the procedure, unit procedure, operation, or phase
associated with the signature.
NewValue
String
The new value for all labels.
SetAllLotContext Object
Property
Type
Description
ProcedureID
String
Hierarchical path name to the procedure, unit procedure, operation, or phase
associated with the signature.
NewValue
String
The new value for all lots.
Property
Type
Description
SignoffState
SignoffStates
Current state of the signoff. See the Enumerations section for the definition of
the type.
CommentControl
CommentControls Defines if a comment is required, optional, or not allowed for the signoff. See
the Enumerations section for the definition of the type.
Meaning
String
The meaning of the signoff.
CompletionTime
String
The time the signoff was completed or cancelled. If the signoff is Incomplete,
the value is an empty string.
SignerName
String
The full name of the user that completed the signoff. If the signoff is Incomplete
or Canceled, the value is an empty string.
SignerID
String
The user ID of the user that completed the signoff. If the signoff is Incomplete or
Canceled, the value is an empty string.
SignerComment
String
The comment that was entered when the signoff was completed.
PermissionList
Array
An array of the Windows users or groups that are permitted to complete the
signoff.
Signoff Object
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
SelectedStepBatchID
Applies To
ProcedureView Control
Description
Returns the control recipe batch ID to which the selected recipe step belongs.
This property is read-only at run time.
Syntax
object.SelectedStepBatchID [= text]
The SelectedStepBatchID property syntax has these parts:
Part
Description
object
An object expression that evaluates to an object in the Applies To list.
text
A string that evaluates to the control recipe batch ID.
Remarks
When a transition in the procedure is selected, the value of this property is a zerolength string.
SelectedStepClass
Applies To
ProcedureView Control
Description
Returns the class of the equipment object to which the selected recipe step
corresponds.
This property is not available at design time and is read-only at run time.
Syntax
object.SelectedStepClass [= text]
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
The SelectedStepClass property syntax has these parts:
Part
Description
object
An object expression that evaluates to an object in the Applies To list.
text
A string that evaluates to the equipment object’s class to which the selected recipe step
corresponds.
Remarks
The equipment resource type to which the step corresponds is relative to the type
of the step:
Procedure Step Type
SelectedStepCommandSet
=
Corresponding Equipment Type
Procedure
=
Process Cell
Unit Procedure
=
Unit
Operation
=
Unit
Phase
=
Equipment Phase
Applies To
ProcedureView Control
Description
Returns the current command set for the currently selected step object.
This property is not available at design time and is read-only at run time.
Syntax
[cmdset =] object.SelectedStepCommandSet
The SelectedStepCommandSet property syntax has these parts:
Part
Description
cmdset
Command set of the currently selected step object.
object
An object expression that evaluates to an object in the Applies To list.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Remarks
If there is no step currently selected, this property is specific to the depicted
procedure.
SelectedStepControl
Applies To
ProcedureView Control
Description
Returns the control string for the currently selected step object.
This property is not available at design time and is read-only at run time.
Syntax
[ctrl =] object.SelectedStepControl
The SelectedStepControl property syntax has these parts:
Part
Description
ctrl
Control string for the currently selected step object.
object
An object expression that evaluates to an object in the Applies To list.
Remarks
If there is no step currently selected, this property is specific to the depicted
procedure.
SelectedStepEquipment
Name
Applies To
ProcedureView Control
Description
Returns the equipment resource name to which the selected step in the recipe
corresponds.
This property is not available at design time and is read-only at run time.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Syntax
[equip =] object.SelectedStepEquipmentName
The SelectedStepEquipmentName property syntax has these parts:
Part
Description
equip
The equipment resource name to which the selected step in the recipe corresponds.
object
An object expression that evaluates to an object in the Applies To list.
Remarks
When a transition in the procedure is selected, the value of this property is a zerolength string.
SelectedStepEquipment
Path
Applies To
ProcedureView Control
Description
Returns the equipment resource path to which the selected step in the recipe
corresponds.
This property is not available at design time and is read-only at run time.
Syntax
[equip =] object.SelectedStepEquipmentPath
The SelectedStepEquipmentPath property syntax has these parts:
Part
Description
equip
The equipment resource name to which the selected step in the recipe corresponds.
object
An object expression that evaluates to an object in the Applies To list.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Remarks
When a transition in the procedure is selected, the value of this property is a zerolength string.
SelectedStepFailure
Applies To
ProcedureView Control
Description
Returns the failure string for the currently selected step object.
This property is not available at design time and is read-only at run time.
Syntax
[fail =] object.SelectedStepFailure
The SelectedStepFailure property syntax has these parts:
Part
Description
fail
Failure string for the currently selected step object.
object
An object expression that evaluates to an object in the Applies To list.
Remarks
If there is no step currently selected, this property is specific to the depicted
procedure.
SelectedStepID
Applies To
ProcedureView Control
Description
Returns the procedure ID of the currently selected step object.
This property is not available at design time and is read-only at run time.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Syntax
[ID =] object.SelectedStepID
The SelectedStepID property syntax has these parts:
Part
Description
ID
Procedure ID of the currently selected regular step object.
object
An object expression that evaluates to an object in the Applies To list.
Remarks
If there is no step currently selected, this property will return a zero-length string.
Refer to the FactoryTalk Batch Server API Communications Language Reference for
information on the format of a procedure ID.
SelectedStepIndex
Applies To
ProcedureView Control
Description
Returns the step index for the currently selected step object.
This property is not available at design time and is read-only at run time.
Syntax
[index =] object.SelectedStepIndex
The SelectedStepIndex property syntax has these parts:
Part
Description
index
Integer step index for the currently selected step object.
object
An object expression that evaluates to an object in the Applies To list.
Remarks
If there is no step currently selected or the selected step does not represent a phase,
this property will return zero.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
SelectedStepIsFailed
Applies To
ProcedureView Control
Description
Returns a flag indicating the failure status of the currently selected step object.
This property is not available at design time and is read-only at run time.
Syntax
[fail =] object.SelectedStepIsFailed
The SelectedStepIsFailed property syntax has these parts:
Part
Description
fail
A Boolean expression indicating that the currently selected step is or is not failed.
object
An object expression that evaluates to an object in the Applies To list.
Settings
The settings for fail are:
Setting
Description
True
The currently selected step is failed.
False
The currently selected step is not failed.
Remarks
If there is no step currently selected, this property is specific to the depicted
procedure.
SelectedStepKeyName
Applies To
ProcedureView Control
Description
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
This property is not available at design time and is read-only at run time.
Syntax
[keyname =] object.SelectedStepKeyName
The SelectedStepKeyName property syntax has these parts:
Part
Description
keyname
The key parameter name for the currently selected step.
object
An object expression that evaluates to an object in the Applies To list.
Remarks
If there is no step currently selected, this property is specific to the depicted
procedure.
SelectedStepKeyVal
Applies To
ProcedureView Control
Description
Returns the key parameter value for the currently selected step object.
This property is not available at design time and is read-only at run time.
Syntax
[keyval =] object.SelectedStepKeyVal
The SelectedStepKeyVal property syntax has these parts:
Part
Description
keyval
The key parameter value for the currently selected step.
object
An object expression that evaluates to an object in the Applies To list.
Remarks
If there is no step currently selected, this property is specific to the depicted
procedure.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
SelectedStepMessage
Applies To
ProcedureView Control
Description
Returns the message for the currently selected step object.
This property is not available at design time and is read-only at run time.
Syntax
[message =] object.SelectedStepMessage
The SelectedStepMessage property syntax has these parts:
Part
Description
message
Message for the currently selected step.
object
An object expression that evaluates to an object in the Applies To list.
Remarks
If there is no regular step currently selected, this property is specific to the depicted
procedure. If the selected step does not represent a phase, this property will return
a zero-length string.
SelectedStepMode
Applies To
ProcedureView Control
Description
Returns the mode of the currently selected step object.
This property is not available at design time and is read-only at run time.
Syntax
[mode =] object.SelectedStepMode
The SelectedStepMode property syntax has these parts:
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Part
Description
mode
Mode of the currently selected step.
object
An object expression that evaluates to an object in the Applies To list.
Remarks
If there is no step currently selected, this property is specific to the depicted
procedure.
SelectedStepName
Applies To
ProcedureView Control
Description
Returns the name of the currently selected step object.
This property is not available at design time and is read-only at run time.
Syntax
[name =] object.SelectedStepName
The SelectedStepName property syntax has these parts:
Part
Description
name
Name of the currently selected step.
object
An object expression that evaluates to an object in the Applies To list.
Remarks
If there is no step currently selected, this property is specific to the depicted
procedure.
SelectedStepParallelism
Applies To
ProcedureView Control
Description
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
This property is not available at design time and is read-only at run time.
Syntax
[parallel =] object.SelectedStepParallelism
The SelectedStepParallelism property syntax has these parts:
Part
Description
parallel
Enumerated type of parallelism in which the currently selected step is involved, as described
in Settings.
object
An object expression that evaluates to an object in the Applies To list.
Settings
The possible ordinals representing types of parallelism are:
Enumeration
Value
Description
pvwParallelismNone
0
Selected step is not in parallel with any other steps (it is not preceded by a
divergence, and is not succeeded by a convergence).
pvwParallelism
Simple
1
Selected step is preceded with an AND divergence, and succeeded with an AND
convergence, and all other steps preceded by that divergence are also succeeded by
that convergence (and vice-versa).
pvwParallelism
Unknown
2
All other cases.
Remarks
If there is no regular step currently selected, this property is specific to the depicted
procedure.
SelectedStepParameters
Applies To
ProcedureView Control
Description
Returns a delimited string containing the parameter data for the selected step.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Syntax
[parms =] object.SelectedStepParameters
The SelectedStepParameters property syntax has these parts:
Part
Description
parms
Delimited string containing the parameter data for the selected step.
object
An object expression that evaluates to an object in the Applies To list.
Remarks
If there is no step currently selected, this property is specific to the depicted
procedure.
If a transition recipe element is selected, this property returns a zero-length string.
If the returned string is not of zero-length, the parameters detailed in the string are
delimited by crlf, and the fields within each parameter detail substring are
delimited by tabs. The order in which parameter fields are included in each
parameter substring is: Name, Type, Units, High, Low, Default, and Value.
SelectedStepParameters2
Applies to:
ProcedureView Control
Description
Returns a delimited string containing the recipe parameter limits data for the
selected step.
This property is not available at design time and is read-only at run time.
Syntax
[parms =] object.SelectedStepParameters2
The SelectedStepParameters2 property syntax has these parts:
Part
Description
parms
Delimited string containing the parameter data for the selected step.
object
An object expression that evaluates to an object in the Applies To list.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Remarks
If there is no step currently selected, this property is specific to the depicted
procedure. If a transition recipe element is selected, this property returns a zerolength string. If the returned string is not of zero-length, the parameters detailed in
the string are delimited by crlf, and the fields within each parameter detail
substring are delimited by tabs. The order in which parameter fields are included
in each parameter substring is: Name, Type, Unit, Max, Min, Default, Value,
LowLimit, HighLimit, LowLowLimit, HighHighLimit, LowLowLowLimit,
HighHighHighLimit.
SelectedStepReports
Applies To
ProcedureView Control
Description
Returns a delimited string containing the report data for the selected step.
This property is not available at design time and is read-only at run time.
Syntax
[reports =] object.SelectedStepReports
The SelectedStepReports property syntax has these parts:
Part
Description
reports
Delimited string containing the report data for the selected step.
object
An object expression that evaluates to an object in the Applies To list.
Remarks
If there is no regular step currently selected, this property is specific to the depicted
procedure. If a transition recipe element is selected, this property returns a zerolength string. If the returned string is not of zero-length, the reports detailed in the
string are delimited by crlf, and the fields within each report detail substring are
delimited by tabs. The order in which report fields are included in each report
substring is: Name, Units, Value.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
SelectedStepReports2
Applies To
ProcedureView Control
Description
Returns a delimited string containing the recipe parameter report limits data for
the selected step.
This property is not available at design time and is read-only at run time.
Syntax
[reports =] object.SelectedStepReports2
The SelectedStepReports2 property syntax has these parts:
Part
Description
reports
Delimited string containing the report data for the selected step.
object
An object expression that evaluates to an object in the Applies To list.
Remarks
If there is no regular step currently selected, this property is specific to the depicted
procedure. If a transition recipe element is selected, this property returns a zerolength string. If the returned string is not of zero-length, the reports detailed in the
string are delimited by crlf, and the fields within each report detail substring are
delimited by tabs. The order in which report fields are included in each report
substring is: Name, Unit, Value, LowLimit, HighLimit, LowLowLimit,
HighHighLimit, LowLowLowLimit, HighHighHighLimit.
SelectedStepRequest
Applies To
ProcedureView Control
Description
Returns the pending request for the phase represented by the currently selected
step object.
This property is not available at design time and is read-only at run time.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Syntax
[request =] object.SelectedStepRequest
The SelectedStepRequest property syntax has these parts:
Part
Description
request
Pending request of the currently selected step.
object
An object expression that evaluates to an object in the Applies To list.
Remarks
If there is no step currently selected or the currently selected step does not
represent a phase, this property will return a zero-length string.
SelectedStepResourceID
Applies To
ProcedureView Control
Description
Returns the resource ID of the equipment resource to which the selected recipe
step corresponds.
This property is not available at design time and is read-only at run time.
Syntax
[ID=] object.SelectedStepResourceID
The SelectedStepResourceID property syntax has these parts:
Part
Description
ID
Procedure ID of the currently selected regular step object.
object
An object expression that evaluates to an object in the Applies To list.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Remarks
The type of the selected step determines the resource to which the selected step is
specific, as follows:
Type
Corresponding Resource ID
0 (Null)
-1
1 (Procedure)
Resource ID of the Process Cell in which the procedure is executing
2 (Unit Procedure)
Resource ID of the Unit against which the unit procedure is executing
3 (Operation)
Resource ID of the Unit against which the operation is executing
4 (Phase)
Resource ID of the Equipment Module against which the phase is executing
Remarks
When a transition in the procedure is selected, the value of this property is minus
one (-1).
SelectedStepState
Applies To
ProcedureView Control
Description
Returns the state of the currently selected step object.
This property is not available at design time and is read-only at run time.
Syntax
[state =] object.SelectedStepState
The SelectedStepState property syntax has these parts:
Part
Description
state
State of the currently selected step.
object
An object expression that evaluates to an object in the Applies To list.
Remarks
If there is no regular step currently selected, this property is specific to the depicted
procedure.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
SelectedStepStateNum
Applies To
ProcedureView Control
Description
Returns the state number for the currently selected step object.
This property is not available at design time and is read-only at run time.
Syntax
[statenum =] object.SelectedStepStateNum
The SelectedStepStateNum property syntax has these parts:
Part
Description
statenum
Integer state number for the currently selected step.
object
An object expression that evaluates to an object in the Applies To list.
Settings
The following table identifies the possible values of the statenum property:
Value
StateNum
State
0
stUnknown
UNKNOWN
10
stAborting
ABORTING
20
stHolding
HOLDING
30
stStopping
STOPPING
40
stRestarting
RESTARTING
50
stRunning
RUNNING
60
stHeld
HELD
70
stComplete
COMPLETE
80
stStopped
STOPPED
90
stAborted
ABORTED
100
stIdle
IDLE
110
stStarting
STARTING
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Remarks
If there is no step currently selected, this property is specific to the depicted
procedure.
SelectedStepString#
Applies To
ProcedureView Control
Description
Returns the content of the cross invocation string, where # evaluates to the cross
invocation string number (1 through 5), associated with the selected recipe step.
This property is not available at design time and is read-only at run time.
Syntax
[stepstring =] object.SelectedStepString#
The SelectedStepString# property syntax has these parts:
Part
Description
stepstring
A string that evaluates to the cross invocation string # associated with the selected recipe
step.
object
An object expression that evaluates to an object in the Applies To list.
Remarks
When a transition in the procedure is selected, the value of this property is a zerolength string. If the string is configured with square brackets, the brackets will be
included in the return value of this property. The corresponding equipment
element is determined as described in the SelectedStepResourceID property.
SelectedStepType
Applies To
ProcedureView Control
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Description
Returns the type of equipment resource to which the selected recipe step
corresponds.
This property is not available at design time and is read-only at run time.
Syntax
[type =] object.SelectedStepType
The SelectedStepType property syntax has these parts:
Part
Description
type
An integer value representing the type of equipment resource to which the selected recipe
step corresponds.
object
An object expression that evaluates to an object in the Applies To list.
Settings
The settings for type are:
Value
Description
0
Null
1
Process Cell
2
Unit
3
Equipment Module
Remarks
When a transition in the procedure is selected, the value of this property is Null
(0).
SelectedStepUnit
Applies To
ProcedureView Control
Description
Returns the unit ID of the unit against which currently selected step object is
executing.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
This property is not available at design time and is read-only at run time.
Syntax
[unit =] object.SelectedStepUnit
The SelectedStepUnit property syntax has these parts:
Part
Description
unit
Unit ID for the currently selected step.
object
An object expression that evaluates to an object in the Applies To list.
Remarks
If there is no step currently selected, this property is specific to the depicted
procedure.
SelectedTransition
Acquiring
Applies To
ProcedureView Control
Description
Returns a flag that indicates whether or not the currently selected transition is
waiting on equipment acquisition.
This property is not available at design time and is read-only at run time.
Syntax
[acquiring =] object.SelectedTransitionAcquiring
The SelectedTransitionAcquiring property syntax has these parts:
Part
Description
acquiring
A Boolean expression indicating that the currently selected transition is or is not waiting for an
equipment acquisition to complete.
object
An object expression that evaluates to an object in the Applies To list.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Settings
The settings for acquiring are:
Setting
Description
True
The currently selected transition is waiting for an equipment acquisition to complete.
False
The currently selected transition is not waiting for an equipment acquisition to complete.
Remarks
If there is no transition currently selected, this property will return False.
SelectedTransition
Condition
Applies To
ProcedureView Control
Description
Returns the condition for transition for the currently selected transition.
This property is not available at design time and is read-only at run time.
Syntax
[condition =] object.SelectedTransitionCondition
The SelectedTransitionCondition property syntax has these parts:
Part
Description
condition
String that holds the condition for the currently selected transition.
object
An object expression that evaluates to an object in the Applies To list.
Remarks
If there is no transition currently selected, this property will return a zero-length
string.
SelectedTransition
Evaluation
Applies To
ProcedureView Control
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Description
Returns a condition evaluation for the currently selected transition.
This property is not available at design time and is read-only at run time.
Syntax
[eval =] object.SelectedTransitionEvaluation
The SelectedTransitionEvaluation property syntax has these parts:
Part
Description
eval
A string that holds the condition evaluation for the currently selected transition.
object
An object expression that evaluates to an object in the Applies To list.
Remarks
The format of this string property is identical to the EXPRESSION execute as
documented in the Server API Communications Language Reference. If no
transition is currently selected, this property will return a zero-length string.
SelectedTransitionFailure
Applies To
ProcedureView Control
Description
Returns the failure message for the currently selected transition.
This property is not available at design time and is read-only at run time.
Syntax
[fail =] object.SelectedTransitionFailure
The SelectedTransitionFailure property syntax has these parts:
Part
Description
fail
String that holds the failure message for the currently selected transition.
object
An object expression that evaluates to an object in the Applies To list.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Remarks
If there is no transition currently selected or no pending failure for the currently
selected transition, this property will return a zero-length string.
SelectedTransitionState
Applies To
ProcedureView Control
Description
Returns the state of the currently selected transition.
This property is not available at design time and is read-only at run time.
Syntax
[state =] object.SelectedTransitionState
The SelectedTransitionState property syntax has these parts:
Part
Description
state
String that holds the state of the currently selected transition.
object
An object expression that evaluates to an object in the Applies To list.
Remarks
If no transition is currently selected, this property will return a zero-length string.
SelectedTransitionState
Num
Applies To
ProcedureView Control
Description
Returns the state number of the currently selected transition.
This property is not available at design time and is read-only at run time.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Syntax
[statenum =] object.SelectedTransitionStateNum
The SelectedTransitionStateNum property syntax has these parts:
Part
Description
statenum
Integer that identifies the state of the currently selected transition.
object
An object expression that evaluates to an object in the Applies To list.
Settings
The following table identifies the allowable values for statenum:
Value
StateNum
State
0
stUnknown
UNKNOWN
60
stHeld
HELD
80
stStopped
STOPPED
90
stAborted
ABORTED
100
stIdle
IDLE
120
stArmed
ARMED
130
stArming
ARMING
140
stFiring
FIRING
Remarks
If there is no transition currently selected, this property will return zero.
ShowConditions
Applies To
ProcedureView Control
Description
Returns or sets a flag that determines if transition conditions are displayed in the
depicted procedure.
Syntax
[show =] object.ShowConditions
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
The ShowConditions property syntax has these parts:
Part
Description
show
A Boolean expression that indicates if transition conditions are or are not displayed in the
depiction of the current procedure.
object
An object expression that evaluates to an object in the Applies To list.
Settings
The settings for show are:
ShowCustomMenuItems
Setting
Description
True
Transition conditions are displayed in the depiction of the current procedure.
False
Transition conditions are not displayed in the depiction of the current procedure.
Applies To
ControlRecipeList Control, ProcedureView Control, PromptsList Control
Description
Returns or sets a flag that determines if area model cross invocation strings are
properly formatted for cross invocation support resulting in custom menu items
added to the control’s pop-up menu.
Syntax
object.ShowCustomMenuItems [= menu]
The ShowCustomMenuItems property syntax has these parts:
Part
Description
object
An object expression that evaluates to an object in the Applies To list.
menu
A Boolean expression that specifies if cross invocation strings result in custom menu items
added to the control’s popup menu.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Settings
The settings for menu are:
Setting
Description
True
Cross invocation strings will result in custom menu items.
False
Cross invocation strings will not result in custom menu items. (Default)
Remarks
By default, this property is False. Only cross invocation strings that are formatted
correctly will result in additional menu items.
ShowDisconnectedMessage Applies To
SignatureList Control
Description
Returns or sets a flag that determines if a message will be displayed in place of the
data grid when the control is disconnected from the FactoryTalk Batch Server.
Syntax
object.ShowDisconnectedMessage [=flag]
The ShowDisconnectedMessage property syntax has these parts:
Part
Description
object
An object expression that evaluates to a SignatureList control.
flag
A boolean value that determines if a message will be displayed in place of the data grid
when the control is disconnected from the FactoryTalk Batch Server.
(Default = True)
Remarks
If the property has a value of False, the signature list will be cleared when
communication is lost with the FactoryTalk Batch Server, but no message will be
displayed.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
ShowElapsedTime
Applies To
TimerView Control
Description
Returns or sets a flag that determines if the "Elapsed Time" column is displayed.
Syntax
object.ShowElapsedTime [= flag]
The ShowElapsedTime property syntax has these parts:
ShowFilter
Part
Description
object
An object expression that evaluates to a TimerStepList control.
flag
A boolean value that determines if the "Elapsed Time" column is displayed or not. Default =
True.
Applies To
TimerView Control
Description
Returns or sets a flag that determines if the Timer Step Filter dialog is displayed
during run time.
Syntax
object.ShowFilter [= flag]
The ShowFilter property syntax has these parts:
Part
Description
object
An object expression that evaluates to a TimerStepList control.
value
A boolean value that determines if the timer step filter dialog is displayed or not during run
time. Default = True.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
ShowMenu
Applies To
ControlRecipeList Control, PromptsList Control, ProcedureView Control,
SignatureList Control
Description
Returns or sets a value that determines if the shortcut menu should be displayed
when the control is right-clicked.
Syntax
object.ShowMenu [= value]
The ShowMenu property syntax has these parts:
Part
Description
object
An object expression that evaluates to an object in the Applies To list.
value
A Boolean expression indicating whether the shortcut menu will be displayed when the
control is right-clicked.
Settings
The settings for value are:
ShowRecipeLimits
Setting
Description
True
The shortcut menu will be displayed when the control is right-clicked. (Default)
False
The shortcut menu will not be displayed when the control is right-clicked.
Applies to
ProcedureView Control
Description
Returns or sets a value that determines if the limit values are displayed on the
Properties - Recipe Parameters tab.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Syntax
object.ShowRecipeLimits [= value]
The ShowRecipeLimits property syntax has these parts:
Part
Description
object
An object expression that evaluates to an object in the Applies To list.
value
A Boolean expression indicating whether the limit values will display on the Properties Recipe Parameters tab.
Settings
The settings for value are:
Setting
Description
True
The limit values will display on the Properties - Recipe Parameters tab. (Default)
False
The limit values will not display on the Properties - Recipe Parameters tab.
Remarks
The ShowRecipeLimits value can be set at design time or run time. The property
cannot be changed when the Properties dialog is displayed.
ShowRemainingTime
Applies To
TimerView Control
Description
Returns or sets a flag that determines if the "Remaining Time" column is displayed.
Syntax
object.ShowRemainingTime [= flag]
The ShowRemainingTime property syntax has these parts:
Part
Description
object
An object expression that evaluates to a TimerStepList control.
value
A boolean value that determines if the "Remaining Time" column is displayed or not. Default
= True.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
ShowReportLimits
Applies to
ProcedureView Control
Description
Returns or sets a value that determines if the limit values are displayed on the
Properties - Report Parameters tab.
Syntax
object.ShowReportLimits [= value]
The ShowReportLimits property syntax has these parts:
Part
Description
object
An object expression that evaluates to an object in the Applies To list.
value
A Boolean expression indicating whether the limit values will display on the Properties Report Parameters tab.
Settings
The settings for value are:
Setting
Description
True
The limit values will display on the Properties - Report Parameters tab. (Default)
False
The limit values will not display on the Properties - Report Parameters tab.
Remarks
The ShowReportLimits value can be set at design time or run time. The property
cannot be changed when the Properties dialog is displayed.
ShowSetPoint
Applies To
TimerView Control
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Description
Returns or sets a flag that determines if the "Setpoint" column is displayed.
Syntax
object.ShowSetPoint [= flag]
The ShowSetPoint property syntax has these parts:
ShowState
Part
Description
object
An object expression that evaluates to a TimerStepList control.
value
A Boolean value that determines if the "Setpoint" column is displayed or not. Default =
True.
Applies To
TimerView Control
Description
Returns or sets a flag that determines if the "State" column is displayed.
Syntax
object.ShowState [= flag]
The ShowState property syntax has these parts:
ShowStatusBar
Part
Description
object
An object expression that evaluates to a TimerStepList control.
value
A Boolean value that determines if the "State" column is displayed or not.
Default = True.
Applies To
TimerView Control
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Description
Returns or sets a flag that determines if the control’s status bar is displayed.
Syntax
object.ShowStatusBar [= flag]
The ShowStatusBar property syntax has these parts:
ShowStepIndices
Part
Description
object
An object expression that evaluates to a TimerStepList control.
value
A Boolean value that determines if the control’s status bar is displayed.
Default = True.
Applies To
ProcedureView Control
Description
Returns or sets a flag that determines if step indices are displayed in the depicted
procedure.
Syntax
object.ShowStepIndices = [show]
The ShowStepIndices property syntax has these parts:
Part
Description
object
An object expression that evaluates to an object in the Applies To list.
show
A Boolean expression that indicates if step indices are or are not displayed in the depiction of
the current procedure.
Settings
The settings for show are:
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
ShowStepInstance
Setting
Description
True
Indices will be displayed in the depiction of the current procedure. (Default)
False
Indices will not be displayed in the depiction of the current procedure.
Applies To
ProcedureView Control
Description
Returns or sets a flag that determines if the step’s instance number is included in
its name display.
Syntax
object.ShowStepInstance = [show]
The ShowStepInstance property syntax has these parts:
Part
Description
object
An object expression that evaluates to an object in the Applies To list.
show
A Boolean expression that indicates if the step’s instance number is included in its name
display.
Settings
The settings for show are:
ShowType
Setting
Description
True
The instance number of a step will be included in the display of its name. (Default)
False
The instance number of a step will not be included in the display of its name.
Applies To
TimerView Control
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Description
Returns or sets a flag that determines if the "Type" column is displayed.
Syntax
object.ShowType [= flag]
The ShowType property syntax has these parts:
ShowUnit
Part
Description
object
An object expression that evaluates to a TimerStepList control.
value
A Boolean value that determines if the "Type" column is displayed or not.
Default = True.
Applies To
TimerView Control
Description
Returns or sets a flag that determines if the "Unit" column is displayed.
Syntax
object.ShowUnit [= flag]
The ShowUnit property syntax has these parts:
ShowUnitsOfTime
Part
Description
object
An object expression that evaluates to a TimerStepList control.
value
A Boolean value that determines if the "Unit" column is displayed or not.
Default = True.
Applies To
TimerView Control
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Description
Returns or sets a flag that determines if the "Units of Time" column is displayed.
Syntax
object.ShowUnitsOfTime[= flag]
The ShowUnitsOfTime property syntax has these parts:
SignatureContextColumn
Text
Part
Description
object
An object expression that evaluates to a TimerStepList control.
value
A Boolean value that determines if the "Units of Time" column is displayed or not. Default =
True.
Applies To
SignatureList Control
Description
Returns or sets a value that determines the text displayed in the Signature Context
column header of the list.
Syntax
object.SignatureContextColumnText [= text]
The SignatureContextColumnText property syntax has these parts:
Part
Description
object
An object expression that evaluates to a SignatureList control.
text
A string to be displayed as the column header text for the Signature Context column.
(Default = Signature Context)
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Remarks
Setting this property to a zero-length string ("") will cause the column header to be
displayed without text (empty). Setting this property to Null will raise an error.
SignatureContextColumn
Width
Applies To
SignatureList Control
Description
Returns or sets a value that determines the Signature Context column width in the
list.
Syntax
object.SignatureContextColumnWidth [= value]
The SignatureContextColumnWidth property has these parts:
Part
Description
object
An object expression that evaluates to a SignatureList control.
value
An integer that determines the column width.
(Default = 1440)
Remarks
Setting this property to a value less than zero will raise an error. The column width
is measured in units of twips 22. The minimum value is 1, the maximum value is
32,767.
SignatureContextFilter
Pattern
Applies To
SignatureList Control
22
A twip is a unit of measurement implemented as 1/20 of a point or 1/1440 of an inch.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Description
Returns or sets a filter pattern for the Signature Context column.
Syntax
object.SignatureContextFilterPattern [= pattern]
The SignatureContextFilterPattern property has these parts:
Part
Description
object
An object expression that evaluates to a SignatureList control.
pattern
A string that determines the filter pattern for the Signature Context column.
(Default = *)
Remarks
Setting this property to Null will raise an error. A filter pattern is a string that
determines the string characteristics to be included in a particular column. For
example, if the Signature Context of a particular signature in the signature list does
not match the SignatureContextFilterPattern, that signature is not included in
the signature list. Filter patterns are defined as follows:
Kind of match
Pattern
Match (returns True)
No match (returns False)
Multiple characters
a*a
aa, aBa, aBBBa
aBC
*ab*
abc, AABB, Xab
aZb, bac
Special character
a[*]a
a*a
aaa
Multiple characters
ab*
abcdefg, abc
cab, aab
Single character
a?a
aaa, a3a, aBa
aBBBa
Single digit
a#a
a0a, a1a, a2a
aaa, a10a
Range of characters
[a-z]
f, p, j
2, &
Outside a range
[!a-z]
9, &, %
b, a
Not a digit
[!0-9]
A, a, &, ~
0, 1, 9
Combined
a[!b-m]#
An9, az0, a99
abc, aj0
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
SignatureContextShow
Column
Applies To
SignatureList Control
Description
Returns or sets a flag that determines if the Signature Context column is displayed.
Syntax
object.SignatureContextShowColumn [= flag]
The SignatureContextShowColumn property has these parts:
Part
Description
object
An object expression that evaluates to a SignatureList control.
flag
A boolean value that determines if the Signature Context column is displayed or not.
(Default = True)
Remarks
A value of True indicates that the column will be displayed. A value of False
indicates that the column will not be displayed.
Signatures
Applies To
SignatureList Control
Description
Returns a reference to the collection of signatures in the FactoryTalk Batch Server.
Syntax
[Set col =] object.Signatures
The Signatures property has these parts:
Part
Description
object
An object expression that evaluates to a SignatureList control.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Part
Description
col
An object that refers to the Signatures collection object associated with the FactoryTalk
Batch Server.
Remarks
The Signatures collection contains Signature objects. See the “SelectedSignature
(on page 189)” property for the definition of a Signature object. Each Signature
object key in the Signatures collection is IDSignatureID.
SignoffMeaningColumn
Text
Applies To
SignatureList Control
Description
Returns or sets a value that determines the text displayed in the Signoff Meaning
column header of the list.
Syntax
object.SignoffMeaningColumnText [= text]
The SignoffMeaningColumnText property has these parts:
Part
Description
object
An object expression that evaluates to a SignatureList control.
text
A string to be displayed as the column header text for the SignoffMeaning column.
(Default = Signoff Meaning)
Remarks
Setting this property to a zero-length string ("") will cause the column header to
display without text. Setting this property to Null will raise an error.
SignoffMeaningColumn
Width
Applies To
SignatureList Control
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Description
Returns or sets a value that determines the Signoff Meaning column width in the
list.
Syntax
object.SignoffMeaningColumnWidth [= value]
The SignoffMeaningColumnWidth property has these parts:
Part
Description
object
An object expression that evaluates to a SignatureList control.
value
An integer that determines the column width.
(Default = 1440)
Remarks
Setting this property to a value less than zero will raise an error. The column width
is measured in units of twips 23. The minimum value is 1, the maximum value is
32,767.
SignoffMeaningFilter
Pattern
Applies To
SignatureList Control
Description
Returns or sets a filter pattern for the Signoff Meaning column.
Syntax
object.SignoffMeaningFilterPattern [= pattern]
The SignoffMeaningFilterPattern property has these parts:
Part
Description
object
An object expression that evaluates to a SignatureList control.
23
A twip is a unit of measurement implemented as 1/20 of a point or 1/1440 of an inch.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
A string that determines the filter pattern for the Signoff Meaning column.
(Default = *)
pattern
Remarks
Setting this property to Null will raise an error. A filter pattern is a string that
determines the string characteristics to be included in a particular column. For
example, if the Signoff Meaning of a particular signature in the signature list does
not match the SignoffMeaningFilterPattern, that signature is not included in
the signature list. Filter patterns are defined as follows:
SignoffMeaningShow
Column
Kind of match
Pattern
Match (returns True)
No match (returns False)
Multiple characters
a*a
aa, aBa, aBBBa
aBC
*ab*
abc, AABB, Xab
aZb, bac
Special character
a[*]a
a*a
aaa
Multiple characters
ab*
abcdefg, abc
cab, aab
Single character
a?a
aaa, a3a, aBa
aBBBa
Single digit
a#a
a0a, a1a, a2a
aaa, a10a
Range of characters
[a-z]
f, p, j
2, &
Outside a range
[!a-z]
9, &, %
b, a
Not a digit
[!0-9]
A, a, &, ~
0, 1, 9
Combined
a[!b-m]#
An9, az0, a99
abc, aj0
Applies To
SignatureList Control
Description
Returns or sets a flag that determines if the Signoff Meaning column is displayed.
Syntax
object.SignoffMeaningShowColumn [= flag]
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
The SignoffMeaningShowColumn property has these parts:
Part
Description
object
An object expression that evaluates to a SignatureList control.
flag
A boolean value that determines if the Signoff Meaning column is displayed or not.
(Default = True)
Remarks
A value of True indicates that the column will be displayed. A value of False
indicates that the column will not be displayed.
SignoffSecurityColumnText Applies To
SignatureList Control
Description
Returns or sets a value that determines the text displayed in the Signoff Security
column header of the list.
Syntax
object.SignoffSecurityColumnText [= text]
The SignoffSecurityColumnText property has these parts:
Part
Description
object
An object expression that evaluates to a SignatureList control.
text
A string to be displayed as the column header text for the SignoffSecurity column.
(Default = Signoff Security)
Remarks
Setting this property to a zero-length string ("") will cause the column header to
display without text. Setting this property to Null will raise an error.
SignoffSecurityColumn
Width
Applies To
SignatureList Control
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Description
Returns or sets a value that determines the Signoff Security column width in the
list.
Syntax
object.SignoffSecurityColumnWidth [= value]
The SignoffSecurityColumnWidth property has these parts:
Part
Description
object
An object expression that evaluates to a SignatureList control.
value
An integer that determines the column width.
(Default = 1440)
Remarks
Setting this property to a value less than zero will raise an error. The column width
is measured in units of twips 24. The minimum value is 1, the maximum value is
32,767.
SignoffSecurityFilter
Pattern
Applies To
SignatureList Control
Description
Returns or sets a filter pattern for the Signoff Security column.
Syntax
object.SignoffSecurityFilterPattern [= pattern]
The SignoffSecurityFilterPattern property has these parts:
Part
Description
object
An object expression that evaluates to a SignatureList control.
pattern
A string that determines the filter pattern for the Signoff Security column.
(Default = *)
24
A twip is a unit of measurement implemented as 1/20 of a point or 1/1440 of an inch.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Remarks
Setting this property to Null will raise an error. A filter pattern is a string that
determines the string characteristics to be included in a particular column. For
example, if the Signoff Security of a particular signature in the signature list does
not match the SignoffSecurityFilterPattern, that signature is not included in the
signature list. Filter patterns are defined as follows:
SignoffSecurityShow
Column
Kind of match
Pattern
Match (returns True)
No match (returns False)
Multiple characters
a*a
aa, aBa, aBBBa
aBC
*ab*
abc, AABB, Xab
aZb, bac
Special character
a[*]a
a*a
aaa
Multiple characters
ab*
abcdefg, abc
cab, aab
Single character
a?a
aaa, a3a, aBa
aBBBa
Single digit
a#a
a0a, a1a, a2a
aaa, a10a
Range of characters
[a-z]
f, p, j
2, &
Outside a range
[!a-z]
9, &, %
b, a
Not a digit
[!0-9]
A, a, &, ~
0, 1, 9
Combined
a[!b-m]#
An9, az0, a99
abc, aj0
Applies To
SignatureList Control
Description
Returns or sets a flag that determines if the Signoff Security column is displayed.
Syntax
object.SignoffSecurityShowColumn [= flag]
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
The SignoffSecurityShowColumn property has these parts:
Part
Description
object
An object expression that evaluates to a SignatureList control.
flag
A boolean value that determines if the Signoff Security column is displayed or not.
(Default = True)
Remarks
A value of True indicates that the column will be displayed. A value of False
indicates that the column will not be displayed.
Sorted
Applies To
ControlRecipeList Control, PromptsList Control, SignatureList Control
Description
Returns or sets a value that determines whether the items in a control are sorted.
Syntax
object.Sorted [= value]
The Sorted property syntax has these parts:
Part
Description
object
An object expression that evaluates to an object in the Applies To list.
value
A Boolean expression specifying whether the items are sorted, as described in Settings.
Settings
The settings for value are:
Setting
Description
True
The list items are sorted alphabetically, according to the SortOrder property. (Default)
False
The list items are not sorted.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Remarks
The Sorted property must be set to True for the settings in the SortOrder and
SortKey properties to take effect.
SortKey
Applies To
ControlRecipeList Control, PromptsList Control, SignatureList Control
Description
Returns or sets a value that determines how the items in a control are sorted.
Syntax
object.SortKey [= value]
The SortKey property syntax has these parts:
Part
Description
object
An object expression that evaluates to an object in the Applies To list.
value
An integer specifying the sort key, as described in Settings.
Settings
The settings for value are:
Setting
Description
Integer
Index of the column by which the control’s contents are sorted (columns are zero-based).
Remarks
The Sorted property must be set to True before the change takes place. Setting
this property to a value less than zero or greater than or equal to the number of
columns (12) will raise an error.
SortOrder
Applies To
ControlRecipeList Control, PromptsList Control, SignatureList Control
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Description
Returns or sets a value that determines whether items in a control are sorted in
ascending or descending order.
Syntax
object.SortOrder [= value]
The SortOrder property syntax has these parts:
Part
Description
object
An object expression that evaluates to an object in the Applies To list.
value
An integer specifying the type of sort order, as described in Settings.
Settings
The settings for value are:
Enumeration
Value
Description
lvwAscending
0
Ascending order. Sorts from the beginning of the alphabet (A-Z) or the earliest date.
Numbers are sorted as strings, with the first digit determining the initial position in the
sort, and subsequent digits determining sub-sorting. (Default)
lvwDescending
1
Descending order. Sorts from the end of the alphabet (Z-A) or the latest date. Numbers
are sorted as strings, with the first digit determining the initial position in the sort, and
subsequent digits determining sub-sorting.
Remarks
The Sorted property must be set to True before a list will be sorted in the order
specified by SortOrder. Setting this property to a value outside of the allowable
range will raise an error.
StartTimeColumnText
Applies To
ControlRecipeList Control
Description
Returns or sets a value that determines the text displayed in the Start Time
column header of the list.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Syntax
object.StartTimeColumnText [= text]
The StartTimeColumnText property syntax has these parts:
Part
Description
object
An object expression that evaluates to an object in the Applies To list.
text
A string to be displayed as the column header text for the Start Time column.
(Default = Start Time)
Remarks
Setting this property to a zero-length string ("") will cause the column header to be
displayed without text (empty). Setting this property to Null will raise an error.
StartTimeColumnWidth
Applies To
ControlRecipeList Control
Description
Returns or sets a value that determines the Start Time column width in the
control recipe list.
Syntax
object.StartTimeColumnWidth [= value]
The StartTimeColumnWidth property syntax has these parts:
Part
Description
object
An object expression that evaluates to an object in the Applies To list.
value
An integer or enumeration that determines the Start Time column width.
(Default = 1440)
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Remarks
Setting this property to a value less than zero will raise an error. The column width
is measured in units of twips 25.
StartTimeFilterPattern
Applies To
ControlRecipeList Control
Description
Returns or sets the filter pattern for the Start Time column.
Syntax
object.StartTimeFilterPattern [= pattern]
The StartTimeFilterPattern property syntax has these parts:
Part
Description
object
An object expression that evaluates to an object in the Applies To list.
pattern
A string that determines the filter pattern for the Start Time column.
(Default = *)
Remarks
Setting this property to Null will raise an error.
A filter pattern is a string that determines the string characteristics to be included
in a particular column. For example, if the Start Time of a particular control recipe
in the control recipe list does not match the StartTimeFilterPattern, that control
recipe is not included in the control recipe list. Filter patterns are defined as
follows:
Kind of match
Pattern
Match (returns True)
No match (returns False)
Multiple characters
a*a
aa, aBa, aBBBa
aBC
*ab*
abc, AABB, Xab
aZb, bac
a[*]a
a*a
aaa
Special character
25
A twip is a unit of measurement implemented as 1/20 of a point or 1/1440 of an inch.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
StateColumnText
Kind of match
Pattern
Match (returns True)
No match (returns False)
Multiple characters
ab*
abcdefg, abc
cab, aab
Single character
a?a
aaa, a3a, aBa
aBBBa
Single digit
a#a
a0a, a1a, a2a
aaa, a10a
Range of characters
[a-z]
f, p, j
2, &
Outside a range
[!a-z]
9, &, %
b, a
Not a digit
[!0-9]
A, a, &, ~
0, 1, 9
Combined
a[!b-m]#
An9, az0, a99
abc, aj0
Applies To
ControlRecipeList Control, SignatureList Control
Description
Returns or sets a value that determines the text displayed in the State column
header of the list.
Syntax
object.StateColumnText [= text]
The StateColumnText property syntax has these parts when used with the
ControlRecipeList control:
Part
Description
object
An object expression that evaluates to an object in the Applies To list.
text
A string to be displayed as the column header text for the State column.
(Default = State)
The StateColumnText property syntax has these parts when used with the
SignatureList control:
Part
Description
object
An object expression that evaluates to a SignatureList control.
text
A string to be displayed as the column header text for the State column.
(Default = State)
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Remarks
Setting this property to a zero-length string ("") causes the column header to be
displayed without text (empty). Setting this property to Null will raise an error.
StateColumnWidth
Applies To
ControlRecipeList Control, SignatureList Control
Description
Returns or sets a value that determines the State column width in the control
recipe list.
Syntax
object.StateColumnWidth [= value]
The StateColumnWidth property has these parts when used with the
ControlRecipeList control:
Part
Description
object
An object expression that evaluates to an object in the Applies To list.
value
An integer or enumeration that determines the State column width.
(Default = 1440)
The StateColumnWidth property has these parts when used with the
SignatureList control:
Part
Description
object
An object expression that evaluates to a SignatureList control.
value
An integer that determines the column width.
(Default = 1440)
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Remarks
Setting this property to a value less than zero will raise an error. The column width
is measured in units of twips 26. The minimum value is 1, the maximum value is
32,767.
StateFilterPattern
Applies To
ControlRecipeList Control, SignatureList Control
Description
Returns or sets the filter pattern for the State column.
Syntax
object.StateFilterPattern [= pattern]
The StateFilterPattern property has these parts when used with the
ControlRecipeList control:
Part
Description
object
An object expression that evaluates to an object in the Applies To list.
pattern
A string that determines the filter pattern for the State column.
(Default = *)
The StateFilterPattern property has these parts when used with the SignatureList
control:
Part
Description
object
An object expression that evaluates to a SignatureList control.
pattern
A string that determines the filter pattern for the State column.
(Default = *)
Remarks
Setting this property to Null will raise an error.
26
A twip is a unit of measurement implemented as 1/20 of a point or 1/1440 of an inch.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
A filter pattern is a string that determines the string characteristics to be included
in a particular column. For example, if the State of a particular control recipe in
the control recipe list does not match the StateFilterPattern, that control recipe
is not included in the control recipe list or if the State of a particular signature does
not match the StateFilterPattern, that signature will not be displayed. Filter
patterns are defined as follows:
StateShowColumn
Kind of match
Pattern
Match (returns True)
No match (returns False)
Multiple characters
a*a
aa, aBa, aBBBa
aBC
*ab*
abc, AABB, Xab
aZb, bac
Special character
a[*]a
a*a
aaa
Multiple characters
ab*
abcdefg, abc
cab, aab
Single character
a?a
aaa, a3a, aBa
aBBBa
Single digit
a#a
a0a, a1a, a2a
aaa, a10a
Range of characters
[a-z]
f, p, j
2, &
Outside a range
[!a-z]
9, &, %
b, a
Not a digit
[!0-9]
A, a, &, ~
0, 1, 9
Combined
a[!b-m]#
An9, az0, a99
abc, aj0
Applies To
SignatureList Control
Description
Returns or sets a flag that determines if the State column is displayed.
Syntax
object.StateShowColumn [= flag]
The StateShowColumn property has these parts:
Part
Description
object
An object expression that evaluates to a SignatureList control.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Part
Description
flag
A boolean value that determines if the State column is displayed or not.
(Default = True)
Remarks
A value of True indicates that the column will be displayed. A value of False
indicates that the column will not be displayed.
TextFont
Applies To
TimerView Control
Description
Returns or sets the font used for the text displayed in the timer step list.
Syntax
object.TextFont [= font]
The TextFont property has these parts:
TimeColumnText
Part
Description
object
An object expression that evaluates to a TimerStepList control.
flag
New font object to be used when depicting timer step elements. Default = Arial.
Applies To
PromptsList Control, SignatureList Control
Description
Returns or sets a value that determines the text displayed in the Time column
header of the list.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Syntax
object.TimeColumnText [= text]
The TimeColumnText property syntax has these parts when used with the
PromptsList Control:
Part
Description
object
An object expression that evaluates to an object in the Applies To list.
text
A string to be displayed as the column header text for the Time column.
(Default = Time)
The TimeColumnText property syntax has these parts when used with the
SignatureList Control:
Part
Description
object
An object expression that evaluates to a SignatureList control.
text
A string to be displayed as the column header text for the Time column.
(Default = Time)
Remarks
Setting this property to a zero-length string ("") causes the column header to be
displayed without text (empty). Setting this property to Null will raise an error.
TimeColumnWidth
Applies To
PromptsList Control, SignatureList Control
Description
Returns or sets a value that determines the Time column width in the prompts
list.
Syntax
object.TimeColumnWidth [= value]
The TimeColumnWidth property syntax has these parts when used with the
PromptsList Control:
Part
Description
object
An object expression that evaluates to an object in the Applies To list.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Part
Description
value
An integer or enumeration that determines the Time column width.
(Default = 1440)
The TimeColumnWidth property syntax has these parts when used with the
SignatureList Control:
Part
Description
object
An object expression that evaluates to a SignatureList control.
value
An integer that determines the Time column width.
(Default = 1440)
Remarks
Setting this property to a value less than zero will raise an error. The column width
is measured in units of twips 27. The minimum value is 1, the maximum value is
32,767.
TimeFilterPattern
Applies To
PromptsList Control, SignatureList Control
Description
Returns or sets the filter pattern for the Time column.
Syntax
object.TimeFilterPattern [= pattern]
The TimeFilterPattern property syntax has these parts when used with the
PromptsList Control:
Part
Description
object
An object expression that evaluates to an object in the Applies To list.
pattern
A string that determines the filter pattern for the Time column.
(Default = *)
27
A twip is a unit of measurement implemented as 1/20 of a point or 1/1440 of an inch.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
The TimeFilterPattern property syntax has these parts when used with the
SignatureList Control:
Part
Description
object
An object expression that evaluates to a SignatureList control.
pattern
A string that determines the filter pattern for the Time column.
(Default = *)
Remarks
Setting this property to Null will raise an error.
A filter pattern is a string that determines the string characteristics to be included
in a particular column. For example, if the Time of a particular prompt in the
prompts list does not match the TimeFilterPattern, that prompt is not included
in the prompts list, or if the Time of a particular signature in the signature list does
not match the TimeFilterPattern, that signature is not included in the
signature list. Filter patterns are defined as follows:
TimeOutPeriod
Kind of match
Pattern
Match (returns True)
No match (returns False)
Multiple characters
a*a
aa, aBa, aBBBa
aBC
*ab*
abc, AABB, Xab
aZb, bac
Special character
a[*]a
a*a
aaa
Multiple characters
ab*
abcdefg, abc
cab, aab
Single character
a?a
aaa, a3a, aBa
aBBBa
Single digit
a#a
a0a, a1a, a2a
aaa, a10a
Range of characters
[a-z]
f, p, j
2, &
Outside a range
[!a-z]
9, &, %
b, a
Not a digit
[!0-9]
A, a, &, ~
0, 1, 9
Combined
a[!b-m]#
An9, az0, a99
abc, aj0
Applies To
ControlRecipeList Control, PromptsList Control, ProcedureView Control,
TimerView Control
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Description
Returns or sets the amount of time that the FactoryTalk Batch Server should
allow itself to respond to a data request.
Syntax
object.TimeOutPeriod [= value]
The TimeOutPeriod property syntax has these parts:
Part
Description
object
An object expression that evaluates to an object in the Applies To list.
value
The amount of time in milliseconds that the FactoryTalk Batch Server (specified by the Node
property) will continue to work on a client request before it responds to the request with
TIMEOUT. When this happens, it does not necessarily mean that the request has failed. The
Server will continue to service the request, but has acknowledged to the client that it could
not complete the request in the amount of time specified by the TimeoutPeriod property
and it will not hold up the client any longer.
The allowable range is 1 to 3,600,000. The default is 60,000 (60 seconds).
Remarks
Setting this property to a value outside of the allowable range will raise an error.
TimeShowColumn
Applies To
SignatureList Control
Description
Returns or sets a flag that determines if the Time column is displayed.
Syntax
object.TimeShowColumn [= flag]
The TimeShowColumn property has these parts:
Part
Description
object
An object expression that evaluates to a SignatureList control.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Part
Description
flag
A boolean value that determines if the Time column is displayed or not.
(Default = True)
Remarks
A value of True indicates that the column will be displayed. A value of False
indicates that the column will not be displayed.
TopProcedureID
Applies To
ProcedureView Control
Description
Returns or sets ID of the highest (S88 level) procedure that can be depicted by this
control.
Syntax
[procID =] object.TopProcedureID
The TopProcedureID property syntax has these parts:
Part
Description
procID
A string holding the ID of the highest (S88 level) procedure depicted by the control.
object
An object expression that evaluates to an object in the Applies To list.
(Default = nullstring)
Remarks
Refer to the Server API Communications Language Reference for information on
the format of a procedure ID.
There are two manners in which the currently displayed procedure can be
changed:
1. Navigate the hierarchy (view the current procedure’s parent or view a given
step’s procedure in the current procedure).
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
2. Completely change hierarchies (begin within the confines of a different
control recipe).
As a consequence, there are two properties involved in navigation:
1. A procedure ID identified by the TopProcedureID property, which
identifies the hierarchy (control recipe) and the highest-allowed S88 level of
that hierarchy.
2. A procedure ID identified by the CurrentProcedureID property, which
identifies the hierarchy level currently being viewed.
Following this scheme, the CurrentProcedureID is always part of the hierarchy
(control recipe) identified by the TopProcedureID, and is always at or below the
TopProcedureID within the hierarchy. The CurrentProcedureID indicates
what is displayed, and its value is changed either programmatically or through UI
navigation.
The TopProcedureID’s value can only be set programmatically and is only
changed when it is necessary to view a different control recipe or a procedure
within the control recipe currently identified by the TopProcedureID that is at a
higher level than the procedure identified by TopProcedureID. When the value
of TopProcedureID changes such that a new control recipe is specified, the new
value of TopProcedureID should be assigned to CurrentProcedureID as well.
When the TopProcedureID property is assigned a zero-length string as its value,
the control will be empty (no procedure depicted).
TypeColumnText
Applies To
SignatureList Control
Description
Returns or sets a value that determines the text displayed in the Type column
header of the list.
Syntax
object.TypeColumnText [= text]
The TypeColumnText property has these parts:
Part
Description
object
An object expression that evaluates to a SignatureList control.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Part
Description
text
A string to be displayed as the column header text for the Type column.
(Default = Type)
Remarks
Setting this property to a zero-length string ("") will cause the column header to
display without text. Setting this property to Null will raise an error.
TypeColumnWidth
Applies To
SignatureList Control
Description
Returns or sets a value that determines the Type column width in the list.
Syntax
object.TypeColumnWidth [= value]
The TypeColumnWidth property has these parts:
Part
Description
object
An object expression that evaluates to a SignatureList control.
value
An integer that determines the column width.
(Default = 1440)
Remarks
Setting this property to a value less than zero will raise an error. The column width
is measured in units of twips 28. The minimum value is 1, the maximum value is
32,767.
TypeFilterPattern
Applies To
SignatureList Control
28
A twip is a unit of measurement implemented as 1/20 of a point or 1/1440 of an inch.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Description
Returns or sets a filter pattern for the Type column.
Syntax
object.TypeFilterPattern [= pattern]
The TypeFilterPattern property has these parts:
Part
Description
object
An object expression that evaluates to a SignatureList control.
pattern
A string that determines the filter pattern for the Type column.
(Default = *)
Remarks
Setting this property to Null will raise an error. A filter pattern is a string that
determines the string characteristics to be included in a particular column. For
example, if the Type of a particular signature in the Signature List does not match
the TypeFilterPattern, that signature is not included in the Signature List. Filter
patterns are defined as follows:
Kind of match
Pattern
Match (returns True)
No match (returns False)
Multiple characters
a*a
aa, aBa, aBBBa
aBC
*ab*
abc, AABB, Xab
aZb, bac
Special character
a[*]a
a*a
aaa
Multiple characters
ab*
abcdefg, abc
cab, aab
Single character
a?a
aaa, a3a, aBa
aBBBa
Single digit
a#a
a0a, a1a, a2a
aaa, a10a
Range of characters
[a-z]
f, p, j
2, &
Outside a range
[!a-z]
9, &, %
b, a
Not a digit
[!0-9]
A, a, &, ~
0, 1, 9
Combined
a[!b-m]#
An9, az0, a99
abc, aj0
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
TypeShowColumn
Applies To
SignatureList Control
Description
Returns or sets a flag that determines if the Type column is displayed.
Syntax
object.TypeShowColumn [= flag]
The TypeShowColumn property has these parts:
Part
Description
object
An object expression that evaluates to a SignatureList control.
flag
A boolean value that determines if the Type column is displayed or not.
(Default = True)
Remarks
A value of True indicates that the column will be displayed. A value of False
indicates that the column will not be displayed.
UnitColumnText
Applies To
PromptsList Control
Description
Returns or sets a value that determines the text displayed in the Unit column
header of the list.
Syntax
object.UnitColumnText [= text]
The UnitColumnText property syntax has these parts:
Part
Description
object
An object expression that evaluates to an object in the Applies To list.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Part
Description
text
A string to be displayed as the column header text for the Unit column.
(Default = Unit)
Remarks
Setting this property to a zero-length string ("") will cause the column header to
display without text (empty). Setting this property to Null will raise an error.
UnitColumnWidth
Applies To
PromptsList Control
Description
Returns or sets a value that determines the Unit column width in the prompts list.
Syntax
object.UnitColumnWidth [= value]
The UnitColumnWidth property syntax has these parts:
Part
Description
object
An object expression that evaluates to an object in the Applies To list.
value
An integer or enumeration that determines the Unit column width.
(Default = 1440)
Remarks
Setting this property to a value less than zero will raise an error. The column width
is measured in units of twips 29.
UnitFilterPattern
Applies To
PromptsList Control
29
A twip is a unit of measurement implemented as 1/20 of a point or 1/1440 of an inch.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Description
Returns or sets the filter pattern for the Unit column.
Syntax
object.UnitFilterPattern [= pattern]
The UnitFilterPattern property syntax has these parts:
Part
Description
object
An object expression that evaluates to an object in the Applies To list.
pattern
A string that determines the filter pattern for the Unit column.
(Default = *)
Remarks
Setting this property to Null will raise an error.
A filter pattern is a string that determines the string characteristics to be included
in a particular column. For example, if the Unit of a particular prompt in the
prompts list does not match the UnitFilterPattern, that prompt is not included
in the prompts list. Filter patterns are defined as follows:
Kind of match
Pattern
Match (returns True)
No match (returns False)
Multiple characters
a*a
aa, aBa, aBBBa
aBC
*ab*
abc, AABB, Xab
aZb, bac
Special character
a[*]a
a*a
aaa
Multiple characters
ab*
abcdefg, abc
cab, aab
Single character
a?a
aaa, a3a, aBa
aBBBa
Single digit
a#a
a0a, a1a, a2a
aaa, a10a
Range of characters
[a-z]
f, p, j
2, &
Outside a range
[!a-z]
9, &, %
b, a
Not a digit
[!0-9]
A, a, &, ~
0, 1, 9
Combined
a[!b-m]#
An9, az0, a99
abc, aj0
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
UnitsColumnText
Applies To
ControlRecipeList Control
Description
Returns or sets a value that determines the text displayed in the Units column
header of the list.
Syntax
object.UnitsColumnText [= text]
The UnitsColumnText property syntax has these parts:
Part
Description
object
An object expression that evaluates to an object in the Applies To list.
text
A string to be displayed as the column header text for the Units column.
(Default = Units In Use)
Remarks
Setting this property to a zero-length string ("") will cause the column header to
display without text (empty). Setting this property to Null will raise an error.
UnitsColumnWidth
Applies To
ControlRecipeList Control
Description
Returns or sets a value that determines the Units column width in the control
recipe list.
Syntax
object.UnitsColumnWidth [= value]
The UnitsColumnWidth property syntax has these parts:
Part
Description
object
An object expression that evaluates to an object in the Applies To list.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Part
Description
value
An integer or enumeration that determines the Units column width.
(Default = 1440)
Remarks
Setting this property to a value less than zero will raise an error. The column width
is measured in units of twips 30.
UnitsFilterPattern
Applies To
ControlRecipeList Control
Description
Returns or sets the filter pattern for the Units column.
Syntax
object.UnitsFilterPattern [= pattern]
The UnitsFilterPattern property syntax has these parts:
Part
Description
object
An object expression that evaluates to an object in the Applies To list.
pattern
A string that determines the filter pattern for the Units column.
(Default = *)
Remarks
Setting this property to Null will raise an error.
A filter pattern is a string that determines the characteristics of strings to be
included in a particular column. For example, if the Unit of a particular control
recipe in the control recipe list does not match the UnitsFilterPattern, that
control recipe is not included in the control recipe list. Filter patterns are defined
as follows:
30
A twip is a unit of measurement implemented as 1/20 of a point or 1/1440 of an inch.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
UseExternalBatchSec
User
Kind of match
Pattern
Match (returns True)
No match (returns False)
Multiple characters
a*a
aa, aBa, aBBBa
aBC
*ab*
abc, AABB, Xab
aZb, bac
Special character
a[*]a
a*a
aaa
Multiple characters
ab*
abcdefg, abc
cab, aab
Single character
a?a
aaa, a3a, aBa
aBBBa
Single digit
a#a
a0a, a1a, a2a
aaa, a10a
Range of characters
[a-z]
f, p, j
2, &
Outside a range
[!a-z]
9, &, %
b, a
Not a digit
[!0-9]
A, a, &, ~
0, 1, 9
Combined
a[!b-m]#
An9, az0, a99
abc, aj0
Warning:
Do NOT modify this property! It is intended for internal use only and must not be
modified in any way.
Applies To
ControlRecipeList Control, PromptsList Control, ProcedureView Control,
SignatureList Control
Description
The User property is not available at design time and is read-only at run time. It is
used to determine if the operator has permission to execute a particular command.
Syntax
[result =] object.User
The User property syntax has these parts:
Part
Description
result
Boolean expression that specifies the user name associated with the control's current user
context.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Part
Description
object
An object expression that evaluates to an object in the Applies To list.
Remarks
This property defaults to the Batch Server’s default user. The property’s value is
changed using the various security-related methods for logging in and out users.
UserContext
Applies To
ControlRecipeList Control, PromptsList Control, ProcedureView Control,
SignatureList Control, TimerView Control
Description
Returns a string representing the current user context for the list control, of the
form computername/username. The UserContext property is not available at
design time and is read-only at run time.
Syntax
[result =] object.UserContext
The UserContext property syntax has these parts:
Part
Description
result
Boolean expression that specifies the control's current user context.
object
An object expression that evaluates to an object in the Applies To list.
Remarks
The UserContext property is included in all commands sent to the FactoryTalk
Batch Server and recorded in the journal events created.
ValueColumnText
Applies To
PromptsList Control
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Description
Returns or sets a value that determines the text displayed in the Value column
header of the list.
Syntax
object.ValueColumnText [= text]
The ValueColumnText property syntax has these parts:
Part
Description
object
An object expression that evaluates to an object in the Applies To list.
text
A string to be displayed as the column header text for the Value column.
(Default = Default)
Remarks
Setting this property to a zero-length string ("") will cause the column header to
display without text (empty). Setting this property to Null will raise an error.
ValueColumnWidth
Applies To
PromptsList Control
Description
Returns or sets a value that determines the Value column width in the prompts
list.
Syntax
object.ValueColumnWidth [= value]
The ValueColumnWidth property syntax has these parts:
Part
Description
object
An object expression that evaluates to an object in the Applies To list.
value
An integer or enumeration that determines the Value column width.
(Default = 1440)
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Remarks
Setting this property to a value less than zero will raise an error. The column width
is measured in units of twips 31.
ValueFilterPattern
Applies To
PromptsList Control
Description
Returns or sets the filter pattern for the Value column.
Syntax
object.ValueFilterPattern [= pattern]
The ValueFilterPattern property syntax has these parts:
Part
Description
object
An object expression that evaluates to an object in the Applies To list.
pattern
A string that determines the filter pattern for the Value column.
(Default = *)
Remarks
Setting this property to Null will raise an error.
A filter pattern is a string that determines the string characteristics to be included
in a particular column. For example, if the Value of a particular prompt in the
prompts list does not match the ValueFilterPattern, that prompt is not included
in the prompts list. Filter patterns are defined as follows:
Kind of match
Pattern
Match (returns True)
No match (returns False)
Multiple characters
a*a
aa, aBa, aBBBa
aBC
*ab*
abc, AABB, Xab
aZb, bac
a[*]a
a*a
aaa
Special character
31
A twip is a unit of measurement implemented as 1/20 of a point or 1/1440 of an inch.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
View
Kind of match
Pattern
Match (returns True)
No match (returns False)
Multiple characters
ab*
abcdefg, abc
cab, aab
Single character
a?a
aaa, a3a, aBa
aBBBa
Single digit
a#a
a0a, a1a, a2a
aaa, a10a
Range of characters
[a-z]
f, p, j
2, &
Outside a range
[!a-z]
9, &, %
b, a
Not a digit
[!0-9]
A, a, &, ~
0, 1, 9
Combined
a[!b-m]#
An9, az0, a99
abc, aj0
Applies To
ControlRecipeList Control, PromptsList Control, ProcedureView Control
Description
Returns or sets the appearance of the control items. The View property functions
differently for the ControlRecipeList control and PromptsList control than it
does for the ProcedureView control.
Syntax
object.View [= value]
The View property syntax has these parts:
Part
Description
object
An object expression that evaluates to an object in the Applies To list.
value
An integer or enumeration specifying the control’s appearance, as described in Settings.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Settings
The settings for the ControlRecipeList and PromptsList controls value are:
Enumeration
Value
Description
lvwIcon
0
Icon. Each item is represented by a full-sized (standard) icon and a text label.
lvwSmallIcon
1
Small Icon. Each item is represented by a small icon and a text label that
appears to the right of the icon. The items appear horizontally.
lvwList
2
List. Each item is represented by a small icon and a text label that appears to the
right of the icon. The items are arranged vertically, each on its own line with
information arranged in columns.
lvwReport
3
Report. Each item is displayed with its small icon and text labels. (Default)
The settings for the ProcedureView control value are:
Enumeration
Value
Description
pvwViewSFC
0
Depict procedures in SFC style. (Default)
pvwViewTable
1
Depict procedures in a table format.
Remarks
When the Icon view is selected for the ControlRecipeList or PromptsList
controls, use the LabelWrap property to specify if the ListItem object’s labels are
wrapped or not. In Report view, you can hide the column headers by setting the
HideColumnHeaders property to True. Setting this property to a value outside
of the allowable range will raise an error.
By default, the ProcedureView control displays procedures in the SFC view.
Visible
Applies To
ControlRecipeList Control, PromptsList Control, ProcedureView Control,
SignatureList Control, TimerView Control
Description
Specifies whether a control is visible.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Syntax
object.Visible [= value]
The Visible property syntax has these parts:
Part
Description
object
An object expression that evaluates to an object in the Applies To list.
value
A Boolean value indicating whether or not the object is visible.
(Default = True).
Remarks
A True value indicates that the control will be visible. A False value indicates that
the control will not be visible.
Zoom
Applies To
ProcedureView Control
Description
Returns or sets the percentage magnification of the currently depicted procedure
in the SFC view.
Syntax
object.Zoom [= zoom]
The Zoom property syntax has these parts:
Part
Description
object
An object expression that evaluates to an object in the Applies To list.
zoom
String that holds the current magnification of the procedure depicted.
Remarks
The minimum allowable value for this property is 1 and the maximum is 300.
Text is not included in the depiction of the current procedure when the zoom
percentage is at or below 35%. This property has no effect on the control’s Table
view. The default value of the Zoom property is 100.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Chapter 4
Events
An event is an action recognized by an object (such as clicking the mouse or
pressing a key) for which you can write code to respond. Events can occur as a
result of a user action or program code, or can be triggered by the control.
ActiveStepChangeBegin
Applies To
ProcedureView Control
Description
Indicates that the user has begun an active step change.
Syntax
Private Sub object_ActiveStepChangeBegin
The ActiveStepChangeBegin event syntax has these parts:
Part
Description
object
An instance of the ProcedureView ActiveX Control.
Remarks
The ActiveStepChangeBegin event will fire when the user starts making an
active step change (the mouse pointer turns into the pointing hand).
Tip:
ActiveStepChangeEnd
When coding an application, it is recommended that you do not allow a second active step change
to begin before the first one is complete or canceled. If a second active step change begins before
the first is complete or canceled, the mouse pointer does not return to the default.
Applies To
ProcedureView Control
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Description
Indicates that the user has stopped making an active step change.
Syntax
Private Sub object_ActiveStepChangeEnd
The ActiveStepChangeEnd event syntax has these parts:
Part
Description
object
An instance of the ProcedureView ActiveX Control.
Remarks
The ActiveStepChangeEnd event will fire when the user stops making an active
step change (when the mouse pointer changes from the pointing hand back to the
default) either because the active step change succeeded or because it was
cancelled.
Change
Applies To
ProcedureView Control, TimerView Control
Description
Indicates that the control’s contents have changed.
Syntax
Private Sub object_Change([index As Integer])
The Change event syntax has these parts:
Part
Description
object
An object expression that evaluates to an object in the Applies To list.
index
Integer that uniquely identifies the control instance if it is in a control array.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Remarks
The Change event will fire every time new status data is received for the currently
depicted procedure, and each time a new procedure is depicted (due to either
navigation or a change to the value of the TopProcedureID property).
Click
Applies To
ControlRecipeList Control, PromptsList Control, ProcedureView, SignatureList
Control
Description
Fires when the mouse is clicked within the specified control.
Syntax
Private Sub object_Click( )
The Click event syntax has these parts:
Part
Description
object
An object expression that evaluates to an object in the Applies To list.
Remarks
The ProcedureView control’s Click event will fire in both the SFC and Table
views, regardless of where the control is clicked.
CommunicationStatus
Change
Applies To
ProcedureView Control
Description
Indicates that the status of the communication link between the control and the
FactoryTalk Batch Server service has changed.
Syntax
Private Sub object_CommunicationStatusChange(ByVal connected As Boolean)
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
The CommunicationStatusChange event syntax has these parts:
DblClick
Part
Description
object
An object expression that evaluates to an object in the Applies To list.
connected
Boolean that indicates that communication has been established (True) or has been lost
(False).
Applies To
PromptsList Control, ProcedureView Control, SignatureList Control
Description
Fires when the mouse is double-clicked within the specified control.
Syntax
Private Sub object_DblClick( )
The DblClick event syntax has one part:
DblClickControlRecipe
Part
Description
object
An object expression that evaluates to an object in the Applies To list.
Applies To
ControlRecipeList Control
Description
Occurs when the user presses and releases a mouse button, then presses and
releases it again, over a control recipe in the control.
Syntax
Private Sub object_DblClickControlRecipe( )
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
The DblClickControlRecipe event syntax has one part:
InitDblClick
Part
Description
object
An object expression that evaluates to an object in the ControlRecipeList control.
Applies To
ProcedureView Control
Description
Indicates that the initial step in the currently depicted procedure has been doubleclicked.
Syntax
Private Sub object_InitDblClick(cancel As Boolean)
The InitDblClick event syntax has these parts:
Part
Description
object
An object expression that evaluates to an object in the Applies To list.
cancel
Boolean that, when set to False within this event procedure, prevents the control’s inherent
response to this event from occurring.
Remarks
The control’s inherent response to this event is to navigate up, depicting the
parent procedure of the currently depicted procedure. Setting the cancel argument
to False during this event procedure will prevent this navigation from occurring.
KeyDown
Applies To
ControlRecipeList Control, PromptsList Control, ProcedureView Control,
SignatureList Control
Description
Fires when a key is pressed.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Syntax
Private Sub object_KeyDown(KeyCode As Integer, Shift As Integer)
The KeyDown event syntax has these parts:
KeyPress
Part
Description
object
An object expression that evaluates to an object in the Applies To list.
KeyCode
An integer representing the key that was pressed to cause the event. An example of a key
code is vbKeyF1 which represents the F1 key in Visual Basic.
Shift
An integer indicating whether any of the shift, ctrl, or alt keys were pressed when the mouse
button specified was pressed or released. The possible values are:
0 = No keys
4 = alt
1 = SHIFT
5 = shift and alt
2 = ctrl
6 = ctrl and alt
3 = shift and ctrl
7= shift and ctrl and alt
Applies To
ControlRecipeList Control, PromptsList Control, ProcedureView Control,
SignatureList Control
Description
Fires when a key is pressed and released.
Syntax
Private Sub object_KeyPress(keyascii As Integer)
The KeyPress event syntax has these parts:
Part
Description
object
An object expression that evaluates to an object in the Applies To list.
keyascii
An integer representing the standard ANSI keycode.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
KeyUp
Applies To
ControlRecipeList Control, PromptsList Control, ProcedureView Control,
SignatureList Control
Description
Fires when a key is released).
Syntax
Private Sub object_KeyUp(KeyCode As Integer, Shift As Integer)
The KeyUp event syntax has these parts:
MouseDown
Part
Description
object
An object expression that evaluates to an object in the Applies To list.
KeyCode
An integer representing the key that was released to cause the event. An example of a key
code is vbKeyF1 which represents the F1 key in Visual Basic.
Shift
An integer indicating whether any of the shift, ctrl, or alt keys were pressed when the mouse
button specified was pressed or released. The possible values are:
0 = No keys
4 = alt
1 = SHIFT
5 = shift and alt
2 = ctrl
6 = ctrl and alt
3 = shift and ctrl
7 = shift and ctrl and alt
Applies To
ControlRecipeList Control, PromptsList Control, ProcedureView Control,
SignatureList Control
Description
Fires when a mouse button is pressed.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Syntax
Private Sub object_MouseDown(Button As Integer, Shift As Integer, X As
Single, Y As Single)
The MouseDown event syntax has these parts:
MouseMove
Part
Description
object
An object expression that evaluates to an object in the Applies To list.
Button
An integer representing the button that was pressed to cause the event. The possible values
are:
1 = left mouse button
2 = right mouse button
4 = middle mouse button
Shift
An integer indicating whether any of the shift, ctrl, or alt keys were pressed when the mouse
button specified was pressed or released. The possible values are:
0 = No keys
4 = alt
1 = SHIFT
5 = shift and alt
2 = ctrl
6 = ctrl and alt
3 = shift and ctrl 7 = shift and ctrl and alt
X
A number that indicates the x-coordinate of the mouse pointer’s location. The coordinate
system is based upon the settings in the object’s ScaleHeight, ScaleWidth, ScaleLeft, and
ScaleProperties.
Y
A number that indicates the y-coordinate of the mouse pointer’s location. The coordinate
system is based upon the settings in the object’s ScaleHeight, ScaleWidth, ScaleLeft, and
ScaleProperties.
Applies To
ControlRecipeList Control, PromptsList Control, ProcedureView Control,
SignatureList Control
Description
Fires when the mouse is moved.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Syntax
Private Sub object_MouseMove(Button As Integer, Shift As Integer, X As Single,
Y As Single)
The MouseMove event syntax has these parts:
MouseUp
Part
Description
object
An object expression that evaluates to an object in the Applies To list.
Button
An integer representing the button that was pressed (MouseDown) or released (MouseUp)
to cause the event. The possible values are:
0 = No buttons
4 = Middle
1 = Left
5 = Left and Middle
2 = Right
6 = Right and Middle
3 = Left and Right
7 = All buttons
Shift
An integer indicating whether any of the shift, ctrl, or alt keys were pressed when the mouse
button specified was pressed or released. The possible values are:
0 = No keys
4 = alt
1 = SHIFT
5 = shift and alt
2 = ctrl
6 = ctrl and alt
3 = shift and ctrl
7 = shift and ctrl and alt
X
A number that indicates the x-coordinate of the mouse pointer’s location. The coordinate
system is based upon the settings in the object’s ScaleHeight, ScaleWidth, ScaleLeft, and
ScaleProperties.
Y
A number that indicates the y-coordinate of the mouse pointer’s location. The coordinate
system is based upon the settings in the object’s ScaleHeight, ScaleWidth, ScaleLeft, and
ScaleProperties.
Applies To
ControlRecipeList Control, PromptsList Control, ProcedureView Control,
SignatureList Control
Description
Fires when a mouse button is released.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Syntax
Private Sub object_MouseUp(Button As Integer, Shift As Integer, X As Single, Y
As Single)
The MouseUp event syntax has these parts:
NewCurrentProcedure
Part
Description
object
An object expression that evaluates to an object in the Applies To list.
Button
An integer representing the button that was released to cause the event. The possible values
are:
1 = left mouse button
2 = right mouse button
4 = middle mouse button
Shift
An integer indicating whether any of the shift, ctrl, or alt keys were pressed when the mouse
button specified was pressed or released. The possible values are:
0 = No keys
4 = alt
1 = SHIFT
5 = shift and alt
2 = ctrl
6 = ctrl and alt
3 = shift and ctrl
7 = shift and ctrl and alt
X
A number that indicates the x-coordinate of the mouse pointer’s location. The coordinate
system is based upon the settings in the object’s ScaleHeight, ScaleWidth, ScaleLeft, and
ScaleProperties.
Y
A number that indicates the y-coordinate of the mouse pointer’s location. The coordinate
system is based upon the settings in the object’s ScaleHeight, ScaleWidth, ScaleLeft, and
ScaleProperties.
Applies To
ProcedureView Control
Description
Indicates that the control’s CurrentProcedureID property has changed.
Syntax
Private Sub object_NewCurrentProcedure([index As Integer])
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
The NewCurrentProcedure event syntax has these parts:
NewTopProcedure
Part
Description
object
An object expression that evaluates to an object in the Applies To list.
index
Integer that uniquely identifies the control instance if it is in a control array.
Applies To
ProcedureView Control
Description
Indicates that the control’s TopProcedureID property has changed.
Syntax
Private Sub object_NewTopProcedure([index As Integer])
The NewTopProcedure event syntax has these parts:
Part
Description
object
An object expression that evaluates to an object in the Applies To list.
index
Integer that uniquely identifies the control’s instance if it is in a control array.
Remarks
The Change event will fire every time a change to the TopProcedureID property
value occurs, whether it is set by the user or modified due to the effects of the
ActiveUnit feature.
OnIncompleteSignature
CountChange
Applies To
SignatureList Control
Description
Fires when the number of incomplete signatures in the FactoryTalk Batch Server
changes.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Syntax
Private Sub object_OnIncompleteSignatureCountChange[(count As Long])
The OnIncompleteSignatureCountChange event syntax has these parts:
Part
Description
Object
An object expression that evaluates to a SignatureList control.
Count
The new number of incomplete signatures in the FactoryTalk Batch Server.
Remarks
The value returned will be equal to the current value of the
IncompleteSignatureCount property.
OnSelChange
Applies To
ControlRecipeList Control, PromptsList Control, SignatureList Control
Description
Fires when the current selection in the list changes.
Syntax
Private Sub object_OnSelChange[(item As ControlRecipe)]
Private Sub object_OnSelChange[(item As Prompt)]
Private Sub object_OnSelChange[(item As Signature]
The OnSelChange event syntax has these parts:
Part
Description
object
An object expression that evaluates to an object in the Applies To list.
item
Returns a reference to the newly-selected item in the list.
Remarks
See the SelectedControlRecipe property for the ControlRecipe object
definition, the SelectedPrompt property for the Prompt object definition, and
the SelectedSignature property for the Signature object definition.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
OnSignatureUpdate
Applies To
SignatureList Control
Description
Fires when the data contained in the Signatures property changes.
Syntax
Private Sub object_OnSignatureUpdate
The OnSignatureUpdate event syntax has these parts:
Part
Description
object
An object expression that evaluates to a SignatureList control.
Remarks
Because this control uses OPC, this event does not necessarily fire every Interval
milliseconds. Rather, it only fires when data actually changes.
OnUpdate
Applies To
ControlRecipeList Control, PromptsList Control
Description
Fires when the new data has been retrieved from the FactoryTalk Batch Server.
Syntax
Private Sub object_OnUpdate
The OnUpdate event syntax has these parts:
Part
Description
object
An object expression that evaluates to an object in the Applies To list.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Remarks
Use this event procedure to tell the container what to do after each update interval
has elapsed.
The Interval property specifies the interval between OnUpdate events in
milliseconds.
SimpleOnSelChange
Applies To
ControlRecipeList Control, PromptsList Control, SignatureList Control
Description
Fires when the currently-selected control recipe in the list changes.
Syntax
Private Sub object_SimpleOnSelChange(ByVal ValueID As String)
The OnSelChange event syntax has these parts:
StepClick
Part
Description
object
An object expression that evaluates to an object in the Applies To list.
ValueID
A reference to the ID of the newly-selected control recipe or event.
Applies To
ProcedureView Control
Description
Indicates that a regular step in the currently depicted procedure has been clicked.
Syntax
Private Sub object_StepClick(ByVal stepID As String, cancel As Boolean)
The StepClick event syntax has these parts:
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Part
Description
object
An object expression that evaluates to an object in the Applies To list.
stepID
Procedure ID of the step that was clicked.
cancel
A Boolean expression that, when set to False within this event procedure, prevents the
control’s inherent response to this event from occurring.
Remarks
The control’s inherent response to this event is to change the currently selected
recipe element. Setting the cancel argument to False during this event procedure
will prevent a change of the currently selected recipe element.
StepDblClick
Applies To
ProcedureView Control
Description
Indicates that a regular step in the currently depicted procedure has been doubleclicked.
Syntax
Private Sub object_StepDblClick(ByVal stepID As String, cancel As Boolean)
The StepDblClick event syntax has these parts:
Part
Description
object
An object expression that evaluates to an object in the Applies To list.
stepID
Procedure ID of the step that was clicked.
cancel
A Boolean expression that, when set to False within this event procedure, prevents the
control’s inherent response to this event from occurring.
Remarks
The control’s inherent response to this event is to navigate down, depicting the
procedure of the regular step that was double-clicked. Setting the cancel argument
to False during this event procedure will prevent the navigation from occurring.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
TransitionClick
Applies To
ProcedureView Control
Description
Indicates that a transition in the currently depicted procedure has been clicked.
Syntax
Private Sub object_TransitionClick(ByVal condition As String, cancel As Boolean)
The TransitionClick event syntax has these parts:
Part
Description
object
An object expression that evaluates to an object in the Applies To list.
condition
Condition of the transition that was clicked.
cancel
A Boolean expression that, when set to False within this event procedure, prevents the
control’s inherent response to this event from occurring.
Remarks
The control’s inherent response to this event is to make the transition that was
clicked the currently selected recipe element. Setting the cancel argument to False
during this event procedure will prevent the currently selected recipe element
from changing.
TransitionDblClick
Applies To
ProcedureView Control
Description
Indicates that a transition in the currently depicted procedure has been doubleclicked.
Syntax
Private Sub object_TransitionDblClick(ByVal evaluation As String, cancel As
Boolean)
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
The TransitionDblClick event syntax has these parts:
Part
Description
object
An object expression that evaluates to an object in the Applies To list.
evaluation
Condition evaluation of the transition that was double-clicked.
cancel
A Boolean expression that, when set to False within this event procedure, prevents the
control’s inherent response to this event from occurring.
Remarks
The control’s inherent response to this event is to display the condition’s
evaluation of the transition that was double-clicked. Setting the cancel argument to
False during this event procedure will prevent the transition condition evaluation
from being displayed.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Chapter 5
Enumerations
This section lists all of the enumerations that may be used with the controls in this
library. These enumerations are also listed and described in the property
documentation and methods to which they apply.
ControlRecipeList
Command Enumerations
ControlRecipeMode
Enumerations
EquipmentTypes
Enumerations
Value
Enumeration
1
crCommandAbort
4
crCommandCreateControlRecipe
8
crCommandClearFailures
11
crCommandHold
14
crCommandPause
17
crCommandRemove
21
crCommandRestart
22
crCommandResume
24
crCommandStart
26
crCommandStop
28
crCommandComment
Value
Enumeration
12
crModeManual
5
crModeAuto
27
crModeSemiAuto
Value
Enumeration
0
crlEquipTypeNull
1
crlEquipTypeProcessCell
2
crlEquipTypeUnit
3
crlEquipTypePhase
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
ParamDataType
Enumerations
ParamResponseType
Enumerations
Value
Enumeration
0
bcDataTypeUnknown
1
bcDataTypeReal
2
bcDataTypeInteger
3
bcDataTypeString
5
bcDataTypeEnum
Value
Enumeration
1
bcResponseTypeUnknown
2
bcResponseTypeValue
3
bcResponseTypeUnackPrompt
4
bcResponseTypeDeferred
Value
Enumeration
0
pvwBorderStyleNone
1
pvwBorderStyleFixedSingle
Value
Enumeration
1
pvwCommandAbort
4
pvwCommandCreateControlRecipe
5
pvwCommandAuto
6
pvwCommandBind
8
pvwCommandClearFailures
9
pvwCommandNewParameters
11
pvwCommandHold
12
pvwCommandManual
13
pvwCommandParameterChange
14
pvwCommandPause
20
pvwCommandReset
21
pvwCommandRestart
22
pvwCommandResume
24
pvwCommandStart
26
pvwCommandStop
27
pvwCommandSemiAuto
ProcedureView BorderStyle
Enumerations
ProcedureView Command
Enumerations
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
ProcedureView Parallelism
Enumerations
ProcedureView States
Enumerations
ProcedureView View
Enumerations
Value
Enumeration
28
pvwCommandComment
30
pvwCommandDisconnect
Value
Enumeration
0
pvwParallelismNone
1
pvwParallelismSimple
2
pvwParallelismUnknown
Value
Enumeration
0
pvwStateUnknown
10
pvwStateAborting
20
pvwStateHolding
30
pvwStateStopping
40
pvwStateRestarting
50
pvwStateRunning
54
pvwStateReporting
60
pvwStateHeld
70
pvwStateComplete
80
pvwStateStopped
90
pvwStateAborted
100
pvwStateIdle
110
pvwStateReady
120
pvwStateStarting
130
pvwStateArmed
140
pvwStateArming
150
pvwStateFiring
160
pvwStateConnecting
170
pvwStateDownloading
180
pvwStateUploading
190
pvwStateUploadHeld
Value
Enumeration
0
pvwViewSFC
1
pvwViewTable
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
SignatureList
CommentControls
Enumerations
Value
Enumeration
0
sigOptional
1
sigRequired
2
sigNotAllowed
SignatureList
DeviationTypes
Enumerations
Value
Enumeration
0
sigNormal
11
sigLow
12
sigLowLow
13
sigLowLowLow
21
sigHigh
22
sigHighHigh
23
sigHighHighHigh
Value
Enumeration
1
sigSignatureIncomplete
2
sigSignatureComplete
3
sigSignatureCancelled
4
sigSignatureSystemCancelled
Value
Enumeration
1
sigCommand
2
sigGeneralUsage
3
sigParameterDeviation
4
sigParameterAck
5
sigReportDeviation
6
sigUnitBind
7
sigUnitBindAck
8
sigPhaseBind
9
sigPhaseBindAck
10
sigRemoveBatch
11
sigActiveStepChange
12
sigAddEvent
13
sigSetParameter
14
sigSetAllLabel
15
sigSetAllLot
SignatureList
SignatureStates
Enumerations
SignatureList
SignatureTypes
Enumerations
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
SignatureList SignoffStates
Enumerations
Value
Enumeration
1
sigSignoffIncomplete
2
sigSignoffComplete
3
sigSignoffCancelled
4
sigSignoffSystemCancelled
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Appendix A
Creating an ActiveX control application
This section contains an example application illustrating the versatility and
functionality of the FactoryTalk Batch ActiveX Controls Library. The example
provides a brief overview of the process used to create an application using the
FactoryTalk Batch ActiveX Controls Library. Only selected examples of code are
provided.
ActiveX controls can be used to:
ActiveX controls example
interface
•
Create a custom interface
•
Filter sensitive information to the operator
•
Send data to the FactoryTalk Batch Server
•
Receive data from the FactoryTalk Batch Server
The FactoryTalk Batch ActiveX Controls example incorporates the
ControlRecipeList control, the PromptsList control, the ProcedureView
control, SignatureList control, and the TimerView control into a single
application. Together, these four controls contain much of the FactoryTalk Batch
View functionality, allowing a user to command batches, acknowledge prompts,
acknowledge signatures, perform manual binding, perform an active step change,
and view a running control recipe.
The four ActiveX controls are separated using a Tabstrip control. Each ActiveX
control can be viewed separately by selecting the tab that corresponds to that
control. At the top of the ActiveX control example application is a toolbar that
allows you to interact with the FactoryTalk Batch Server by clicking buttons to
create and control batches as also done in the FactoryTalk Batch View.
Additionally, a menu has been incorporated into the application, allowing you to
issue commands without the using a mouse.
ControlRecipeList control
The ControlRecipeList control provides a window that displays a control recipe
list that has been added to the batch list. Control recipes remain in the
ControlRecipeList window until removed by the operator or until the
FactoryTalk Batch Server is re-started with a cold boot. The ControlRecipeList
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
includes a horizontal scroll bar that is used to access batch data extending beyond
the viewable width of the control.
PromptsList Control
The PromptsList control provides a window that displays a list of
unacknowledged prompts requiring operator attention. Unacknowledged
prompts remain within the control’s window until they are acknowledged. The
PromptsList control includes a horizontal scroll bar that is used to access prompt
data extending beyond the viewable width of the control.
ProcedureView Control
The ProcedureView control provides a graphical representation of a control
recipe that has been placed on the batch list. Control recipes are viewed in table
format or as a sequential function chart (SFC). All recipe procedural levels are
navigated using the ProcedureView control. In addition to viewing a current
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
control recipe, the control also allows operators to command batches, perform
manual binding, perform active step changes and change recipe step parameter
values.
SignatureList Control
The SignatureList Control provides a graphical representation of signatures that
have been generated against a batch. Signatures remain on the Signature List until
the associated batch is removed from the batch list. Selecting a signature from the
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
list will invoke the associated Signature dialog box used to complete the signoff
requirements and record the signature electronically.
TimerView Control
The TimerView control provides an interface to view all the Timer steps in
batches currently on the batch list. You can configure filter criteria for the
TimerView control. You can also configure the behavior of the TimerView
control through the control’s property pages during design time. During run time
you will have the ability to change the setpoint value for COUNT_DOWN
timers. If enabled, you can also change the filtering of the TimerView ActiveX
control.
Configuring TimerView properties
The Property Pages dialog box of the TimerView ActiveX control allows you to
view properties associated with the different levels of the control recipe. The
dialog box contains three tabs: Parameter, Report and Recipe.
The Property Pages dialog box is accessed by right-clicking on the ActiveX
control in the design environment. The Property Pages dialog box has five tabs
for use in configuring the ActiveX control: Appearance, Behavior,
Communication, Color, and Font.
The manual actions described below in the following sections are also available
programmatically through properties, methods, and events on the control.
Viewing the Appearance tab
The Appearance tab displays a text box that allows the user to either enter a string
of text to filter the displayed Timer steps, or the user can open the Timer Step
Filters dialog box by clicking the browse button next to the Filter Pattern text
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
box, which allows the user to set the filter using the user interface rather than
having to type in the filter manually. (See "Using Filters" in the Batch ActiveX
Controls User’s Guide for more information.)
The user can choose whether to apply the filter to the area model unit name, the
Batch ID, or batch list item’s recipe path. This value must be set to one or the
other and the pattern must be valid for the type chosen.
There are nine check boxes displayed below the Filter Pattern:
•
Show Type
•
Show Unit
•
Show Elapsed Time
•
Show Setpoint
•
Show Remaining Time (count_down only)
•
Enable Filter Menu
•
Show Units of TIme
•
Enable Filter Status Bar
•
Show State
The check boxes control what information is displayed for Timer steps in the
TimerView ActiveX control. By default the Show Type, Show Elapsed Time,
Show Remaining Time, Show Setpoint, Show Units of Time, Show State, and
Show Unit check boxes are selected. The user can select and deselect the check
box to change what information for a Timer step is displayed in the ActiveX
control.
If the Enable Filter Menu check box is selected then the control displays, during
run time, a pop-up menu with the Filter option enabled. The Filter option opens
the Filters dialog box. If the Enable Filter Menu check box is not selected then
the Filter pop-up menu item will be disabled on the ActiveX control. (See "Using
Filters" in the ActiveX Controls User’s Guide for more information.)
If the Enable Filter Status Bar check box is selected, the user can double-click in
the status bar during run time to open the Timer Step Filter dialog box. (See
"Using Filters" in the ActiveX Controls User’s Guide for more information.)
Viewing the Behavior tab
The Behavior tab allow the user to configure certain run-time elements of the
ActiveX control.
Selecting the AutoSizeColumns check box will cause the size of the columns to
auto adjust to fit the largest text in the column including the header text. Upon
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
each refresh of the control the size of the columns will adjust accordingly. The first
time the control is executed the columns will auto-adjust as part of the
initialization sequence.
Viewing the Communication tab
The Communication tab of the Property Pages dialog box allows the user to
configure communication to the FactoryTalk Batch Server. The Node box allows
the user to enter the computer name of the computer on which the Batch Server is
residing. If the Node box is blank, the TimerView ActiveX control will attempt to
connect to the server specified in the Net registry key, and if the registry key does
not exist then the ActiveX control will assume the Batch Server is local and will
attempt to connect to the local machine.
The user can also configure the Call Timeout, Connect Timeout, Timeout Period,
and Retry Period for the connection the ActiveX control makes to the Batch
Server. Use the sliders to set the value for each configurable item. The value of the
slider is displayed in a text box (view-only).
Viewing the Color and Font tabs
The Color tab of the Properties Pages dialog box allows the user to configure the
different colors associated with the ActiveX control. Currently, the only color
option is BackColor, which controls the empty space (background) of the Timer
step grid control.
The Font tab of the Properties Pages dialog box of the TimerView ActiveX
control allows the user to configure the font for the text used in the control. At
this time the only font option is TextFont, which controls font for the entire
Timer grid contents.
Using Properties, Methods
and Events
This ActiveX control example consists of a Visual Basic form and an assortment of
controls placed on the form. In addition to the visible controls (command
buttons, labels, etc.), there are also required controls not visible on the form
(timers, imagelists, etc.), as well as the ControlRecipeList, PromptsList,
ProcedureView, SignatureList and TimerView controls supplied with the
ActiveX Controls Library.
This section illustrates some of the Visual Basic code used to create the
FactoryTalk Batch ActiveX controls example, specifically the use of the controls’
properties and methods.
Tip:
In order to use the controls provided by the FactoryTalk Batch ActiveX Controls Library, the BatchView,
ProcedureView, SignatureList, and TimerView ActiveX Control Library components must be added to the
Visual Basic project.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
ControlRecipeList
This FactoryTalk Batch ActiveX Controls example centers on the functionality of
the ControlRecipeList ActiveX control. The ControlRecipeList operates
similarly to the Batch List window of the FactoryTalk Batch View, displaying
control recipes and recipe header data. The ControlRecipeList is also used as a
visual means of selecting batches. There is no additional code required to use the
ControlRecipeList as implemented in this example. (Refer to the ActiveX Controls
Library User’s Guide for information on using the ControlRecipeList control.)
PromptsList
The PromptsList ActiveX control is used by the ActiveX controls example to
determine the presence of unacknowledged prompts. The status of the
PromptsList is monitored by a Timer control that flashes the Unacknowledged
Prompts icon if prompts are present in the PromptsList. Where prlPrompts is the
name given to the instance of the PromptsList control in the example, the
following code is placed in the OnUpdate event for the PromptsList:
Private Sub prlPrompts_OnUpdate()
If prlPrompts.Prompts.Count > 0 Then
tmrFlash.Enabled = True
Else
tmrFlash.Enabled = False
End If
End Sub
The OnUpdate event fires every time new data is sent to or returned from the
FactoryTalk Batch Server. The timer (tmrFlash) that contains the code used to
flash the icon is enabled whenever one or more prompts are present in the
PromptsList control. When there are no longer prompts in the PromptsList, the
timer is disabled and the icon ceases to flash.
ProcedureView
In order for the ProcedureView control to display a table or SFC for a control
recipe, it must be provided with the ID of the topmost procedure to display. This
can be done by setting the TopProcedureID property of the ProcedureView
control to the control recipe’s CreateID property that has been selected in the
ControlRecipeList control.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Where pvwProcedureView is the name given to the instance of the ProcedureView
control in the example and crlRecipes is the name given to the ControlRecipeList
control, the following code is placed in the SimpleOnSelChange event for the
ControlRecipeList.
Private Sub crl_OnSelChange(ByVal SelectedControlRecipe As
batchview.ControlRecipe)
If crl.ControlRecipes.Count > 0 Then
SFC.TopProcedureID =
crl.SelectedControlRecipe.CreateID
ElseIf crl.ControlRecipes.Count = 0 Then
SFC.TopProcedureID = 0
End If
End Sub
Placing this code in the SimpleOnSelChange event procedure of the
ControlRecipeList, will cause the ProcedureView control to be updated with a
new top level procedure whenever a control recipe is selected in the
ControlRecipeList control. The different procedure levels can then be navigated
using the ProcedureView control. (Refer to the ActiveX Controls User’s Guide for
information on using the ProcedureView control.)
SignatureList
The SignatureList ActiveX control is used by the ActiveX Controls example to
display signatures associated with a batch. The SignatureList operates similarly to
the FactoryTalk Batch View’s Signature List window, displaying signatures and
signature header data. The SignatureList is also used as a visual means of selecting
signatures. There is no additional code required to use the SignatureList as
implemented in this example. (Refer to the ActiveX Controls Library User’s Guide
for information on using the SignatureList control.)
Toolbar Command Buttons
The code required to create buttons to command a batch generally requires only a
few lines. An example of this is the code required for the Add Batch toolbar
button.
Where crlRecipes is the name given to the instance of the ControlRecipeList
control in this example and ADD_BATCH is a constant declaration evaluating to
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
the key value of the Add Batch toolbar button, the following code is placed in the
ButtonClick event procedure of the Toolbar control:
Select Case Button.Key
Case Is = "ADD_BATCH"
If crlRecipes.CanCreateControlRecipe Then
crlRecipes.CreateControlRecipe
End If
...
End Select
•
The CanCreateControlRecipe method verifies that a batch can be created.
•
The CreateControlRecipe method displays the Master Recipe List dialog
box, allowing the operator to choose a master recipe and proceed to the
Create Control Recipe Wizard.
The code behind the Remove Batch button is similar to the Add Batch button
code in structure. However, because removing a batch is specific to a single batch,
the method requires an additional statement used to determine whether or not
there are any batches within the ControlRecipeList. If the
RemoveControlRecipe method is executed and unable to locate a batch, an error
will occur. Determining if there are batches that can be removed before activating
the RemoveControlRecipe method ensures that no errors will occur.
Where crlRecipes is the name given to the instance of the ControlRecipeList
control in this example and REMOVE_BATCH is a constant declaration
evaluating to the key value of the Remove Batch toolbar button, the following code
is placed in the ButtonClick event procedure of the Toolbar control:
Select Case Button.Key
Case Is = "REMOVE_BATCH"
If crlRecipes.ControlRecipes.Count > 0 Then
If crlRecipes.SelectedControlRecipe.CommandMask. _
IsRemoveValid = True Then
crlRecipes.RemoveControlRecipe _
(crlRecipes.SelectedControlRecipe.CreateID)
End If
End If
...
End Select
•
The SelectedControlRecipe.CommandMask property is used to
determine if the selected batch can be removed from the list.
•
The RemoveControlRecipe method removes the selected batch.
Tip:
The RemoveControlRecipe method also requires a batch’s CreateID (the unique identification number
assigned to a batch by the FactoryTalk Batch Server). In this example, the
SelectedControlRecipe.CreateID property passes the selected batch’s CreateID to the
RemoveControlRecipe method.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
State commands can be issued to control recipes in both the ControlRecipeList
and the ProcedureView. However, because state commands are relative to the
control recipe at the procedural level when issued from the ControlRecipeList
control and relative to the selected recipe step when issued from the
ProcedureView control, state commands are handled differently when issued to
the two different controls.
The following illustrates the syntax for issuing a Start command in both the
ControlRecipeList control and the ProcedureView control.
Start Command from the ControlRecipeList Control
Where crlRecipes is the name given to the ControlRecipeList control instance in
this example and START is a constant declaration evaluating to the key value of
the Start Batch toolbar button, the following code is placed in the ButtonClick
event procedure of the Toolbar control:
Select Case Button.Key
Case Is = "START"
If crlRecipes.SelectedControlRecipe.CommandMask. _
IsStartValid = True Then
crlRecipes.StartControlRecipe (intCreateID)
End If
...
End Select
Start Command from the ProcedureView Control
Where pvwProcedureView is the name given to the ProcedureView control
instance in this example and START is a constant declaration evaluating to the
key value of the Start Batch toolbar button, the following code is placed in the
ButtonClick event procedure of the Toolbar control:
Select Case Button.Key
Case Is = "START"
If pvwProcedureView.CanStart = True Then
pvwProcedureView.CommandCurrentStep (pvwCommandStart)
End If
...
End Select
Toolbar Mode Buttons
Another group of toolbar buttons that follow this pattern are the Mode buttons.
When responding to a click of the Manual toolbar button, it must first be
determined if there are any batches in the ControlRecipeList. Then you must
determine if the mode change is valid for the selected batch, and if so, change the
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
mode. In this example, the following code is placed in the ButtonClick event
procedure for the Toolbar control.
Where crlRecipes is the name given to the ControlRecipeList control instance in
this example and MANUAL is a constant declaration evaluating to the key value
of the Remove Batch toolbar button, the following code is placed in the
ButtonClick event procedure of the Toolbar control:
Select Case Button.Key
Case Is = "MANUAL"
If crlRecipes.ControlRecipes.Count > 0 Then
Dim RecipeID
RecipeID = crlRecipes.SelectedControlRecipe.CreateID
If crlRecipes.SelectedControlRecipe.CommandMask. _
IsManualValid = True Then
crlRecipes.SetControlRecipeMode(RecipeID),crModeManual
End If
End If
...
End Select
•
SelectedControlRecipe.CommandMask is used to determine if the
change to MANUAL mode is valid.
•
The SetControlRecipeMode method is used to change the selected batch’s
mode to MANUAL.
•
The SetControlRecipeMode method must be passed to the CreateID of
the batch (represented by the variable RecipeID) and the mode to which the
batch is being changed (the constant expression crModeManual).
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Appendix B
Default Column Labels
The following tables provide the column numbers and default labels for the
ControlRecipeList, PromptsList, ProcedureView, SignatureList, and
TimerViewList controls.
ControlRecipeList
PromptsList
Column #
Default Label
1
Batch ID
2
Recipe
3
Description
4
Start Time
5
Elapsed Time
6
State
7
Mode
8
Failure
9
Override
10
Process Cell
11
Units In Use
12
Phases In Use
13
Create ID
Column #
Default Label
1
Time
2
Batch ID
3
Source Step
4
Description
5
Type
6
Default
7
EU
8
Area
9
Process Cell
10
Unit
11
Phase
12
Prompt ID
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
ProcedureView
SignatureList
TimerViewList
Column #
Default Label
0
no label used
The row number is displayed in this column.
1
no label used
The recipe structure icon is displayed in this column.
2
no label used
A status icon for the step is displayed in this column.
3
Name
4
State
5
Mode
6
Failure
7
Unit
8
Owner
9
Step Index
10
Message
11
Request
12
Parameter 1
Additional Parameter columns can be displayed by setting the DisplayedParameters property. The
default label for each additional Parameter column is Parameter #.
Column #
Default Label
1
Time
2
Batch ID
3
Procedure ID
4
Type
5
State
6
Signoff Meaning
7
Signoff Security
8
Signature Context
9
Action ID
Column #
Default Label
1
Step Name
2
Type
3
Elapsed Time
4
Remaining Time
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Column #
Default Label
5
Setpoint
6
Units of Time
7
State
8
Unit
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
INTEGRATED PRODUCTION & PERFORMANCE SUITE
Production Management
Batch
PC-BASED PHASE PROGRAMMER'S TECHNICAL REFERENCE
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Chapter 1
Introducing PC-based phases
This guide was developed to provide information and procedures required to
create and use PC-based phases, and is intended to be used as a reference guide.
Important:
Document organization
DDE server is no longer supported. If you are upgrading from RSBatch 4.X or an earlier version, you
will need to set all tags to use an OPC server. Also, due to a functional address change in batchphs.ocx,
the tag separator has changed from an underscore (_) to a period (.). You can quickly change the
Equipment Editor tag separator to a period by editing the batcheqp.ini file to change the default
separator. (See “Set tag items to default name (on 326.)”)
This guide provides information about designing phases for use in FactoryTalkВ®
Batch recipes. The following subjects are presented:
1. Creating a PC-based phase (see “Creating a PC-based phase (on page
315)”).
2. Using a PC-based phase (see “Using a PC-based phase (on page 323)”).
3. Descriptions of the Properties, methods, and events (see “Properties,
methods, and events (on page 329)”).
4. Application notes and example phase (see “Application notes and example
phase (on page 337)”).
5. Adding a general usage signature request to a PC-Base Phase (see “Adding a
general usage Signature Request (on page 321)”).
6. Using parameter and report parameter limits (see “Using parameter and
report parameter limits (on page 321)”).
PC-based phase overview
The PC-Based Phase option is an ActiveX control that allows you to design
phases for use in FactoryTalk Batch recipes. These phases are used for a variety of
tasks, such as operator prompts, timers and calculations. A PC-based phase
communicates with the FactoryTalk Batch Server, and does not require a processconnected device. It can be used in place of phase logic, allowing you to decrease
the amount of memory required within your process-connected device.
PC-based phases use the Batch Phase Execution Control, which encapsulates the
FactoryTalk Batch phase logic interface and the OPC interface. The Phase
Execution Control functions as a data server for PC-based phases and supports the
full functionality of a FactoryTalk Batch phase. It is an SP88-aware component
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
and is used to provide Level 2 control of the Batch Control system. The Phase
Execution Control is a persistent component that supports automatic
checkpointing. It can be accessed directly from within Visual Basic, Microsoft
Access, or any other Microsoft-compatible control container.
Tip:
PC-based phases
The Phase control is part of a group of FactoryTalk Batch ActiveX controls that are found in the BATCHPHS.OCX
file. When distributing your application, you may install the BATCHPHS.OCX file in any directory, as long as the
control is properly registered. (See the Microsoft Visual Basic Programmer’s Guide for more information on how to
add an ActiveX control to a Visual Basic project.)
A PC-based phase allows you to program a phase outside of a process-connected
device. You can program the phase to meet your own unique requirements from
within your Microsoft-compatible control container. The PC-based phase works
the same way as any phase defined in a process-connected device, communicating
with the FactoryTalk Batch Server through the Phase Execution Control. This
saves your system’s memory for processes requiring interaction with hardware.
After a PC-based phase is created, the FactoryTalk Batch area model must be
updated to include the new phase and the appropriate equipment module(s).
Because the Phase Execution Control behaves as a data server, a new data server
definition must be created. The data server definition is created using the
Equipment Editor, and defined using the Phase Execution Control’s
communication parameters. The phase can then be added to your recipes. The
PC-based phase must remain active during recipe execution, allowing the phase to
communicate with the FactoryTalk Batch Server through the Phase Execution
Control.
An activity log file is created for each PC-based phase when it runs. This log file,
Singleton.log, is written to the WINDOWS\system32 directory.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Execution of a PC-based phase
The following is an example of a PC-based phase executing within a recipe. The
PC-based phase is created to prompt the operator to take a sample to Quality
Control and then enter the results. The phase communicates with the
FactoryTalk Batch Server by way of the Phase Execution Control. The phase can
direct the Server to prompt the operator, wait for results and have the Server store
the result in the electronic batch record. The recipe only proceeds if the result is
within the appropriate range.
1. As the batch is processed, the QC_Chk phase is executed.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
2. The QC_Chk phase displays a screen to the operator, requesting that the
operator have QC take an in-process sample. The QC_Chk phase will not
continue processing until the operator enters the QC result.
3. When the operator enters the result, the QC_Chk phase sends the report
value to the FactoryTalk Batch Server, by way of the Phase Execution
Control, which in turn stores the value in the electronic batch record.
While the phase is executing, an activity log file is updated with process
events.
4. Control is returned to the recipe; it continues processing the balance of the
transitions and steps.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Chapter 2
Creating a PC-based phase
A PC-based phase is created using the Phase Execution Control and an OLE
container application. The control is added to the container application, placed in
the appropriate medium (form, spreadsheet, document, etc.), and its properties,
methods, and events defined.
The instructions included in this section relate to creating a PC-based phase
within Visual Basic. If you choose to implement a PC-based phase in an
application other than Visual Basic, click More Controls on the Control Toolbox
to retrieve the Phase Execution Control.
Adding the phase execution
control to a Visual
Basic project
The Phase Execution Control must be added to the Visual Basic toolbox in order
to make it available to your project. The instructions included here define the
steps for manually adding the control to the toolbox after starting a new project.
However, if you choose, you may configure the control to load automatically.
1. Start Visual Basic.
2. From the Projects menu, select Components. The Components dialog box
opens.
3. Select the Controls tab. The available Custom Controls are displayed in a
list.
4. Scrolling through the list, locate and select the Phase Execution Control.
5. Click OK to close the dialog box. The Phase Execution Control is available
on the Visual Basic toolbox. It is marked with a picture of a valve.
Placing the phase execution control on a form
1. Select the Phase Execution Control in the Visual Basic toolbox.
2. Position the cursor on the form where you want the control.
3. Click and drag to draw the outline of the control on the form.
4. When you release the button, the new Phase Execution Control is placed at
the location specified. The PC-based phase can now be programmed.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Setting the PC-based phase properties
In order to enable communication between a PC-based phase and the FactoryTalk
Batch Server, properties can be modified in two ways. With the phase selected, you
can use the Properties window to locate and set the appropriate properties, or you
can use the custom Property Pages dialog box. All properties specific to the Phase
Execution Control that can be configured at design time are included in this
dialog box.
Custom properties
Right-click the Phase Execution Control and select Properties. The Property
Pages dialog box opens with the Configuration tab selected. This dialog box
displays all custom properties that must be set for the control.
Select the Operation tab; the following configuration information is available:
If you attempt to configure a property at design time with an invalid entry you are
notified of the error by a message box, which includes a range of valid entries. If
you attempt to configure a property at design time that does not support
configuration at design time, a message box opens. If you attempt to configure a
property at run time that does not support modification at run time, an entry is
written to the activity log file.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Programming the PC-based phase
The PC-based phase requires specific methods and events in order to function
properly. These methods and events are predefined in the Phase Execution
Control, and must be programmed for the specific PC-based phase being created.
The following describes each of the required methods, along with example code
for the OnRestart event. (Refer to "Properties, methods, and events (on page 329)”
for additional methods.)
Methods
Programming the initialize method
You must invoke the Initialize method in order to create OPC tags and establish
the PLI’s scan interval. This is done by calling the Initialize method, and is usually
performed in the Form_Load() event. The following is an example of calling the
Initialize method:
Private Sub Form_Load()
Charge.Initialize �Initialize the control
End Sub
Programming the terminatestate method
The TerminateState method is used to terminate the active state. You must call
this method if you wish the phase to complete its current state. The five active
states are RUNNING, HOLDING, STOPPING, RESTARTING, and
ABORTING. For example, calling TerminateState while RUNNING will
transition the phase to COMPLETE. The following is an example of calling the
TerminateState method: Const UploadAllReports = 2000
Select Case Agitate.StepIndex
Case 4:
� ensure that previous request is complete
If Agitate.Request = 0 Then
Agitate.Report(1) = txtAgitateElaspedTime.Text
If Not Agitate.Owner Then
� upload all report parameters
Agitate.Request = UploadAllReports
End If
Agitate.StepIndex = 5
End If
Exit Sub
Case 5:
� ensure that report upload is complete
If Agitate.Request = 0 Then
Agitate.TerminateState �Terminates the active state
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
End If
Exit Sub
End Select
Events
The phase programmer must follow certain conventions when using Visual Basic
and the Phase Execution Control:
•
NEVER use modal dialog boxes or other user interface that causes the
program logic to wait at some point. This may prevent the PLI from
responding to state changes.
•
NEVER use "looping" logic that waits at some point. This may prevent
the PLI from responding to state changes. The PLI will run every X
milliseconds as specified by the Interval property. Use "Select Case" or
"If Then Else" logic combined with changes to the step index property,
to advance from section to section within your code.
•
The phase programmer is responsible for transitioning the phase from
an active state (RUNNING, STOPPING, etc.) to a finished state
(COMPLETE, STOPPED, etc.) using the TerminateState method.
Programming the OnRestart event
The PLI uses the StepIndexBuffer property to store the Step Index when the
phase is HELD. The Step Index is then restored (by the TerminateState method)
when the phase transitions from RESTARTING to RUNNING. Typically, the
StepIndexBuffer would be checked to determine where the phase was HELD.
The RESTART logic would then determine if it’s safe for the phase to RESTART
at that step, or if it should RESTART at an earlier step. The OnRUN event logic
should account for all possible restart conditions.
An example of the conventions that should be used to program the events follows:
Private Sub Agitate_OnRestart
� Restart the phase at the beginning if it was HELD at
� step #2. Otherwise, it’s OK to restart where we left off.
5. If Agitate.StepIndexBuffer = 2 Then
Agitate.StepIndexBuffer = 1
6. End If
7. Agitate.TerminateState
� transition to RUNNING
End Sub
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Creating the executable
When you have defined the Phase Execution Control’s properties, methods, and
events, you must create the executable that runs during recipe execution. (Refer to
the Microsoft Visual Basic documentation for specific instructions on creating the
executable file.)
Adding the phase execution
control to a Visual C++
project
We suggest that you contact Rockwell Product Support to determine which
version of the Microsoft Foundation Classes (MFC) are currently used by the
FactoryTalk Batch Control product. Any phases written with Visual C++ should
use the same version.
Creating a new project
1. Start the MFC AppWizard executable.
2. Select the Dialog Based option.
3. Make sure support for ActiveX Controls is selected.
4. Use MFC as a shared DLL.
Adding the control to the project
1. From the Project menu, select Add to Project.
2. Select the Components and Controls option.
3. Open the Registered ActiveX Controls folder.
4. Select the Phase Execution Control.
Adding the control to the dialog
1. Open the Project Dialog (not the About box, if there is one).
2. Add the Phase Execution Control to the dialog from the Control toolbar.
Tip:
ADD ONE INSTANCE OF THE CONTROL FOR EACH PHASE! The resource ID assigned here will be used to create
event handlers (the framework for phase logic) and will be associated with a member variable that will
allow access to the phase’s properties from within source code.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Accessing control properties from Visual C++
1. Right-click the Phase Execution Control’s icon.
2. The properties that require configuration at design time are found under
the Operation and Configuration tabs. You can view all properties by
using the All tab.
Configuring the BaseTagName property
Visual C++ does not allow you to configure the Name property of the control.
You must perform the following two steps to allow the phase to function properly.
Tip:
Even though DDE server is no longer supported, the use of DDE in a property name has no significance and is
not associated with the server.
1. Set the UseDefaultDDETagName property to FALSE.
2. Set the DDEBaseTagName property to the name of the phase. This will
become the base for all OPC tag names (example: BASENAME_ST for
phase state).
Adding control events
Use the resource ID of the phase for each event.
1. Right-click the Phase Execution Control’s icon.
2. Select the event.
3. Double-click the event.
4. Edit the member function name as desired and click OK.
Adding a member variable derived from the Phase Control Class
Using the Class Wizard, add a member variable to the project’s dialog class for
each phase (each instance of the control).
Tip:
The category is Control, and the variable type is the Phase Control Class. Use the appropriate resource
ID as assigned to the instance of the control in the dialog.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Adding phase logic to event handlers
Reference the Phase Execution Control’s properties and methods using the
member variable names.
A Phase Logic Request can be used to generate a Signature Request for a PC-based
phase. (For more information on configuring a General Signature Request see the
FactoryTalk Batch PCD Programmer’s Technical Reference.)
Adding a general usage
Signature Request
Before you can successfully use the General Signature Request, Electronic
Signatures must be configured in the area model. Signature Templates define the
Signature Signoff information required to complete a Signature Request generated
against a phase. Each Signature can require up to three Signoffs which consist of
security permissions and optional comments. (See the FactoryTalk Batch
Equipment Editor User’s Guide for information on configuring Signature
Templates.)
Using parameter and report
parameter limits
The Phase Execution Control can be configured to obtain the Parameter and
Report Parameter Limits defined on a PC-based phase in the area model. (See
“Using limit tags on a PC-based phase (on page 344)”).
The PC-based phase, like any other phase, can be assigned a Verification Method
and associated with Verification Policies in the Area Model. Adding additional
phase parameter tags and code to the Phase Execution Control application allows
the parameter values to be downloaded to the user for use in the control. Assigning
Verification Policies to a PC-based phase can generate Signature Requests when
Parameter or Report Parameter Limit values are too high or too low. (See the
FactoryTalk Batch Equipment Editor User’s Guide for information on Verification
Methods and Command Verification Policies.)
If a PC-based phase has Tag Locking enabled, and Limit Tags enabled on the
Equipment Module, additional Limit Tags are created. For example, if the phase
parameter has a Verification Method equal to High/Low, three additional tags are
created for the Equipment Module as shown here:
Tip:
•
Phasename.P01M - tag for the Verification Method
•
Phasename.P01H - tag for the High Limit
•
Phasename.P01L - tag for the Low Limit
Parameter Limit Tags and Report Limit Tags are created with a tag delimiter which must be removed
when used with a PC-Based Phase. (See Set tag items to default name" on page 326)”).
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Distributing PC-based
phase applications
Please read the license agreement that was shipped with this software. You are
bound by the licensing restrictions contained in the agreement. You can use all of
the files accompanying this product for development use. You can redistribute the
runtime version of the software in accordance with the terms of the license
agreement.
Tip:
The FactoryTalk Batch Server is required for the phase execution control to function and must be
installed on the remote computer.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Chapter 3
Using a PC-based phase
After creating the PC-based phase executable, you must perform the following
tasks:
•
Update the area model in the FactoryTalk Batch Equipment Editor
•
Add the phase to your recipes using the FactoryTalk Batch Recipe
Editor
The following table indicates the relationship between the PC-based phase’s
properties and the area model. You must adhere to the rules shown here to allow
for proper communication.
The OPC’s Watchdog Item Access Path
=
PC-based phase’s OPC Access Path for Tags, as defined in Visual Basic, or other
container, or the Topic property (changing one also changes the other)
PC-based phase’s Name property, as defined in
Visual Basic, or other container
=
Equipment Module’s Tag name, as defined in the Equipment Editor
Updating the area model
You must add a new data server definition to your area model, as well as add the
new phase and associated equipment module.
1. Open the area model in which the new phase will be utilized.
2. From the Edit menu, select Data Server, or click the Edit Data Servers
toolbar button. The Data Servers dialog box opens.
3. Click Add. The Add Data Server dialog box opens.
4. Enter the new data server definition name in the Name box.
5. From the Type list, select PC Phase OPC.
The default values for the data server type are displayed. The Watchdog
Item Name must be WATCHDOG. Any string may be used for the
Watchdog Item Access Path, but the same string must be used in the PCbased phase’s Topic property.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
6. Enter the following information for the new data server definition and then
click OK to return to the Data Servers dialog box:
Watchdog Item Access Path:
Phase (user-definable)
Watchdog Item Name:
watchdog
7. Create a phase to be used as the PC-based phase. Assign the required
number of parameter, report, and request tags. Generally, these would be
equal to the number assigned to the PC-based phase’s properties.
8. Create an instance of this phase in the appropriate unit(s). Be sure to use
the same name for the equipment module as the Name property defined for
the PC-based phase.
9. Assign the new data server definition to each of the tags in the newly
defined equipment module. Do not change the Item names. These should
follow standard conventions and start with the name assigned to the
instance of the control in the container application.
10. Save the area model with the new changes.
Modifying Visual Basic phase instances
The following section discusses changing the default tag separator and updating
your area model.
1. Edit the batcheqp.ini file and change the default Equipment Editor tag
separator to a period. Save the batcheqp.ini file.
2. Start the Equipment Editor. Double-click on a Visual Basic equipment
module instance within a unit to display the Edit Equipment Module
dialog box.
Tip:
The tag separator used in the FactoryTalk Batch Equipment Editor must be removed for all PC-based phase
parameter, report, and request data tags. By default, the tags are set up as [Phasename].P01 for
parameters, [Phasename].R01 for report parameters, and [Phasename].Q01 for request data parameters.
The period (.) tag separator must be removed in order for the tags to be used. The tags should be
[Phasename]P01 for parameters, [Phasename]R01 for report parameters, and [Phasename]Q01 for request
data parameters.
The ten base tags need a period; the upload, download, and request tags do not require a period as the tag
separator.
3. Select the Tags tab on the Edit Equipment Module dialog box and click
the Defaults button.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Important:
This is an irreversible action! Once the Defaults button is clicked, all applicable tag items are
automatically changed.
A message displays stating that all tag items have been set to their default
names.
4. Click OK. This places a "." into each tag prior to the separator. You may
verify this by double-clicking on a tag address to open the Edit Equipment
Module Tag dialog box (shown here).
Notice that the Item Name reference of CALCULATE_WEIGHT1P01 is
now CALCULATE_WEIGHT1.P01.
All other tags should have a "." separator in the Item Name tag addressing,
such as:
•
CALCULATE_WEIGHT1.F
•
CALCULATE_WEIGHT1.W
•
CALCULATE_WEIGHT1.OC
•
CALCULATE_WEIGHT1.RQ
Tip:
Parameter, report, and data request tags do not have a tag separator, as shown here:
•
CALCULATE_WEIGHT1P01
•
CALCULATE_WEIGHT1R01
•
CALCULATE_WEIGHT1Q01
Important:
Another way to change addressing is exporting and importing the area model, but this is not
recommended since it can introduce errors to the area model.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Set tag items to default name
This section discusses setting all of the tag items in an area model to their defaults.
1. From the Edit menu, select Set Default Tag Items. Verify that you want to
set all of the tags to their default names.
2. Click OK to continue. A message dialog box opens when the process is
complete.
3. Click OK to return to the Design View area.
Important:
Use Set Default Tag Items with caution. For example, if you have removed the tag separators
from the tag items in your area model, setting the default tag items will put the default tag
separator back in.
1. Open the Recipe Editor.
Adding the new phase to a
recipe
2. Open the recipe to which the new phase will be added.
3. Add the phase and associated transition to the recipe.
4. Verify and save the recipe.
Running a recipe with a PCbased phase
The PC-based phase executable must be active when the recipe is processed.
1. Start the PC-based phase executable.
2. Start the FactoryTalk Batch Server.
3. Open the FactoryTalk Batch View or HMI application.
4. Create a batch from the recipe containing the PC-based phase.
5. Run the batch. The recipe phase will interact with the PC-based phase and
perform its pre-programmed functions.
The icon that represents the phase will change color, based on the state of the
phase. These color changes will match the colors used in the FactoryTalk Batch
View:
•
Green represents RESTARTING, CONNECTING and
DOWNLOADING
•
Dark Green represents RUNNING and UPLOADING
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Tip:
•
Yellow represents HOLDING
•
Dark Yellow represents HELD and UPLOAD HELD
•
Magenta represents ABORTING
•
Dark Magenta represents ABORTED
•
Blue represents STOPPING
•
Dark Blue represents STOPPED
•
Black represents READY, IDLE, and COMPLETE
The FactoryTalk Batch Server may upload material addition information twice when a phase is transitioned
to External during the upload. This is especially true when the Server is configured for a warm or warm-all
restart.
This is a matter of timing; if the phase transition occurs at just the right moment, the Server records the
UPLOADING and the report parameter values, and then changes to External. In that case, when the
operator puts the phase back into Program mode, the Server uploads the reports again.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Appendix A
Properties, methods, and events
A PC-based phase is created using the Phase Execution Control and an OLE
container application. The control must be added to the container application,
placed in the appropriate medium (form, spreadsheet, document, etc.), and its
properties, methods, and events defined. This section defines those properties,
methods and events.
The following tables provide a summary of the properties associated with the
Phase Execution Control and a description of each property.
Properties
Summary
Can Be
Changed At:
Run
time?
Design time?
Property
Indexed
Type
Read Only
CheckPointEnable
No
Boolean
No
Yes
Yes
None
ClearRequest
No
Boolean
No
Yes
Yes
None
Command
No
Long
N/A
No
No
Phasename_OC
DDEBaseTagName
No
String
No
DownloadRequest
No
Boolean
Yes
ExternalCommand
No
Long
No
No
Failure
No
Long
No
No
Interval
No
Long
No
LogFileName
No
Text
No
Name
No
Text
NumberOfParameters
No
NumberOfReports
No
NumberOfReqData
No
32
33
34
35
36
Tag
Yes
*
32
None
No
No
None
Phasename_EC
Phasename_F
Yes
*
33
None
Yes
Yes
None
No
Yes
No
None
Long
No
Yes
*
34
None
Long
No
Yes
* 35
None
Long
No
Yes
*
None
36
Only before initialization
Only before initialization
Only before initialization
Only before initialization
Only before initialization
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Owner
No
Boolean
No
No
** 37
Phasename_W
Parameter(N)
Yes
Text
No
No
**
PhasenamePnn
Pause
No
Boolean
Yes
No
No
Phasename_P
Paused
No
Boolean
No
No
**
39
Phasename_PD
Report(N)
Yes
Text
No
No
** 40
PhasenameRnn
Request
No
Long
No
No
**
41
Phasename_RQ
RequestData(N)
Yes
Text
No
No
**
42
PhasenameQnn
RestoreRequest
No
Boolean
No
Yes
Yes
None
SingleStep
No
Boolean
Yes
No
No
Phasename_SS
Status
No
Long
Yes
No
No
Phasename_ST
StepIndex
No
Long
No
No
**
StepIndexBuffer
No
Long
No
No
Yes
None
StepIndexInitialValue
No
Long
No
Yes
Yes
None
Topic
No
Text
No
Yes
*
None
Unit
No
Long
Yes
No
No
Phasename_UN
UseDefaultDDETag-Name
No
Boolean
No
Yes
*
45
None
WatchdogFailureValue
No
Long
No
Yes
*
46
None
WatchdogStatus
No
Boolean
Yes
No
No
None
WatchdogTimeout
No
Long
No
Yes
*
None
38
43
44
47
Phasename_SI
Descriptions
Property
Description
CheckPointEnable
User configurable flag. When set to TRUE, a checkpoint file will be updated as needed with all
pertinent run-time parameters.The checkpoint file is an internal reference file which is not usermodifiable.The file is updated after each scan if a property change is seen. This file is then loaded
when the phase application is started, or when the CheckPoint method is called. When set to FALSE,
a checkpoint file is not maintained. The default value is TRUE.
37
38
39
40
41
42
43
44
45
46
47
Only after initialization
Only after initialization
Only after initialization
Only after initialization
Only after initialization
Only after initialization
Only after initialization
Only before initialization
Only before initialization
Only before initialization
Only before initialization
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
ClearRequest
User configurable flag. When set to TRUE, any pending request by the phase logic is cancelled when a
change of state is initiated. This property should be used in conjunction with the RestoreRequest
property. The PLI will not allow ClearRequest to be FALSE and RestoreRequest to be TRUE (the
request would be issued twice in this case). The default value is TRUE.
Command
Contains the command information as received from the FactoryTalk Batch Server. The phase
responds to this command register when the phase is in program control ("owned" by the Batch
Server). This parameter is reset after each PLI scan, so its contents are NOT indicative of the last
command sent by the Batch Server.
DDEBaseTagName
Used as the base for tag names when the UseDefaultDDETagName property is set = FALSE and
DDEBaseTagName property is not null. For example, if this property is set = BOO, and the
UseDefaultDDETagName property is FALSE, then the tag for the phase state is BOO_ST. If this
property is empty, the Name property is used as the tag name base regardless of how the
UseDefaultDDETagName property is set.
DownloadRequest
Flag set by the PLI if the FactoryTalk Batch Server has sent a DOWNLOAD command to the phase. The
Server sends a DOWNLOAD command when there is a "Transfer of Control" condition between two
consecutive equipment modules (phase instances) based on the same phase. An example would be
two consecutive agitation phases where a change in agitation speed is desired when a tank level has
reached a certain point. The default value is FALSE.
ExternalCommand
Contains the command information as received from an external source (an HMI, for example). The
phase responds to this command register when the phase is in external control (NOT "owned" by the
FactoryTalk Batch Server). The default value is 0.
Failure
The Failure property is set within the phase logic as desired when there is an error condition that
should cause the phase to be HELD. When this property is set to any value greater than zero, the PLI
will execute the HOLDING sequence. The PLI will also set this property to the WatchdogFailureValue
when the watchdog status is bad and will HOLD the phase. The valid range is 0 to 32767 and the
default value is 0.
Interval
Determines the execution interval (in milliseconds) of the PLI and phase logic. (This value should be
the number of seconds multiplied by 1000.) The default value is 1000.
LogFileName
File name prefix (.LOG is added by the phase execution control) for the activity log file. The default
value is BATCHPHS.
Name
Name of the equipment module. This property must match the name given to the equipment
module in the Equipment Editor. Parenthesis created for control arrays are ignored. The default value
is Phase1.
NumberOfParameters
Indicates the number of parameter tags that will be available to the phase. Generally, this value will
be equivalent to the number of parameter tags assigned within the Equipment Editor. The valid
range is 0 to 999 and the default value is 5.
NumberOfReports
Indicates the number of report tags that will be available to the phase. Generally, this value will be
equivalent to the number of report tags assigned within the Equipment Editor. The valid range is 0 to
999 and the default value is 5.
NumberOfRequestData
Indicates the number of request data tags that will be available to the phase. Generally, this value
will be equivalent to the number of request data tags assigned within the Equipment Editor. The
valid range is 0 to10 and the default value is 5.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Owner
Determines phase ownership. When set to TRUE, the phase is in External control and will respond to
the contents of the ExternalCommand property. When set to FALSE, the phase is owned by the
FactoryTalk Batch Server and will respond to the Command property. The default value is FALSE.
Parameter(N
Phase parameters, where the total number (N) is specified in the NumberOfParameters property.
These are downloaded from the FactoryTalk Batch Server by placing the appropriate values into the
Request property. A NULL string is returned if Initialize has not yet been called; "Invalid index" is
returned when an illegal (out of range) index is used. (Refer to the PCD Programmer’s Technical
Reference guide for details.)
Pause
The Pause property (pausING) is set by the PLI when the Pause command is received, or when
"single-step" mode is activated. (Refer to the FactoryTalk Batch Server API Communications
Language Reference guide for further details). The default value is FALSE.
Paused
Set within the phase logic as desired to place the phase in the Paused state. A Resume command
must be issued to continue phase execution when the Paused (pausED) property is set. (Refer to the
PCD Programmer’s Technical Reference guide for details). The default value is FALSE.
Report(N
Report parameters, where the total number (N) is specified in the NumberOfReports property. Report
parameters are set within the phase logic to upload report values to the FactoryTalk Batch Server for
archiving. The phase logic must store report values to this property and then store an "Upload
Request" to the Request property. A NULL string is returned if Initialize has not yet been called;
"Invalid index" is returned when an illegal (out of range) index is used.
Request
Used to make requests to the FactoryTalk Batch Server to accomplish a wide range of tasks such as
downloading and uploading parameter and report values. Phase logic stores a predefined request
value to this property to initiate action by the Server. This property value must be equal to zero
before storing a valid request into this property. This property will return to zero when the Server has
completed the requested action. (Refer to the PCD Programmer’s Technical Reference Guide for
details.) The valid range is 1000 to 2147483648 and the default value is 0.
RequestData(N)
Request data parameters, where the total number (N) is specified in the NumberOfRequestData
property. The RequestData property performs two functions: 1) supplies additional arguments for a
Request that is being made using the Request property, and 2) transfers data values from a sending
Transfer phase to a receiving Transfer phase. A NULL string is returned if Initialize has not yet been
called; "Invalid index" is returned when an illegal (out of range) index is used. (Refer to the PCD
Programmer’s Technical Reference Guide for details.)
RestoreRequest
User configurable flag. When the phase transitions from RESTARTING to RUNNING, this property
(when TRUE) will cause the request that was pending at the time the phase was HELD to be restored
and executed. This property should be used in conjunction with the ClearRequest property. The PLI
will not allow ClearRequest to be FALSE and RestoreRequest to be TRUE (the request would be issued
twice in this case). The default value is TRUE.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
SingleStep
Flag toggled by the PLI when it receives a SingleStep command. When "single-stepping" is turned
ON, the Pause (pausING) property is set to TRUE if the phase has been in the "free-running" state.
This combination is referred to as the "single-step pausing" state. When "single-stepping" is turned
OFF, both the Pause (pausING) and Paused (pausED) properties are cleared (set to FALSE) and the
phase return to the "free-running" state. (Refer to the PCD Programming Guide for details). The
default value is FALSE.
Status
Contains a numerical value that represents the current phase state. The following are the possible
values with the corresponding state:
10 = ABORTING
20 = HOLDING
30 = STOPPING
40 = RESTARTING
50 = RUNNING
60 = HELD
70 = COMPLETE
80 = STOPPED
90 = ABORTED
100 = IDLE
The default value is 100.
StepIndex
Set equal to the StepIndexInitialValue property by the PLI when the phase is STARTed or RESET. The
phase logic may use this property to control program flow. The default value is 1.
StepIndexBuffer
Used by the PLI to save the StepIndex property when the phase is HELD. The StepIndex is restored
from the StepIndexBuffer when the phase is RESTARTED. The default value is 0.
StepIndexInitialValue
Default value of the step index. The PLI initializes the StepIndex property to the StepIndexInitialValue
value when the START or RESET command is received. The default value is 1.
Topic
This is the Watchdog Item Access Path as defined in a OPC server within the area model. You may
define multiple OPC servers to be used with PC-based phases. They do not need to use the same
topic. You may also use multiple instances of a control within one project and refer to different OPC
servers. If the Topic property is set at run-time, it must be set before the Initialize method is called.
The default value is BATCH.
Unit
Contains the UnitID of the Unit that controls the phase. The default value is 0.
UseDefaultDDETagName
User configurable flag. When set to TRUE, or when the DDEBaseTagName property is not null, the
content of the Name property is used as the base for tag names. When set to FALSE, and the
DDEBaseTagName property is not null, then the content of the DDEBaseTagName property is used.
WatchdogFailureValue
This is the value that the Failure register is set to when the WatchdogStatus is bad. The value used
here should then be defined within the phase_failure enumeration set in the area model. The default
is 13. This property can be set to 0, which will "turn off" the "hold on watchdog failure" logic; the
phase will not be HELD when the WatchdogStatus goes bad. The valid range is 0 to 2147483648.
WatchdogStatus
Current status of the watchdog between the FactoryTalk Batch Server and the phase. A zero (FALSE)
indicates that the status is bad and communications are down. The PLI will set the Failure property to
13 when the WatchdogStatus is bad. The default value is FALSE.
WatchdogTimeout
Interval, in seconds, between watchdog checks by the PLI 48. If the WatchdogTimeout property is set
at run-time, it must be set before the Initialize method is called. The default value is 20. The valid
range is 5 to 1800 seconds.
The timeout period is configurable in the Batchsvr.ini file, entered in milliseconds. The
default settings are in the [XMAN] section: WatchdogPeriod=10000 and
WatchdogCycles=5. The default time period for the FactoryTalk Batch Server is ten (10)
seconds. The PCD timer should be set to a value slightly larger than the product of the
WatchdogPeriod and the WatchdogCycles.
48
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
The following section provides a summary of each method associated with the
Phase Execution Control and a description of how each method is used. There are
no parameters associated with any of these methods.
Methods
Summary
Method
Return Value
Description
CheckPoint
True = success
False = failure
Called to force an update of the checkpoint data file.
Initialize
True = success
False = failure
Used to initialize the control. The control will not function properly if this method
is not invoked.
LogTagNames
True
Used to write all tag names to the activity log file.
TerminateState
None
Your application must call this method to complete the transition of an Active
state.
Transition Command methods:
CommandAbort
True = success
False = failure
Used to transition the phase to ABORTING.
CommandHold
True = success
False = failure
Used to transition the phase to HOLDING.
CommandReset
True = success
False = failure
Used to transition the phase to IDLE.
CommandRestart
True = success
False = failure
Used to transition the phase to RESTARTING.
CommandStart
True = success
False = failure
Used to transition the phase to RUNNING.
CommandStop
True = success
False = failure
Used to transition the phase to STOPPING.
Descriptions
Checkpoint
This method is invoked to update the checkpoint data file. Typically, this is not
needed since the checkpoints are saved as needed at the end of every PLI scan. It
should only be called AFTER the Initialize method has been called and executed
successfully.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Initialize
This method performs all initialization and MUST be called before the phase will
execute properly. It only needs to be called once and in fact, will not execute again
if called more than once. You should check the return value and not allow the
application to continue if this method fails. Initialize does the following:
•
Loads checkpoint data if required (fires OnCheckPointFail if the
checkpoint read fails).
•
Creates and initializes all tags.
•
Creates the watchdog.
•
Creates a timer based on the Interval property.
•
Fires the OnPowerUp event.
LogTagNames
This method writes all tag names to the activity log file. It is used as a tool to view
the current tag names. It should only be called AFTER the Initialize method has
created and initialized the tags. It will always return a value of TRUE.
TerminateState
This method is used to terminate an active state and transition the phase to the
next desired state. In other words, it will cause the phase to change state as shown
in the following table:
Current State
Transitioned State upon Call of
TerminateState
ABORTING
ABORTED
HOLDING
HELD
STOPPING
STOPPED
RESTARTING
RUNNING
RUNNING
COMPLETE
The phase programmer must use TerminateState within the phase logic to
transition the phase state at the appropriate time. Refer to the PCD Programmer’s
Technical Reference Guide for instructions regarding state transition logic.
Transition command methods
The Transition Command methods allow the phase programmer to change the
state of the phase from within the source code. The state transition rules must be
followed in order for the PLI within the Phase Execution Control to honor the
command. The following table shows the command name, the state to which the
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
phase will transition, and the state(s) that the phase must be in for the command
to be honored.
Method
Phase Transitions to
Phase State must be
CommandAbort
ABORTING
HOLDING, STOPPING, RUNNING, RESTARTING, or HELD
CommandHold
HOLDING
RUNNING or RESTARTING
CommandReset
IDLE
COMPLETE, ABORTED, or STOPPED
CommandRestart
RESTARTING
HELD (and the phase has not failed)
CommandStart
RUNNING
IDLE (and the phase has not failed)
CommandStop
STOPPING
HOLDING, RUNNING, RESTARTING, or HELD
The following table provides a brief description for each event associated with the
Phase Execution Control. There are no parameters associated with any of these
events.
Events
Event
Description
OnAbort
Fired by the Phase Execution control when the phase is in the ABORTING state. Only happens AFTER the
Initialize method is invoked.
OnHold
Fired by the Phase Execution control when the phase is in the HOLDING state. Only happens AFTER the
Initialize method is invoked.
OnRun
Fired by the Phase Execution control when the phase is in the RUNNING state. Only happens AFTER the
Initialize method is invoked.
OnRestart
Fired by the Phase Execution control when the phase is in the RESTARTING state. Only happens AFTER the
Initialize method is invoked.
OnStop
Fired by the Phase Execution control when the phase is in the STOPPING state. Only happens AFTER the
Initialize method is invoked.
OnIdle
Fired by the Phase Execution control when the phase is in the IDLE state. Only happens AFTER the
Initialize method is invoked.
OnLoadCheckPointFail
Fired by the Phase Execution control during startup IF there are no valid checkpoints to load AND the
CheckPointEnable property is set to TRUE.
OnPowerUp
Fired by the Phase Execution control during execution of the Initialize method. Only called if the
Initialize method is successful.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Appendix B
Application notes and example phase
This section contains application notes and an example of a generic PC-based
phase. The example uses the sample application (SampleDemo) that is installed
with FactoryTalk Batch. (For more information on the sample application, see the
FactoryTalk Batch Getting Results Guide.)
Application notes
The following are points to remember when programming PC-based phases:
•
There should be a data type mismatch between the request data tag(s)
configured in the area model and tags configured on the Visual Basic
ActiveX control. In the area model the tags must be configured as integers
for the FactoryTalk Batch Server to work correctly; in the ActiveX control
they are configured as strings. The OPC call made from the Server converts
the strings to integers. All other tags should have a one-to-one mapping of
tag types.
•
If you remove tag locking from the phase class configured in the Equipment
Editor, the FactoryTalk Batch Server will try to do the conversion from the
tag type configured in the class to the type that is used in the instance. This
is useful for PC-based phases because this allows you to create the phase
class parameters and reports of any data type you choose. At the instance
level, you can then change the actual instance tag types of the parameters
and reports to strings, which are required by the PC-based phase. This is
especially useful for material-enabled phases where the tag type of the
AMOUNT report tag must be real, and the tag type of the
FEED_COMPLETE report tag must be enumeration.
•
The tag separator used in the Equipment Editor must be removed for all
PC-based phase parameter, report, and request data tags. By default, the tags
are set up as [Phasename].P01 for parameters, [Phasename].R01 for report
parameters, and [Phasename].Q01 for request data parameters. The period
(.) tag separator must be removed in order for the tags to be used. The tags
should be [Phasename]P01 for parameters, [Phasename]R01 for report
parameters, and [Phasename]Q01 for request data parameters.
•
The Name in the Equipment Editor’s Edit Equipment Module dialog box
must agree exactly with the Name property of the phase.
•
Phase controls can be added to Visual Basic forms as control arrays. In this
case, the phase control’s property index number corresponds to the number
at the end of the Equipment Module’s name. For example, if CHARGE1 is
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
the Equipment Module name, the corresponding Visual Basic Phase
Control name created as part of a control array is CHARGE(1). The "1" is
the index property of the control. The programmer must decide when to
use a control array or individual names for phase controls.
PC-based phase example
•
The phase control sets the step index property to the
StepIndexInitialValue upon entering the control event (OnRun, OnStop,
etc.). Use this value to reference the first step in the OnRun event logic.
The user can subsequently set the step index to any value (see the example
phase).
•
Remember that the code is executed based on the value in the Interval
property. For example, if the Interval value is 1000 milliseconds, the code is
repeated every second.
•
If a download of parameters is required, place it in the first step, as shown in
the accompanying example for the OnRun event. This approach ensures
that the download is only issued once. The next "step" should wait until the
request register is reset to zero by FactoryTalk Batch before proceeding
through the remaining steps.
•
If assigning a value to a variable, and it is not in a case select structure or
some other IF statement structure, it will have the value assigned to it each
time that event fires. This could lead to errors in code execution of the
control event.
•
If using multiple phase controls on the same form, make sure that each
phase control variable is unique to the phase if declared in the general
declaration section. The example program is for only one phase, but if there
were other phase controls, the variables used in one could not be used in the
other. This could lead to one phase overwriting values needed by another
phase. It is conceivable that there could be exceptions.
•
To run a Visual Basic phase, make an executable file (.exe). Start the Visual
Basic phase, start the FactoryTalk Batch Server, check that the
communication between the two is good (tag verification should also be
done at this point until all tags verify successfully). The Visual Basic phase is
now ready to have a recipe run against it.
'=================================================
'This program was written using Microsoft Visual Basic 6 and
'is intended to be used as a starting point for creating your
'own PC-Based Phases.
'================================================
'Phase request definitions
Const NO_REQUEST_PENDING = 0
Const REQUEST_ALL_PARAMETERS = 1000
Const UPLOAD_ALL_PARAMETERS = 2000
Private Sub Form_Load()
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
End Sub
'Initialize the PC-Based Phase Control
PH_CHECK_A.Initialize
Private Sub PH_CHECK_A_OnAbort()
'Terminate the current state of the phase
PH_CHECK_A.TerminateState
End Sub
Private Sub PH_CHECK_A_OnHold()
'Terminate the current state of the phase
PH_CHECK_A.TerminateState
End Sub
Private Sub PH_CHECK_A_OnIdle()
'Terminate the current state of the phase
PH_CHECK_A.TerminateState
End Sub
Private Sub PH_CHECK_A_OnRestart()
End Sub
'Terminate the current state of the phase
PH_CHECK_A.TerminateState
Private Sub PH_CHECK_A_OnRun()
'The following Select Case performs the processing steps
'for the PH_CHECK_A logic. The initial step index for the
'phase is zero ("0").
Select Case PH_CHECK_A.StepIndex
Case 0:
'Wait until no requests are pending
If PH_CHECK_A.Request = NO_REQUEST_PENDING Then
'Ask server to download all parameters for phase
PH_CHECK_A.Request = REQUEST_ALL_PARAMETERS
PH_CHECK_A.StepIndex = 10
End If
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Case 10:
'Wait until parameters have been downloaded
If PH_CHECK_A.Request = NO_REQUEST_PENDING Then
PH_CHECK_A.StepIndex = 20
End If
Case 20:
'This case statement should contain the code required
'to perform the function of the phase
PH_CHECK_A.StepIndex = 30
Case 30:
'This case statement should contain the code required
'to put report data into report registers
PH_CHECK_A.Report(1) = PH_CHECK_A.Parameter(1)
PH_CHECK_A.StepIndex = 40
Case 40:
'Wait until no requests are pending
If PH_CHECK_A.Request = NO_REQUEST_PENDING Then
'Upload reports
PH_CHECK_A.Request = UPLOAD_ALL_PARAMETERS
PH_CHECK_A.StepIndex = 50
End If
Case 50:
'Wait until upload has completed
If PH_CHECK_A.Request = NO_REQUEST_PENDING Then
PH_CHECK_A.StepIndex = 60
End If
Case 60:
PH_CHECK_A.TerminateState
Case Else
PH_CHECK_A.StepIndex = PH_CHECK_A.StepIndexInitialValue
End Select
End Sub
Private Sub PH_CHECK_A_OnStop()
'Terminate the current state of the phase
PH_CHECK_A.TerminateState
End Sub
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Creating a new PC-based phase
1. Using MS Visual Basic version 6.0 or greater, create a new standard
executable and add the Phase Execution Control to the form. (See
“Creating a PC-based phase (on page 315)” for information on creating a
PC-based phase.)
2. Copy the text from the PC-based phase example into the code window of
the project.
3. Change the Name property of the Phase Execution Control to
PH_CHECK_A.
4. Set the CheckPointEnable property to FALSE.
5. Set the StepIndexInitialValue property to 0.
6. Create an executable file. This file must be running during batch execution.
FactoryTalk Batch Equipment Editor
You must add a new data server definition (DSDF) to your area model, as well as
add a new phase and associated equipment module.
1. Open the SampleDemo area model in which the new phase will be utilized.
2. From the Edit menu, select Data Server, or click the Edit Data Servers
toolbar button. The Data Servers dialog box opens.
3. Click Add. The Add Data Server dialog box opens.
4. Enter the new data server definition name in the Name box.
5. From the Type list, select PC Phase OPC.
6. The default values for the data server type are displayed. The Watchdog
Item Name must be WATCHDOG. Any string may be used for the
Watchdog Item Access Path, but the same string must be used in the PCbased phase’s Topic property. Enter the following information for the new
data server definition and then click OK to return to the Data Servers
dialog box:
Watchdog Item Access Path:
Phase (user-definable)
Watchdog Item Name:
watchdog
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
7. Create a new phase named PHASE. Assign the required number of
parameter, report, and request tags. Generally, these would be equal to the
number assigned to the PC-based phase’s properties.
8. Create an instance of this phase named PH_CHECK_A in the appropriate
unit(s). Be sure to use the same name for the equipment module as the
Name property defined for the PC-based phase.
9. Assign the new data server definition to each of the tags in the newly
defined equipment module. Do not change the Item names. These should
follow standard conventions and start with the name assigned to the
instance of the control in the container application. (Refer to the
FactoryTalk Batch Equipment Editor User's Guide for information on
assigning data servers.)
10. Save the area model with the new changes.
11. Open the Recipe Editor.
12. Open the recipe to which the new phase will be added.
13. Add the phase and associated transition to the recipe.
14. Verify and save the recipe.
PC-based phase example
'================================================
'This program was written using Microsoft Visual Basic 6 and
'is intended to be used as a starting point for creating your
'own PC-Based Phases.
'================================================
'Phase request definitions
Const NO_REQUEST_PENDING = 0
Const REQUEST_ALL_PARAMETERS = 1000
Const UPLOAD_ALL_PARAMETERS = 2000
Private Sub Form_Load()
End Sub
'Initialize the PC-Based Phase Control
PH_CHECK_A.Initialize
Private Sub PH_CHECK_A_OnAbort()
'Terminate the current state of the phase
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
End Sub
Private Sub PH_CHECK_A_OnHold()
'Terminate the current state of the phase
PH_CHECK_A.TerminateState
End Sub
Private Sub PH_CHECK_A_OnIdle()
'Terminate the current state of the phase
PH_CHECK_A.TerminateState
End Sub
Private Sub PH_CHECK_A_OnRestart()
End Sub
'Terminate the current state of the phase
PH_CHECK_A.TerminateState
Private Sub PH_CHECK_A_OnRun()
'The following Select Case performs the processing steps
'for the PH_CHECK_A logic. The initial step index for the
'phase is zero ("0").
Select Case PH_CHECK_A.StepIndex
Case 0:
'Wait until no requests are pending
If PH_CHECK_A.Request = NO_REQUEST_PENDING Then
'Ask server to download all parameters for phase
PH_CHECK_A.Request = REQUEST_ALL_PARAMETERS
PH_CHECK_A.StepIndex = 10
End If
Case 10:
'Wait until parameters have been downloaded
If PH_CHECK_A.Request = NO_REQUEST_PENDING Then
PH_CHECK_A.StepIndex = 20
End If
Case 20:
'This case statement should contain the code required
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
'to perform the function of the phase
PH_CHECK_A.StepIndex = 30
Case 30:
'This case statement should contain the code required
'to put report data into report registers
PH_CHECK_A.Report(1) = PH_CHECK_A.Parameter(1)
PH_CHECK_A.StepIndex = 40
Case 40:
'Wait until no requests are pending
If PH_CHECK_A.Request = NO_REQUEST_PENDING Then
'Upload reports
PH_CHECK_A.Request = UPLOAD_ALL_PARAMETERS
PH_CHECK_A.StepIndex = 50
End If
Case 50:
'Wait until upload has completed
If PH_CHECK_A.Request = NO_REQUEST_PENDING Then
PH_CHECK_A.StepIndex = 60
End If
Case 60:
PH_CHECK_A.TerminateState
Case Else
PH_CHECK_A.StepIndex = PH_CHECK_A.StepIndexInitialValue
End Select
End Sub
Private Sub PH_CHECK_A_OnStop()
'Terminate the current state of the phase
PH_CHECK_A.TerminateState
End Sub
Using limit tags on a PC-based phase
To obtain the Parameter Limits or Report Parameter Limits using a Visual Basic
application, you can configure additional phase parameter tags in the PC-based
phase which can be used as addresses for the limit tags in the area model.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
The following steps are necessary to use limit tags with a Visual Basic application:
1. In Visual Basic, during PC-based phase configuration, specify additional
phase parameter tags on the Custom Properties dialog box of the Phase
Execution Control. The number of phase parameter tags required is equal
to the normal number of phase parameter tags plus the number of limit tags
specified in the area model.
2. In the Equipment Editor, assign a Verification Method to the PC-based
phase parameters or phase report parameters.
3. Select the equipment module and enable the Parameter Limit Tags or the
Report Limit Tags by checking Enable Limit Tags.
4. From the Parameter or Report Limit Tags tab, double-click on a Limit
Tag to open the Edit Equipment Module Tag dialog box. Change the
Item Name to one of the phase parameter tag addresses (names) defined in
Visual Basic. The Item Name is referenced in code to display Limit values.
Example: PHASE1P01M changes to PH_CHECK_AP03
5. At runtime, when the PC-based phase requests the Limit Tags, the
FactoryTalk Batch Server loads the limit values into the additional phase
parameter tags. The PC-based phase can access the value of these tags using
the get_RequestData method. The set_RequestData is used to reset the
value of the tag.
PC-based phase limit tag example
The code sample below could be used to display Parameter Limit tags using a
Visual Basic application. This example is an extension of the previous code sample.
(See "PC-based phase example on page 340)” for more information.)
Follow the steps below to add Limit Tags to the PC-based phase created in the
previous example:
1. In the Equipment Editor, verify that the PC-based phase has Tag Locking
enabled and two parameters.
2. Assign a Verification Method of High/Low to both of the parameters.
3. On the PC-based Equipment Module, Parameter Limit Tags tab, check
Enable Limit Tags. The following six additional tags are created:
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
•
PARMTR01H, PARMTR01L, PARMTR01M
•
PARMTR02H, PARMTR02L, PARMTR02M
4. On the Tags tab, double-click on one of the new Limit Tags. The Edit
Equipment Module Tag dialog box opens.
5. Change the Limit Tag Item Name to a phase parameter tag name. Repeat
this for each Limit Tag. These names are referenced in code to display the
Limit Tag values.
For example:
•
PHASE1P01M changes to PH_CHECK_AP03
•
PHASE1P01L changes to PH_CHECK_AP04
•
PHASE1P01H changes to PH_CHECK_AP05
•
PHASE1P02M changes to PH_CHECK_AP06
•
PHASE1P02L changes to PH_CHECK_AP07
•
PHASE1P02H changes to PH_CHECK_AP08
6. In Visual Basic, create a form similar to the one shown here:
7. Add phase parameter tags on the Custom Properties dialog box of the
Phase Execution Control. These tags are referenced in code to display the
status of the phase, the parameter values, and the Limit Tag values.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
8. Add code to map the phase parameter tags defined in the area model to the
labels on the form. The code will be similar to the following example:
Private Sub Form_Load()
PH_CHECK_A.Initialize
lState.Caption = PH_CHECK_A.Status
End Sub
Private Sub PH_CHECK_A_OnRun()
lState.Caption = PH_CHECK_A.Status
lParameterValue(0).Caption = PH_CHECK_A.Parameter(1)
lParameterValue(1).Caption = PH_CHECK_A.Parameter(2)
lParameterMethod(0).Caption = PH_CHECK_A.Parameter(3)
lParameterLowLimit(0).Caption = PH_CHECK_A.Parameter(4)
lParameterHighLimit(0).Caption = PH_CHECK_A.Parameter(5)
lParameterMethod(1).Caption = PH_CHECK_A.Parameter(6)
lParameterLowLimit(1).Caption = PH_CHECK_A.Parameter(7)
lParameterHighLimit(1).Caption = PH_CHECK_A.Parameter(8)
End Sub
PH_CHECK_A.TerminateState
lState.Caption = PH_CHECK_A.Status
End Sub
9. Save your Visual Basic project and make a new executable.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
No additional coding is necessary to enable Signature Requests on a PC-based
phase. If a PC-based phase parameter or report parameter is configured with a
Verification Method and a Signature Template, the FactoryTalk Batch Server
generates a Signature Request if the recipe parameter or report parameter Limit
Tag values exceed their defined limits.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Index
A
AbortControlRecipe method, 41
Acknowledge method, 41
AcknowledgeUI method, 42
ActionFilterPattern property, 76
ActionIDColumnText property, 75
ActionIDColumnWidth property, 76
ActionIDIsValid method, 43
ActionIDShowColumn property, 77
ActionUI method, 43
ActiveStepChangeBegin event, 273
ActiveStepChangeEnd event, 273
ActiveUnit property, 78
ActiveUnitProcedureNumber property, 79
ActiveX control, 341
ActiveX custom control, 315
adding to a Visual Basic project, 319
placing on a form, 319
adding phase to a recipe, 330
Appearance property, 80
Area, 187, 191
AreaColumnText property, 81
AreaColumnWidth property, 81
AreaFilterPattern property, 82
Arrange property, 83
AutoArrange property, 84
AutoSizeColumns property, 85
B
BackColor property, 86
BatchID, 187, 191
BatchIDColumnText property, 87
BatchIDColumnWidth property, 87
BatchIDEditable property, 88
BatchIDFilterPattern property, 89
BatchIDShowColomn property, 90
BatchVersionCompatible property, 91
BindUI method, 44
BorderStyle property, 91
C
C++ project, 323
CallTimeout property, 92
CanAbort property, 93
CanAcknowledge property, 94
CanBind property, 95
CanBindAcknowledge property, 96
CanChangeActiveStep property, 97
CanClearFailures property, 98
CanComment property, 99
CanCreateControlRecipe property, 100
CanDisconnect property, 101
CanHold property, 102
CanPause property, 103
CanRemove property, 104
CanRestart property, 105
CanResume property, 106
CanSetAutomatic property, 107
CanSetManual property, 108
CanSetSemiAuto property, 109
CanStart property, 110
CanStop property, 111
Change event, 274
ChartDrawWidth property, 112
ChartFont property, 113
ChartFontBold property, 114
ChartFontItalic property, 114
ChartFontName property, 115
ChartFontSize property, 116
ChartFontStrikethru property, 116
ChartFontUnderline property, 117
CheckPoint method
using, 338
CheckPointEnable
description, 334
summary, 338
ClearRequest
description, 334
summary, 338
Click event, 275
collection
phases, 187
process cells, 187
units, 187
Command
description, 334
summary, 338
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Command Verification Policies, 325
CommandCurrentStep method, 47
CommentControlRecipe method, 47
CommentSelectedControlRecipeUI method, 48
CommentUI method, 48
CommunicationStatus property, 118
CommunicationStatusChange event, 275
configure DDEBaseTagName property, 324
Connection property, 119
ConnectTimeout property, 120
control events, 324
ControlRecipeList control, 22
ControlRecipes property, 121
CreateControlRecipe method, 49
CreateIDColumnText property, 122
CreateIDColumnWidth property, 123
CreateIDFilterPattern property, 123
CrossInvocationString#, 187, 191
CurrentProcedureAbstract property, 125
CurrentProcedureAuthor property, 125
CurrentProcedureDate property, 126
CurrentProcedureDescription property, 126
CurrentProcedureID property, 127
CurrentProcedureProductCode property, 127
CurrentProcedureVersion property, 128
D
data tags
request, 341
data type mismatch, 341
DblClick event, 276
DblClickControlRecipe event, 276
DefaultBatchID property, 128
DefaultScale property, 129
DescriptionColumnText property, 130
DescriptionColumnWidth property, 131
DescriptionFilterPattern property, 131
DialogFontBold property, 133
DialogFontItalic property, 133
DialogFontName property, 134
DialogFontSize property, 134
DialogFontStrikethru property, 135
DialogFontUnderline property, 136
DisplayCurrentStep method, 49
DisplayedParameters property, 137
DisplayLimits property, 137
DisplayNonIncomplete property, 138
DisplayParentStep method, 50
distributing PC-based phase applications, 326
Domains property, 139
DoubleClickNavigation property, 139
DownloadRequest
description, 334
summary, 338
E
ElapsedTimeColumnText property, 140
ElapsedTimeColumnWidth property, 140
ElapsedTimeFilterPattern property, 141
Enabled property, 142
Enumerations, 291
EUColumnText property, 143
EUColumnWidth property, 144
EUFilterPattern property, 144
events
ActiveStepChangeBegin, 273
ActiveStepChangeEnd, 273
Change, 274
Click, 275
CommunicationStatusChange, 275
DblClick, 277
InitDblClick, 277
KeyDown, 277
KeyPress, 278
KeyUp, 279
MouseDown, 279
MouseMove, 280
MouseUp, 281
NewCurrentProcedure, 282
NewTopProcedure, 283
OnSelChange, 284
OnUpdate, 285
overview, 22
SimpleOnSelChange, 286
StepClick, 286
StepDblClick, 287
TransitionClick, 288
TransitionDblClick, 288
executable
creating, 323
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Execute method, 51
execution of PC-based phase, 317
ExternalCommand
description, 334
summary, 338
F
Failure, 187
description, 334
summary, 338
FailureColumnText property, 145
FailureColumnWidth property, 146
FailureFilterPattern property, 147
filter
status bar, 300
FilteredControlRecipeCount property, 148
FilteredPromptCount property, 149
FilterOnBatchID property, 149
FilterOnRecipePath property, 150
FilterOnUnitName property, 150
FilterPattern property, 151
FitToWindow method, 51
Font property, 152
ForeColor property, 152
G
GetColumnText method, 52
GetColumnWidth method, 52
GetFilterPattern method, 53
GetItem method, 54
GetShowColumn method, 55
H
HideColumn method, 55
HideColumnHeaders property, 153
HoldControlRecipe method, 56
I
InitDblClick event, 277
Initialize method
programming, 321
using, 339
Interval
description, 334
summary, 338
Interval property, 155
InvocationProgID property, 155
IsFiltered property, 156
K
KeyPress event, 278
KeyUp event, 279
L
LabelWrap property, 157
Limit Tags, 348
ListSeparator property, 158
LogFileName
description, 334
summary, 338
Login method, 57
LoginUI method, 57
M
MatchBackColor property, 158
MatchFont property, 159
MatchForeColor property, 160
material-enabled phases, 341
methods
AbortControlRecipe, 41
Acknowledge, 41
AcknowledgeUI, 42
ActionIDIsValid, 43
ActionUI, 43
BindUI, 44
CommandCurrentStep, 47
CommentControlRecipe, 47
CommentSelectedControlRecipeUI, 48
CommentUI, 48
CreateControlRecipe, 49
DisplayCurrentStep, 49
DisplayParentStep, 50
Execute, 51
FitToWindow, 51
GetColumnText, 52
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
GetColumnWidth, 52
GetFilterPattern, 53
GetItem, 54
GetShowColumn, 55
HideColumn, 55
HoldControlRecipe, 56
Login, 57
LoginUI, 57
overview, 22
PauseControlRecipe, 58
programming, 321
PromptIDIsValid, 58
Refresh, 59
RefreshToken, 59
RemoveControlRecipe, 60
RestartControlRecipe, 60
ResumeControlRecipe, 61
SelectControlRecipe, 62
SelectPrompt, 62
SelectSignature, 63
SetColumnText, 63
SetColumnWidth, 64
SetControlRecipeMode, 65
SetFilterPattern, 65
SetShowColumn, 67
ShowAboutBox, 67
ShowColumn, 68
ShowPropertiesDialog, 68
SignatureIDIsValid, 69
SignatureUI, 69
SignoffIsValid, 70
StartControlRecipe, 71
StepChangeCancel, 71
StepChangeCommit, 72
StepChangeStart, 72
StopControlRecipe, 73
summary, 338
MFC AppWizard, 323
Mode, 187
ModeColumnText property, 161
ModeColumnWidth property, 162
ModeFilterPattern property, 162
MouseDown event, 279
MouseIcon property, 163
MouseMove event, 280
MousePointer property, 164
MouseUp event, 281
N
Name
description, 334
summary, 338
NewCurrentProcedure event, 282
NewTopProcedure event, 283
Node property, 166
NumberOfParameters
description, 334
summary, 338
NumberOfReports
description, 334
summary, 338
NumberOfReqData
summary, 338
NumberOfRequestData
description, 334
O
OnIncompleteSignatureCountChange event, 283
OnRestart Event
programming, 322
OnSelChange event, 284
OnSignatureUpdate event, 285
OnUpdate event, 285
Owner
description, 334
summary, 338
P
Parameter(N)
description, 334
summary, 338
Pause
description, 334
summary, 338
PauseControlRecipe method, 58
Paused
description, 334
summary, 338
PC-based phase
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
definition, 315
distributing applications, 326
executable, 323
running in a recipe, 330
setting properties, 320
PersistLogins property, 166
Phase Execution Control
adding to a Visual Basic project, 319
C++ project, 323
placing on a form, 319
PhaseColumnText property, 167
PhaseColumnWidth property, 168
PhaseFilterPattern property, 168
phases collection, 187
PhasesColumnText property, 169
PhasesColumnWidth property, 170
PhasesFilterPattern property, 171
ProcedureIDColumnText property, 172
ProcedureIDColumnWidth property, 173
ProcedureIDFilterPattern property, 173
ProcedureIDShowColumn property, 174
ProcedureView
viewing step properties, 300
ProcedureView control, 25
process cells collection, 187
ProcessCellColumnText property, 175
ProcessCellColumnWidth property, 176
ProcessCellFilterPattern property, 176
programming the PC-based phase, 321
events, 322
PromptIDColumnText property, 177
PromptIDColumnWidth property, 178
PromptIDFilterPattern property, 179
PromptIDIsValid method, 58
Prompts property, 180
PromptsList control, 23
PromptType, 191
PromptTypeColumnText property, 181
PromptTypeColumnWidth property, 181
PromptTypeFilterPattern property, 182
properties
ActionFilterPattern, 76
ActionIDColumnText, 75
ActionIDColumnWidth, 76
ActionIDShowColumn, 77
ActiveUnit, 78
ActiveUnitProcedureNumber, 79
Appearance, 80
AreaColumnText, 81
AreaColumnWidth, 81
AreaFilterPattern, 82
Arrange, 83
AutoArrange, 84
AutoSizeColumns, 85
BackColor, 86
BatchIDColumnText, 87
BatchIDColumnWidth, 87
BatchIDEditable, 88
BatchIDFilterPattern, 89
BatchIDShowColomn, 90
BatchVersionCompatible, 91
BorderStyle, 91
CallTimeout, 92
CanAbort, 93
CanAcknowledge, 94
CanBind, 95
CanBindAcknowledge, 96
CanChangeActiveStep, 97
CanClearFailures, 98
CanComment, 99
CanCreateControlRecipe, 100
CanDisconnect, 101
CanHold, 102
CanPause, 103
CanRemove, 104
CanRestart, 105
CanResume, 106
CanSetAutomatic, 107
CanSetManual, 108
CanSetSemiAuto, 109
CanStart, 110
CanStop, 111
ChartDrawWidth, 112
ChartFont, 113
ChartFontBold, 114
ChartFontItalic, 114
ChartFontName, 115
ChartFontSize, 116
ChartFontStrikethru, 116
ChartFontUnderline, 117
CommunicationStatus, 118
Connection, 119
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
ConnectTimeout, 120
ControlRecipes, 121
CreateIDColumnText, 122
CreateIDColumnWidth, 123
CreateIDFilterPattern, 123
CurrentProcedureAbstract, 125
CurrentProcedureDate, 126
CurrentProcedureID, 127
CurrentProcedureVersion, 128
DefaultBatchID, 128
DefaultScale, 129
DescriptionColumnText, 130
DescriptionColumnWidth, 131
DescriptionFilterPattern, 131
DialogFontBold, 133
DialogFontItalic, 133
DialogFontName, 134
DialogFontStrikethru, 135
DialogFontUnderline, 136
DisplayedParameters, 137
DisplayLimits, 137
DisplayNonIncomplete, 138
Domains, 139
ElapsedTimeColumnText, 140
ElapsedTimeColumnWidth, 140
ElapsedTimeFilterPattern, 141
Enabled, 142
EUColumnText, 143
EUColumnWidth, 144
EUFilterPattern, 144
FailureColumnText, 145
FailureColumnWidth, 146
FailureFilterPattern, 147
FilteredControlRecipeCount, 148
FilteredPromptCount, 149
FilterOnBatchID, 149
FilterOnRecipePath, 150
FilterOnUnitName, 150
FilterPattern, 151
Font, 152
ForeColor, 152
HideColumnHeaders, 153
Interval, 155
InvocationProgID, 155
IsFiltered, 156
LabelWrap, 157
ListSeparator, 158
MatchBackColor, 158
MatchFont, 159
MatchForeColor, 160
ModeColumnText, 161
ModeColumnWidth, 162
ModeFilterPattern, 162
MouseIcon, 163
MousePointer, 164
Node, 166
overview, 22
PersistsLogin, 166
PhaseColumnText, 167
PhaseColumnWidth, 168
PhaseFilterPattern, 168
PhasesColumnText, 169
PhasesColumnWidth, 170
PhasesFilterPattern, 171
ProcedureIDColumnText, 172
ProcedureIDColumnWidth, 173
ProcedureIDFilterPattern, 173
ProcedureIDShowColumn, 174
ProcessCellColumnWidth, 176
ProcessCellFilterPattern, 176
PromptIDColumnText, 177
PromptIDColumnWidth, 178
PromptIDFilterPattern, 179
Prompts, 180
PromptTypeColumnText, 181
PromptTypeColumnWidth, 181
PromptTypeFilterPattern, 182
RecipeColumnText, 183
RecipeColumnWidth, 184
RecipeFilterPattern, 185
RetryPeriod, 186
SecurityEnabled, 187
SelectedControlRecipe, 187
SelectedPrompt, 191
SelectedSignature, 193
SelectedStepBatchID, 199
SelectedStepClass, 199
SelectedStepCommandSet, 200
SelectedStepControl, 201
SelectedStepEquipmentName, 201
SelectedStepEquipmentPath, 202
SelectedStepID, 203
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
SelectedStepIndex, 204
SelectedStepIsFailed, 205
SelectedStepKeyName, 205
SelectedStepMessage, 207
SelectedStepName, 208
SelectedStepParameters, 209
SelectedStepParameters2, 210
SelectedStepReports, 211
SelectedStepReports2, 212
SelectedStepRequest, 212
SelectedStepResourceID, 213
SelectedStepState, 214
SelectedStepStateNum, 215
SelectedStepString#, 216
SelectedStepType, 216
SelectedStepUnit, 217
SelectedTransitionAcquiring, 218
SelectedTransitionCondition, 219
SelectedTransitionFailure, 220
SelectedTransitionStateNum, 221
setting, 320
ShowConditions, 222
ShowCustomMenuItems, 223
ShowDisconnectedMessage, 224
ShowElapsedTime, 225
ShowFilter, 225
ShowMenu, 226
ShowRecipeLimits, 226
ShowRemainingTime, 227
ShowReportLimits, 228
ShowSetPoint, 228
ShowState, 229
ShowStatusBar, 229
ShowStepInstance, 231
ShowType, 231
ShowUnit, 232
ShowUnitsOfTime, 232
SignatureContextColumnText, 233
SignatureContextColumnWidth, 234
SignatureContextFilterPattern, 234
SignatureContextShowColumn, 236
Signatures, 236
SignoffMeaningColumnText, 237
SignoffMeaningColumnWidth, 237
SignoffMeaningFilterPattern, 238
SignoffMeaningShowColumn, 239
SignoffSecurityFilterPattern, 241
SignoffSecurityShowColumn, 242
SignoffSecurtiyColumnText, 240
SignoffSecurtiyColumnWidth, 240
Sorted, 243
SortKey, 244
SortOrder, 244
StartTimeColumnText, 245
StartTimeColumnWidth, 246
StartTimeFilterPattern, 247
StateColumnText, 248
StateColumnWidth, 249
StateFilterPattern, 250
StateShowColumn, 251
TextFont, 252
TimeColumnText, 252
TimeColumnWidth, 253
TimeFilterPattern, 254
TimeShowColumn, 256
TypeColumnText, 258
TypeColumnWIdth, 259
TypeFilterPattern, 259
TypeShowColumn, 261
UnitColumnText, 261
UnitColumnWidth, 262
UnitFilterPattern, 262
UnitsColumnText, 264
UnitsColumnWidth, 264
UnitsFilterPattern, 265
User, 266
UserContext, 267
ValueColumnText, 267
ValueColumnWidth, 268
ValueFilterPattern, 269
View, 270
Visible, 271
Zoom, 272
Properties dialog box
TimerView, 300
R
RecipeColumnText property, 183
RecipeColumnWidth property, 184
RecipeFilterPattern property, 185
recipes
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
adding a PC-based phase, 330
running with a PC-based phase, 330
Refresh method, 59
RefreshToken method, 59
remove tag locking, 341
RemoveControlRecipe method, 60
Report(N)
description, 334
summary, 338
Request
description, 334
summary, 338
request data tag, 341
RequestData(N)
description, 334
summary, 338
RestartControlRecipe method, 60
RestoreRequest
description, 334
summary, 338
ResumeControlRecipe method, 61
RetryPeriod property, 186
S
SecurityEnabled property, 187
SelectControlRecipe method, 62
SelectedControlRecipe property, 187
SelectedPrompt property, 191
SelectedSignature property, 193
SelectedStepBatchID property, 199
SelectedStepClass property, 199
SelectedStepCommandSet property, 200
SelectedStepControl property, 201
SelectedStepEquipmentName property, 201
SelectedStepEquipmentPath property, 202
SelectedStepFailure property, 203
SelectedStepID property, 203
SelectedStepIndex property, 204
SelectedStepIsFailed property, 205
SelectedStepKeyName property, 205
SelectedStepKeyVal property, 206
SelectedStepMessage property, 207
SelectedStepMode property, 207
SelectedStepName property, 208
SelectedStepParallelism property, 208
SelectedStepParameters property, 209
SelectedStepParameters2 property, 210
SelectedStepReports property, 211
SelectedStepReports2 property, 212
SelectedStepRequest property, 212
SelectedStepResourceID property, 213
SelectedStepState property, 214
SelectedStepStateNum property, 215
SelectedStepString# property, 216
SelectedStepType property, 216
SelectedStepUnit property, 217
SelectedTransitionAcquiring property, 218
SelectedTransitionCondition property, 219
SelectedTransitionEvaluation property, 219
SelectedTransitionFailure property, 220
SelectedTransitionState property, 221
SelectedTransitionStateNum property, 221
SelectPrompt method, 62
SelectSignature method, 63
SetColumnText method, 63
SetColumnWidth method, 64
SetControlRecipeMode method, 65
SetFilterPattern method, 65
SetShowColumn method, 67
ShowAboutBox method, 67
ShowColumn method, 68
ShowConditions property, 222
ShowCustomMenuItems property, 223
ShowDisconnectedMessage property, 224
ShowElapsedTime property, 225
ShowFilter property, 225
ShowMenu property, 226
ShowPropertiesDialog method, 68
ShowRecipeLimits property, 226
ShowRemainingTime property, 227
ShowReportLimits property, 228
ShowSetPoint property, 228
ShowState property, 229
ShowStatusBar property, 229
ShowStepIndices property, 230
ShowStepInstance property, 231
ShowType property, 231
ShowUnit property, 232
ShowUnitsOfTime property, 232
SignatureContextColumnText property, 233
SignatureContextColumnWidth property, 234
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
SignatureContextFilterPattern property, 234
SignatureContextShowColumn property, 236
SignatureIDIsValid method, 69
SignatureList control, 24, 299
Signatures property, 236
SignatureUI method, 69
SignoffIsValid method, 70
SignoffMeaningColumnText property, 237
SignoffMeaningColumnWidth property, 237
SignoffMeaningFilterPattern property, 238
SignoffMeaningShowColumn property, 239
SignoffSecurityFilterPattern property, 241
SignoffSecurityShowColumn property, 242
SignoffSecurtiyColumnText property, 240
SignoffSecurtiyColumnWidth property, 240
SimpleOnSelChange event, 286
SingleStep
description, 334
summary, 338
Sorted property, 243
SortKey property, 244
SortOrder property, 244
StartControlRecipe method, 71
StartTimeColumnText property, 245
StartTimeColumnWidth property, 246
StartTimeFilterPattern property, 247
StateColumnText property, 248
StateColumnWidth property, 249
StateFilterPattern property, 250
StateShowColumn property, 251
Status
description, 334
summary, 338
status bar
filter, 300
StepChangeCancel method, 71
StepChangeCommit method, 72
StepChangeStart method, 72
StepClick event, 286
StepDblClick event, 287
StepIndex
description, 334
summary, 338
StepIndexBuffer
description, 334
summary, 338
StepIndexInitialValue
description, 334
summary, 338
StopControlRecipe method, 73
T
tag locking, 341
tag separator, 341
TerminateState method
programming, 321
using, 339
TextFont property, 252
TimeColumnText property, 252
TimeColumnWidth property, 253
TimeFilterPattern property, 254
TimeOutPeriod property, 255
TimerView
appearance, 300
TimerView control, 26, 300
TimeShowColumn property, 256
Topic
description, 334
summary, 338
TopProcedureID property, 257
Transition Command methods, 339
TransitionClick event, 288
TransitionDblClick event, 288
TypeColumnText property, 258
TypeColumnWIdth property, 259
TypeFilterPattern property, 259
TypeShowColumn property, 261
U
Unit
description, 334
summary, 338
UnitColumnText property, 261
UnitColumnWidth property, 262
UnitFilterPattern property, 262
Units collection, 187
UnitsColumnText property, 264
UnitsColumnWidth property, 264
UnitsFilterPattern property, 265
updating the area model, 327, 345
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
upload request
warm restart, 330
UseDefaultDDETagName
description, 334
summary, 338
User property, 266
UserContext property, 267
V
ValueColumnText property, 267
ValueColumnWidth property, 268
ValueFilterPattern property, 269
verification method, 325
View property, 270
Visible property, 271
W
warm restart
upload requests, 330
WatchdogFailureValue
description, 334
summary, 338
WatchdogStatus
description, 334
summary, 338
WatchdogTimeout
description, 334
summary, 338
Z
Zoom property, 272
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Rockwell Automation Support
Rockwell Automation provides technical information on the web to assist you in using its products.
At http://www.rockwellautomation.com/support/, you can find technical manuals, a knowledge base of FAQs,
technical and application notes, sample code and links to software service packs, and a MySupport feature that you can
customize to make the best use of these tools. For an additional level of technical phone support for installation,
configuration, and troubleshooting, we offer TechConnect support programs. For more information, contact your local
distributor or Rockwell Automation representative, or visit http://www.rockwellautomation.com/support/.
Installation Assistance
If you experience a problem within the first 24 hours of installation, review the information that is contained in this
manual. You can contact Customer Support for initial help in getting your product up and running.
United States or Canada
1.440.646.3434
Outside United States or Canada
Use the Worldwide Locator at http://www.rockwellautomation.com/support/, or contact your local Rockwell Automation
representative.
New Product Satisfaction Return
Rockwell Automation tests all of its products to ensure that they are fully operational when shipped from the
manufacturing facility. However, if your product is not functioning and needs to be returned, follow these procedures.
United States
Contact your distributor. You must provide a Customer Support case number (call the phone number above to obtain one) to your distributor to
complete the return process.
Outside United States
Please contact your local Rockwell Automation representative for the return procedure.
Documentation Feedback
Your comments will help us serve your documentation needs better. If you have any suggestions on how to improve this
document, complete this form, publication RA-DU002, available at http://www.rockwellautomation.com/literature/.
Rockwell Automation Publication BATCH-RM211B-EN-P - November 2014
Supersedes Publication BATCH-RM211A-EN-E - March 2010
Copyright В© 2014 Rockwell Automation, Inc. All rights reserved.
Was this manual useful for you? yes no
Thank you for your participation!

* Your assessment is very important for improving the work of artificial intelligence, which forms the content of this project

Download PDF

advertisement