® B0193YB

REV C

I/A Series®
Batch Suite
User's Guide
July 30, 2001
Foxboro, FOX, FoxAPI, FoxView and I/A Series are trademarks of Invensys Systems, Inc.
Invensys is a trademark of Invensys plc.
ActiveX, Microsoft, MS-DOS, Windows and Windows NT are registered trademarks of Microsoft
Corporation.
Intel is a trademark of Intel Corporation.
NuTCRACKER is a trademark of DataFocus Inc.
PostScript is a trademark of Adobe Systems Inc.
All other brand names may be trademarks of their respective companies.

Copyright 1999-2001 Invensys Systems, Inc.

All rights reserved

SOFTWARE LICENSE AND COPYRIGHT INFORMATION

Before using the Invensys Systems, Inc. supplied software supported by this documentation, you
should read and understand the following information concerning copyrighted software.
1. The license provisions in the software license for your system govern your obligations
and usage rights to the software described in this documentation. If any portion of
those license provisions is violated, Invensys Systems, Inc. will no longer provide you
with support services and assumes no further responsibilities for your system or its
operation.
2. All software issued by Invensys Systems, Inc. and copies of the software that you are
specifically permitted to make, are protected in accordance with Federal copyright
laws. It is illegal to make copies of any software media provided to you by
Invensys Systems, Inc. for any purpose other than those purposes mentioned in the
software license.
Contents
Figures................................................................................................................................. xxv

Tables................................................................................................................................. xxix

Preface.............................................................................................................................. xxxiii
General Enhancements ........................................................................................................ xxxiii
80 Character String Variables ......................................................................................... xxxiii
Configure System to Support 2 or 3 Recipe Levels ......................................................... xxxiii
Configure System to Disable Retain Recipe Approvals when Syncing ............................ xxxiii
Phase and Phase Parameter Descriptions ........................................................................ xxxiii
Process Modeling ................................................................................................................ xxxiii
Enumeration Data Type ................................................................................................. xxxiii
Update Database Confirm Dialog .................................................................................. xxxiv
Unit of Measure for Process Variables ............................................................................ xxxiv
Train Attributes .............................................................................................................. xxxiv
Train Information Interface ........................................................................................... xxxiv
Material Management Enhancements ................................................................................. xxxiv
Material Characteristic Data Types ................................................................................ xxxiv
Recipe Management Enhancements .................................................................................... xxxiv
Unit Procedure Level in Recipe ...................................................................................... xxxiv
Recipe Unit Procedure Library ....................................................................................... xxxiv
Cut, Copy & Paste ......................................................................................................... xxxiv
Sort Formula Parameters ................................................................................................. xxxv
Printing Enhancements ................................................................................................... xxxv
Print Recipe Procedure Only ...................................................................................... xxxv
Recipe Print Preview ................................................................................................... xxxv
Gray Background Option Switch for Procedure Printout ........................................... xxxv
Tabular (Non-PostScript™) Reports ......................................................................... xxxv
Landscape or Portrait Orientation .............................................................................. xxxv
Validate All Recipes ......................................................................................................... xxxv
Synchronize All Recipes with Model ............................................................................... xxxv
Download Phase Type ..................................................................................................... xxxv
Security on Recipe Delete ............................................................................................... xxxvi
Batch Management Enhancements ..................................................................................... xxxvi
Improved Performance ................................................................................................... xxxvi
Procedure Execution Jumps ............................................................................................ xxxvi
Simulation At Runtime .................................................................................................. xxxvi
View & Adjust Allocation Queue ................................................................................... xxxvi
Batch View/Batch Display .............................................................................................. xxxvi
Batch Information Server .................................................................................................... xxxvi

iii
B0193YB – Rev C Contents

1. Welcome to I/A Series Batch ............................................................................................. 1

Overview of Capabilities ........................................................................................................... 1
Flexible Recipes and Process Lines ........................................................................................ 1
Process Modeling ................................................................................................................. 1
Creating and Linking Tags ................................................................................................... 2
Materials Tracking Management .......................................................................................... 3
Recipe Management ............................................................................................................. 3
Batch Management .............................................................................................................. 3
Scheduling ....................................................................................................................... 4
Batch Initialization .......................................................................................................... 4
Batch Management .......................................................................................................... 4
History ............................................................................................................................ 4
Batch History ....................................................................................................................... 5
Batch Reports ....................................................................................................................... 5
I/A Series Integration ................................................................................................................ 5
I/A Series Tag Management ................................................................................................. 5
Model Editor ................................................................................................................... 5
Tag Interface Management (TIM) Editor ........................................................................ 5
I/A Series Link Editor ...................................................................................................... 5
I/A Series TIM Shared Variable Utility ............................................................................ 6
Tag Communication ............................................................................................................ 6
Phase Logic Testing Tool (PhaseLogic) ............................................................................ 6
Process Status (ProcStatus) Tool ...................................................................................... 6
Batch Alarms ........................................................................................................................ 6
Extensibility .............................................................................................................................. 6
Managing I/A Series Batch Configurations ................................................................................ 7
I/A Series Batch Program Menus ............................................................................................... 7
I/A Series Batch Server ......................................................................................................... 7
Batch Configuration Client .................................................................................................. 7
Batch Runtime Client .......................................................................................................... 8
Information Server ............................................................................................................... 8
I/A Series Batch Programs ......................................................................................................... 9
Configuration Programs ....................................................................................................... 9
Environment Editor (EnvEdit) ........................................................................................ 9
Process Modeling Editor (ModelEdit) ............................................................................. 9
Tag Interface Management (TIM) Editor (TIMEdit) ...................................................... 9
I/A Series Link Editor (IALink) ....................................................................................... 9
Train Editor (TrainEdit) ................................................................................................. 9
Materials Editor (MaterialEdit) ....................................................................................... 9
Recipe Editor (RecipeEdit) .............................................................................................. 9
Process Log Editor (LogEdit) ........................................................................................... 9
Batch Reporting (BatchReport) ....................................................................................... 9
Security Editor (SecEdit) ............................................................................................... 10
Run-time Programs ............................................................................................................ 10
I/A Series Tag Driver (IADriver) ................................................................................... 10
Environment Manager (EnvMngr) ................................................................................ 10

iv
Contents B0193YB – Rev C

Environment Display (EnvDspl) ................................................................................... 10

Unilink Manager (UnilinkMngr) .................................................................................. 10
Simulation Manager (SimMngr) .................................................................................... 10
Information Manager (InfoMngr) ................................................................................. 10
Batch Manager (BatchMngr) ......................................................................................... 10
System Tag Manager (SysTagMngr) .............................................................................. 10
Event Manager .............................................................................................................. 11
Batch Logger (wwlogvwr) .............................................................................................. 11
Batch Scheduler (BatchSched) (Required in at least one station) .................................... 11
Batch Display (BatchDspl) ............................................................................................ 11
Process Logger Manager (LogMngr) .............................................................................. 11
Security Manager (SecMngr) ......................................................................................... 11
Alarm Comment Application (CommentApp) .............................................................. 11
Tag Interface Management (TIM) System Batch Process (TIMBatch) .......................... 11
Tag Interface Management (TIM) System Function Library Process (TIMFunc) .......... 11
Tag Interface Management (TIM) System Security Process (TIMSec) ........................... 11
Recipe Automation Server (RecipeEdit) ......................................................................... 12
Batch Talk Automation Server (OCXBATCH.OCX) ................................................... 12
Recipe Procedure SFC Active X Control (INBATCHSFC.OCX) ................................. 12
Material Automation Server (MATERIALSVR) ............................................................ 12
Batch Function Interface Type Libraries (BATCHOBJSRV.DLL &
BATCHVBSERVER.DLL) ........................................................................................... 12
Utility Programs ................................................................................................................. 12
Phase Logic Testing Tool (PhaseLogic) .......................................................................... 12
Change Password (ChgPwd) .......................................................................................... 12
ProcessStatus (ProcStatus) ............................................................................................. 12
I/A Series TIM Shared Variable Utility (IATim) ........................................................... 12
I/A Series Batch Configuration Architecture ........................................................................... 13
I/A Series Batch Runtime Architecture .................................................................................... 14

2. System Installation .......................................................................................................... 15

Installing Station Types ........................................................................................................... 17
Setting up an I/A Series Batch System ................................................................................ 17
Installing Microsoft SQL Server 7.0 SP2 ............................................................................ 18
Installing Seagate Crystal Reports Professional 8.0 ............................................................. 18
Installing I/A Series Batch Information Server Components ............................................... 19
Installing an I/A Series Batch Server ........................................................................................ 21
Installing an I/A Series Batch Runtime Client .................................................................... 22
Installing an I/A Series Batch Configuration Client ............................................................ 23
Installing Microsoft Internet Explorer 5 .................................................................................. 25
Installing Internet Information Server (IIS) ............................................................................. 25
Uninstalling I/A Series Batch Software .................................................................................... 26
Batch Runtime Client Uninstall ......................................................................................... 26
Batch Configuration Client Uninstall ................................................................................. 26
Batch Server Uninstall ........................................................................................................ 27
Batch Information Server Uninstall and Cleanup ............................................................... 27

v
B0193YB – Rev C Contents

Uninstall Batch Information Server ......................................................................... 28

Microsoft SQL Server 7.0 Cleanup ..................................................................................... 28
Remove report folders (optional) ................................................................................... 29
Upgrade an existing I/A Series Batch 7.x System ..................................................................... 30
Upgrade Preparation .......................................................................................................... 30
Upgrade I/A Series Batch History Database to v8.0 ............................................................ 30
I/A Series Batch Database Conversions ............................................................................... 35
Move I/A Series 7.x NT 4.0 History Databases to a Windows 2000 SQL Server ................ 37
Disconnect Users from Both SQL Servers ..................................................................... 37
Backup Procedure .......................................................................................................... 38
Restore Procedure .......................................................................................................... 38
Database Integrity Verification ...................................................................................... 39
Cleanup Procedure ........................................................................................................ 40

3. I/A Series Integration ...................................................................................................... 41

I/A Series Batch Responsibilities .............................................................................................. 41
Process Modeling ............................................................................................................... 41
Tag Linking and Validation ............................................................................................... 41
Material Management ........................................................................................................ 41
Recipe Management ........................................................................................................... 41
Batch Schedule Dispatching ............................................................................................... 41
Batch Execution ................................................................................................................. 41
Batch Displays .................................................................................................................... 42
Batch History ..................................................................................................................... 42
Batch Reporting ................................................................................................................. 42
Security .............................................................................................................................. 42
Process Logging .................................................................................................................. 42
I/A Series Control Suite Responsibilities ................................................................................. 42
Unit & Phase Logic Configuration ..................................................................................... 42
Unit & Phase Logic Execution ........................................................................................... 42
Unit & Phase Logic Monitoring ......................................................................................... 42
Alarm Detection & Annunciation ...................................................................................... 43
I/A Series Integration .............................................................................................................. 43
Tag Validation ................................................................................................................... 43
Tag Communications ......................................................................................................... 43
Batch Alarms ...................................................................................................................... 43
Viewing Batch Alarms with FoxAlert .................................................................................. 43
Append Comments to Alarm ............................................................................................. 43
Viewing Sequence Logic ..................................................................................................... 43
Custom Interfaces with FoxView ........................................................................................ 43

4. Environment Management System.................................................................................. 45

Using Environment Display .................................................................................................... 46
File Menu ........................................................................................................................... 47
File/Exit ......................................................................................................................... 47
File/Terminate App ....................................................................................................... 48

vi
Contents B0193YB – Rev C

File/Exit and Shutdown ................................................................................................. 48

Update Menu ..................................................................................................................... 49
Update/Environment .................................................................................................... 49
Update/Runtime ........................................................................................................... 49
Update/Configuration ................................................................................................... 50
View Menu ........................................................................................................................ 50
View/Status ................................................................................................................... 50
Help Menu ........................................................................................................................ 51
Help/Help Topics ......................................................................................................... 51
Help/About Environment Display ................................................................................. 51
Starting and Stopping I/A Series Batch Applications ............................................................... 52
Run-time Applications ....................................................................................................... 52
Using Environment Editor ...................................................................................................... 53
File Menu ........................................................................................................................... 54
File/Exit ......................................................................................................................... 54
Edit Menu .......................................................................................................................... 54
Edit/System Parms ........................................................................................................ 55
Help Menu ........................................................................................................................ 56
Help/Help Topics ......................................................................................................... 56
Help/About Environment Editor ................................................................................... 56
Adding Applications to the Environment ................................................................................ 56
Adding Applications ........................................................................................................... 57
Assigning Application Parameters ............................................................................................ 59
Application Parameter Descriptions ................................................................................... 60
Deleting Application Parameters ........................................................................................ 61
User-Defined (Other) Applications ......................................................................................... 62
User-Defined Application Parameters ................................................................................. 63
Using Environment Manager .................................................................................................. 64
Automatic Startup and Shutdown of Runtime ........................................................................ 64
Environment System Time-out .......................................................................................... 65
Considerations ................................................................................................................... 65

5. Process Modeling ............................................................................................................ 67

Comprehensive Model ....................................................................................................... 67
Connectionless Model ........................................................................................................ 68
Hybrid Model .................................................................................................................... 68
Model Approach Comparisons ........................................................................................... 69
Process Modeling Steps ...................................................................................................... 70
Units ....................................................................................................................................... 70
Process Classes (Processes) ...................................................................................................... 71
Connections ............................................................................................................................ 71
Transfer Classes (Transfers) .................................................................................................... 71
Define Process and Transfer Capabilities .............................................................................. 71
Phases ................................................................................................................................. 71

vii
B0193YB – Rev C Contents

Phase Types ........................................................................................................................ 72

Automatic Phases ......................................................................................................... 72
Manual Phases .............................................................................................................. 72
Semi-automatic Phases .................................................................................................. 72
Download Phases .......................................................................................................... 72
Phase Logic ........................................................................................................................ 73
Phase Parameters ................................................................................................................ 74
Formula Parameters ....................................................................................................... 74
Phase Control and Status Bits ........................................................................................ 74
Interlocks ....................................................................................................................... 74
Control Buttons ............................................................................................................ 74
Segments ................................................................................................................................. 75
Equipment Status .................................................................................................................... 76
Units of Measure ..................................................................................................................... 76
Enumeration ........................................................................................................................... 76
Tags ........................................................................................................................................ 76
Unit Tags ........................................................................................................................... 78
Process Tags ....................................................................................................................... 78
Connection Tags ................................................................................................................ 78
Transfer Tags ..................................................................................................................... 78
System Tags ....................................................................................................................... 78
Using Process and Transfer Tags versus Unit and Connection Tags ................................... 80
Tag Definition ........................................................................................................................ 81
Tagname ............................................................................................................................ 81
Tag Description ................................................................................................................. 83
Data Class .......................................................................................................................... 83
Access Mode ....................................................................................................................... 84
Process Modeling Summary .................................................................................................... 84
Example: Process Phases and Tags ........................................................................................... 85
Ramp Heat Phase Logic ..................................................................................................... 85
Process Tags and Unit Tags ................................................................................................ 85
Process Classes and Generic Phases in Recipe Editor .......................................................... 85
Batch Manager Resolves Process Tags into Unit Tags ......................................................... 86
Model Editor .......................................................................................................................... 87
Deleting Model Components ............................................................................................. 88
Using Model Editor ........................................................................................................... 89
File Menu ........................................................................................................................... 90
File/Validate .................................................................................................................. 90
File/Print ....................................................................................................................... 91
File/Print Preview ......................................................................................................... 91
File/Print Setup ............................................................................................................. 92
File/Exit ......................................................................................................................... 92
Edit Menu .......................................................................................................................... 92
Edit/Units ..................................................................................................................... 92
Edit/Processes ................................................................................................................ 92

viii
Contents B0193YB – Rev C

Edit/Connections .......................................................................................................... 92
Edit/Transfers ................................................................................................................ 92
Edit/Segments ............................................................................................................... 92
Edit/Equipment Status .................................................................................................. 92
Edit/Units of Measure ................................................................................................... 92
Edit/Enumeration ......................................................................................................... 93
Help Menu ........................................................................................................................ 93
Help/Help Topics ......................................................................................................... 93
Help/About Process Modeling ....................................................................................... 93
Units Tab ................................................................................................................................ 93
Adding Units ...................................................................................................................... 94
Changing Unit Names ....................................................................................................... 94
Deleting Units .................................................................................................................... 95
Editing Unit Tags .............................................................................................................. 95
Processes Tab ......................................................................................................................... 96
Adding Process Classes ....................................................................................................... 97
Changing Process Class Names .......................................................................................... 97
Deleting Process Classes ..................................................................................................... 98
Unit Control/State Tags ..................................................................................................... 98
Assigning Units .................................................................................................................. 98
Process Class Attributes .................................................................................................... 100
Assigning Unit Attribute Values ....................................................................................... 101
Editing Process Class Tags ................................................................................................ 102
Process Class Phases ......................................................................................................... 103
Save History ................................................................................................................ 104
Control Buttons .......................................................................................................... 105
Phase Control/Status Bits ............................................................................................ 106
Interlocks ..................................................................................................................... 107
Formula Parameters ..................................................................................................... 109
Automatic Process Phases ............................................................................................ 110
Formula Parameter Configuration of Automatic Process Phases .................................. 112
Manual Process Phases ................................................................................................. 116
Formula Parameter Configuration of Manual Process Phases ....................................... 117
Connections Tab ................................................................................................................... 117
Editing Connections ........................................................................................................ 118
Assign Source and Destination Units ........................................................................... 118
Assigning Segments to Connections ................................................................................. 120
Connection Tags .............................................................................................................. 121
Transfers Tab ....................................................................................................................... 122
Editing Transfers .............................................................................................................. 123
Assigning Source and Destination Process Classes ............................................................ 123
Assigning Connections ..................................................................................................... 125
Transfer Tags ................................................................................................................... 125
Editing Transfer Class Phases ........................................................................................... 127
Saving History ............................................................................................................. 128
Control Buttons .......................................................................................................... 129
Phase Control/Status Bits ............................................................................................ 130

ix
B0193YB – Rev C Contents

Interlocks ..................................................................................................................... 131

Formula Parameters ..................................................................................................... 133
Transfer Phase Configuration ........................................................................................... 134
Automatic and Semi-Automatic Transfer Phases ......................................................... 134
Formula Parameter Configuration of Automatic and Semi-Automatic
Transfer Phases ............................................................................................................ 136
Manual Transfer Phases ............................................................................................... 140
Formula Parameter Configuration of Manual Transfer Phases ..................................... 142
Segments Tab ........................................................................................................................ 143
Equipment Status Tab .......................................................................................................... 144
Units of Measure Tab ........................................................................................................... 146
Import and Export Units of Measure ............................................................................... 146
Enumeration Tab .................................................................................................................. 147
Editing Control Buttons ................................................................................................... 148
Assigning Tags to Buttons ........................................................................................... 149
Phase Control/Status Bits ................................................................................................. 149
Automatic Tag Creation and Assignment .................................................................... 149
Manual Tag Creation and Assignment ........................................................................ 151
Editing Interlocks ............................................................................................................. 151
Assigning Tags ............................................................................................................. 151
Editing Formula Parameters ............................................................................................. 153
Entering and Configuring Formula Parameters ........................................................... 155
Formula Parameter Examples ...................................................................................... 155

6. Tag Management .......................................................................................................... 161

Process Model Editor (ModelEdit) ........................................................................................ 162
Tag Interface Management (TIM) Editor ............................................................................. 162
Interfaces .......................................................................................................................... 162
Nodes ............................................................................................................................... 163
Using TIM Editor ............................................................................................................ 163
I/A Series Linker (IALink) ..................................................................................................... 165
Default Map File & Links ................................................................................................ 165
TagMap File ..................................................................................................................... 166
Default TagMap Functionality .................................................................................... 166
Control Signals ............................................................................................................ 166
Phase Block Interface ................................................................................................... 168
Unit Block Interface ......................................................................................................... 171
TIMMap File ................................................................................................................... 172
Default TIMMap Functionality .................................................................................. 172
StrMap File ...................................................................................................................... 173
Default StrMap Functionality ...................................................................................... 173
Using I/A Series Linker .................................................................................................... 174
File Menu .................................................................................................................... 176
Edit Menu ................................................................................................................... 180
View Menu .................................................................................................................. 180

x
Contents B0193YB – Rev C

The Filter Dialog Box ........................................................................................................... 181

Help Menu .................................................................................................................. 182
TIM Shared Variable Utility ................................................................................................. 182
Tag Communications Overview ............................................................................................ 183
IADriver ........................................................................................................................... 183
Process Status (ProcStatus) Display .................................................................................. 183
Using Process Status Display ................................................................................................. 184
PHASE_EXEC Sequence Block ............................................................................................ 185
PHASE_EXEC Configuration File Description ............................................................... 186
Using TIM Tags with a Control Processor ............................................................................ 188
I/A Series Batch Configuration Procedures ............................................................................ 189

7. Materials Editor............................................................................................................. 193

Using the Materials Status Window ...................................................................................... 194
File Menu ......................................................................................................................... 195
File/Validate ................................................................................................................ 195
File/Print ..................................................................................................................... 196
File/Print Preview File/Print Preview ........................................................................... 197
File/Print Setup ........................................................................................................... 198
File/Exit ....................................................................................................................... 198
Edit Menu ........................................................................................................................ 198
Edit/Materials Editor ................................................................................................... 198
Edit/Material Locations ............................................................................................... 199
View Menu ...................................................................................................................... 199
View/Assigned Units ................................................................................................... 199
View/Partial List .......................................................................................................... 199
View/Full List .............................................................................................................. 200
View/Find ................................................................................................................... 200
Help Menu ...................................................................................................................... 200
Help/Help Topics ....................................................................................................... 200
Help/About Materials Status ....................................................................................... 201
Using the Materials Editor .................................................................................................... 201
Using the Material Location Assignment Editor .................................................................... 203
Assigning a Material to a Unit .......................................................................................... 204
Define Lot Tracking Information ..................................................................................... 204

8. Recipe Editor................................................................................................................. 207

Header .................................................................................................................................. 207
Equipment Requirements ...................................................................................................... 208
Formula ................................................................................................................................ 208
Procedure .............................................................................................................................. 209
Unit Procedures ............................................................................................................... 210
Operations ....................................................................................................................... 210

xi
B0193YB – Rev C Contents

Phases ............................................................................................................................... 210

Parameters ........................................................................................................................ 211
Transition Logic ............................................................................................................... 212
Using Recipe Editor .............................................................................................................. 213
File Menu ......................................................................................................................... 214
File/New ..................................................................................................................... 214
File/Open .................................................................................................................... 215
File/Save ........................................................................................................................... 217
File/Delete Recipes ...................................................................................................... 218
File/Validate ................................................................................................................ 219
File/Approvals ............................................................................................................. 219
File/History ................................................................................................................. 220
File/Import/Export ...................................................................................................... 222
File/Save View Settings ................................................................................................ 223
File/Synchronize Recipes ............................................................................................. 223
File/Print ..................................................................................................................... 225
File/Print Preview ........................................................................................................ 226
File/Print Setup ........................................................................................................... 226
File/Exit ....................................................................................................................... 226
Edit Menu ........................................................................................................................ 227
Header .................................................................................................................................. 227
Edit/Recipe Header ..................................................................................................... 227
Equipment Requirements ...................................................................................................... 230
Assigning Process Classes .................................................................................................. 232
Editing Process Instances .................................................................................................. 233
Process Instances ........................................................................................................ 233
Assigning Units to Process Class Instances ................................................................... 234
Unit Selection Mode ................................................................................................... 235
Attributes .................................................................................................................... 236
Example Equipment Requirements ............................................................................. 237
Editing Transfer Instances ................................................................................................ 239
Transfer ....................................................................................................................... 239
Assigning Source and Destination Instances ................................................................ 240
Example Transfer Instance Selection ............................................................................ 242
Formula ................................................................................................................................ 243
Edit/Formula Inputs .................................................................................................... 244
Edit/Formula Outputs ................................................................................................. 248
Process Variables .............................................................................................................. 252
Edit/Process Variables .................................................................................................. 252
Unit Procedures Library ................................................................................................... 253
Operations Library ........................................................................................................... 254
Edit/Operations Library .............................................................................................. 254
Edit/Recipe States ........................................................................................................ 255
Edit/Recipe Types ....................................................................................................... 256
View Menu ...................................................................................................................... 257
View/Main Toolbar ..................................................................................................... 257
View/Unit Procedure Toolbar ..................................................................................... 257

xii
Contents B0193YB – Rev C

View/Operation Toolbar ............................................................................................. 258

View/Phase Toolbar .................................................................................................... 258
View/Status Bar ........................................................................................................... 258
View/Unit Procedure View .......................................................................................... 258
View/Unit Procedure Zoom In .................................................................................... 258
View/Unit Procedure Zoom Out ................................................................................. 258
View/Operation View .................................................................................................. 258
View/Operation Zoom In ............................................................................................ 259
View/Operation Zoom Out ......................................................................................... 259
View/Phase View ......................................................................................................... 259
View/Phase Zoom In ................................................................................................... 259
View/Phase Zoom Out ................................................................................................ 259
Help Menu ...................................................................................................................... 259
Help/Help Topics ....................................................................................................... 259
Help/About Recipe Editor ........................................................................................... 260
Building a Recipe Procedure ................................................................................................. 260
Procedure Layout ............................................................................................................. 260
Unit Procedures ........................................................................................................... 260
Sequence of Operations ............................................................................................... 261
Sequence of Phases ...................................................................................................... 261
Procedure Objects ............................................................................................................ 261
Unit Procedures Toolbar ............................................................................................. 261
Operations Toolbar ..................................................................................................... 262
Phases Toolbar ............................................................................................................ 264
Storing Unit Procedures ................................................................................................... 265
Loading a Unit Procedure ................................................................................................ 266
Unit Procedure ............................................................................................................ 266
Storing Operations ........................................................................................................... 266
Loading an Operation ...................................................................................................... 268
Operation Validity ...................................................................................................... 268
Recipe Procedure Mechanics ............................................................................................ 269
Inserting Procedure Objects ......................................................................................... 269
Transition Objects ....................................................................................................... 271
Branch Objects ............................................................................................................ 274
Branch Execute Types ................................................................................................. 275
Loop Objects ............................................................................................................... 276
Cutting and Copying Procedure Objects .......................................................................... 277
Pasting Procedure Objects ................................................................................................ 278
Deleting Procedure Objects .............................................................................................. 279
Moving and Nesting Procedure Objects ........................................................................... 285
Unit Procedure Properties ................................................................................................ 285
Operation Properties ........................................................................................................ 286
Phase Properties ............................................................................................................... 287
Phase Tab .................................................................................................................... 288
Instructions Tab .......................................................................................................... 290
Parameters Tab ............................................................................................................ 291
Input Phase Parameters ............................................................................................... 292
Output Phase Parameters ............................................................................................ 293

xiii
B0193YB – Rev C Contents

Process Variable Parameters ......................................................................................... 294

Document Tab ............................................................................................................ 294
Building Recipes in a Connectionless Process Model ............................................................. 295
Recipe Procedure Summary .................................................................................................. 296

9. Train Editor .................................................................................................................. 301

Using Train Editor ................................................................................................................ 301
File Menu ......................................................................................................................... 303
File/Print ..................................................................................................................... 303
File/Print Preview ........................................................................................................ 303
File/Print Setup ........................................................................................................... 304
File/Exit ....................................................................................................................... 304
Help Menu ...................................................................................................................... 304
Help/Help Topics ....................................................................................................... 304
Help/About Train Editor ............................................................................................ 304
Assigning Units to Trains ...................................................................................................... 304
Assigning Attributes to Trains ............................................................................................... 305

10. Batch Management System ......................................................................................... 307

Batch Management .......................................................................................................... 309
Using Batch Scheduler .......................................................................................................... 309
Starting Batch Scheduler .................................................................................................. 309
Batch Scheduler Operation ............................................................................................... 310
File Menu ......................................................................................................................... 310
File/Print ..................................................................................................................... 310
File/Print Preview ........................................................................................................ 311
File/Print Setup ........................................................................................................... 311
File/Exit ....................................................................................................................... 311
Edit Menu ........................................................................................................................ 312
Delete Batch ............................................................................................................... 312
Edit/Cleanup .............................................................................................................. 312
Move Up ..................................................................................................................... 312
Move Down ................................................................................................................ 312
View Menu ...................................................................................................................... 313
View/Batch Editor ....................................................................................................... 313
View/Undo Sorting .................................................................................................... 313
View/Filters ................................................................................................................ 313
View/Errors ................................................................................................................. 315
View/Toolbar .............................................................................................................. 315
View/Status Bar ........................................................................................................... 315
Initialize Menu ................................................................................................................. 316
Initialize/Batch ........................................................................................................... 316
Initialize/All ................................................................................................................ 316
Options Menu .................................................................................................................. 317
Options/Execute in Order .......................................................................................... 317
Help Menu ...................................................................................................................... 318

xiv
Contents B0193YB – Rev C

Defining a Batch .............................................................................................................. 318

Batch Identification ..................................................................................................... 318
Recipe Assignment ...................................................................................................... 319
Quantity Assignment ................................................................................................... 319
Train Assignment ........................................................................................................ 319
Batch Execution Mode ................................................................................................ 320
Status ........................................................................................................................... 320
Changing the Batch Schedule List .................................................................................... 321
Add ............................................................................................................................. 321
Change ........................................................................................................................ 321
Configuring Batch Scheduler ................................................................................................ 321
Batch Scheduler Parameters .............................................................................................. 322
Setting Batch Scheduler Properties ................................................................................... 322
Always on Top ............................................................................................................ 323
User can change – Schedule Filter ............................................................................... 323
Customize Main Toolbar ............................................................................................ 323
Permanently Dock Toolbar ......................................................................................... 324
Large Icons .................................................................................................................. 324
Batch View Startup Parameters .................................................................................... 325
Starting Batch View from Batch Scheduler ....................................................................... 325
Save Configuration ........................................................................................................... 325
Set Batch Schedule to Run Mode ..................................................................................... 325
Using Batch Schedule with Optimization Software ............................................................... 325
Using Batch View ................................................................................................................ 326
Configuring Batch View ................................................................................................... 326
Batch View Parameters ..................................................................................................... 327
Setting Batch View Properties .......................................................................................... 328
Always on Top ............................................................................................................ 329
View Type ................................................................................................................... 329
User Options Check Boxes .......................................................................................... 332
Customize Toolbars ..................................................................................................... 334
Permanently Dock Toolbar ......................................................................................... 335
Large Icons .................................................................................................................. 336
Batch Scheduler Startup Parameters ............................................................................ 336
Batch Alert .................................................................................................................. 336
Starting Batch Scheduler from Batch View ....................................................................... 336
Save Configuration ........................................................................................................... 336
Set Batch View to Run Mode ........................................................................................... 336
Using Batch Display .............................................................................................................. 336
File Menu ......................................................................................................................... 338
File/Exit ....................................................................................................................... 338
Actions Menu ................................................................................................................... 338
Actions/Manual Operation .......................................................................................... 338
Actions/Save Control Recipe ....................................................................................... 338
Actions/Activate Jump Mode ....................................................................................... 339
Windows Menu ............................................................................................................... 340
Windows/Schedule ...................................................................................................... 340

xv
B0193YB – Rev C Contents

Windows/Batch Messages ............................................................................................ 340

Windows/Equipment Allocation ................................................................................. 341
Windows/Phase Parameter Editor ............................................................................... 344
Windows/Transition Logic .......................................................................................... 344
Windows/FoxAlert ...................................................................................................... 344
Windows/Phase Sequence ............................................................................................ 344
View Menu ...................................................................................................................... 345
View/Errors ................................................................................................................. 345
View/Main Toolbar ..................................................................................................... 345
View/SFC Toolbar ...................................................................................................... 345
View/Fox Toolbar ....................................................................................................... 345
View/Unit Procedure View .......................................................................................... 345
View/Unit Procedure Zoom In .................................................................................... 345
View/Unit Procedure Zoom Out ................................................................................. 345
View/Operation View .................................................................................................. 346
View/Operation Zoom In ............................................................................................ 346
View/Operation Zoom Out ......................................................................................... 346
View/Phase View ......................................................................................................... 346
View/Phase Zoom In ................................................................................................... 346
View/Phase Zoom Out ................................................................................................ 346
View/Large Icons ......................................................................................................... 347
Help Menu ...................................................................................................................... 347
Help/Help Topics ....................................................................................................... 347
Help/About Batch Display .......................................................................................... 347
Batch Display Layout ....................................................................................................... 347
Batch Display Toolbar ................................................................................................. 348
SFC Toolbar ................................................................................................................ 349
Batch Identification ..................................................................................................... 349
Phase List .................................................................................................................... 349
Question List ............................................................................................................... 349
Batch Control Buttons ................................................................................................ 349
Phase Parameter List .................................................................................................... 350
Instruction List ............................................................................................................ 350
View Doc/Ack Doc Button ......................................................................................... 350
Phase Control Buttons ................................................................................................. 350
Sequence of Unit Procedures and Operations .............................................................. 350
Sequence of Phases ...................................................................................................... 350
Batch Display Functionality ............................................................................................. 351
Batch Control .............................................................................................................. 351
Batch Execution Mode ................................................................................................ 352
Phase Comments ......................................................................................................... 352
Phase Interlocks ........................................................................................................... 352
Equipment Selection ................................................................................................... 352
Phase Control and Status ............................................................................................. 353
Editing Formula Parameters ........................................................................................ 354
Answering Questions ................................................................................................... 354
Phase Acknowledgment ............................................................................................... 354
Phase Parameter Editor ................................................................................................ 354

xvi
Contents B0193YB – Rev C

Active Transition Objects ............................................................................................ 356

Using Batch View ................................................................................................................. 356
Starting Batch Manager ......................................................................................................... 357
Batch Execution .................................................................................................................... 357
Equipment Allocation ...................................................................................................... 357
Automatic Allocation and Release ................................................................................ 357
Recipe Allocation and Release ..................................................................................... 358
Manual Allocation and Release ................................................................................... 359
Batch Execution Modes .................................................................................................... 359
Automatic Batch Mode ............................................................................................... 359
Semi-Automatic Batch Mode ...................................................................................... 362
Manual Batch Mode .................................................................................................... 362
Batch Execution Mode Changes .................................................................................. 362
Unit Selection Modes ....................................................................................................... 363
Automatic Unit Selection ............................................................................................ 363
Manual Unit Selection ................................................................................................. 364
Process Phases .................................................................................................................. 364
Automatic Phases ......................................................................................................... 364
Manual Phases ............................................................................................................. 364
Process Phases with Material Input Parameters ............................................................ 364
Process Phases with Material Output Parameters ......................................................... 366
Transfer Phases ................................................................................................................. 366
Automatic Transfer Phases .......................................................................................... 366
Manual Transfer Phases ............................................................................................... 366
Transfer Phases with Material Input Parameters .......................................................... 366
Transfer Phases with Material Output Parameters ....................................................... 368
Continue Mode Execution ............................................................................................... 368
Contention for Shared Equipment ................................................................................... 369
Runtime Recipe Procedure Jumps - Jump Mode .............................................................. 370
Report Triggering ............................................................................................................. 371
End Of Batch Operation .................................................................................................. 371
Batch Runtime Errors ...................................................................................................... 371
Batch Schedule Errors ...................................................................................................... 373
Warm Restart ........................................................................................................................ 373
Starting Batch Manager with Warm Restart Function ...................................................... 373
Batch Execution ............................................................................................................... 374
Batch Restart Mode .......................................................................................................... 374
Control System Synchronization ...................................................................................... 375
Manual Operation ............................................................................................................ 376
Batch Display Attribute Considerations ....................................................................... 376

11. History System ............................................................................................................ 379

History Database Tables ....................................................................................................... 379
AlarmComment .......................................................................................................... 379
AnalogAlarm ............................................................................................................... 380
Archive History ........................................................................................................... 381

xvii
B0193YB – Rev C Contents

AuditEvent .................................................................................................................. 381

BatchAdmin ................................................................................................................ 382
BatchDetail ................................................................................................................. 382
BatchIdLog .................................................................................................................. 383
BatchQuestion ............................................................................................................. 384
BooleanAlarm .............................................................................................................. 384
CodeTable ................................................................................................................... 385
Config ......................................................................................................................... 387
DocViewEvent ............................................................................................................ 387
EquipStatus ................................................................................................................. 388
ErrorQ ........................................................................................................................ 389
Event ........................................................................................................................... 389
MaterialChar ............................................................................................................... 389
MaterialInput .............................................................................................................. 390
MaterialInputChange .................................................................................................. 390
MaterialOutput ........................................................................................................... 391
NonBatchOperatorActions .......................................................................................... 392
OperatorAction ........................................................................................................... 392
OperatorComment ...................................................................................................... 392
PhaseInstruction .......................................................................................................... 393
ProcessLog ................................................................................................................... 393
ProcessVar ................................................................................................................... 394
ProcessVarChange ....................................................................................................... 394
ReportDef ................................................................................................................... 395
ReportLog ................................................................................................................... 395
ReportOutputTypes .................................................................................................... 396
ReportPrinters ............................................................................................................. 396
ReportQueue ............................................................................................................... 396
ReportQueueParams .................................................................................................... 396
ReportViewers ............................................................................................................. 396
SequenceBlock ............................................................................................................. 397
Transition .................................................................................................................... 398
TransitionExpression ................................................................................................... 398
UserProfile .................................................................................................................. 398

12. Reporting System ........................................................................................................ 401

Reporting System Components ............................................................................................. 401
Information Server ........................................................................................................... 401
History Queue ................................................................................................................. 401
History Queue Reader ...................................................................................................... 401
Microsoft Internet Information Server (IIS) ..................................................................... 401
Report Client ................................................................................................................... 401
Report Configuration ....................................................................................................... 402
Report Queue ................................................................................................................... 402
Report Queue Reader ....................................................................................................... 402
Report Schedule ............................................................................................................... 402
Report View ..................................................................................................................... 402
Reporting System Architecture .............................................................................................. 402

xviii
Contents B0193YB – Rev C

Reporting System Security .................................................................................................... 403

Configuring Printers ............................................................................................................. 404
Using The Batch Reporting System ....................................................................................... 404
Batch Reporting ............................................................................................................... 405
Report Configuration ....................................................................................................... 406
Report Scheduling ............................................................................................................ 410
Add One Time Schedule ............................................................................................. 414
Add Daily Schedule ..................................................................................................... 415
Add Weekly Schedule .................................................................................................. 415
Add Monthly Schedule ................................................................................................ 416
Report Viewing ................................................................................................................ 419
Creating Reports ................................................................................................................... 422
Unsupported Report Templates ....................................................................................... 422

13. Process Logging........................................................................................................... 425

Process Log Criteria .............................................................................................................. 425
General Logging Criteria .................................................................................................. 425
Log Trigger ................................................................................................................. 425
Log Interval ................................................................................................................. 426
Data Destination ......................................................................................................... 426
Tags ................................................................................................................................. 427
Using Process Log Editor ...................................................................................................... 427
File Menu ........................................................................................................................ 427
File/New ..................................................................................................................... 427
File/Open .................................................................................................................... 428
File/Save ...................................................................................................................... 428
File/Validate ................................................................................................................ 429
File/Delete ................................................................................................................... 429
File/Print ..................................................................................................................... 429
File/Print Preview ........................................................................................................ 430
File/Print Setup ........................................................................................................... 431
File/Exit ....................................................................................................................... 431
Edit Menu ........................................................................................................................ 431
Edit/Groups ................................................................................................................ 432
Creating a Process Log Group ............................................................................................... 432
Using Process Log Manager .................................................................................................. 437
Starting Process Log Manager ........................................................................................... 437
Runtime Logging Criteria ................................................................................................ 438

14. Security System ........................................................................................................... 439

Using Security Editor ............................................................................................................ 440
Using Security Editor for the First Time .......................................................................... 441
File Menu ......................................................................................................................... 442
File/Validate ................................................................................................................ 442
File/Print ..................................................................................................................... 442

xix
B0193YB – Rev C Contents

File/Print Preview ........................................................................................................ 442

File/Print Setup ........................................................................................................... 443
File/Exit ....................................................................................................................... 443
Edit Menu ........................................................................................................................ 443
Edit/Security Levels ..................................................................................................... 443
Edit/Operator Stations ................................................................................................ 443
Edit/User Accounts ..................................................................................................... 443
Edit/Applications-Functions ........................................................................................ 443
Help Menu ...................................................................................................................... 443
Help/Help Topics ....................................................................................................... 444
Help/About Security Editor ......................................................................................... 444
Security System Configuration .............................................................................................. 444
Security Enabled ............................................................................................................... 444
Retries .............................................................................................................................. 444
Password Time-out .......................................................................................................... 444
Password Reuse ................................................................................................................ 444
Comment ......................................................................................................................... 444
Security Levels ....................................................................................................................... 444
Operator Stations .................................................................................................................. 445
User Accounts ....................................................................................................................... 446
Security Level ................................................................................................................... 448
Password .......................................................................................................................... 448
Recipes ............................................................................................................................. 449
Operator Stations ............................................................................................................. 449
Applications-Functions ......................................................................................................... 450
Adding a New Application ............................................................................................... 451
Enabling Application Security .......................................................................................... 452
Adding a New Function ................................................................................................... 453
Enabling Function Security .............................................................................................. 453
Application-Function Descriptions ................................................................................... 453
Run-time Security ............................................................................................................ 455
Starting the Security Manager .......................................................................................... 455
Changing Passwords ......................................................................................................... 455
Application Security Requests .......................................................................................... 456
Function Security Requests .............................................................................................. 456

15. Expression Editor ........................................................................................................ 459

Using Expression Editor ........................................................................................................ 459
Starting the Expression Editor .......................................................................................... 459
Editing an Expression ....................................................................................................... 459
Edit Buttons ..................................................................................................................... 460
Expression Elements .............................................................................................................. 461
Operators ......................................................................................................................... 461
Operands .......................................................................................................................... 462
Functions ......................................................................................................................... 462
Delimiters ........................................................................................................................ 463

xx
Contents B0193YB – Rev C

Expression Building Rules ..................................................................................................... 463

Expression Examples ............................................................................................................. 464

16. Phase Logic Development and Testing........................................................................ 467

Phase Block Design Guidelines ............................................................................................. 467
Definition of a Phase Block .............................................................................................. 467
Phase Block Rules of Operation ....................................................................................... 468
Function Block Diagram .................................................................................................. 468
Operational Flow Chart ................................................................................................... 469
Control System Memory Configuration ........................................................................... 470
Phase Block Memory Guidelines ................................................................................. 471
Control System Code Structure ........................................................................................ 471
Phase Block ................................................................................................................. 471
Complete Program ...................................................................................................... 473
Unit Control .................................................................................................................... 475
Hold Propagation ........................................................................................................ 477
Phase Control ................................................................................................................... 477
Phase Status ...................................................................................................................... 478
Formula Parameters .......................................................................................................... 480
Parameter Types .......................................................................................................... 480
Parameter Type Extensions .......................................................................................... 480
Definition of Parameter Extensions ............................................................................. 481
Control Buttons .......................................................................................................... 482
Interlocks ..................................................................................................................... 482
Alarms .............................................................................................................................. 483
Input and Output Control ............................................................................................... 483
Using the Phase Logic Testing Tool ...................................................................................... 484
Starting the Phase Logic Testing Tool .............................................................................. 484
File Menu ......................................................................................................................... 485
File/Exit ....................................................................................................................... 485
Help Menu ...................................................................................................................... 485
Help/Help Topics ....................................................................................................... 486
Help/About Phase Logic .............................................................................................. 486
Exercising Phases ................................................................................................................... 486

17. Tag Interface Management (TIM) System .................................................................. 487

TIM System Configuration ................................................................................................... 488
Tag Interface Management (TIM) Editor (TIMEdit) ....................................................... 488
TIMMap File ................................................................................................................... 488
I/A Link Editor (IALink) .................................................................................................. 488
I/A Series TIM Shared Variable Utility (IATIM) ............................................................. 488
TIM System Runtime ........................................................................................................... 489
TIM Batch Process (TIMBatch) ....................................................................................... 489
TIM Function Library Process (TIMFunc) ...................................................................... 489
TIM Security Process (TIMSec) ....................................................................................... 489
Batch Focus Versus Unit Focus ........................................................................................ 489

xxi
B0193YB – Rev C Contents

Working with List Tags ............................................................................................... 489

Actions Requiring Security Clearance .......................................................................... 490
Batch Function Interfaces ............................................................................................ 491
Tag Generation ........................................................................................................... 491
Batch Management System Interface ..................................................................................... 492
Manipulate the Batch Schedule ........................................................................................ 492
View and Adjust Allocation Queue .................................................................................. 498
Monitor and Control Active Batches ................................................................................ 500
Manipulate Recipe Focus ................................................................................................. 505
Monitor and Respond to Batch Questions ....................................................................... 506
Enter Batch Comments .................................................................................................... 508
Monitor and Control Active Phases .................................................................................. 508
Select Equipment for Allocation ....................................................................................... 517
Monitor Batch Messages .................................................................................................. 518
Description .................................................................................................................. 519
Edit Phases and Parameters .............................................................................................. 520
Monitor and Control Equipment ..................................................................................... 525
View/Force Transition Logic ............................................................................................ 528
Save Control Recipe ......................................................................................................... 531
Monitor and Respond to Errors ....................................................................................... 532
Batch Management System Interface Handshake Errors ................................................... 533
Security System Interface ...................................................................................................... 535
Interact with Security System ........................................................................................... 535
Security System Interface Handshake Errors ......................................................................... 537
Batch Function Interface ....................................................................................................... 539
Phase Prepare/Complete ................................................................................................... 539
Evaluate Equipment for Allocation ................................................................................... 542
Log Equipment Status ...................................................................................................... 545
Equipment Allocation Changes ........................................................................................ 547
TIM Runtime Operation ...................................................................................................... 549

18. Batch Alarm ................................................................................................................ 551

BATCH_ID System Tag ...................................................................................................... 552
Event Manager ...................................................................................................................... 553
I/A Series Control Strategy - Alarm Considerations ............................................................... 553
Viewing Batch Alarms with FoxAlert .................................................................................... 555
Entering Alarm Comments with FoxAlert ............................................................................. 555
Unsuspending Equipment Phases with FoxAlert ................................................................... 555

19. Redundancy................................................................................................................. 557

Setting Up a Redundant I/A Series Batch Server ................................................................... 558
Network Overview ........................................................................................................... 558
Example of a Redundant Server Configuration ..................................................................... 558

xxii
Contents B0193YB – Rev C

RedCfg and Lmhosts File Examples ................................................................................. 559

RedCfg File Example ................................................................................................... 560
RedCfg File Structure ....................................................................................................... 560
Lmhosts File ................................................................................................................ 561
Hosts File .................................................................................................................... 561
Installing a Redundant Batch System .................................................................................... 561
Batch Client - Redundancy Configuration ....................................................................... 562
Server Configuration (Post-Server Installation) ............................................................ 562
Batch Client Configuration ......................................................................................... 562
Post-Installation Requirement .......................................................................................... 563
Redundancy Verification ....................................................................................................... 563
Redundancy Operation ......................................................................................................... 564
Directory Configuration ................................................................................................... 565
Initial System Startup ....................................................................................................... 565
RedMngr Startup Procedure ............................................................................................. 565
Typical Redundant Sequence of Operation ........................................................................... 566
Initial Startup ................................................................................................................... 566
Normal Runtime Operation ............................................................................................. 567
Backup System Failure ..................................................................................................... 567
Master System Failure ...................................................................................................... 567
Master System Failure while Backup’s Operating System is Failed .................................... 567
Failed System Recovery .................................................................................................... 568
Dual-Master Recovery ...................................................................................................... 568
Manual Switch-Over to Backup System ........................................................................... 568
Shutting Down a Redundant System ................................................................................ 568
Redundant System Points of Interest ..................................................................................... 569
Redundancy Status Utility (RedState) ................................................................................... 569

20. System Administration ................................................................................................ 571

Information Server Administration ....................................................................................... 571
History Administration .................................................................................................... 572
User Accounts ............................................................................................................. 574
Error Queue Administration ............................................................................................ 574
Information Server Configuration .................................................................................... 575
History Archiving ............................................................................................................. 576
Adding an Archive Job ................................................................................................. 577
Adding a Purge Job ...................................................................................................... 579
Adding a Restore Job ................................................................................................... 581
Completed Archives ......................................................................................................... 583
Report Log Administration .............................................................................................. 585
Changing an Information Server Assignment on a Batch Server ....................................... 586
Changing a Batch Server Assignment on an Information Server ....................................... 587
Backing Up I/A Series Batch Databases ................................................................................. 588
Using the DBCOPY Utility ............................................................................................. 588
Managing I/A Series Batch Configurations ............................................................................ 589

xxiii
B0193YB – Rev C Contents

Configuring I/A Series Subsystems for Windows NT Support .............................................. 599

I/A Series Control System ................................................................................................ 599
Configuring CP to generate a “return-to-normal” message for a
SENDCONF message ................................................................................................. 599
Enhanced Control Processor Software to Support LOOPID ....................................... 600
Configuring Alarm and Message Destination Group
Device Parameter for Each Compound ............................................................................ 600
Control Processor Custom Templates Files ................................................................. 601
I/A Series FoxAlert Alarm Subsystem ............................................................................... 602
Configuring I/A Series Operator Action Journal ................................................................... 605

Index .................................................................................................................................. 607

xxiv
Figures
1-1. I/A Series Batch Configuration Architecture ............................................................... 13
1-2. I/A Series Batch Runtime Architecture ........................................................................ 14
4-1. Environment Management System Architecture ......................................................... 46
5-1. Interface Between Phase Logic and Batch Management System .................................. 73
5-2. Process Modeling Summary ........................................................................................ 84
5-3. Example Plant ............................................................................................................. 87
5-4. Copying the Process Model Configuration Database ................................................... 88
5-5. Analog Process Variable Parameter Example ............................................................. 156
5-6. Discrete Process Variable Parameter Example ............................................................ 157
5-7. String Process Variable Parameter Example ............................................................... 158
5-8. Input Parameter Example .......................................................................................... 159
5-9. Output Parameter Example ....................................................................................... 160
6-1. I/A Series Batch Tag Management System ................................................................ 161
6-2. I/A Series Batch Default TagMap File ....................................................................... 167
6-3. Phase-Block Function Diagram ................................................................................. 169
6-4. Phase Block Control State Diagram .......................................................................... 170
6-5. Unit Block Function Diagram .................................................................................. 171
6-6. Unit Control State Diagram ...................................................................................... 172
6-7. I/A Series Batch Default TIMMap File ..................................................................... 173
6-8. Default StrMap File .................................................................................................. 174
6-9. I/A Series Linker ....................................................................................................... 176
6-10. The Generate Menu .................................................................................................. 179
6-11. I/A Series Batch Link Editor Parameter Linking ........................................................ 180
6-12. Filter Window ........................................................................................................... 181
6-13. ProcStatus Display Window ...................................................................................... 184
6-14. I/A Series Batch PHASE_EXEC Configuration File* ................................................ 187
7-1. Materials Editor ........................................................................................................ 194
8-1. Four Parts of a Recipe ............................................................................................... 207
8-2. Architecture of a Formula ......................................................................................... 209
8-3. Transfer and Process Instance Examples .................................................................... 231
8-4. Equipment Requirements Diagram Example ............................................................ 237
8-5. Process Class Instance Editor Window ...................................................................... 237
8-6. Transfer Class Instance Editor Window .................................................................... 243
8-7. Recipe Editor ............................................................................................................ 260
8-8. Branch Execute Types ............................................................................................... 276
8-9. Deleting a Heat Phase ............................................................................................... 280
8-10. Deleting the ManAdd Phase ...................................................................................... 282
8-11. Deleting an Entire Branch ......................................................................................... 283
8-12. Deleting a Loop ........................................................................................................ 284
8-13. Input Phase Parameters ............................................................................................. 292
8-14. Output Phase Parameters .......................................................................................... 293
8-15. Process Variable Parameters ...................................................................................... 294
8-16. Material Transfer Operation and Phase Procedure .................................................... 296
8-17. Operation and Phases ................................................................................................ 297

xxv
B0193YB – Rev C Figures

8-18. Operation Library ..................................................................................................... 298

8-19. Branch and Transition Objects ................................................................................. 299
8-20. Phase Properties ........................................................................................................ 300
9-1. Train Editor .............................................................................................................. 301
10-1. Batch Management ................................................................................................... 309
10-2. Batch Scheduler Window .......................................................................................... 310
10-3. Print Screen Window ................................................................................................ 311
10-4. Select Reports Window ............................................................................................. 311
10-5. Schedule Filters Window - CLB Tab ........................................................................ 313
10-6. Schedule Filters Window - Recipe Tab ..................................................................... 314
10-7. Schedule Filters Window - Train Tab ....................................................................... 314
10-8. Schedule Filters Window - Mode/Status Tab ............................................................ 315
10-9. Errors Window with Error Message .......................................................................... 315
10-10. Unexecutable Recipe ................................................................................................. 317
10-11. Batch Editor Window ............................................................................................... 318
10-12. Recipes Window ....................................................................................................... 319
10-13. Trains Window ......................................................................................................... 320
10-14. Batch Scheduler ........................................................................................................ 321
10-15. Batch Scheduler Properties ........................................................................................ 323
10-16. Customize Toolbar Window ..................................................................................... 324
10-17. Batch Scheduler Toolbar with Large Icons ................................................................ 324
10-18. Properties Window ................................................................................................... 329
10-19. Batch View - SFC ..................................................................................................... 330
10-20. Batch View - Equipment Allocation .......................................................................... 331
10-21. Batch View - Batch Detail ......................................................................................... 331
10-22. Batch View - Phase Control ...................................................................................... 332
10-23. Batch View - Batch Messages .................................................................................... 332
10-24. Unit Filter ................................................................................................................. 333
10-25. Unit Focus ................................................................................................................ 333
10-26. Customize Main Toolbar Buttons ............................................................................. 334
10-27. Customize for Toolbar Buttons ................................................................................. 334
10-28. Customize SFC Toolbar Buttons .............................................................................. 334
10-29. Customize Batch Toolbar Buttons ............................................................................ 335
10-30. Toolbars Docked at Bottom and Right of Screen ...................................................... 335
10-31. Save Control Recipe Screen ....................................................................................... 339
10-32. Schedule Window ..................................................................................................... 340
10-33. Batch Messages Window ........................................................................................... 341
10-34. Equipment Allocation Window ................................................................................ 342
10-35. Batch Display Window ............................................................................................. 348
10-36. Batch Mode Window ................................................................................................ 352
10-37. Comment Window ................................................................................................... 352
10-38. Equipment Selection Window .................................................................................. 353
10-39. Phase Parameter Editor Window ............................................................................... 355
10-40. Active Transitions Window ....................................................................................... 356
10-41. Units Sharing Equipment ......................................................................................... 369
10-42. Warm Restart Function ............................................................................................ 374
12-1. Reporting System Overview ...................................................................................... 403
13-1. Process Logging ......................................................................................................... 425

xxvi
Figures B0193YB – Rev C

13-2. Expression Editor Window ....................................................................................... 426

14-1. Security System ......................................................................................................... 440
14-2. Entering User ID and Password ................................................................................ 441
14-3. Print Window ........................................................................................................... 442
14-4. Select Reports Window ............................................................................................. 443
14-5. Security Levels Editor ................................................................................................ 445
14-6. Operator Stations Editor ........................................................................................... 446
14-7. User Accounts Editor ................................................................................................ 447
14-8. Assign Security Levels Window ................................................................................. 448
14-9. Change Password Window ........................................................................................ 448
14-10. Recipe Access Window .............................................................................................. 449
14-11. Operator Stations ...................................................................................................... 450
14-12. Applications Functions Editor ................................................................................... 451
14-13. Assign Security levels Window .................................................................................. 452
14-14. Change Password ...................................................................................................... 456
14-15. Security Clearance Request ....................................................................................... 456
14-16. Security Clearance Windows ..................................................................................... 457
15-1. Expression Editor ...................................................................................................... 460
16-1. Phase Logic ............................................................................................................... 469
16-2. Operational Flow Chart ............................................................................................ 470
16-3. General Phase Block Structure .................................................................................. 473
16-4. Complete Control System Program Structure ........................................................... 475
16-5. Phase Status .............................................................................................................. 480
16-6. Phase Logic Window ................................................................................................. 485
17-1. Tag Interface Management System ............................................................................ 487
17-2. Tags in Batch Scheduler ............................................................................................ 490
18-1. Major Elements of the Batch Alarm Subsystem ......................................................... 552
19-1. Redundant Server Configuration ............................................................................... 559
19-2. Redundant Functionality .......................................................................................... 565
20-1. Batch Info Server Administration Window ............................................................... 572
20-2. History Admin Window ........................................................................................... 573
20-3. Error Queue Admin Window ................................................................................... 575
20-4. Info Server Config Window ...................................................................................... 576
20-5. History Archive Window .......................................................................................... 577
20-6. Add Archive Page ...................................................................................................... 578
20-7. Add Purge Page ......................................................................................................... 580
20-8. Add Restore Page ...................................................................................................... 582
20-9. Completed Archives List ........................................................................................... 584
20-10. Completed Archives Details Page .............................................................................. 585
20-11. Report Log Administration Page ............................................................................... 586

xxvii
B0193YB – Rev C Figures

xxviii
Tables
2-1. Station Type Software Requirements .......................................................................... 15
2-2. Upgrading I/A Series Batch Databases ......................................................................... 35
4-1. Environment System Parameters ................................................................................. 55
4-2. Simulation Manager (SimMngr) ................................................................................. 60
4-3. Process Log Manager (LogMngr) ................................................................................ 60
4-4. Batch Manager (BatchMngr) ....................................................................................... 60
4-5. Batch Display (BatchDspl) .......................................................................................... 61
4-6. I/A Series Tag Driver (IADriver) ................................................................................. 61
4-7. Event Manager ............................................................................................................ 61
4-8. Application Types ....................................................................................................... 63
5-1. Comprehensive, Connectionless, and Hybrid Model Approaches ............................... 69
5-2. Process Modeling Steps ............................................................................................... 70
5-3. Download Phases ........................................................................................................ 72
5-4. Phase Parameters ......................................................................................................... 75
5-5. Tag Types and Usage .................................................................................................. 76
5-6. Unit, Connection and Segment Information ............................................................... 79
5-7. Critical Phase Logic Data Points ................................................................................. 80
5-8. Tagname Structure ...................................................................................................... 82
5-9. Delimiters ................................................................................................................... 82
5-10. Automatically Generated Tagnames ............................................................................ 82
5-11. Deleting Model Components ...................................................................................... 89
5-12. Phase Parameter Configurations ................................................................................ 111
5-13. Formula Parameter Configurations ........................................................................... 114
5-14. Phase Parameter Configurations ................................................................................ 116
5-15. Phase Parameter Configurations ................................................................................ 136
5-16. Formula Parameter Configurations ........................................................................... 139
5-17. Phase Parameter Configurations ................................................................................ 141
5-18. Formula Parameter Configurations ........................................................................... 142
5-19. Automatic Tagname Examples .................................................................................. 151
5-20. Formula Parameter Elements .................................................................................... 154
6-1. Interface Groups and Action Groups ......................................................................... 162
6-2. Default Map File ....................................................................................................... 165
6-3. Phase Level Signals .................................................................................................... 168
6-4. CSV Format .............................................................................................................. 177
6-5. Valid Tag Data Classes .............................................................................................. 178
6-6. Generate Tag Options ............................................................................................... 179
6-7. Filter Options ........................................................................................................... 181
6-8. Default Configurations for Phase Block Status Values ............................................... 186
6-9. Default Configurations for Unit and Phase Block Batch Control Values ................... 186
6-10. Phase Block Status/Unit Block Control Values ......................................................... 188
8-1. Examples of Unit Procedures and Process Class Instances ......................................... 210
8-2. Example Operations .................................................................................................. 210
8-3. Examples of Process and Transfer Phases ................................................................... 211
8-4. Examples of Formula Parameters ............................................................................... 211

xxix
B0193YB – Rev C Tables

8-5. Transition Logic Operators ....................................................................................... 212

8-6. Examples of Attribute Range Definitions .................................................................. 236
8-7. Example of Batch Management System Results ......................................................... 238
8-8. Phase Types .............................................................................................................. 271
8-9. Transition Expression Examples ............................................................................... 273
10-1. Batch Execution Modes ............................................................................................ 320
10-2. Batch Statuses ........................................................................................................... 320
10-3. Batch Scheduler Parameters ...................................................................................... 322
10-4. Batch View Parameters .............................................................................................. 327
10-5. Phantom Batch ......................................................................................................... 338
10-6. Status Color Codes ................................................................................................... 350
10-7. SFE Phase Status Color Codes .................................................................................. 350
10-8. Batch Status .............................................................................................................. 351
10-9. Phase Statuses ........................................................................................................... 353
10-10. Possible States at System Shutdown .......................................................................... 375
10-11. Tag Data Class and Element Relationships ............................................................... 377
11-1. AlarmComment ........................................................................................................ 379
11-2. AnalogAlarm ............................................................................................................. 380
11-3. ArchiveHistory .......................................................................................................... 381
11-4. AuditEvent ................................................................................................................ 381
11-5. BatchAdmin .............................................................................................................. 382
11-6. BatchDetail ............................................................................................................... 383
11-7. BatchIdLog ............................................................................................................... 383
11-8. BatchQuestion .......................................................................................................... 384
11-9. BooleanAlarm ........................................................................................................... 384
11-10. CodeTable ................................................................................................................ 385
11-11. DocViewEvent .......................................................................................................... 388
11-12. EquipStatus ............................................................................................................... 388
11-13. ErrorQ ...................................................................................................................... 389
11-14. Event ......................................................................................................................... 389
11-15. MaterialChar ............................................................................................................. 389
11-16. MaterialInput ............................................................................................................ 390
11-17. MaterialInputChange ................................................................................................ 391
11-18. MaterialOutput ......................................................................................................... 391
11-19. NonBatchOperatorActions ....................................................................................... 392
11-20. OperatorAction ......................................................................................................... 392
11-21. OperatorComment ................................................................................................... 393
11-22. PhaseInstruction ....................................................................................................... 393
11-23. ProcessLog ................................................................................................................ 394
11-24. ProcessVar ................................................................................................................. 394
11-25. ProcessVarChange ..................................................................................................... 394
11-26. ReportDef ................................................................................................................. 395
11-27. ReportLog ................................................................................................................. 395
11-28. ReportOutputTypes .................................................................................................. 396
11-29. ReportPrinters ........................................................................................................... 396
11-30. ReportQueue ............................................................................................................ 396
11-31. ReportQueueParams ................................................................................................. 396
11-32. ReportViewers ........................................................................................................... 396

xxx
Tables B0193YB – Rev C

11-33. SequenceBlock .......................................................................................................... 397

11-34. Transition ................................................................................................................. 398
11-35. TransitionExpression ................................................................................................. 398
11-36. UserProfile ................................................................................................................ 399
12-1. Report Configuration Parameters .............................................................................. 408
12-2. Report Schedule Properties ....................................................................................... 413
12-3. One Time Schedule .................................................................................................. 415
12-4. Add Daily Schedule ................................................................................................... 415
12-5. Add Weekly Schedule ............................................................................................... 416
12-6. Add Monthly Schedule ............................................................................................. 416
12-7. Unsupported Report Templates ................................................................................ 422
14-1. Application-Function Descriptions ........................................................................... 454
15-1. Operators .................................................................................................................. 461
15-2. Operands .................................................................................................................. 462
15-3. Functions .................................................................................................................. 463
15-4. Delimiters ................................................................................................................. 463
15-5. Tags .......................................................................................................................... 464
15-6. Expression Examples ................................................................................................. 465
17-1. Summary of Tags ...................................................................................................... 491
17-2. Manipulate the Batch Schedule Tags ......................................................................... 492
17-3. View and Adjust Allocation Queue Tags ................................................................... 498
17-4. Monitor and Control Active Batches Tags ................................................................ 501
17-5. Manipulate Recipe Focus Tags .................................................................................. 505
17-6. Batch Question Tags ................................................................................................. 506
17-7. Batch Comments Tags .............................................................................................. 508
17-8. Batch Phase Tags ...................................................................................................... 509
17-9. Batch Selection Tags ................................................................................................. 517
17-10. Batch Message Tags .................................................................................................. 519
17-11. Phase Editing Tags .................................................................................................... 520
17-12. Equipment Tags ........................................................................................................ 525
17-13. View/Force Transition Logic Tags ............................................................................ 528
17-14. Save Control Recipe Tags .......................................................................................... 531
17-15. Monitor and Respond to Error Tags ......................................................................... 533
17-16. Handshake Errors ..................................................................................................... 534
17-17. Security System Tags ................................................................................................. 535
17-18. Handshake Error Tags .............................................................................................. 538
17-19. Phase Prepare/Complete Tags ................................................................................... 539
17-20. Evaluate Equipment for Allocation Tags ................................................................... 542
17-21. Log Equipment Status Tags ...................................................................................... 545
17-22. Equipment Allocation Change Tags .......................................................................... 547
17-23. TIM Runtime Applications ....................................................................................... 549
19-1. Redundancy Status Values ........................................................................................ 569
20-1. Archive Job ............................................................................................................... 579
20-2. Purge Job .................................................................................................................. 581
20-3. Restore Job ................................................................................................................ 583
20-4. I/A Series Batch Configuration Directory Files .......................................................... 590

xxxi
B0193YB – Rev C Tables

xxxii
Preface
This manual is written for the individuals who will be configuring and applying the batch control
system. This includes process and control engineers, and experienced technicians who are very
knowledgeable about control system programming and process control.
Since the last release of the batch control system, the following enhancements and changes have
been made to the product.

General Enhancements
80 Character String Variables
Process Variables designated as type String now support 80 character string values.

Configure System to Support 2 or 3 Recipe Levels

A System Variable is provided that enables either 2 or 3 levels in the Recipe procedure. The
default setting is 3. System Variables are set using the Environment Editor, Edit pull down menu
selection.

Configure System to Disable Retain Recipe Approvals when

Syncing
A System Variable is provided that disables the capability to retain recipe approvals when syncing
recipes with the process model. System Variables are set using the Environment Editor, Edit pull
down menu selection.

Phase and Phase Parameter Descriptions

Phase Descriptions and Phase Parameter Descriptions are displayed in the Recipe Editor, Batch
Display and Batch View.

Process Modeling
Enumeration Data Type
The enumeration data type for process variables is now supported. Enumeration sets can be cre-
ated and assigned to process variables. For example, COLOR is an enumeration set. The value of
1 represents the color White, the value 2 represents the color Blue, and so on. The COLOR
enumeration set can be assigned to the process variable, probably of the same or similar name,
COLOR. When used in the system, the operator will see and use the string attribute of the enu-
meration, White, Blue, and so forth. The control system uses the integer representation of the
string, 1, 2, 3, and so forth. Enumerations provide users and operators with the textual descrip-
tions of process variables and allow the control system to use a corresponding numerical value.

xxxiii
B0193YB – Rev C Preface

Update Database Confirm Dialog

Whenever a user performs an “Update Runtime” or “Update Configuration” from the Environ-
ment Display a dialog (similar to the Windows® Explorer Confirm File Replace dialog) is dis-
played to confirm the action and allows the user to continue or reject the action. The dialog
indicates the time and date stamp of the configuration database and the runtime database.

Unit of Measure for Process Variables

A table of 16-character Units of Measure can be created, maintained and assigned to Process Vari-
ables in the system. Units of Measure need only be entered once in the system and are assigned to
process variables using a pull-down list.

Train Attributes
The capability to define train attributes with units of measure is provided. Two train attributes,
Capacity and Production Rate, are pre-defined system attributes. Users can also add their own
train attributes. Train attributes are used by external scheduling programs.

Train Information Interface

An interface is provided so that external applications can access train information and their
attributes. The Batch Suite NT system provides access to train information through the Recipe
Automation Server.

Material Management Enhancements

Material Characteristic Data Types
The capability to define Material Characteristics of data type String, Boolean and Integer, in addi-
tion to the previously supported Real data type, is now provided.

Recipe Management Enhancements

Unit Procedure Level in Recipe
All three levels of the recipe procedure as defined by ISA S88.01, that is, Unit Procedures, Unit
Operations and Phases, are supported.

Recipe Unit Procedure Library

The capability to save configured unit procedures to a library and retrieve and insert a unit proce-
dure from the library to a recipe procedure is provided.

Cut, Copy & Paste

The capability to select, cut or copy and paste a configured recipe unit procedure, operation or
phase in a recipe procedure is provided. The selected element can be pasted in the recipe again
and again.

xxxiv
Preface B0193YB – Rev C

Sort Formula Parameters

The Formula Inputs, Formula Outputs and Formula Process Variable editors now provide a sort-
ing capability for their list of parameters. The list of formula inputs, for example, can be sorted by
material id, material name, quantity, and so forth. by selecting the title of the column in the list.

Printing Enhancements
Print Recipe Procedure Only
The option to print only the recipe procedure without parameters is provided. Transition logic is
included in the printout.

Recipe Print Preview

The capability to preview a recipe printout is provided.

Gray Background Option Switch for Procedure Printout

The user can turn on or off, using a radio button, the gray background of a recipe procedure
printout.

Tabular (Non-PostScript™) Reports

Tabular (non-PostScript) reports are now available for printing all aspects of a recipe including:
Header, Formula, Equipment Requirements and Procedure.

Landscape or Portrait Orientation

Tabular reports can be configured to print in landscape or portrait orientation.

Validate All Recipes

A capability is provided in the recipe editor to validate all recipes in the recipe database against the
process model. The capability is accessed from the Recipe File pull down menu and is enabled by
selecting the “Validate Only” option button on the Validate and Synchronize dialog. The capabil-
ity provides a display of the results.

Synchronize All Recipes with Model

A capability is provided in the Recipe Editor to automatically update all recipe phases with the
process model phase. This capability is useful when a phase is modified in the process model, for
example, a phase parameter is changed or added, and the phase is used in one or more recipes.
Previously, each recipe had to be opened and the phase manually synchronized with the model.
Now, there is a facility that automatically updates all recipes that use the phase to reflect the
changed or added parameter using the default value, defined in the model, as the assigned recipe
value.

Download Phase Type

A new phase type, Download, has been added. Download type phases function exactly as Manual
phases with one exception – they do not require operator acknowledgement for the phase to exe-
cute. Download (as do Manual) type phases do not require phase control and status handshaking.

xxxv
B0193YB – Rev C Preface

Security on Recipe Delete

Security can now be applied to the Delete recipe function of the Recipe Editor. This capability is
configured using the Security Editor.

Batch Management Enhancements

Improved Performance
The Batch Manager (Batch Engine) has been enhanced to improve batch client responsiveness
when executing recipes that have phases with large numbers of parameters. Several other perfor-
mance improvement enhancements have been included in key areas.

Procedure Execution Jumps

The capability to restart execution of a recipe procedure after a jump forward or backwards in the
recipe procedure during or prior to the execution of a batch is supported. Appropriate limitations
based on the equipment allocated to the batch shall be imposed.
This capability has some limitations, especially when used in batches that have multiple units
allocated in a split-batch type scenario. Therefore, read the manual carefully before using this
capability.

Simulation At Runtime
The capability to execute a recipe in simulation mode while batches are executing is provided.

View & Adjust Allocation Queue

Batch Display and Batch View incorporate a view that allows a user to evaluate the batches that
are queued up for a unit and to adjust the queue as necessary. The user must have the proper secu-
rity privileges to access this capability.

Batch View/Batch Display

Security can now be configured for the FoxSFC function in Batch View and Batch Display. This
capability is configured using the Security Editor.

Batch Information Server

The Batch Information Server is a Windows NT® 4.0 or Windows 2000 computer platform that
utilizes Microsoft® SQL Server 7.0 (SP2) for batch history and reporting.
For reporting, the batch system uses Seagate Crystal Reports Professional 8.0. Access to the web-
based reporting system is achieved using Microsoft Internet Information Server (IIS) for web
server technology.
The web based reporting system uses Active Server Page (ASP) content and is accessed by
Microsoft Internet Explorer 5 browsers. Using the browser, users can configure, schedule, print
and view reports.
Examples of report templates are provided. However, they are not intended to satisfy your report-
ing requirements. It is therefore your responsibility to modify and enhance the templates and con-
figure all of the necessary reporting requirements.

xxxvi
1. Welcome to I/A Series Batch
This chapter provides a general overview and discussion of the capabilities of the I/A Series
Batch software, including process modeling, creating and using tags, recipe management,
materials tracking, batch management, history and reporting. It explains the interface between
I/A Series Batch software and I/A Series Control Suite software, including alarming and utility
programs.

Overview of Capabilities
I/A Series Batch is a flexible batch management system that is designed to be configured quickly
and easily once fundamental concepts are understood. It is extremely important to read this sec-
tion of the manual before attempting to use the batch system.
Once basic batch system concepts are understood, you should be able to build and edit configura-
tions quickly without using this manual. As with most menu driven systems, you will become
more proficient by using the manual as a reference to improve your understanding of the batch
system and how to apply features that may not be obvious.
Consistent with the Instrument Society of America (ISA) S88.01 standard, I/A Series Batch
allows you to create recipes quickly and easily and simulate their execution against a model of the
process – all before writing one line of control code. I/A Series Batch also provides complete pro-
duction history and materials genealogy.
I/A Series Batch’s powerful batch engine, combined with its integration to FoxView™, FoxAlert
and FoxSFC, means that you can reduce the cost and time to implement your batch-related
processes by up to 60% over competitive solutions.
I/A Series Batch provides out-of-the-box batch management functionality that eliminates the
need for unsustainable custom code in a programmable logic controller (PLC) or distributed con-
trol system (DCS) and dramatically reduces the life-cycle engineering effort. The sophisticated
batch engine is responsible for unit-to-unit material tracking, short term scheduling, dynamic
batch and equipment management, and batch history and reporting. The batch management sys-
tem also supports redundancy for critical applications.

Flexible Recipes and Process Lines

Within the batch control system, recipe procedures can be changed and new formula and process
lines can be easily re-configured, not re-engineered, for new product introductions. The batch sys-
tem is flexible because it lets you model your plant, create new process lines, manage recipes,
schedule and execute batches, and keep a history of all batch processing activity.
Flexibility in a batch process makes a plant more competitive. Improvements result because of
faster line changeovers, faster time-to-market for new products, quick response to customer
orders, accurate batch history, and consistent product quality.

Process Modeling
A batch processing plant consists of units and connections. Units process and/or hold materials
whereas connections transfer materials between units.

1
B0193YB – Rev C 1. Welcome to I/A Series Batch

A unit is a vessel that can hold and/or process materials. Some units have no processing capabili-
ties, as is the case with bulk storage vessels, manual add stations, and hold tanks. Other units have
significant processing capabilities, as is the case with most reactors, blenders, mixers, dryers,
retorts, and washers. Examples of processing capabilities are agitating, mixing, heating, cooling,
blending, and packaging. Other examples of units are storage tanks, silos, ovens, fillers, washers,
retorts, molders, bottlers, wrappers, cartoners and palletizers.
Connections consist of equipment such as pumps, valves, separators, condensers and flowmeters
that are necessary for transferring a product from one unit to another.
All units that have the same processing capabilities or perform the same function are grouped into
one process class. All the connections between the same two process classes are grouped into one
transfer class. Process Classes and Transfer Classes define a family of units and connections,
respectively. The ability to group units and connections into classes is the essence of a true flexible
batch system.
Processing and transferring capabilities are defined by phases. Each phase is an independent
action that may contain a unique set of Parameters. Parameters configure the phase based on rec-
ipe requirements. Phases can be automatically executed by the control system or manually exe-
cuted by an operator. The execution of automatic phases is performed by the control system using
Phase Logic.
Process Modeling is the process of identifying the processing capabilities of a plant. There are five
basic elements involved in any process modeling: defining the Units, Process Classes (Processes),
Connections, Transfer Classes (Transfers), and Processing Capabilities. The following guidelines
describe the basic steps that you use to develop a process model.:
1. Identify each unit and its attributes.
2. Group units into process classes.
3. Identify all connections between units.
4. Define all equipment segments and assign to connections.
5. Group connections into transfer classes.
6. Define the processing capabilities of each process class (phases and parameters).
7. Define the transferring capabilities of each transfer class (phases and parameters).
8. Define equipment statuses.
9. Define trains.
10. Develop phase logic.
An integral part of Process Modeling involves defining specific data points called Tags. Tags are
associated with all Units, Processes, Connections, and Transfers and allow data to move between
the batch system and the control system. Tags must be defined prior to configuring any of the
batch system programs. There is no limit to the number of tags that you can have in your batch
system.

Creating and Linking Tags

When the process model is created, tags are created for units, connections, segments, phases, and
phase parameters. There are other tags created by the Tag Interface Management (TIM) system
called TIM tags. TIM tags provide an interface to the I/A Series Batch Manager and Security
Manager so that I/A Series control logic and FoxView software can communicate and interact
with batch execution.

2
1. Welcome to I/A Series Batch B0193YB – Rev C

Model and TIM tags must be linked to I/A Series Control compound:block.parameter and shared
variable tags using the I/A Series Link Editor. The I/A Series Link Editor provides automatic and
manual linking of tags and validates that the tags exist in I/A Series Control.

Materials Tracking Management

Materials Tracking Management includes the ability to define materials as ingredients, intermedi-
ates, finished goods, by-products, and others. The ability to define characteristics is provided for
each material entered in the system.
The Materials Editor is used to track the location of materials that are stored in units. This usually
pertains to bulk ingredients and work-in-process (WIP) materials. The batch management system
uses the ingredient location data to determine where to get ingredients when a batch is to be pro-
duced. This capability allows ingredient locations to be independent of recipes and control pro-
grams, and permits ingredients to change locations with no effect on recipe execution.
The materials database is used by the Recipe Editor in the construction of recipes. Only materials
in the materials database can be used in recipes.
When new bulk ingredients are received, the unit location may be entered into the materials data-
base by plant personnel. A lot identification can also be assigned to the material. Multiple lots of
the same ingredient may be stored in the same vessel. The batch management system updates the
database when ingredients are used and when intermediates or finished goods are produced. The
database provides for easy access to WIP information and can be used to update higher level mate-
rial management and material resource planning (MRP) systems with ingredient usage informa-
tion, WIP, and finished goods production. The Materials Editor is not an inventory management
system, but may be used to complement existing systems.

Recipe Management
The I/A Series Recipe Management provides the capability to create recipes according to the
guidelines outlined in the ISA S88.01 Flexible Batch Standard. A three-level hierarchical approach
to recipe building features the use of unit procedures, operations and phases.
The batch management system provides recipe management that enables master recipes to be
constructed and edited. Master recipes are not process line specific; rather, they are equipment
independent. They can be assigned to any process line (train) that has units belonging to the
classes of process equipment defined in the recipe. A master recipe becomes a control recipe when
units, defined in the train, are dynamically allocated and used to produce a batch.
A master recipe is not necessarily size specific, but can be scaled to the batch size defined by pro-
duction scheduling. All formula quantities for ingredients, intermediates, by-products, and fin-
ished goods are entered as either actual quantities or can be expressed as a percent of the total
batch size. Quantities expressed in percentages are scaled by the batch management system when
the batch is executed.
The Recipe Editor provides several text and graphical editors to develop and maintain recipes.
Recipes can be saved, retrieved, and printed. A version history capability provides an accurate
time stamped history of all changes that have been made to the recipe.

Batch Management
Batch Management consists of batch scheduling, batch initialization, co-ordination of batch exe-
cution with the control system, interfacing with operators, and batch history activity. These con-
cepts are further described in the following section.

3
B0193YB – Rev C 1. Welcome to I/A Series Batch

Scheduling
Batch Scheduler is responsible for dispatching the batches that are ready to run to the plant oper-
ators. Scheduling involves the manual entry of the batch identification, master recipe, batch size,
and Train into the Batch Scheduler. Each batch that is added to the scheduler, must be initialized
before it can be executed.

Batch Initialization
Each batch must be initialized before it is executed. The initialization process involves validation
of the recipe, checking if the Train exists, checking if the bulk materials defined in the recipe are
available in the Train, ensuring that the recipe’s equipment requirements are satisfied by the Train,
and verifying that the Process Model database is compatible with the recipe.

Batch Management
Batch Manager directs and supervises the execution of each batch. Batch Manager interprets reci-
pes and enables the control system. Based on the recipe’s procedure, blocks of control software
referred to as phase blocks, are signaled for execution by Batch Manager. Phase block control
logic, located in the control system, is responsible for controlling the process. Prior to starting
each phase block, Batch Manager verifies that the phase block is ready for execution. If it is ready,
the phase parameter values are downloaded to the block, and then the block is started.
Batch Manager also interfaces with Batch Display and Batch View which provide a user interface
for operators. Batch Display and Batch View provide information about all batches that are ini-
tialized and/or executing in the system. Operators can put a batch or phase in hold. They can also
use the interface to restart and abort batches or phases. The interface also allows operators to
change phase parameter values, acknowledge the execution of phases, review phase interlock sta-
tuses, and enter comments during batch execution.
Batch Manager co-ordinates the usage of process units for each batch and is capable of managing
the simultaneous execution of a large number of batches. Each batch is a unique entity within the
batch system. In batch systems that contain simultaneous batch executions, contention for the
allocation of the same process units may occur. Batch Manager allocates units to batches as they
become available and releases the units when they are no longer required by the batch.
Flexible batch systems using controllers must take the approach in which a supervisory computer
becomes an active participant in batch execution. The reason for this is attributed to the very
sophisticated unit management in a flexible batch system. Most controllers do not have the ability
to program a unit manager that is capable of interpreting and executing recipe procedures that can
be constructed in the batch control system.
A master recipe uses classes of process units, not specific units. This means that phases pertain to a
class of units, not to a specific unit. When Batch Manager executes a master recipe, each phase
encountered is converted into a unit specific phase. This process is called master recipe to Partial
control recipe conversion. The Train assigned to produce the batch specifies all of the units that
can be used. The Batch Manager automatically converts the master recipe into a control recipe
based on the units found in the Train.

History
Batch Manager captures and stores all processing and operator activity during the execution of a
batch.

4
1. Welcome to I/A Series Batch B0193YB – Rev C

Batch History
I/A Series Batch uses Microsoft SQL Server for its historical database. This approach is very open
and allows easy access to all batch history.
The batch management system is responsible for logging all information related to the production
of a batch into the history database. This data includes all of the events, process data, production
information, material usage, operator comments, operator actions, equipment used to produce
the associated batch, and all batch-related process alarms.

Batch Reports
I/A Series Batch uses a web-based interface for report configuration, scheduling and viewing. The
reporting system utilizes Seagate Crystal Reports Professional for report development. This
approach is very flexible and allows the creation of custom reports. I/A Series Batch includes a set
of predefined report templates. Utilizing these templates, you can create customized reports to
suit your specific requirements. The batch system also allows you to configure and execute histor-
ical reports during runtime. Report execution can also be configured to automatically trigger dur-
ing batch execution or at the end of a batch.

I/A Series Integration

I/A Series Tag Management
I/A Series Batch interfaces to other I/A Series Control Suite components like Control Processors
and FoxView software through tags. There are several I/A Series Batch components that create,
edit, link, validate, communicate and, in general, manage tags. These components are discussed
below.

Model Editor
The Model Editor is used to construct the plant model consisting on units, connections, phases,
phase parameters and segments. Tags are automatically created using these names and are used by
the I/A Series Batch to communicate with I/A Series controllers.

Tag Interface Management (TIM) Editor

The Tag Interface Management (TIM) system is a tag-based interface to the Batch Manager and
the Security Manager. TIM is built on the Batch Talk API and Security API, but instead of using
C functions to interact with the manager, tags are used. The TIM system is configurable allowing
functionality to be enabled or disabled and the number of client nodes required to be defined.

I/A Series Link Editor

The tags created by the Model Editor and TIM must be linked to I/A Series
compound:block.parameter and shared variable tags using the I/A Series Link Editor. The Link
Editor provides capabilities to link tags automatically using default links, as defined in a Tag Map
file. TIM tags are also automatically linked using default links defined in the TIM Map file. Addi-
tionally, individual Model and TIM tags can be manually linked when the default links do not
apply. The Link Editor also validates Model and TIM tags to verify that the links are valid
I/A Series tags.

5
B0193YB – Rev C 1. Welcome to I/A Series Batch

I/A Series TIM Shared Variable Utility

The TIM Shared Variable Utility creates a system startup file that is used to create and register
shared variable names with the I/A Series Control system. The utility eliminates the need to man-
ually create these tags.

Tag Communication
All tag communication between the I/A Series Batch and I/A Series Control Suite is through the
FoxAPI™. Tag communication between I/A Series Batch and I/A Series Control Suite are used to
interface to unit control logic, phase logic and operator displays. There are two utilities or tools
available to diagnose, troubleshoot and exercise tag communications between I/A Series Batch
and I/A Series Control Suite.

Phase Logic Testing Tool (PhaseLogic)

The Phase Logic testing tool is used to test and exercise the handshake interface between the
Batch Manager and the I/A Series based phase logic. Phase Logic is a testing tool and should not
be used during normal operation.

Process Status (ProcStatus) Tool

The ProcStatus tool is used to monitor I/A Series Batch tags at run time.

Batch Alarms
Batch alarms, in I/A Series Batch, are captured, associated with a batch and stored in the history
database. The LOOPID parameter of the I/A Series compound is the key in accomplishing this
objective. All units, connections, and segments have system tags that reflect the batch to which
they are allocated. Each unit, connection and segment also has a corresponding I/A Series com-
pound or block in the I/A Series control station. The Batch Manager, when it allocates equipment
to a batch, writes the Batch ID to the equipment’s system tags. These tags are linked to the equip-
ment’s COMPOUND.LOOPID parameter. When alarms occur in the compound, an alarm mes-
sage is sent to I/A Series Batch where it is stored in the history database and annunciated in
FoxAlert.
The I/A Series Batch Display provides a capability to launch FoxAlert to view the alarms for a
selected batch. Additionally, from FoxAlert, an alarm can be selected and a comment can be
appended to it using the Alarm Comment Editor.

Extensibility
I/A Series Batch includes ActiveX™ objects, ActiveX Servers and a library of API functions that
allow integration with external applications such as ERP and scheduling systems. These features
allow you to develop custom applications that access the batch control system that share and
exchange formulas/recipes, materials and production results.
I/A Series Batch uses Microsoft SQL Server for its historical database. This approach is very open
and allows easy access to all batch history.
These features make it easy for you to integrate with enterprise resource planning (ERP) and
advanced planning systems (APS), allowing I/A Series Batch to be a key link in successful supply
chain management initiatives.

6
1. Welcome to I/A Series Batch B0193YB – Rev C

Managing I/A Series Batch Configurations

When the I/A Series Batch server is installed, a default folder structure is created. It is recom-
mended that you do not modify this structure except for one notable exception: the configuration
folder.
The I/A Series Batch configuration that you create is located in the
D:\IA Series Batch\cfg\config_A folder. When I/A Series Batch is running, it must find your con-
figuration in config_A. If you intend to develop other configurations, you should create a differ-
ent folder and move the contents of the configuration into it. For example, create a folder named
AnotherConfig, and then move the configuration files from config_A into it. You can then copy
an empty set of default database files from the dflt_cfg folder into the config_A folder. For infor-
mation on identifying configuration, see “Managing I/A Series Batch Configurations” on
page 589.

I/A Series Batch Program Menus

I/A Series Batch software is comprised of batch server and batch client options that are accessed
from program menus on your desktop. This section provides a summary of the various program
menu items associated with the server and client installations. For more information on installing
I/A Series Batch servers and clients, see Chapter 2 “System Installation”.

I/A Series Batch Server

When you install an I/A Series Batch Server, the following menu items appear in the Batch Server
menu. Each menu item is described below.

BatchLogger starts the BatchLogger application which displays all system activity, such
as starting and stopping of applications, warning messages, error messages,
and so forth.

Environment starts the Environment Display and initializes the background processes
Display necessary to access I/A Series Batch configuration and runtime applica-
tions.

Release Notes displays a summary of user documentation issues, and known issues and
solutions for the batch system.

What’s New displays a summary of the enhancements and features that are included in
the batch system.

Uninstall Batch starts the unInstallShield program which allows you to remove the
Server I/A Series Batch server from your computer.

Batch Configuration Client

When you install a Batch Configuration Client, a set of menus are created which contain the
I/A Series Batch Configuration Client submenu which contains the items described below.

Process Modeling Editor

starts Process Modeling Editor on the client.

7
B0193YB – Rev C 1. Welcome to I/A Series Batch

TIM Editor starts TIM Editor on the client.

I/A Series Link Editor

starts I/A Series Link Editor on the client.

Train Editor starts Train Editor on the client.

Material Editor starts Material Editor on the client.

Recipe Editor starts Recipe Editor on the client.

Batch Report starts Batch Report on the client.

Security Editor starts Security Editor on the client.

Process Log Editor starts Process Log Editor on the client.

UnInstall starts the unInstallShield program which allows you to remove the Batch
Configuration Client from your computer.

Batch Runtime Client

When you install a Batch Runtime Client, a menu is created which contains the Batch Runtime
Client submenu. The following summary describes these menu items and other installed
components.

Batch Display starts Batch Display on the client.

Batch View starts Batch View on the client.

Batch Scheduler starts Batch Schedule on the client

Batch Report starts Batch Report on the client.

unInstallShield starts the unInstallShield program which allows you to completely remove
the Batch Runtime Client from your computer.

Information Server
When you install an Information Server, a menu is created which contains the Batch InfoServer
submenu. The following summary describes these menu items and other installed components.

BatchAdmin starts the Batch Info Server Administration application.

BatchLogger starts the BatchLogger application which displays all system activity, such
as starting and stopping of applications, warning messages and error
messages.

Uninstall starts the unInstallShield program which allows you to remove the Infor-
Information Server mation Server software from your computer.

8
1. Welcome to I/A Series Batch B0193YB – Rev C

I/A Series Batch Programs

The following section summarizes the programs that are available from the Environment Editor.
Program summaries are divided into three categories: configuration programs, runtime programs
and utility programs.

Configuration Programs
The following configuration programs are used to develop and manage your batch system.

Environment Editor (EnvEdit)

(Required) The Environment Editor is used to define the batch configuration and runtime appli-
cations that are to be executed.

Process Modeling Editor (ModelEdit)

(Required) The Process Modeling Editor provides the capability for a user to create a process
model database. Only one Process Modeling Editor can run in a system at a time.

Tag Interface Management (TIM) Editor (TIMEdit)

(Required) The TIM Editor is used to define the I/A Series workstation nodes and the interface
functionality needed at each node. Based on the selected interfaces, a unique set of TIM tags is
created for each node.

I/A Series Link Editor (IALink)

(Required) The I/A Series Link Editor associates I/A Series Batch tags with I/A Series Control
tags.

Train Editor (TrainEdit)

(Required) The Train Editor is used to create production lines on which batches are scheduled.

Materials Editor (MaterialEdit)

(Required) The Materials Editor provides the capability for a user to create and edit a materials
database both on and offline. Multiple Materials Editors can run in a system enabling multiple
users to edit the same database simultaneously.

Recipe Editor (RecipeEdit)

(Required) The Recipe Editor provides the capability for a user to create and edit a recipe database
both on and offline. Multiple Recipe Editors can run in a system enabling multiple users to edit
the same database simultaneously.

Process Log Editor (LogEdit)

(Optional) The Process Log Editor is used to create, edit, and print batch-related data logging
configurations.

Batch Reporting (BatchReport)

(Optional) The BatchReport icon launches a web browser which provides access to the batch sys-
tem’s web-based reporting system.

9
B0193YB – Rev C 1. Welcome to I/A Series Batch

Security Editor (SecEdit)

(Optional) Security Editor allows you to define batch system users, user security levels, user
access, recipe access for each user, and the capability to enable/disable applications and functions
that require security.

Run-time Programs
The following run-time programs are used by the batch system during batch execution.

I/A Series Tag Driver (IADriver)

The I/A Series Tag Driver (IADriver) utilizes the FoxAPI for reading and writing tags between
I/A Series Batch components and I/A Series Control Suite components, such as FoxView software
and control stations. (Required for Run-time)

Environment Manager (EnvMngr)

(Required) The Environment Manager manages the execution of the batch run-time applications
defined with the Environment Editor.

Environment Display (EnvDspl)

(Required) The Environment Display is a client of the Environment Manager and provides a sin-
gle interface for starting and stopping all batch system GUI applications.

Unilink Manager (UnilinkMngr)

(Required) The Unlink Manager manages inter-process communications among all the batch
system applications.

Simulation Manager (SimMngr)

(Required for Simulation) The Simulation Manager replaces the communication drivers for a
batch system and allows the system to be executed without control system hardware present.

Information Manager (InfoMngr)

(Required) Information Manager provides general batch server information to client applications.

Batch Manager (BatchMngr)

(Required) Batch Manager interfaces with the process model, recipe, and materials databases. The
Batch Manager works in conjunction with the Batch Scheduler and Batch Display programs. The
Batch Manager executes all recipes, manages unit allocation, moves batch information to the his-
tory database queue, and triggers reports.

System Tag Manager (SysTagMngr)

(Required) The System Tag Manager is responsible for generating the system tags for all the
equipment in the process model.

10
1. Welcome to I/A Series Batch B0193YB – Rev C

Event Manager
(Required) Event Manager is an NT service that is automatically started when NT boots. The
Event Manager is the batch alarm services responsible for storing the batch-related alarm in the
batch historian.

Batch Logger (wwlogvwr)

(Optional) The Batch Logger displays messages for all system activity for the Batch Server, Run-
time Clients and Configuration Clients such as startup, shutdown, warnings and errors as well as
time and date stamps.

Batch Scheduler (BatchSched) (Required in at least one station)

Batch Scheduler interfaces with the Batch Manager and is used to construct a schedule of batches
to be executed. Multiple Batch Schedulers can run in a system.

Batch Display (BatchDspl)

(Optional) The Batch Display is a client of the Batch Manager, and provides all the run-time
information concerning the execution of a single batch. Multiple Batch Displays can run in a
system.

Process Logger Manager (LogMngr)

(Optional) The Process Logger Manager controls the data logging of any tag in the system accord-
ing to the logging configuration.

Security Manager (SecMngr)

(Required) Security Manager is used in batch and external applications to evaluate and respond to
requests for security clearance.

Alarm Comment Application (CommentApp)

(Optional) The Alarm Comment Application is launched from FoxAlert after a batch alarm is
selected. The application provides an interface for users to enter comments that are appended to
batch alarms.

Tag Interface Management (TIM) System Batch Process (TIMBatch)

(Optional) The TIM System Batch Process manages the run-time tag interface between the batch
management system and the workstations and/or control stations defined in the system.

Tag Interface Management (TIM) System Function Library Process

(TIMFunc)
(Optional) The TIM System Function Library Process manages the run-time tag interface
between the batch functions and the computers and/or controllers defined in the system.

Tag Interface Management (TIM) System Security Process (TIMSec)

(Optional) The TIM System Security Process manages the run-time tag interface between the
security system and the computers and/or controllers defined in the system.

11
B0193YB – Rev C 1. Welcome to I/A Series Batch

Recipe Automation Server (RecipeEdit)

(Optional) The Recipe Automation Server is an integral part of Recipe Editor and is installed on
the Batch Server and the Batch Configuration Client. (Refer to COM Technical Reference Guide
(B0193YC) for more information.)

Batch Talk Automation Server (OCXBATCH.OCX)

(Optional) The OCXBATCH.OCX is a background server supporting ActiveX technology that
provides all functionality provided by the Batch Talk API. This server is installed in the Batch
Server, Run-time and Configuration Clients. (Refer to COM Technical Reference Guide
(B0193YC) for more information.)

Recipe Procedure SFC Active X Control (INBATCHSFC.OCX)

(Optional) The SFC ActiveX Control is a GUI-based control for the recipe procedure. This con-
trol is installed in the Batch Server, Run-time and Configuration Clients. (Refer to COM Techni-
cal Reference Guide (B0193YC) for more information.)

Material Automation Server (MATERIALSVR)

(Optional) The Material Automation Server provides access to the Material database using
ActiveX technology. This server is installed in the Batch Server, Run-time and Configuration Cli-
ents. (Refer to COM Technical Reference Guide (B0193YC) for more information.)

Batch Function Interface Type Libraries (BATCHOBJSRV.DLL &

BATCHVBSERVER.DLL)
(Optional) The Batch Function Interface Type libraries are used to construct a Batch Manager in-
process server. The libraries provide access to the key events during batch execution. (Refer to
COM Technical Reference Guide (B0193YC) for more information.)

Utility Programs
Phase Logic Testing Tool (PhaseLogic)
(Optional) The Phase Logic module permits individual phase execution independent of any batch
operation.

Change Password (ChgPwd)

(Optional) The Change Password application permits you to interact with the security system
from the command line in order to change a user’s password. The Change Password utility is part
of the security system.

ProcessStatus (ProcStatus)
(Optional) The ProcessStatus application permits monitoring and changing any of the I/A Series
Batch equipment or TIM tags.

I/A Series TIM Shared Variable Utility (IATim)

(Optional) The I/A Series TIM Shared Variable Utility is used to create a system startup file that
creates shared variable names and registers them with the I/A Series system.

12
1. Welcome to I/A Series Batch B0193YB – Rev C

I/A Series Batch Configuration Architecture

ModelEdit TrainEdit MaterialEdit RecipeEdit

CfgModelDB MaterialDB RecipeDB

LogEdit TIMEdit EnvEdit SecEdit

SecurityDB CfgTIMDB EnvDB SecurityDB

IALink
TAGMAP CfgIALinkDB

SecEdit
TIMMAP

STRMAP
IATIM.hostname1 IATIM.hostname2 IATIM.hostnameN

Figure 1-1. I/A Series Batch Configuration Architecture

13
B0193YB – Rev C 1. Welcome to I/A Series Batch

I/A Series Batch Runtime Architecture

RecipeEdit MaterialEdit EnvMngr

EnvDB

Lock
Manager
RecipeDB MaterialDB BatchDB .BatchWR (lm_tcp)

BatchSched
(OCX Batch)

InfoMngr BatchMngr
SQL Server
BatchDspl
(OCX Batch,
SFCOCX)
TIMBatch
TIMSec
TIMFunc

TrainEdit UniLinkMngr SysTagMngr

ModelDB

SimMngr LogMngr
Batch History

IA Driver
IALinkDB TIMDB LogDB

IA Series
Control State

Figure 1-2. I/A Series Batch Runtime Architecture

14
2. System Installation
This section describes the installation options for your I/A Series Batch system components.
An I/A Series Batch system consists of several different station types. These include a Batch Server,
Information Server, and Batch Clients (Runtime and Configuration). Each station includes both
I/A Series Batch Software and third-party software. A typical batch system consists of a Batch
Server, an Information Server, and Batch Clients that are connected over a network.
The I/A Series Batch software is dependent on the presence of third-party software for proper
installation and operation. If the third-party software is not present, you are unable to install the
I/A Series Batch software.

NOTE
If you are installing an Information Server on a Windows NT 4.0 Server platform,
you will need to obtain the following third-party software from Microsoft
Corporation:

Microsoft Windows NT 4.0 Service Pack 5

Microsoft Windows NT 4.0 Option Pack

The table below summarizes the Station Type and the I/A Series Batch software and third-party
software installed on each.

Table 2-1. Station Type Software Requirements

I/A Series Batch Platform/Operating Included with

Station Type System Third Party Software Batch package
Information Server Windows 2000 Microsoft SQL Server Yes
Server Service Pack 1 7.0 Service Pack 2
Seagate Crystal Reports Yes
Professional 8.0
Windows NT 4.0 Windows NT 4.0 No
Server Service Pack 5 Service Pack 5
Seagate Crystal Reports Yes
Professional 8.0
Microsoft SQL Server Yes
7.0 Service Pack 2
Microsoft Internet Yes
Explorer 5
IIS (NT Option Pack 4) No
Windows NT 4.0 No
Service Pack 5
MDAC 2.1 (SP2) Yes

15
B0193YB – Rev C 2. System Installation

Table 2-1. Station Type Software Requirements (Continued)

I/A Series Batch Platform/Operating Included with

Station Type System Third Party Software Batch package
Batch Server AW70 [Windows NT 4.0 Microsoft Internet Yes
Service Pack 5] Explorer 5
Windows NT 4.0 No*
Service
Pack 5
Batch Runtime WP70 [Windows NT 4.0 Microsoft Internet Yes
Client or Workstation Service Pack 5] Explorer 5
Batch Configuration Windows NT 4.0 No*
Client Service
Pack 5
*Note: Not supplied by Foxboro.

NOTE
The Information Server can reside on either Windows 2000 Server or Windows NT
4.0 Server.

The recommended procedures for installing the third party software are
included in this chapter.

It is recommended that you upgrade older versions of Crystal Reports to Crystal

Reports Professional 8.0.

It is recommended that you do not install Crystal Reports (any version) on a

Batch Server Station.

If you are reinstalling I/A Series Batch software, see “Uninstalling I/A Series Batch
Software” on page 26.

The following diagram describes a possible network strategy that might be implemented as part of
your I/A Series Batch System.

NOTE
For information regarding Ethernet networking, refer to B0400BE I/A Series Ether-
net Networking.

16
2. System Installation B0193YB – Rev C

Corporate Network

I/A Series
Batch Information
Server

HUB

AW70 AW70 AW70

Batch Server or or
(For Redundant WP 70 WP70
System Configuration,
Batch Config Client Batch Runtime Client
see chapter 19.)

I/A NODEBUS

Control
Processors

Installing Station Types

The setup of an I/A Series Batch system is a two step process. For each station type you are
required to:
1. Install the required third-party software.

NOTE
If the required third party software is not installed then you will be unable to
install the I/A Series Batch software.

In order to install the I/A Series Batch software, you must be logged on as an
administrator or as a user with administrative privileges.

2. Install the I/A Series Batch software.

Setting up an I/A Series Batch System

Recommended sequence of installation.
1. Setup an I/A Series Batch Information Server.
a. If using Windows 2000 Server operating system:

17
B0193YB – Rev C 2. System Installation

♦
Execute the procedure for “Installing Microsoft SQL Server 7.0 SP2” on
page 18.
♦ Execute the procedure for “Installing Seagate Crystal Reports Professional
8.0” on page 18.
♦ Execute the procedure for “Installing I/A Series Batch Information Server
Components” on page 19.
b. If using Windows NT 4.0 Server operating system:
♦ Install Window NT 4.0 Server Service Pack 5.
♦ Execute the procedure for “Installing Microsoft SQL Server 7.0 SP2” on
page 18.
♦ Execute the procedure for “Installing Seagate Crystal Reports Professional
8.0” on page 18.
♦ Execute the procedure for “Installing Internet Information Server (IIS)” on
page 25.
♦
Execute the procedure for “Installing I/A Series Batch Information Server
Components” on page 19.
2. Setup an I/A Series Batch Server:
a. Execute the procedure for “Installing Microsoft Internet Explorer 5” on page 25.
b. Execute the procedure for “Installing an I/A Series Batch Server” on page 21.
3. Setup an I/A Series Batch Runtime Client or I/A Series Batch Configuration Client.
a. Execute the procedure for “Installing Microsoft Internet Explorer 5” on page 25.
b. Execute the procedure for “Installing an I/A Series Batch Runtime Client” on
page 22 or “Installing an I/A Series Batch Configuration Client” on page 23.

Installing Microsoft SQL Server 7.0 SP2

1. Insert the I/A Series Batch Disk 1 into the CD-ROM drive. The auto-run capability
of Windows starts the setup. If it does not, select Run from the Start menu and type
E:\IABatch\setup.exe (where E: is your CD-ROM drive).
2. On the Installation Options window, choose to install the prerequisite software.
3. On the System Installation Options window, enable the Install SQL 7.0 SP2 radio
button. Click Next.

NOTE
The SQL Server installation takes 10 or more minutes. After the installation com-
pletes, the station automatically restarts.

Installing Seagate Crystal Reports Professional 8.0

1. Insert the I/A Series Batch Disk 1 into the CD-ROM drive. The auto-run capability
of Windows starts the setup. If it does not, select Run from the Start menu and type
E:\IABatch\setup.exe (where E: is your CD-ROM drive).
2. On the Installation Options window, choose to install the prerequisite software.

18
2. System Installation B0193YB – Rev C

3. On the System Installation Options window, enable the Install Crystal Reports Pro-
fessional 8.0 radio button. Click Next.
4. Insert the I/A Series Batch Disk 2. After the CD is read. Click OK.
5. The Seagate Crystal Reports Professional Edition Setup window is provided. Click
Next.
6. The Seagate Crystal Reports Professional Setup window is displayed. Enable the I
accept the License Agreement radio button and click Next.
7. The Seagate Crystal Reports Professional Edition Setup window is displayed.
Enable the Typical radio button and click Next to begin the installation.
8. The Seagate Crystal Reports Professional Edition Setup window is displayed. Click
Next. The installation process is started and services are stopped as required. When
complete, the Seagate Software Registration Wizard is provided. Select Register
Later.
9. The last window is the Seagate Crystal Reports Professional Edition Setup window.
It will indicate the success of the installation. Click Finish.

Installing I/A Series Batch Information Server Components

This procedure will create the Batch History databases and install the required Information Server
components. The Information Server cannot be installed on a station that contains other
I/A Series Batch software. The following instructions assume that a network strategy has been
implemented that will provide communication between the Information Server, Batch Server, and
Batch Clients.
If you have not installed the required third party software, then a System Information window
will be displayed which will inform you of the third party software that is needed for the station.
You will not be able to install the I/A Series Batch software until the required third party software
is installed.
1. Insert the I/A Series Batch Disk 1 into the CD-ROM drive. The auto-run capability
of Windows will start the setup program. If it does not, select Run from the Start
menu and enter: E:\IABatch\setup.exe (where E: is your CD-ROM drive)
2. On the Installation Options window, choose to install the I/A Series Batch software.
3. You will be prompted to review the Release Notes. It is recommended that you review
the Release Notes, as they may contain important information regarding the installa-
tion procedure.

To view the Release Notes click Yes. When finished reviewing the Release Notes close
them and continue to the next step in this installation procedure.
4. If you chose not to review the Release Notes at this time, click No and continue to the
next step in this installation procedure.
5. Review the information in the Welcome window. Click Next when finished.
6. Read the I/A Series Batch License Agreement. Click Yes to accept the agreement. If
you click No to reject the agreement, the installation will exit. Click Next when
finished.
7. On the Select Components window, enable the Information Server checkbox. Dis-
able all other checkboxes.

19
B0193YB – Rev C 2. System Installation

8. On the SQL Server Login window:

a. Enter or select a Server.
b. Enable the User SQL Server authentication radio button.
c. For the Login Name enter sa. Leave the Password field blank.
d. Click OK to continue the installation.
9. On the History Database Creation window you can perform the following:
a. Accept the name and location of the History Database (default is BatchHistory).
b. Accept the name and location of the Log File (default is BatchHistory).

NOTE
It is recommended that you create the log files on a different physical drive than
where the database files are located.

c. Accept the Initial DB Size (MB) (default is 2).

d. Accept the Initial Log Size (MB) (default is 2).
Accept the defaults and then click Create Database to continue the installation.
10. On the Archive Database Creation window you can perform the following:
a. Accept the name and location of the Archive Database (default is
BatchArchive).
b. Accept the name and location of the Log File (default is BatchArchive).

NOTE
It is recommended that you create the log files on a different physical drive than
where the database files are located.

c. Accept the Initial DB Size (MB) (default is 2).

d. Accept the Initial Log Size (MB) (default is 2).
Accept the defaults and then click Create Database to continue the installation.

NOTE
The database creation process may take 10 or more minutes to complete.

11. On the Information Components window, accept the default Destination Folder or
browse to select a different location. Click Next to continue the installation.

NOTE
After clicking Next, a box will appear called “Updating Crystal Reports 8.0.”

12. On the I/A Series Batch Server Information window, enter the host name (computer
name) of your Batch Server in the Host1 field.

20
2. System Installation B0193YB – Rev C

NOTE
The Host1 field is case sensitive.

If you are installing a redundant system, see Chapter 19 “Redundancy” in this User’s
Guide.
13. Click Next to complete the installation. When the installation has completed, the sta-
tion must be restarted.
14. Enable the Yes, I want to restart my computer now radio button, and then click
Finished.

NOTE
When the Information Server is installed, the Report Path is C:\BatchInfoS-
erver\Crystal by default. The default Report Path is always associated with the C:
drive even if the Information Server is installed on a different drive. If the Informa-
tion Server is installed on a different drive, then Report Path must be edited using
the Config button on the Information Server's AdminWeb page. If you change the
Report Path, the ReportQReader service must be restarted. Users should consider
this when creating and editing recipes that include reports. For more information on
using the AdminWeb page, see Chapter 20 “System Administration”.

Installing an I/A Series Batch Server

If you have not installed the required third party software, then a System Information window is
displayed which will inform you of the third party software that is needed for the station. You can-
not install the I/A Series Batch software until the required third party software is installed.
If you are installing a redundant system, see Chapter 19 “Redundancy” in this User’s Guide.
1. From the control panel, disable the FoxAPI and FOX® I/A Series software from start-
ing when the station is restarted.
2. Restart the station.
3. Insert the I/A Series Batch Disk 1 into the CD-ROM drive. The auto-run capability
of Windows will start the setup. If it does not, select Run from the Start menu and
enter E:\IABatch\setup.exe (where E: is your CD-ROM drive).
4. On the Installation Options window, chose to install the I/A Series Batch software.
5. You are prompted to review the Release Notes. It is recommended that you review the
Release Notes, as they may contain important information regarding the installation
procedure.

To view the Release Notes click Yes. When finished reviewing the Release Notes
close them and continue to the next step in this installation procedure.

If you chose not to review the Release Notes at this time, click No and continue to
the next step in this installation procedure.
6. Review the information in the Welcome window and then click Next when you are
finished.

21
B0193YB – Rev C 2. System Installation

7. Read the I/A Series Batch License Agreement. Click Yes to accept the agreement. If
you click No to reject the agreement, the installation exits.
8. On the Select Components window, enable the Batch Server checkbox and then
click Next.

NOTE
The Batch Clients check box is enabled since the Batch Client applications are a
necessary part of a Batch Server installation.

9. On the Information Server Hostname window, enter the host name (computer name)
of your Information Server.

NOTE
The host name of the Information Server is case sensitive.

10. Click Next.

11. On the Setup Complete window, enable the No, I will restart my computer later radio
button. Remove the CD and click Finish.
12. From the control panel, check the box to re-enable FoxAPI and Fox I/A to start when
the station is restarted.
13. Restart the station.

Installing an I/A Series Batch Runtime Client

If you have not installed the required third party software then a System Information window will
be displayed which will inform you of the third party software that is needed for the station. You
will not be able to install the I/A Series Batch software until the required third party software is
installed.
If you are installing a redundant system, see Chapter 19 “Redundancy” in this User’s Guide.
1. From the control panel, disable FoxAPI and Fox I/A from starting when the station is
restarted.
2. Restart the station.
3. Insert the I/A Series Batch Disk 1 into the CD-ROM drive. The auto-run capability
of Windows starts the setup. If it does not, select Run from the Start menu and enter
E:\IABatch\setup.exe (where E: is your CD-ROM drive).
4. On the Installation Options window, choose to install the I/A Series Batch software.
5. You are prompted to review the Release Notes. It is recommended that you review the
Release Notes, as they may contain important information regarding the installation
procedure.

To view the Release Notes click Yes. When finished reviewing the Release Notes
close them and continue to the next step in this installation procedure.

If you chose not to review the Release Notes at this time, click No and continue to
the next step in this installation procedure.

22
2. System Installation B0193YB – Rev C

6. Review the information in the Welcome window and then click Next when you are
finished.
7. Read the I/A Series Batch License Agreement. Click Yes to accept the agreement. If
you click No to reject the agreement, the installation exits.
8. On the Select Components window, enable the Batch Clients checkbox. Disable all
other check boxes.
9. Click the Change button.
10. On the Select Sub-components window, enable the Batch Runtime Client checkbox.
Disable the Batch Configuration Client checkbox. Click Continue.
11. On the Select Components Sub-components window, click Next.
12. On the Information Server Hostname window, enter the host name of your Informa-
tion Server.

NOTE
The host name (computer name) of the Information Server is case sensitive.

13. Click Next.

14. On the I/A Series Batch Runtime Client Configuration Data window, enter the host
name (computer/letterbug) of your Batch Server.

NOTE
The host name of the Batch Server is case sensitive.

15. Click Next.

16. On the Setup Complete window, enable the No, I will restart my computer later radio
button. Remove the CD and click Finish.
17. From the control panel, check the box to re-enable FoxAPI and Fox I/A to start when
the station is restarted.
18. Restart the station.

Installing an I/A Series Batch Configuration Client

If you have not installed the required third party software then a System Information window will
be displayed which will inform you of the third party software that is needed for the station. You
will not be able to install the I/A Series Batch software until the required third party software is
installed.

NOTE
I/A Series applications need to be running on the client in order to map the net-
work drives during installation of Configuration and/or Runtime Client Options if
the client’s only connection to the server is through the Nodebus.

1. On the Batch Server, create a share for the D:\IASeriesBatch directory It is recom-
mended that you name the share “IABatch”.

23
B0193YB – Rev C 2. System Installation

2. On the station where you intend to install the I/A Series Batch Configuration Client,
map a drive to the Batch Server’s share for the D:\IASeriesBatch directory.
3. From the control panel, to disable FoxAPI and Fox I/A from starting when the station
is restarted.
4. Restart the station.
5. Insert the I/A Series Batch Disk 1 into the CD-ROM drive. The auto-run capability
of Windows starts the setup. If it does not, select Run from the Start menu and type
E:\IABatch\setup.exe (where E: is your CD-ROM drive).
6. On the Installation Options window, choose to install the I/A Series Batch software.
7. You are prompted to review the Release Notes. It is recommended that you review the
Release Notes, as they may contain important information regarding the installation
procedure.

To view the Release Notes click Yes. When finished reviewing the Release Notes
close them and continue to the next step in this installation procedure.

If you chose not to review the Release Notes at this time, click No and continue to
the next step in this installation procedure.
8. Review the information in the Welcome window and then click Next when you are
finished.
9. Read the I/A Series Batch License Agreement. Click Yes to accept the agreement. If
you click No to reject the agreement, the installation exits.
10. On the Select Components window, enable the Batch Clients checkbox. Disable all
other check boxes.
11. Click the Change button.
12. On the Select Sub-components window, enable the Batch Configuration Client
checkbox, disable the Batch Runtime Client checkbox, and then click Continue.
13. On the Select Components window, click Next.
14. On the Information Server Hostname window, enter the host name of your Informa-
tion Server.

NOTE
The host name (computer name) of the Information Server is case sensitive.

15. Click Next.

16. On the I/A Series Batch Configuration Client Configuration Data window, enter the
host name (computer name/letterbug) of the Batch Server and the letter of the local
drive that was mapped to D:\IASeriesBatch on the Batch Server.

NOTE
The host name of the Batch Server is case sensitive.

17. Click Next.

24
2. System Installation B0193YB – Rev C

18. On the Setup Complete window, enable the No, I will restart my computer later radio
button. Remove the CD and click Finish.
19. From the control panel, check the box to re-enable FoxAPI and Fox I/A to start when
the station is restarted.
20. Restart the station.

Installing Microsoft Internet Explorer 5

1. Insert the I/A Series Batch Disk 1 into the CD-ROM drive. The auto-run capability
of Windows will start the setup. If it does not, select Run from the Start menu and
type E:\IABatch\setup.exe where E: is your CD-ROM drive.
2. On the Installation Options window, choose to install the prerequisite software.
3. On the System Installation Options window, enable the Install Internet Explorer 5
radio button. Click Next.
4. Insert the I/A Series Batch Disk 2 into the CD-ROM drive. After the CD has been
read, click OK.
5. Read the instruction to reinsert I/A Series Batch Disk 1 after the Internet Explorer
installation has finished. Click OK.
6. Read the Internet Explorer 5 License Agreement. Enable the appropriate radio button
to accept or reject the agreement. If you do not accept the agreement, the installation
does not continue.
7. Choose the Typical installation. Click Next.
8. When the installation has finished, click Finish, restart the station.

Installing Internet Information Server (IIS)

NOTE
Software required for this section must be obtained from Microsoft.

NOTE
This procedure is only required if you are using the Windows NT 4.0 Server Oper-
ating System for your Information Server platform. The Windows 2000 Server
Operating system includes IIS.

1. Install Windows NT 4.0 Option Pack.

a. If a dialog pops up that states Setup detected that Windows NT 4.0 SP4 or greater
is installed on your machine. We haven't tested this product on SP4. Do you
wish to proceed?, answer Yes to proceed with the installation.
b. Read the End User License Agreement. Click Accept to accept the agreement. If
you click Decline to reject the agreement, the installation will exit.
c. Choose the Typical installation.
d. Accept the default settings for Microsoft Internet Information Server.

25
B0193YB – Rev C 2. System Installation

e. Accept the default setting for SMTP Service.

2. Install/reapply Windows NT 4.0 Service Pack 5.
a. Read the license agreement. Enable the Accept the License Agreement (must
accept before installing the Service Pack) checkbox.
b. If desired, enable the Backup files necessary to uninstall this Service Pack at a
later time (requires approximately 60 MB additional disk space) checkbox.
c. If desired, view the Readme file by clicking on the ReadMe button.
d. Click Install to install the service pack.
e. When prompted click Restart to complete the installation and restart the station.
3. Install MDAC 2.1 Service Pack 2.
a. Insert the I/A Series Batch Disk 1 into the CD-ROM drive. (If the auto-run capa-
bility of Windows starts the I/A Series Batch setup, then cancel it.)
b. Select Run from the Start menu and type E:\mdac_typ.exe where E: is your CD-
ROM drive.

NOTE
For more detailed information on installing IIS, see IIS 4.0 Recommended Installa-
tion Procedure at: www.microsoft.com/technet/support.

Uninstalling I/A Series Batch Software

Batch Runtime Client Uninstall
1. Select uninstall Batch Runtime Client from the Start > Programs > IA Series Batch >
Runtime Client menu.
2. The Confirm File Deletion dialog appears. Click Yes to continue the uninstall.
3. The Remove Programs From Your Computer dialog appears. This dialog will provide
the status of the uninstall.

NOTE
During the uninstall the Removed Shared File? Dialog may pop up. Click the Yes
To All button to remove all shared files.

4. At the completion of the uninstall, if it was unable to remove all items then click on
the Details button to view the items that were not removed. (This is most likely to
include \HistQ\histq.taf, and \bin\*.aeh files.) Make note of the items that were not
removed and click OK to close the Remove Programs From Your Computer dialog.
5. Remove all items that may have been left behind, including the \IASeriesBatch folder.
6. Restart the station.

Batch Configuration Client Uninstall

1. Unmap the drive to the Batch Server.

26
2. System Installation B0193YB – Rev C

2. Select uninstall Batch Configuration Client from the Start > Programs > IA Series
Batch > Configuration Client menu.
3. The Confirm File Deletion dialog appears. Click Yes to continue the uninstall.
4. The Remove Programs From Your Computer dialog appears. This dialog will provide
the status of the uninstall.

NOTE
During the uninstall the Removed Shared File? Dialog may pop up. Click the Yes
To All button to remove all shared files.

5. At the completion of the uninstall, if it was unable to remove all items then click on
the Details button to view the items that were not removed. (This is most likely to
include \HistQ\histq.taf, and \bin\*.aeh files.) Make note of the items that were not
removed and click OK to close the Remove Programs From Your Computer dialog.
6. Remove all items that may have been left behind, including the \IASeriesBatch folder.
7. Restart the station.

Batch Server Uninstall

1. Perform an Exit and Shutdown from Environment Display. Close the Batch Logger.
2. Select uninstall Batch Server from the Start > Programs > IA Series Batch > Server
menu.
3. The Confirm File Deletion dialog appears. Click Yes to continue the uninstall.
4. The Remove Programs From Your Computer dialog appears. This dialog will provide
the status of the uninstall.

NOTE
During the uninstall the Removed Shared File? Dialog may pop up. Click the Yes
To All button to remove all shared files.

5. At the completion of the uninstall, if it was unable to remove all items then click the
Details button to view the items that were not removed. (This is most likely to
include \config_A\host.dat, \config_A\vista.taf, \config_A\batchwr, \HistQ\histq.taf,
and \bin\*.aeh files.) Make note of the items that were not removed and click OK to
close the Remove Programs From Your Computer dialog.
6. Remove all items that may have been left behind, including the \IASeriesBatch folder.
7. Restart the station.

Batch Information Server Uninstall and Cleanup

The uninstall and cleanup of the Batch Information Server station is a multi step process:
1. Uninstall the Batch Information Server.
2. Cleanup Microsoft SQL Server 7.0
3. Remove report folders (optional).

27
B0193YB – Rev C 2. System Installation

Uninstall Batch Information Server

1. Select uninstall InformationServer from the Start > Programs > IA Series Batch >
BatchInfoServer menu.
2. The Confirm File Deletion dialog appears. Click Yes to continue the uninstall.
3. The Remove Programs From Your Computer dialog appears. This dialog will provide
the status of the uninstall.
4. At the completion of the uninstall, if it was unable to remove all items then click the
Details button to view the items that were not removed. (This is most likely to
include \AdminWeb, \ReportWeb, \bin\Scr8_webregfix.exe, \bin\BatchCOM-
Wrap.dll, \bin\wwdebug.dll, and \bin\*.aeh files.) Make note of the items that were
not removed and click OK to close the Remove Programs From Your Computer dia-
log.
5. Remove all items that may have been left behind, including the \BatchInfoServer
folder.
6. Restart the station
7. The Information Server uninstall does not remove the AdminWeb and ReportWeb
default websites from Microsoft Internet Information Server. To remove the websites,
use the following procedure:
a. For an Information Server installed on the Windows NT 4.0 Server operating sys-
tem: On the Start menu, select Programs > Windows NT 4.0 Option Pack >
Microsoft Internet Information Server > Internet Service Manager. This will start
the Microsoft Management Console. Expand the Internet Information Server
icon.
For an Information Server installed on the Windows 2000 Server operating sys-
tem: On the Start menu, select Programs > Administrative Tools > Internet Ser-
vices Manager. This will start the Internet Services Manager.
b. Expand the icon for the hostname of your Information Server.
c. Expand the icon for the Default Website.
d. Right click AdminWeb and select the Delete option.
e. Right click ReportWeb and select the Delete option.

Microsoft SQL Server 7.0 Cleanup

To remove items added to Microsoft SQL Server by the I/A Series Batch software, the following
steps should be performed:
1. Start Enterprise Manager (Start > Programs > Microsoft SQL Server 7.0 > Enterprise
Manager).
2. Expand the SQL Server tree (in the left window pane).
3. Remove history databases:
a. Expand the Databases tree (in the left window pane).
b. Place the mouse cursor over BatchArchive.
c. Right-click then select Delete.
d. Place the mouse cursor over BatchHistory.

28
2. System Installation B0193YB – Rev C

e. Right-click then select Delete.

4. Remove Extended Stored Procedures:
a. Expand the Master database tree (in the left window pane).
b. Double-click Extended Stored Procedures.
c. Select xp_ListReports (in the right window pane).
d. Right-click then select Delete.
e. Select xp_SyncReportLog.
f. Right-click then select Delete.
5. Remove Report Categories and Jobs:
a. Expand the Management tree (in the left window pane).
b. Expand the SQL Server Agent tree.
c. Select Jobs.
d. Right-click then select All Tasks > Manage Job Categories.
e. A Job Categories dialog will be displayed.
f. Select BatchArchives (0).
g. Click Delete.
h. Select BatchHistory (1).
i. Click Delete.
j. Click Close.
k. Select a job with Category BatchReports (in the right window pane)
l. Right-click then select Delete.
m. Repeat steps 4 and 5 for any other BatchReports job.
6. Remove Batch Logins:
a. Expand the Security tree (in the left window pane).
b. Select Logins.
c. Select BatchAdminUser (in the right window pane).
d. Right-click then select Delete.
e. Select BatchUser (in the right window pane).
f. Right-click then select Delete.
7. Remove log and data files:
The BatchHistory_Data.mdf, BatchArchive_Data.mdf, BatchHistory_Log.ldf,
BatchArchive_Log.ldf files should be removed from the station. The locations of these
files were specified during the SQL Database Creation portion of the Information
Server install.

Remove report folders (optional)

Report output files are not uninstalled nor are they archived. Report folders contain any report
file output as configured using the ReportWeb. Folder names are created by the user.

29
B0193YB – Rev C 2. System Installation

Upgrade an existing I/A Series Batch 7.x System

NOTE
You should always perform a complete backup of your batch system before perform-
ing a system upgrade.

Please read through all instructions before performing the upgrade.

Upgrade Preparation
1. All open batches should be closed prior to running the upgrade. The batch schedule is
not preserved by the upgrade.
2. Open the Environment Editor and make a note of your configuration settings. If you
have customized the environment, you will need to re-edit the settings after the
upgrade.
3. Make note of any customized settings that you made to the StrMap.txt, TagMap.txt,
and TIMMap.txt files. You will need to edit these files after the upgrade.
4. Make a backup copy of your configuration(s) by copying your d:\IASeries-
Batch\cfg\config_A (and other configuration folders if applicable) to a location out-
side of the IASeriesBatch directory.
5. In SQL Server, backup the I/A Series Batch history and archive databases.
6. Uninstall the existing system software as follows:
a. If applicable, un-map the drives to the Batch Server on the Batch Configuration
Client.
b. If applicable, uninstall the Batch Configuration Client and restart the station.
c. If applicable, uninstall the Batch Runtime Client and restart the station.
d. Perform the following on the Batch Server station:
♦ Disable Fox API and Fox I/A at startup.
♦ Change the startup type of the CSAD service to manual.
♦ Restart the station.
♦ Uninstall the Batch Server and restart the station.

NOTE
Delete any I/A Series Batch files and folders that remain after the uninstall process,
that is, d:\IASeries Batch.

Upgrade I/A Series Batch History Database to v8.0

1. If the existing SQL Server station is a server class machine that meets the minimum
requirements of the PSS then it may be used as the Information Server. On the SQL
Server station, install the prerequisite software for the Information Server as described
earlier in this chapter.

30
2. System Installation B0193YB – Rev C

NOTE
If you will not be converting your I/A Series Batch v7.x history databases then pro-
ceed to step 4.

! CAUTION
If you intend to use I/A Series Batch v7.x batch archive databases then they must be
converted to use the I/A Series Batch v8.0 schema. If you do not convert the archive
database and retain its v7.x format, then the restore function will place an old
schema in the v8.0 batch archive database. Therefore, when the next archive is
scheduled, it will fail because the schema is incorrect.

If your Batch Archive database is read-only you will need to remove this restriction.
Perform the following steps to remove the read-only restriction:

1.) From Enterprise Manager, select the appropriate SQL Server and then expand
the Databases folder.

2.) Right click the BatchArchive database and select Properties.

3.) On the BatchArchive Properties window, select the Options tab and then disable
the Read Only check box.

4.) Click OK to save the changes and close the BatchArchive Properties window.

5.) The BatchArchive database can now be upgraded.

2. If you are upgrading from I/A Series Batch v7.1, copy the\convert folder from Disk 1
to your local hard drive, and then proceed as follows to convert I/A Series Batch v7.1
history databases to v8.0. Otherwise proceed to step 3.
a. Create a User account for Fox on the Information Server station:
♦ Start the User Manager program (Start > Programs > Administrative Tools >
User Manager)
♦ On the User Menu, select New User.
♦ Enter the User name Fox. Enter the password and confirm it.

NOTE
The password that you enter must be identical to the Fox account on all other I/A
stations.

♦ Enable the User Cannot Change Password and Password Never Expires
checkboxes. Disable all other checkboxes.
♦ Click the Groups button.
♦ Select Administrators from the Not member of list and click Add.
♦ Click OK on the Group Memberships window.

31
B0193YB – Rev C 2. System Installation

♦
Click the Add button to add the user account.
♦ Close the User Manager program.
b. Create a SQL login for the new user account Fox:
♦ Start SQL Server Enterprise Manager (Start > Programs > Microsoft SQL
Server 7.0 > Enterprise Manager).
♦ Navigate to your SQL server by expanding the tree under the Microsoft SQL
Servers > SQL Server Group node of the tree in the left pane.
♦ Expand the tree under your SQL server and, in the Security folder, right click
the Logins icon. Choose New Login.
♦ On the General tab, enter Fox as the Name.
♦ Under Authentication, enable the Windows NT authentication radio button.
♦ From the Domain drop-down box, select the name of the station. This should
modify the Name entry to show <station name>/Fox.
♦ Ensure that the Grant access radio button is enabled.
♦ On the Server Roles tab, enable the System Administrators checkbox. This
will grant administrative privileges to the Fox login.
♦ Click OK and then close Enterprise Manager.
c. Run the Convert71.bat file that is located in the \convert folder. The syntax for
running the file is as follows:

Convert71 <ServNM> <HistDB> <ArchDB>

where:

<ServNM> is the name of the station where SQL Server resides (This is required).

<HistDB> is the name of the history database. By default, the name is

BatchHistory, and the command will use the default name if it is not given.

<ArchDB> is the name of the archive database. By default, the name is BatchAr-
chive, and the command will use the default name if it is not given.

Example:

“Convert71 IA_SQL BatchHistory BatchArchive”

d. Copy xp_ListReport.dll and xp_SyncReportLog.dll from the \convert folder to
\MSSQL7\binn.
e. Run the Convert711.bat file that is located in the \convert folder. The syntax for
running the file is as follows:

Convert711 <ServNM> <HistDB> <ArchDB>

where:

32
2. System Installation B0193YB – Rev C

<ServNM> is the name of the station where SQL Server resides. This is required.

<HistDB> is the name of the history database. By default, the name is BatchHis-
tory, and the command will use the default name if it is not given.

<ArchDB> is the name of the archive database. By default, the name is BatchAr-
chive, and the command will use the default name if it is not given.

Example:

“Convert711 IA_SQL BatchHistory BatchArchive”

3. If you are upgrading from I/A Series Batch v7.1.1, copy the\convert folder from Disk
1 to your local hard drive, and then proceed as follows to convert I/A Series Batch
v7.1.1 history databases to v8.0. Otherwise proceed to step 4.
a. Copy xp_ListReport.dll and xp_SyncReportLog.dll from the \convert folder to
\MSSQL\binn.
b. Run the Convert711.bat file that is located in the \convert folder. The syntax for
running the file is as follows:

Convert711 <ServNM> <HistDB> <ArchDB>

where:

<ServNM> is the name of the station where SQL Server resides (This is required).

<HistDB> is the name of the history database. By default, the name is BatchHis-
tory, and the command will use the default name if it is not given.

<ArchDB> is the name of the archive database. By default, the name is BatchAr-
chive, and the command will use the default name if it is not given.

Example:

“Convert711 IA_SQL BatchHistory BatchArchive”

4. Remove the Batch History MDB 7.1 and Batch History Server 7.1 DSNs from the
Batch Server station.
5. On the Information Server station, configure the BatchHistory DSN as follows:
a. In the Control Panel window, double-click the ODBC Data Sources icon.
b. In the ODBC Data Source Administrator window, select the System DSN tab.
c. Click Add.
d. In the Create New Data Source window, select SQL Server for the driver.
e. Click Finish.
f. In the Create a New Data Source to SQL Server window, enter BatchHistory for
the Name of the data source.
g. Select the SQL Server. Click Next.

33
B0193YB – Rev C 2. System Installation

h. Enable the With SQL Server authentication using a login ID and password
entered by the user radio button.
i. Click Client Configuration.
j. In the Edit Network Library Configuration window, enable the TCP/IP radio but-
ton. Click OK to close the window.
k. Enable the Connect to SQL Server to obtain default settings for the additional
configuration options checkbox.
l. Enter a Login ID and Password for an account with administrative privileges.
Default Login ID is “sa” and Password is blank.
m. Click Next.
n. Enable the Change the default database to: checkbox and then select your batch
history database.
o. Click Next.
p. When you have finished, click OK on the ODBC Data Source Administrator
window.
6. Complete the Information Server station setup as follows:
a. Insert the I/A Series Batch Disk 1 into the CD-ROM drive. The auto-run capabil-
ity of Windows will start the setup program. If it does not, select Run from the
Start menu and type E:\IABatch\setup.exe where E: is your CD-ROM drive.
b. On the Installation Options window, choose to install the I/A Series Batch
Software.
c. Review the information in the Welcome window. Click Next when finished.
d. Read the I/A Series Batch License Agreement. Click Yes to accept the agree-
ment. If you click No to reject the agreement, the installation will exit.
e. On the Select Components window, enable the Information Server checkbox.
Disable all other checkboxes.
f. Click the Change button.
g. On the Select Sub-components window, enable the Information Server Compo-
nents checkbox. If you are not using converted v7.1 history databases then enable
the SQL Database Creation checkbox. Otherwise, disable all other checkboxes.
Click Continue.
h. On the Select Components window, click Next.
i. On the Information Components window, accept the default Destination Folder
or browse to select a different location. Click Next to continue.
j. On the I/A Series Batch Server Information window, enter the host name (com-
puter/letterbug name) of your Batch Server in the Host1 field.

NOTE
The Host1 field is case sensitive.

k. Click Next to complete the installation.

34
2. System Installation B0193YB – Rev C

NOTE
If you are converting a configuration that contains a Report database, the conver-
sion utility will require that you enter a path name for the location on the Informa-
tion Server where report output files will be stored. It is recommended that you
create a folder on the Information Server for this purpose at this time.

7. Install an I/A Series Batch Server as described earlier in this chapter.

8. If applicable, install an I/A Series Batch Runtime Client as described earlier in this
chapter.
9. If applicable, install an I/A Series Batch Configuration Client as described earlier in
this chapter.

I/A Series Batch Database Conversions

In order to use a configuration created with I/A Series Batch v7.x in v8.0, the configuration must
be converted. Failure to convert the configuration may render the I/A Series Batch v8.0 system
unusable.
The following table describes the databases that are affected during an upgrade.

Table 2-2. Upgrading I/A Series Batch Databases

Database Conversion Requirements

Environment Required
Note: You must manually reconfigure the Environment database after
the conversion.
History Required
IA Link No conversion required
Materials Required
Note: Material characteristic values are converted to real data types.
Process Logger No conversion required
Process Model Required
Recipe Required
Report Required
Note: You will need to copy any custom Crystal Report files to the
Information Server. Do not overwrite any of the Crystal Report files
that were installed as part of the Information Server software.

Note: I/A Series Batch v8.0 does not support expression triggered
reports. If you were using expression triggered reports in a previous ver-
sion, they are converted when you upgrade the databases and they will
appear in the list of configured reports in the ReportWeb web page. The
report names will exist in the ReportDef table in batch history. How-
ever, even though these reports will be listed, they will not be generated.
Security Required

35
B0193YB – Rev C 2. System Installation

Table 2-2. Upgrading I/A Series Batch Databases (Continued)

Database Conversion Requirements

Tag Interface Required
Management (TIM)

To Convert I/A Series Batch Configuration Databases:

1. Start Environment Display and then perform an Exit and Shutdown.
2. Close Batch Logger.
3. To convert the configuration databases proceed as follows.
a. On the Batch Server station, select Run from the Start menu and enter D:\IASer-
iesBatch\bin\CvtMaster.exe.
b. Acknowledge the message to backup your configuration(s) and ensure that the
Information Server is operating properly.
c. Click the Configuration button to browse and select a location for the configura-
tion.
d. If applicable, enter a path name for the location on the Information Server where
report output files will be stored.
e. Click Convert.

When the conversion has finished, a window will display the databases that were
converted, those that failed to be converted or were skipped, and those that were
up to date. A detailed log of the conversion operations is contained in the
DbCvt.txt file. This file is located in the configuration folder specified earlier.
4. Copy the following files from the converted configuration to D:\IASeries-
Batch\cfg\config_A.

NOTE
Copy only the files listed here. Copying files not listed may overwrite more recent
files, rendering the I/A Series Batch software inoperative.

a. CfgIALinkDB.dat, dbd, and .key

b. CfgModelDB.dat, dbd, and .key
c. CfgTIMDB.dat, dbd, and .key
d. IALinkDB.dat, dbd, and .key
e. LoggerDB.dat, dbd, and .key
f. MaterialDB.dat, dbd, and .key
g. ModelDB.dat, dbd, and .key
h. RecipeDB.dat, dbd, and .key
i. SecurityDB.dat, dbd, and .key
j. TIMDB.dat, dbd, and .key

36
2. System Installation B0193YB – Rev C

NOTE
It is assumed that D:\IASeriesBatch\cfg\config_A contains empty databases. If it does
not, it is recommended that the contents of \config_A be deleted and the contents
of \dflt_cfg be copied to \config_A.

5. Start Environment Display.

6. Perform an Update > Environment.
7. Perform an Update > Runtime.

Move I/A Series 7.x NT 4.0 History Databases to a Windows

2000 SQL Server
The following section describes how to move a Windows NT 4.0 based history database to a
Windows 2000 SQL Server. To do this you will need to first disconnect all users from both SQL
Servers and then backup your existing databases on the Windows NT 4.0 system and then, from
the Windows 2000 SQL Server, perform a restore.

NOTE
The following procedures should be performed by individuals with experience in
SQL Server administration. In some cases, these procedures may need to be slightly
modified to accomodate different server configurations.

Disconnect Users from Both SQL Servers

1. Start the SQL Server 7.0 Enterprise Manager
Start > Programs > Microsoft SQL Server 7.0 > Enterprise Manager
2. Select Console Root, expand the Microsoft SQL Servers folder, select SQL Server
Group, and then right-click the required server and select Properties.
3. On the SQL Server Properties window, select the General tab.
4. In the Autostart policies when the operating system starts pane, disable the
Autostart SQL Server Agent and Autostart MSDTC checkboxes.
5. Click the Startup parameters button. On the Startup Parameters window, enter -m
in the Parameters box and then click Add.

The “-m” option enables the single user mode. Do not remove or change any parame-
ters that are already entered.
6. Click OK on the Startup Parameters window.
7. Click OK on the SQL Server Properties window.
8. In SQL Server Enterprise Manager, select Console Root, expand the Microsoft SQL
Servers folder, select SQL Server Group and then right-click the required server and
select Stop.
This will stop the selected SQL Server. If you are asked to stop other services, select
Yes for each request.

37
B0193YB – Rev C 2. System Installation

9. In SQL Server Enterprise Manager, select Console Root, expand the Microsoft SQL
Servers folder, select SQL Server Group and then right-click the required server and
select Start.

Backup Procedure
Backup the BatchHistory, BatchArchive, MSDB, and Master databases on the source machine. If
you are using tape backups, the following steps can be skipped and you can proceed directly to the
Restore procedure.

To Backup the Source Databases:

1. Start the SQL Server 7.0 Enterprise Manager
Start > Programs > Microsoft SQL Server 7.0 > Enterprise Manager
2. Select Console Root, expand the Microsoft SQL Servers folder, select SQL Server
Group, and then right-click the required server and expand the Database folder.
3. Right-click the Master database and select All Tasks > Backup Database from the
drop down menu provided.
4. On the SQL Server Backup window, enable the overwrite existing media radio but-
ton General tab. On the Options tab, enable the verify database and initialize and
label media checkboxes.
5. On the SQL Server Backup window General tab, click the Add button.
6. On the Choose Backup Destination window, append the File Name field with the
appropriate database name.

NOTE
When specifying the backup filenames, use filenames without spaces or special char-
acters. Also, there must be only one entry in the destination List Box.

7. Repeat the backup process for each of the BatchArchive, BatchHistory, and MSDB
databases.
8. Share the directory on the source machine (Windows NT 4.0 Server) where the back-
ups are located.
9. Using the share of the source computer, copy each of the backup files from the source
computer to the backup location C:\mssql7\backup\ directory of the destination com-
puter (Windows 2000 Server).

Restore Procedure
Restore the master database of the destination server from the backup of the master database of
the source computer (now located in the local backup directory C:\mssql7\backup).

NOTE
To restore the Master database, the destination SQL Server must be in the single
user mode.

38
2. System Installation B0193YB – Rev C

To Restore the Master Database:

1. Start the SQL Server 7.0 Enterprise Manager
Start > Programs > Microsoft SQL Server 7.0 > Enterprise Manager
2. Select Console Root, expand the Microsoft SQL Servers folder, select SQL Server
Group, and then right-click the required server and expand the Database folder.
3. Right-click the Master database, point to All Tasks > Restore Database... from the
drop down menu provided.
4. On the Restore Database window, enable the Restore: From Device radio button.
5. On the Restore Database window, click the Select Devices... button.
6. On the Choose Restore Devices window, click the Add... button.
7. On the Choose Restore Destinations window, click the ... button.
8. On the Backup Device Location window, select the master backup file now located in
the local backup directory (C:\mssql7\backup) and click the OK button.
9. On the Choose Restore Destination window, click the OK button.
10. On the Choose Restore Devices window, click the OK button.
11. On the Restore Database window Options tab, enable the Force restore over exist-
ing databases checkbox.

NOTE
Enable this checkbox only when restoring onto a system that has databases installed
already.

12. On the Restore Database window, click OK to start the Restore. A message notifies
you that the operation was successful and the server was stopped (this in not an error
message).

NOTE
Before you continue with this procedure, reverse single user mode setting of the
destination SQL server and restart the service. At this point it is likely that the His-
tory and Archive databases will be marked “suspect” and will appear gray in the
Enterprise Manager. This is to be expected and is not a problem.

13. Repeat the above restore process for each of the MSDB, BatchHistory, and BatchAr-
chive databases after reversing the single user mode.

Database Integrity Verification

Using Enterprise Manager, check the integrity of the new server using DBCC checkdb (database)
for each of the databases that were restored.
It is recommended that you create a backup (of the newly created databases) on the destination
machine for each of these media from the destination machine to verify proper functionality and
establish a valid starting point.

39
B0193YB – Rev C 2. System Installation

Cleanup Procedure
After completing the above steps, perform the following cleanup procedure.
1. Remove the share that you created in the Backup Procedure earlier in this section.
2. Ensure that the source database is not set to single user (-m) mode (that is, the “-m”
switch is removed – see Disconnect Users from SQL Server earlier in this section).
3. In the Autostart policies when the operating system starts pane, enable the
Autostart SQL Server Agent and Autostart MSDTC checkboxes.

40
3. I/A Series Integration
I/A Series Batch Suite encompasses a very broad set of hardware, software and services needed
to provide a complete batch solution. I/A Series Batch is a key software component of I/A Series
Batch Suite. I/A Series Batch is designed to work with components of I/A Series Control Suite
and I/A Series Information Suite. This chapter of the I/A Series Batch User’s Guide describes
the roles and responsibilities of each of the major components that make up the I/A Series Batch
Suite and how they are integrated to provide an environment for creating a world class batch
solution.

I/A Series Batch Responsibilities

Process Modeling
Model Editor is a tool used to define the physical equipment and capabilities of the plant. The
process model takes the form of units, connections, segments, phases, phase parameters, equip-
ment status and trains. As equipment and capabilities are defined tags are created that define the
interface points between I/A Series Batch and Control Suite for unit and phase control. The pro-
cess model is used extensively to define equipment requirements and recipe procedures.

Tag Linking and Validation

Tags are created using the Model Editor and TIM Editors. The I/A Series Link Editor is a tool
that allows tags to be linked automatically and manually to Control Suite tags. The Link Editor
also is used to validate and synchronize tags between I/A Series Batch and Control Suite.

Material Management
The Batch Suite Material Management capability provides an editor and database of materials
used and produced on the plant floor. The system provides capabilities to track incoming bulk
materials and is used by the Batch Suite to find bulk material locations and to append material
vendor lot identifications to history as bulk materials are consumed. The database is used exten-
sively to define formulas during recipe development.

Recipe Management
The I/A Series Batch Recipe Management capability provides a graphical editor to build, edit,
review and approve master recipes. The editor allows recipes to be assigned by type and by state.
The Recipe Editor makes extensive use of the process model and material databases.

Batch Schedule Dispatching

I/A Series Batch provides a capability that allows you to create, validate and dispatch a schedule of
batches to be executed.

Batch Execution
I/A Series Batch has a sophisticated batch engine that executes recipes to produce batches of mate-
rial as defined by a recipe. The batch engine is responsible for equipment arbitration, allocation

41
B0193YB – Rev C 3. I/A Series Integration

and release, phase execution, batch control, sending all batch events to history and interfacing
with the operator through batch displays and TIM tags.

Batch Displays
Standard batch displays provide operators with all the capability needed to interact with the batch
engine when executing batches.

Batch History
The I/A Series Batch Historian is a storage repository for all batch events and activity. The Batch
Historian is a relational database and fully complies with the FDA 21 CFR Part 11-Electronic
Record; Electronic Signatures; Final Rule.

Batch Reporting
Seagate’s Crystal Reports reporting product is a standard part of I/A Series Batch along with
default SQL queries that can be modified for easy creation of custom batch reports. Batch reports
can be triggered on demand by operators, or automatically through an event. Additionally, a run-
time batch report viewing capability is also provided.

Security
I/A Series Batch provides a comprehensive security system that fully complies with the FDA 21
CFR Part 11-Electronic Record; Electronic Signatures; Final Rule. The system includes a two-
part user identification code that can be assigned to any function in the system with or without
verification from a second user. All security events are logged to Batch history.

Process Logging
The I/A Series Batch Process Logger is responsible for retrieving critical tag values that must be a
part of batch history at periodic time intervals or by the occurrence of events and then logging the
data to the Batch Historian. The Process Logger editor defines groups of tags that are logged at a
defined time interval. Event triggers are defined to start and to stop logging for each group
defined. All values are logged to history with a Batch ID.

I/A Series Control Suite Responsibilities

Unit & Phase Logic Configuration
The Integrated Control Configurator provides engineers with the tools to create unit and phase
logic for the Control Station in the form of sequence blocks. The logic can be configured as a
sequential function chart (graphically) or as sequence logic (textually).

Unit & Phase Logic Execution

The I/A Series Control Processor is responsible for execution of the unit and phase logic.

Unit & Phase Logic Monitoring

I/A Series SFC provides users with a tool to monitor the logic configured as a sequential function
chart (graphically) associated with unit and phase logic. Detail Displays are used to monitor the
logic configured as sequence logic (textually).

42
3. I/A Series Integration B0193YB – Rev C

Alarm Detection & Annunciation

The I/A Series Control Processor is responsible for executing the logic needed to detect alarms
and to communicate alarms to I/A Series Batch and to FoxAlert so that operators are informed of
the event.

I/A Series Integration

Tag Validation
I/A Series Batch automatically creates tags in many ways. The Model Editor creates tags for units,
connections, segments, phases and phase parameters. The I/A Series Link Editor creates tags that
provide an interface between control system logic and I/A Series Batch Manager. In order to
maintain common tag namespace, I/A Series Batch provides a function in the I/A Series Tags
Link Editor to validate the I/A Series Batch tags with the I/A Series control system tags. Any dis-
crepancies are identified and displayed to the user.

Tag Communications
I/A Series Batch communicates with I/A Series Control Processors using IADriver.

Batch Alarms
I/A Series Batch uses the Event Manager application for filtering batch alarms from non-batch
alarms. An alarm is considered a batch alarm when it has a non-blank loopId value within the
alarm message. All batch alarms are automatically associated with a BATCH_ID and stored in the
Batch Historian. The association with the BATCH_ID provides for easy retrieval using standard
SQL report queries. A set of batch alarm report queries are provided with Batch Suite.

Viewing Batch Alarms with FoxAlert

Alarms associated with a batch can be viewed with I/A Series Current Alarm Display (CAD). You
must focus on the desired batch with the Batch Suite Batch Display and then launch CAD from
the Batch Display. CAD filters its database of alarms to display only the alarms associated with the
selected batch.

Append Comments to Alarm

An enhancement that allows comments to be added to any batch alarms displayed in FoxAlert is
provided for enhanced batch alarm documentation. Any batch alarm displayed in FoxAlert can be
selected and a comment added. The comment is stored in the Batch Historian. A set of alarm
report queries is provided with Batch Suite which also reports any comments entered for an alarm.

Viewing Sequence Logic

An enhancement that allows you to view the sequence logic for the phase that is currently selected
from BatchView or Batch Display.

Custom Interfaces with FoxView

Most applications have some unique requirements where custom logic needs to be developed.
Using I/A Series Batch TIM Tags linked to Shared Variables and FoxView’s scripting capability,

43
B0193YB – Rev C 3. I/A Series Integration

custom operator displays can be developed and background processes can be created to allow
automatic scheduling of batches, acknowledgement of batch events and in general, interact with
Batch Manager.

44
4. Environment Management
System
This chapter explains how the Environment Management system works, sorting and displaying
the list of selected applications in the order in which they will be executed.
The Environment Management System manages the execution of applications within the batch
system. The system consists of the Environment Editor, Environment Manager, and Environ-
ment Display. Use Environment Editor to configure the applications that run on the Batch
Server. Environment Manager starts and stops applications, manages databases and provides sys-
tem control. Environment Display is a graphical user interface (GUI) for visualizing and interact-
ing with the batch system.
The Environment Management System monitors the interdependencies of system applications to
ensure correct startup and shutdown sequences. The Environment Management System also
allows you to configure the operation of custom applications.
You can use Environment Editor to define the applications that run on a Batch Server. An Envi-
ronment is configured by selecting applications from a list of available applications. The editor
then sorts and displays the list of selected applications in the order that they will be executed. This
sequential ordering is necessary due to interdependencies of batch applications.
Environment Manager determines which applications are displayed in the Environment Display
by reading the environment database. Environment Manager ensures that the proper interdepen-
dent applications are running and displays an appropriate error message otherwise. For example,
you may want to add Batch Display to the Environment Display. The operation of Batch Display
requires the server capability of Batch Manager. Therefore, the editor must ensure that Batch
Manager is selected or already in the system.
Environment Display is the user interface to the batch server applications. Operators typically use
Environment Display to view the status of background applications and start foreground
applications.
The Environment Management System provides an environment for editing an offline copy of
the Process Model database (CfgModelDB). This capability allows you to edit an offline copy of
the model while the batch system continues normal run-time operation. After you complete your
changes to the model, you can shut down the run-time system, update the configuration process
model database with the run-time process model database, and then restart the system.
Figure 4-1 below illustrates the architecture of the Environment Management System.

45
B0193YB – Rev C 4. Environment Management System

Figure 4-1. Environment Management System Architecture

Using Environment Display

Environment Display is the graphical user interface between operators and the applications run-
ning in the batch management system. Use Environment Display for starting batch system appli-
cations, configuring the environment system and viewing the status of background applications.

To Start Environment Display:

1. On the Windows Start menu, click Programs, point to IA Series Batch Suite, and
then point to Environment Display.
2. The Environment Display window appears.

NOTE
When Environment Display is started, the Environment Manager, Lock Manager
(lm_tcp) and Security Manager (SecMngr) applications are started in the back-
ground.

46
4. Environment Management System B0193YB – Rev C

3. When the Environment Display starts, it also starts the Batch Logger. The Batch Log-
ger displays messages for all system activity for the Batch Server, Runtime Clients and
Configurations Clients such as startup, shutdown, warnings and errors along with
time and date stamps. If the Batch Logger is closed, it can be restarted by selecting the
Windows Start menu, click Programs, point to IA Series Batch Suite, Batch Server
and then point to Batch Logger.
A typical Batch Logger window is shown here.

File Menu
The Environment Display File menu provides system functions for the Environment Display
application.

File/Exit
Use the File/Exit menu to stop the Environment Display application. Selecting File/Exit does not
stop background run-time applications or services.

To Stop the Environment Display:

Click File and then select Exit.

47
B0193YB – Rev C 4. Environment Management System

File/Terminate App
♦ Use the File/Terminate menu to terminate applications that failed to start or stop in
the batch system (default timeout is two minutes). The File/Terminate App option
can only be selected when applications are available for termination.

To Terminate an application:
1. From the Applications list, select the application(s) you want to terminate.
2. Click Terminate.
3. Click Close.

NOTE
By default, Environment Manager waits 120 seconds before declaring that an appli-
cation is available for termination. It may be necessary to increase this system time-
out value. For more information on changing the default system timeout value, see
“Environment System Time-out” on page 65.

File/Exit and Shutdown

♦ Use the File/Exit and Shutdown menu to stop the Environment Display, Environ-
ment Manager, Security Manager, Database Lock Manager (lm_tcp), all active batch
system applications (for example, Model Editor, Recipe Editor) and all active run-
time applications.

To Exit and Shutdown the Batch System:

1. Click File and then choose Exit and Shutdown.
2. The batch system begins the process of stopping the run-time system. If configuration
applications such as Model Editor or Recipe Editor are running, you are prompted as
to whether or not you want to stop them.

48
4. Environment Management System B0193YB – Rev C

NOTE
Choosing an Exit and Shutdown completely stops the batch system. If you are not
logged on to the Windows NT operating system with administration privileges, you
are not able to restart Environment Manager or Environment Display. To restart the
batch system, a user with proper administrative privileges must log on. To avoid this
situation you can configure security for the Environment Display Exit and Shut-
down function using the security system.

For more information on configuring security, see Chapter 14 “Security System”.

Update Menu
The Environment Display Update menu allows you to modify the environment (run-time and
configurations) based on changes that you have made to the batch system.

Update/Environment
Use the Update/Environment command to re-initialize the Environment Manager and Display
based on the environment database configuration. Changes that you make to the environment
database with the Environment Editor are not active until you update the environment.

NOTE
You cannot update the environment when any other batch application is running.
This includes applications started on a batch client that access your batch server. All
batch applications, including the run-time system, must be shut down before the
update can be successfully executed.

To Update the Environment:

1. From the Environment Display file menu, select Update and then click Environment.
2. The Environment Display message box appears, prompting you to proceed with the
update.
3. Click Yes on the message box.

Update/Runtime
The environment system provides you with the ability to make off-line changes to process models
and tag linker databases. Use Update/Runtime to copy the contents of the process model, link,
and TIM configuration databases into the corresponding run-time databases. Changes that you
make to a process model are not active until you update the run-time databases. You cannot per-
form an Update/Runtime on a running system.

To Update the Runtime:

1. From the Environment Display file menu, select Update and then click Runtime.
2. A confirmation message appears advising that the run-time databases in your system
are going to be overwritten by the configuration databases. The date and time are dis-
played in the message so that you can determine whether or not you want to proceed
with the update.

49
B0193YB – Rev C 4. Environment Management System

! WARNING
The contents of the run-time process model, link, and TIM databases are
overwritten by the configuration databases when you perform a run-time update.
You should back up your run-time databases before proceeding.

3. Click Yes to update the run-time databases.

Update/Configuration
The environment system provides you with the ability to discard any offline changes to the
process model and tag linker databases. Use Update/Configuration to copy the contents of the
process model, link, and TIM run-time databases into the corresponding configuration databases.
You cannot perform an Update/Configuration on a running system.

To Update the Configuration:

1. From the Environment Display file menu, select Update and then click Configuration.
2. A confirmation message will appear advising that the configuration databases in your
system are going to be overwritten by the run-time databases. The date and time are
displayed in the message so that you can determine whether or not you want to pro-
ceed with the update.

! WARNING
The contents of the configuration process model, link, and TIM databases are over-
written by the run-time databases when you update the configuration. You should
back up your databases before proceeding.

3. Click Yes to update the configuration databases.

View Menu
The Environment Display View menu allows you to monitor the operation of background appli-
cations that were started by the batch system.

View/Status
Use the View/Status menu to display the System Application Status window. This window dis-
plays the current status of the background applications that were automatically started with the
Environment Display. Each application listed in the window must be “Running” in order to ini-
tiate any of the associated configuration and run-time applications.

To View the Status of System Applications:

1. From the Environment Display file menu, select View and then click Status.

50
4. Environment Management System B0193YB – Rev C

2. The System Application Status window appears.

The Database Manager entry refers to the database lock manager (lm_tcp). The His-
tory Queue entry refers to the History Queue functionality required for communica-
tion between the Batch Server and the Batch Information Server. The Security System
entry refers to the Security Manager. These applications are executed as an operating
system service and are started by the Environment Manager.

NOTE
If you are using Redundancy, the System Application Status window will also show
the status of the Redundancy Manager (Redundancy Mngr).

3. Click Close.

Help Menu
The Environment Display Help menu contains commands that provide you with access to the
on-line Help system and information regarding product version.

Help/Help Topics
Use the Help/Help Topics command to display the help contents for Environment Display.

To View the Help Topics for Environment Display:

1. From the Environment Display file menu, select Help and then click Help Topics.
2. The Help Topics window appears.

Help/About Environment Display

Use the Help/About command to view information regarding program version.

To View Help About Topics for Environment Display:

1. From the Environment Display file menu, select Help and then click Help About Envi-
ronment Display.
2. The About Batch Environment Display window appears.
3. Click OK to close the window.

51
B0193YB – Rev C 4. Environment Management System

Starting and Stopping I/A Series Batch Applications

I/A Series Batch Run-time applications can be started and shut down using the Environment Dis-
play or they can be configured to start or shut down automatically.
Use Environment Display to configure the startup of GUI-based and run-time applications. If
you have a plant in which you need unattended shutdown or startup for your batch run-time sys-
tem, see “Automatic Startup and Shutdown of Runtime” on page 64.
Configuration and run-time applications that a have a GUI, and were configured in the Environ-
ment Editor, appear as icons in the environment display. All of the applications in the Environ-
ment Display are started by double-clicking the application’s icon.
Configuration applications start when you select them. Run-time applications start only if the
corresponding server is running. For example, Batch Scheduler and Batch Display do not start if
Batch Manager is not running. If you attempt to start a run-time application and its server is not
started, an error message is displayed.

Run-time Applications
Run-time applications can be started and stopped from the Environment Display. Run-time
applications run as Windows NT services. You can start and stop individual or multiple
applications.

To Start All Run-time Applications:

1. On the Environment Display, click the Runtime button.
2. The Runtime Application Display appears.

3. Click Start All.

4. All of the run-time applications are started in the same order in which they are listed.
When an application is started, a message indicating the application’s status is dis-
played in the Status column of the Runtime Application Display. As each application
starts, its Status changes from Stopped to Starting, and then finally, to Running.

52
4. Environment Management System B0193YB – Rev C

To Stop All Run-time Applications:

1. On the Runtime Application Display, click Stop All.
2. All the run-time applications are stopped in the same order in which they were
started.
When an application is stopped, a message indicating the application’s status is dis-
played in the Status column of the Runtime Application Display. As each application
stops, its Status changes from Started to Stopping, and then, finally to Stopped.
An error message is displayed if you attempt to stop an application that has a interde-
pendent client application running.

To Start a Single Run-time Application:

In the Runtime Application Display, Application list, select the application that you
want to start and click Start App.
When the application is started, a message indicating the application’s status is dis-
played in the Status column of the Runtime Application Display. As the application
starts, its Status changes from Stopped to Starting, and then finally, to Running.
Environment Manager ensures that the appropriate server applications are running
when you attempt to start a single application. If the required servers are not running
for the selected application, an error message is displayed.

To Stop a Single Run-time Application:

In the Runtime Application Display, Applications list, select the application that you
want to stop and then click Stop App.
When the application is stopped, a message indicating the application’s status is dis-
played in the Status column of the Runtime Application Display. As the application
stops, its Status changes from Started to Stopping, and then, finally to Stopped. An
error message is displayed if you attempt to stop an application that has an interde-
pendent client application running.

Using Environment Editor

Use Environment Editor to configure individual applications within the batch system. You can
use Environment Editor to add or remove applications from the environment management sys-
tem and configure application parameters. You can also configure the applications within Envi-
ronment Display that are controlled by Environment Manager.

To Start Environment Editor:

1. On the Environment Display window, click the Environment button.
2. The Environment Editor window appears.

53
B0193YB – Rev C 4. Environment Management System

File Menu
The Environment Editor File menu provides system functions for the Environment Editor appli-
cation.

File/Exit
Use the File/Exit menu to close Environment Editor.

To Close Environment Editor:

On the Environment Editor menu bar, click File and then select Exit.

Edit Menu
The Environment Editor Edit menu allows you to view and modify environment system
parameters.

54
4. Environment Management System B0193YB – Rev C

Edit/System Parms
Use the Edit/System Parms menu to modify the parameter values assigned to background service
applications (for example, Lock Manager and Redundancy Manager) that are started prior to all
applications.

To Edit System Parameters:

1. On the Environment Editor menu bar, click Edit and then select System Parms.
2. The Edit System Parameters window appears.

3. From the Parameters list, select the item that you want to edit.
4. In the Value field, enter the required value in accordance with the table below

Table 4-1. Environment System Parameters

Parameter Description
Max locked files The maximum number of database files under
lock manager control. Default is 256.
Max locks in queue The maximum size of the file lock request queue.
Default is 128.
Max users The maximum number of users lock manager may
control. Default is 32.
Redundancy Time-out The number of seconds that the backup computer
will wait when a communication failure occurs
before it becomes a master. (Applicable to redun-
dant systems only).
User ID Time-out The number of seconds that the current User ID
will be retained before it must be reentered. The
default value of 0 retains the User ID indefinitely.
Number Recipe Levels Number of recipe levels to be shown in Recipe
Edit: Options are 2 and 3. Default is 3.
Allow Sync Approvals Allows the Recipe Edit user to retain recipe
approvals when syncing recipes. Options are 1 or
0. Default is 1.

55
B0193YB – Rev C 4. Environment Management System

The table lists all the available parameters.

5. Click Change.
If you do not click Change, the values that you entered are not updated.
6. Click Close to close the Edit System Parameters window.

NOTE
You must shut down and restart your batch system in order for system parameter
changes to take effect.

Help Menu
The Environment Editor Help menu contains commands that provide you with access to the
online Help system and information regarding product version.

Help/Help Topics
Use the Help/Help Topics command to display the help contents for Environment Editor.

To View Help Topics for Environment Editor:

1. From the Environment Editor file menu, select Help and then click Help Topics.
2. The Help Topics window appears.

Help/About Environment Editor

Use the Help/About command to view version information.

To View About Help Topics for Environment Editor:

1. From the Environment Editor file menu, select Help and then click Help About Envi-
ronment Editor.
2. The About Environment Editor window will appear.
3. Click OK to close the window.

Adding Applications to the Environment

Use the Environment Editor Add Applications window to add batch system applications and
user-defined applications to the environment.
You can also add multiple instances of some configuration and batch client applications running
on a batch server. Some run-time manager applications cannot have multiple instances. If you
attempt to add an instance of a run-time server that is present in the environment, an error mes-
sage is displayed.
When you have multiple instances of configuration and batch client applications running on a
batch server, you must specify a unique name for each. Instance names (12-char max) should
describe the purpose of the application.
Application names, including instances, appear as icon labels in the Environment Display. They
are also listed in the Runtime Application Display.

56
4. Environment Management System B0193YB – Rev C

NOTE
When you add an instance, a unique name is automatically assigned. You can use
Environment Editor to change the name. Instance names within the batch system
must be unique. If they are not, an error message appears.

Adding Applications
To Add an Application:
1. On the Environment Editor window, click the Add button.
2. The Add Application window will appear.

The Applications list contains all the batch system and user-defined applications that
can be added.
3. In the Applications list, select the item that you want to add.
4. Click Apply to add your selection to Environment Editor’s Application list.
Clicking OK also adds an application; however, the Add Applications window closes.
5. Click Close to close the Add Applications window.

57
B0193YB – Rev C 4. Environment Management System

NOTE
Applications in the Environment Editor Application list are shown in the sequence
in which the batch system will execute them.

To Add an Instance of an Application:

1. On the Environment Editor window, click the Add button.
2. The Add Application window appears.
The Applications list contains all the batch system and user-defined applications that
can be added.
3. In the Applications list, select the item that you want to add as an instance.
4. Click Apply to add the instance to Environment Editor’s Application list.
Clicking OK also adds an application; however, the Add Applications window closes.

5. Click Close to close the Add Applications window.

58
4. Environment Management System B0193YB – Rev C

6. The default instance name appears in the Environment Editor Application list and in
the Instance name field.
7. In the Instance field, enter an appropriate name for the application.
8. Click Change.
9. The new Instance name appears in the Instance list of the Environment Editor.

Assigning Application Parameters

Some applications require the assignment of parameters in order to run properly.

To Assign Application Parameters:

1. From Environment Editor, select an application from the Application list.
2. Click the Assign Parm button.
If you select an application whose parameters cannot be configured, the Assign Parm
button is unavailable.
3. The Assign Application Parameters window appears.

4. From the Parameters list, select the appropriate parameter(s).

5. Click Apply to add the parameter(s) to the application.
Clicking OK adds an application and then closes the Assign Application
Parameters window.
6. Click Close to close the Assign Application Parameters window.

To Assign Application Parameter Values:

1. From the Environment Editor Application list, select an application.
2. The parameter appear sin the Parameter list. The current value appears in the Value
list and in the Value field.
If you select an application whose parameters cannot be configured, the list is empty.
3. In the Value field, enter the required value.
For more information on Application Parameters, see “Application Parameter
Descriptions” on page 60.
4. Click Change to update the value.

59
B0193YB – Rev C 4. Environment Management System

Application Parameter Descriptions

All the available parameters for each application are described below.

Table 4-2. Simulation Manager (SimMngr)

Parameters Description
Seconds per Phase Length of time for which each new phase is executed. Default value
of 30 seconds.
Write R/O Tags Enables writing to read-only tags in the batch system.

Table 4-3. Process Log Manager (LogMngr)

Parameters Description
Configuration Enter the name of the configuration defined in the Process Log Editor.

Table 4-4. Batch Manager (BatchMngr)

Parameters Description
Restarting Batches All batches are resumed in their previous state upon system restart.
Phase/Batch Status Batch Manager controls all active phases upon a single batch phase becom-
ing held or restarted.
Init Status Tags The Batch Manager sets all unit and segment status tags to the default
value defined in the Process Model.
LIFO Materials Material consumption uses LIFO instead of the default FIFO method.
Unit States Enables the use of Unit State System tags by Batch Manager. Refer to
Chapter 10 “Batch Management System” for details on Unit Control using
Unit State tags.
COM Interface Enables the use of COM for Batch Hooks in Batch Manager.
Server Node ID Sets Batch Server Unique Indentifier. Allows multiple batch servers to use a
single history database. (Use only the characters A thru Z to define the ID)
Disable Warm Disables loading and saving of warm restart information. Batches are lost
Restart when application stops.
Parm Timeout (sec) Time, in seconds, of all attempts to read a parameter tag value before a tim-
eout failure. The default value is 30 seconds. A value of zero disables retries.
This parameter determines how long Batch Manager continues to retry
reading parameters before generating an error.
Semi-Auto On Batch is placed in semi-automatic mode when a phase is aborted.
Abort
Warm Restart Commit warm restart files to disk immediately when written.
Commit

60
4. Environment Management System B0193YB – Rev C

Table 4-5. Batch Display (BatchDspl)

Parameters Description
Manual Operations Enable the selection of Manual Operation from Batch Display.

Table 4-6. I/A Series Tag Driver (IADriver)

Parameters Description
Read Delta Default is 1.0 - Defines how much a tag value must change before it is
read and I/A Series Batch is updated.
Write Delta Default is 1.0 - Defines how much a tag value must change before it is
written to the I/A Series Control Suite (Control Processor).
Read Scan Rate Default is 1 seconds - Defines Object Manager read scan rate.
Write Scan Rate Default is 2 seconds - Defines Object Manager write scan rate.
Mreaidx Poll Rate Default is 500 ms - Defines the poll rate for I/A Series Batch updates.
The actual poll rate is the Mreaidx Poll Rate value times Read Scan
Rate value. The result is in milliseconds.
TIM Start Poll Rate Default is 10 - Defines the polling rate for TIM tags.
Unlinked Tag Warning Default is False - Enables detection and logging to Batch Logger when
tags are not linked.
Unlinked Tag Ignore Default is False - When this option is enabled, tags which are not
linked are not created by IADriver. This allows other tag servers, such
as SimMngr, to have the opportunity to create and service those tags.
Use caution when utilizing this option since unlinked phase or batch
control tags that are controlled by a simulator (that is, SimMngr) can
cause unexpected results in a production system.
Max Precision Default is False - Enables the maximum available resolution for tag val-
ues.

Table 4-7. Event Manager

Parameters Description
FMI Logical Name If the value is not defined, the batch system uses the name “FBFMI” by
default. FBFMI is the default I/A Series alarm destination name for
Event Manager. You can assign a different alarm destination name, so
that when multiple batch servers are on the same I/A Series network,
I/A Series detected alarms can be sent to the correct Event Manager.

Deleting Application Parameters

To Delete Application Parameters:
1. From Environment Editor, select an application from the Application list.
2. Click the Delete button.

61
B0193YB – Rev C 4. Environment Management System

3. The Application Parameter is no longer assigned to the application.

User-Defined (Other) Applications

User-defined applications and parameters can be added to the environment management system.
Only batch system compatible applications work properly within the environment system. This
features does not support the entry and execution of standard operating system applications. This
section is limited to the description of how to add previously created applications to the environ-
ment system. Creating compatible applications is beyond the scope of this manual.

To Add a User-Defined Application:

1. On the Add Applications window, click Other.
2. The User Defined Applications window appears.

3. Enter a Name (16-char max), Type, Parameters, (optional), and select Client
Of/Server To designations (optional).
The Type drop-down menu lists three application types.

! CAUTION
The Application Name must be unique as compared to all other applications in the
environment. If the Name is not unique then the environment database may
become corrupted.

62
4. Environment Management System B0193YB – Rev C

Table 4-8. Application Types

Type Description
Editor Designates the application as a configuration application within the
Environment system.
Single Runtime Designates the application as a run-time application that can only be
added once to the Environment system.
Multiple Runtime Designates the application as a run-time application that can be added
more than once to the Environment system.

The Client Of and Server To selections define the list item location in the Add Applications list.
The selection of this location is important since the custom application also appears in the Run-
time Applications Display. The order in which the applications are listed is essential for proper
batch system operation. Editors do not appear in the Runtime Application Display and are placed
at the end of the Applications list in the Add Applications window.

User-Defined Application Parameters

Use the User-Defined Application Parameters window to define parameters for your application.
User-defined application parameters are available for selection in the Assign Applications Parame-
ters window after the user-defined application is added to the environment system.

To Add Parameters to a User Defined Application:

1. On the User Defined Applications window, click Edit Parameters.
2. The User Defined Application Parameters window appears.

3. Enter a Name (20-char max), optional Description (120-char max) and

Parameter value.
You can assign multiple parameters to your applications.
4. Enable the Parameter Required check box if your application requires parameters.

63
B0193YB – Rev C 4. Environment Management System

Using Environment Manager

Environment Manager is an operating system service that manages batch system application
execution.
The Environment Manager is responsible for the following functions:
♦ Startup and Shutdown of the database Lock Manager (lm_tcp).
♦ Startup and Shutdown of the Security Manager.
♦ Startup and Shutdown of the Redundancy Manager (if enabled).
♦ Startup and Shutdown of any batch system run-time application.
If you perform a successful installation of the batch system, Environment Manager starts auto-
matically when your computer is started. If you perform an exit and shutdown of the batch sys-
tem, Environment Manager restarts when Environment Display is initiated.

Automatic Startup and Shutdown of Runtime

This section describes how you can automatically start up or shut down your batch system with-
out the intervention of a user. Normally, you would use Environment Editor’s Runtime Applica-
tion Display to do this. In some instances however, you might need to start up or shut down your
batch system when no users are present in your facility.
The example in this section describes a facility in which the batch run-time system is configured
to shut down (or start up) as a result of a power outage. When momentary or prolonged power
outages occur, users and the system software must be able to react accordingly.
The main requirements for automatic shutdown in a batch process are highlighted here.
1. The Batch Server computer must be connected to an uninterruptable power supply
(UPS) which can maintain power to the server computer for a minimum of five
minutes.
2. The server software must recognize external commands initiated from the UPS that
allows it to shut down gracefully with no manual intervention.
3. Upon computer restart, either via power restoration or manually, the batch system
must completely restart run-time operation with no manual intervention.
To satisfy these requirements, the batch system includes an executable (etcmds.exe) that controls
the startup and shutdown of the run-time system. This executable provides options for starting
the run-time system, shutting down the run-time system, or exiting and shutting down the entire
batch system.
The etcmd.exe program, located in the D:\IASeriesBatch\bin folder of your batch system can be
executed from a command prompt or it can be started from another application. The following
options are available and required for the etcmds.exe application.
-r – This option starts the run-time applications. These applications pertain to those
found in the Runtime window opened from the Environment Display.
-s – This option stops only the run-time applications. These applications pertain to those
found in the Runtime window opened from the Environment Display. This option also
automatically halts all batch client applications such as Batch Scheduler and Batch
Display.

64
4. Environment Management System B0193YB – Rev C

-x - This option performs stops all applications. This is identical to performing an Exit
and Shutdown command from the Environment Display. This option also automatically
halts all batch client applications such as Batch Scheduler and Batch Display.

NOTE
One of the above options is required when executing the application. There is no
feedback from this application. It executes without any confirmation.

Environment System Time-out

By default, Environment Manager assumes that an application is available for termination if it has
not started after 120 seconds. For most applications associated with I/A Series Batch, the time-out
value of 120 seconds is sufficient. However, run-time applications such as IADriver often require
a longer period of time in order to start properly. The length of time required varies depending on
your particular application and the number of tags associated with IADriver. Unless you are expe-
riencing a conflict as a result of an insufficient time-out, it is recommended that you do not
change the default value. The following procedure should only be implemented when the default
value of 120 seconds needs to be changed.

To Change the Environment System Timeout:

1. From the Start menu, select Settings, and point to Control Panel.
2. From the Control Panel, select the System icon.
3. On the System Properties window, click the Environment tab.
4. In the System Variables list, add a Variable named TIMEOUT, and enter the required
Value (integer value in seconds).
5. Click the Set button and then click OK to close the System Properties window.
6. To enable the change of Timeout value, you must shut down and restart Windows.

NOTE
Remember that changing the Timeout value has a global effect; that is, Environ-
ment Display will wait the specified amount of time before it reports any applica-
tion that is available for termination.

Considerations
♦ Stopping the batch system automatically can be accomplished by using the function-
ality provided by most intelligent UPS systems. Typically, a UPS has an option that
allows the user to configure a command file, such as a batch file, that executes upon
loss of power. Parameters, such as time delay, associated with this execution can usu-
ally be configured. This provides a very easy method for stopping the batch run-time
system.
♦ Depending on the number of run-time and client applications that are started, the
batch system may take several minutes to shut down completely. The UPS must pro-
vide ample time for a complete, undisturbed shutdown.

65
B0193YB – Rev C 4. Environment Management System

♦ After an Exit and Shutdown occurs (- x), a confirmation dialog box appears on the
screen if the Environment Display is active. This must be acknowledged manually to
completely close the Environment Display application. However, failure to manually
acknowledge this dialog box does not result in any problems or loss of data. All
I/A Series Batch services and databases close prior to this confirmation dialog box.
♦ Starting the batch system automatically can be accomplished by creating a batch file
that starts the etcmds program. This batch file must be placed in the Windows Start-
up program group. The example shown below uses a delay of 150 seconds (sleep 150)
that allows FoxAPI to start before the etcmds program is started. The - r option must
be used to start the run-time applications.
sleep 150
cd d:\
d:\IASeriesBatch\bin\etcmds -r
♦ The start run-time option does not initiate any client applications, such as Batch
Scheduler or Batch Display.
♦ Exercise caution when restarting the batch system. The batch management system
retains knowledge of all active batches and phases. If the controller resets with a power
outage, the batch system and the controller logic may lose synchronization. Proce-
dures should be implemented to recover from such a situation. Options include
manually restarting all previously active phases, putting a UPS on the controller, or
aborting all active phases prior to shutdown.

66
5. Process Modeling
This chapter provides a summary of the three models available for process modeling and
describes the advantages and disadvantages of each.
Configuration of a process model requires a thorough understanding of the process and the con-
trol system that you want to model. Using the Process Modeling Editor to configure a process
model is not an overly complicated task. You will invest most of your development effort in
revising the process model based on information that you gather about a facility’s process, and
achieving the desired level of flexibility.
Obtaining accurate Process and Instrumentation Diagrams (P&IDs) of the process before config-
uring the process model is very important. You use the P&IDs to determine the components and
capabilities of the process.
Batch processing facilities are typically comprised of a variety of vessels, and the equipment neces-
sary to move materials and products between the vessels. Use the Process Modeling Editor to
configure a batch control system in a manner that facilitates recipe creation and the execution of
recipes within batches.
Process models for batch facilities are based on two primary modeling approaches: the Compre-
hensive Model and the Connectionless Model. You can also use a Hybrid Model that contains ele-
ments of both. To ultimately decide which approach is optimal for your specific application, you
should analyze the theoretical batch philosophy of the company, the process that is being mod-
eled, the flexibility requirements, the user interface requirements of the recipe builder and process
operators, and the historical batch recording requirements.
A summary of these approaches, including the benefits and liabilities of each, is described in this
section. All the features of the Process Modeling Editor are described, regardless of which model-
ing approach you choose.

Comprehensive Model
A comprehensive model approach uses all the available configuration tools of the flexible batch
system. It also provides complete material tracking and ease-of-use for the recipe builder and
operators.
In a comprehensive model, the physical process is defined with units and connections. A unit is
defined as any vessel that can hold and/or process materials. Examples of units are bulk storage
vessels, reactors, blenders, mixers, and hold tanks. Unique statuses can be defined that describe
the possible states that each unit can assume. A connection is a group of equipment that transfers
product between units. Examples of connections are pumps, and valves. Some plants have single
units with connections to multiple units while others have multiple connections between two
units. Connections can be further divided into segments. Connection availability is determined
by the status of all the segments that are a part of the connection. Unique statuses can be defined
that describe the possible states that each segment can potentially assume.
All units that have the same processing capabilities or perform the same function are grouped in
the same process class. All connections between the same two process classes are grouped in a
transfer class. The processing and transferring capabilities for each of these classes are defined with
phases. Each phase is an independent action that requires a unique set of parameters. Parameters

67
B0193YB – Rev C 5. Process Modeling

configure the phase based on a recipe’s requirements. A phase can be executed either automatically
or manually. The batch management system is responsible for coordinating unit-to-unit
management.

Connectionless Model
A connectionless model approach uses a subset of the available configuration tools of the flexible
batch system. This approach requires a more complete understanding of the process by the recipe
builder and the operators. A connectionless model approach also provides complete material
tracking.
In a connectionless model, the physical process is defined with units only. Units are the same in
any model, that is, any vessel that can hold and/or process materials. Unique statuses can be
defined that describe the possible states that each unit can assume.
All units that have the same processing capabilities or perform the same function are grouped in
the same process class. The processing capabilities of each class are defined with phases. Each
phase is an independent action that requires a unique set of parameters that configure the phase
based on a recipe’s requirements A phase can be executed either automatically or manually.
The connectionless model approach does not use connections and segments. The movement of
material between units is accomplished using complementary process phases. For example, to
move material from a reactor to a mix tank, a discharge phase associated with the reactor and a
charge phase associated with the mix tank are required. The recipe builder is responsible for coor-
dinating these two phases as part of the recipe procedure. Co-ordination of unit-to-unit manage-
ment is the responsibility of the operator or control system.
Proper material tracking within a connectionless transfer requires the definition of input parame-
ters for the appropriate source class discharge phase, and the definition of output parameters for
the appropriate destination class charge phase.

Hybrid Model
The hybrid model approach uses a combination of elements of the comprehensive and connec-
tionless models. It allows you to configure a process in a way that maximizes the benefits of both
approaches by providing all the available configuration tools, material tracking and ease-of-use for
the recipe builder and operators.
In the hybrid model, the physical process is defined with units and connections. However, only
the static, non-flexible material paths are defined as connections. Flexible paths or those that
involve many possible destinations are not defined as connections. Like the comprehensive and
connectionless models, all the units that have the same processing capabilities or perform the same
function are grouped in the same process class, and all connections between the same two process
classes are grouped into a transfer class.
Flexible paths that are not defined with connections use the complementary process phase
approach.
For more information on complementary process phases, see “Connectionless Model” on
page 68.
The hybrid approach’s most beneficial advantage is that it can minimize the overall number of
connections and associated tags in the model, while preserving all the connections for paths that
are constant.

68
5. Process Modeling B0193YB – Rev C

Model Approach Comparisons

This table summarizes the benefits, liabilities and recommended usage for the comprehensive,
connectionless and hybrid model approaches.

Table 5-1. Comprehensive, Connectionless, and Hybrid Model Approaches

Approach Benefits Liabilities Usage

Comprehensive Automatic unit-to-unit batch Possibility of many connections Totally
Model management and associated connection tags Fixed
Complete material genealogy for flexible paths Process
Intuitive for recipe builder
and operator
Assignment of bulk material
sources for automatic lot
tracking
One phase to conduct mate-
rial transfers minimizes recipe
complexity
Connections and segments
provide some automatic inter-
locking functionality when
moving materials between
units
Connectionless Complete material genealogy Requires complementary pro- Totally
Model Eliminates many connections cess phases in recipes for all Flexible
and connection tags for flexi- material movement Process
ble paths More training for recipe builder
and operator
Operator or control system
must guarantee the co-ordina-
tion of units
Requires extensive control sys-
tem logic and interlocking when
moving materials between units
Automatic tracking of input
materials requires definition of
parameters for the source pro-
cess phase
Automatic tracking of output
materials requires definition of
parameters for the destination
process phase

69
B0193YB – Rev C 5. Process Modeling

Table 5-1. Comprehensive, Connectionless, and Hybrid Model Approaches (Continued)

Approach Benefits Liabilities Usage

Hybrid Model Complete material genealogy Liabilities of comprehensive and Partially
Minimizes flexible connec- connectionless models are Fixed and
tions and preserves static con- present for areas defined with Partially
nections and without connections Flexible
Benefits of comprehensive and Process
connectionless models are
present for areas defined with
and without connections

Process Modeling Steps

This table shows the general steps necessary to create a process model. The steps are shown in
sequential order. The steps required for each approach are marked with an X.

Table 5-2. Process Modeling Steps

Modeling Steps Comprehensive Connectionless Hybrid

1. Define units. X X X
2. Define units of measure. Optional Optional Optional
3. Define enumeration. Optional Optional Optional
4. Group units into process classes and define X X X
attributes.
5. Define all connections between units. X
6. Define all fixed connections between units. X
7. Group connections into transfer classes. X X
8. Define the phases of each process class. X X X
9. Define the phases of each transfer class. X X
10. Define the segments and assign to connections. Optional Optional
11. Define the possible equipment statuses that X X X
units and/or segments can assume.
12. Define Tags for transferring the specific phase X X X
data points between the batch and control systems.
13. Develop phase logic. X X X

Units
A unit is a group of processing equipment that performs one of the following functions.
1. The unit processes materials; examples are reactors, mixers, blenders, and retorts.
2. The unit holds materials; examples are manual add stations, hold tanks, bulk storage
vessels, and filling stations.
Units can have unique attributes, such as capacity or material of construction, which define the
processing capabilities or limitations of the unit.

70
5. Process Modeling B0193YB – Rev C

Process Classes (Processes)

A process class is a group of units. Each unit in the class has the same processing capabilities
and/or performs the same function. For example, a plant may have five blenders, each of which
has the same processing capability. The only difference between the blenders might be capacity
and blending efficiency. All five blenders would, therefore, be identified by one process class.
Some units have no processing capabilities but perform the same function. Examples of these
units are bulk ingredient storage tanks, hold tanks, filling stations, and manual add stations.
Each process can have a common set of attributes, which further define the capabilities of each
unit in the class. Unit attributes are used by the batch management system to verify that the units
in the train match the equipment requirements defined by the recipe.

Connections
A connection defines a group of equipment such as valves, pumps and flowmeters that transfer
materials from a source unit to a destination unit. All connections between units must be defined
when configuring the process model. Some processes may have more than one connection
between the same two units. In this case, each connection is defined separately.

Transfer Classes (Transfers)

Each connection must be assigned to a transfer class. Transfer classes are similar to process classes,
except where process classes are associated with units Transfer classes are associated with connec-
tions. Transfers define a group of connections where all source units are in the same process class
and all destination units are in the same process class. The source and destination process classes
can be the same. For example, all the connections between the source process class, Bulk Ingredi-
ent Silos, and the destination process class, Scales, are assigned to the same transfer class. Another
example of a transfer class includes all the connections between the process class, Scales, and the
process class, Blenders.

Define Process and Transfer Capabilities

Process classes have processing capabilities. These capabilities are defined by Process Phases and
parameters.
Transfer classes have transferring capabilities. These capabilities are defined by Transfer Phases
and their associated parameters.

Phases
A Phase is an independent process action. Phase Logic refers to the logical steps and sequences
within the control system that occur during the execution of a phase. Phase logic can be con-
structed to automatically accommodate formula parameter values received during run time.
Parameter values originate within a recipe.

71
B0193YB – Rev C 5. Process Modeling

Phase Types
There are three types of process phases and four types of transfer phases. Process phases are classi-
fied as either automatic, manual, or download. Transfer phases are classified as either automatic,
semi-automatic, manual, or download.

Automatic Phases
Automatic phases are executed by the control system. Therefore, there must be phase logic in the
control system for the phase to execute. Examples of automatic phases include bulk add, dis-
charge, heat, and mix.

Manual Phases
Manual phases are executed by the batch management system in conjunction with an operator.
The control system is not involved in the execution of a manual phase. Therefore, no phase logic
is required. Examples of manual phases include manual add and test.

Semi-automatic Phases
Semi-automatic can only be defined for transfer phases. Successful execution requires the operator
and the control system to work together in order to successfully complete the phase. Semi-
automatic phases require control system phase logic. An example of a semi-automatic phase is
drum add.

Download Phases
Download phases are executed by the batch management system. They have no phase control or
status tags for handshaking with the control system, and do not require operator acknowledge-
ment. They do not have control button capability, but do allow formula parameter assignments.
When a download phase is encountered during batch execution, the batch manager automatically
writes (downloads) all parameters values to the control system.

NOTE
Download phases are intended to be used to write a Target value to a controller. If
the process model has only parameter Target tags created, then the Target value is
written to both the Target and Actual in history. If Actual tags have been created in
the process model, then the Actual value from the controller is written to history.

Table 5-3. Download Phases

Class Class Type Phase Phase Type

BulkBlnd Transfer BulkAdd Automatic
DrumBlnd Transfer DrumAdd Semi-automatic
Blenders Process Blend Automatic
BlndCook Transfer Discharg Automatic

72
5. Process Modeling B0193YB – Rev C

Table 5-3. Download Phases (Continued)

Class Class Type Phase Phase Type

Cookers Process AgitOn Automatic
AgitOff Automatic
Heat Automatic
Cool Automatic
Soak Automatic
Sample Manual
CookHold Transfer Discharg Automatic

Phase Logic
Phase Logic refers to the steps and sequences in a control system that are exercised during the exe-
cution of a phase. Phase logic makes the control system program very structured and is required to
support every phase defined as automatic or semi-automatic. For example, if a process class of
blenders has three automatic phases, each blender in the process class requires three phase logic
blocks. Similarly, phase logic blocks are required for each automatic and/or semi-automatic phase
defined for each connection assigned to a transfer class. The logic for each may be identical; how-
ever, the physical I/O and internal address assignments are different for each blender in the class.
Manual phases are executed by the batch management system through interaction with operators
and do not require phase logic.

Figure 5-1. Interface Between Phase Logic and Batch Management System

This diagram shows the structured interface between phase logic and the batch management
system.

73
B0193YB – Rev C 5. Process Modeling

Phase Parameters
Phase parameters are used to configure, control, and monitor a phase. There are four types of
parameters: Formula Parameters, Phase Control and Status Bits, Interlocks, and Control Buttons.
Each of these types is shown in the table following the definitions.

Formula Parameters
There are three types of formula parameters: Input, Output, and Process Variable.
A recipe consists of a header, a procedure, equipment requirements, and a formula. The formula
contains the defined Input, Output, and Process Variable parameters. Input and output parame-
ters are used to define and track material transfer quantities. Process variable parameters define
setpoints. Parameter elements, such as high and low deviation, are used to quantify, define, and
track the formula when a batch is executed. Units of Measure can also be assigned to Process
Variables.

Phase Control and Status Bits

Phase Control and Status Bits are used by the batch management system during run-time to con-
trol and monitor the execution of each phase.
For more information on using phase control and status bits, see Chapter 16 “Phase Logic Devel-
opment and Testing”.

Interlocks
Each phase logic block may require interlocks. Interlocks provide safety and security for personnel
and equipment by preventing the execution of a phase when other equipment or operators are not
ready. All tags within the system can be assigned as an interlock to a phase. There is no limit to the
number of interlocks that can be assigned to a phase. The physical interlocking is performed in
the control system, not by the batch control system. In this case, the batch control system serves as
a diagnostic tool by displaying the status of interlocks.

Control Buttons
Operators use control buttons to initiate or alter process actions during phase execution. Control
buttons are included in user interfaces for batch execution displays. There are two control buttons
available for each phase. Control buttons are associated with the values of discrete tags.
A summary of all phase parameters is displayed in the following table.

74
5. Process Modeling B0193YB – Rev C

Table 5-4. Phase Parameters

Parameter Type Elements

Formula Input Target
Actual
High Deviation (%)
Low Deviation (%)
Lot Code
Preact
Lot Code
Material ID
Process Variable Target
Actual
High Deviation (%)
Low Deviation (%)
High Limit
Low Limit
Output Target
Actual
Material ID
Phase Control Start
Hold
Restart
Abort
Reset
Phase Status Ready
Run
Held
Done
Aborted
Interlocked
Interlocks Application Specific
Control Buttons Button #1
Button #2

Segments
A segment is a subsection of a connection. Segments may be defined in the process model when-
ever multiple connections share the same equipment and when it is necessary to prevent the auto-
matic use of common segments. Examples of segments are sections of common piping, shared
valves and shared pumps. Segment definition and usage is optional. If you do use segments in
your model, it is not necessary to assign segments for all the connections.

75
B0193YB – Rev C 5. Process Modeling

Equipment Status
An equipment status represents the transition states of units and/or segments and is defined in the
process model. Equipment Status is evaluated before the allocation of units and/or connections.
The use of equipment status is optional.

Units of Measure
A unit of measure is an attribute of a formula parameter and can be defined for process variables
only. They are defined in the process model. An example of assigning a unit of measure might
involve a process variable formula parameter named Temperature. The unit of measure assigned
to this parameter might be Degrees F. Each process variable in your process model should have a
unit of measure assignment.

Enumeration
An enumeration is a data class which is identified by a Set Name in which a list of integer values
correspond to an alphanumeric string value.
The enumeration data class is available for process variable formula parameters. Enumeration data
class Set Names and Values are defined using the Process Model Editor. Each Enumeration Set
Name is a associated with at least one Enumeration Value and Name. An example of an Enumer-
ation is the Set Name “BOOLEAN”. In this example, you could associate the values 0 and 1 with
the names “FALSE” and “TRUE” respectively. The use of enumerations is optional.

Tags
A tag is a collection of data or information that is given. Tags are named and defined with the Pro-
cess Model Editor. A tag usually corresponds to a control system data point. Tags are also used to
configure batch control system applications such as recipes and reports. All tagnames must be
unique.
There are eight tag types in the batch control system: Unit Tags, Process Tags, Connection Tags,
Transfer Tags, System Class Tags, System Unit Tags, System Connection Tags, and System Seg-
ment Tags. Each type has a unique responsibility as described below
.
Table 5-5. Tag Types and Usage

Value
from
Control
Tag Type Use System Comments
Unit Process Modeling: Yes
Transfer and Process Phase
Interlocks
All SCADA Applications

76
5. Process Modeling B0193YB – Rev C

Table 5-5. Tag Types and Usage (Continued)

Value
from
Control
Tag Type Use System Comments
Process Process Modeling: No Note 1: For each process tag, the
Process Phase Control Buttons Model Editor automatically cre-
Process Phase Control Bits ates one unit tag for each unit in
Process Phase Status Bits the process class.
Process Phase Formula Parameters Note 2: For each process class, the
Recipes: Modeling Editor automatically
Transition Logic creates a set of System Class tags.
Note 3: For each unit in the pro-
cess class, the Model Editor auto-
matically creates a set of System
Unit tags.
Connection Process Modeling: Yes
Transfer and Process Phase Inter-
locks
All SCADA Applications
Transfer Process Modeling: No Note: For each transfer tag, the
Transfer Phase Control Buttons Model Editor automatically cre-
Transfer Phase Control Bits ates one connection tag for each
Transfer Phase Status Bits connection in the transfer.
Transfer Phase Formula
Parameters
Recipes:
Transition Logic
System Process Modeling: No Note 1: System tags are internal
Class Process Phase Formula Parameters batch control system tags and are
Transfer Phase Formula Parameters updated by the batch management
Recipes: system.
Transition Logic Note 2: System Class tags are
automatically generated for each
process and transfer class defined
in the process model.
System Unit All SCADA Applications No Note: System Unit tags are auto-
matically created for each unit
assigned to a process class.
System All SCADA Applications No Note: System Connection tags are
Connection automatically created for each
connection assigned to a transfer
class.
System All SCADA Applications No Note: System Segment tags are
Segment automatically created for each
defined segment.

77
B0193YB – Rev C 5. Process Modeling

Unit Tags
Unit tags define data points that are uniquely associated with a single processing unit.

Process Tags
Process tags define all the data points that are common to all the units associated with a process
class. Each automatically defined process tag generates a set of unit tags for each member in the
process class. For example, if there are three units in a process class and one process tag is entered,
three unit tags are created: one for each unit in the process class. Each of these unit tags may cor-
respond to a specific address in a control system. Process tags are indirectly associated to the con-
trol system by way of the unit tags that they create.
Process tags have an abstract nature; that is, they are not directly associated with the control sys-
tem. They represent a set of unit tags. Process tags become unit tags when a batch is executed in a
process. Process tags may be used as part of recipe transition logic.

Connection Tags
Connection tags define data points uniquely associated with a connection.

Transfer Tags
A transfer tag defines the data points that are common to all the connections associated with a
transfer class. Each automatically defined transfer tag generates a set of connection tags for each
member in the transfer class. For example, if there are three connections in a transfer and one
transfer tag is entered, three connection tags are created: one for each connection in the transfer
class. Each of these connection tags may correspond to a specific address in a control system.
Transfer tags are indirectly associated with the control system by way of the connection tags that
they create.
Transfer tags are abstract in nature; that is they are not directly associated with the control system.
They represent a set of connection tags. Transfer tags become connection tags when a batch is exe-
cuted in a process. Transfer tags may be used as part of recipe transition logic.

System Tags
System tags are automatically created by the Model Editor when a process class, transfer class, or
segment is added to the model. There are four types of system tags: System Class tags, System
Unit tags, System Connection tags, and System Segment tags. System Class tags are identical to
process/transfer tags, system unit tags are identical to unit tags, and System Connection tags are
identical to connection tags. System Segment tags are similar to system connection tags. System
Class tags do not correspond to a specific address in the control system. They are internal batch
control system tags. However, they may be assigned to formula parameter elements and used in
recipe transition logic. System unit, connection, and segment tags may be assigned to the control
system and can be used in SCADA applications.

78
5. Process Modeling B0193YB – Rev C

Table 5-6. Unit, Connection and Segment Information

Description System Class Tagname Data/Information

Unit Allocation Possible Values:
Information Ready
Allocated
Batch_ID Batch ID of batch unit is allocated to.
Batch_Mode Possible Values:
Automatic
Semi-Auto
Manual
Batch_Size Assigned batch size of batch within unit.
Batch_Status Possible Values:
Open
Ready
Run
Held
Aborting
Aborted
Done
Campaign_ID Campaign ID of batch to which unit is allocated.
Last_Recipe_ID ID of last recipe produced within unit.
Lot_ID Lot ID of batch to which unit is allocated.
Recipe_ID ID of recipe assigned to batch within unit.
Recipe_Name Name of recipe assigned to batch within unit.
Status Current status of unit. Possible values are defined by
user in the Equipment Status tab within the Process
Model Editor.
Connection Allocation Possible Values:
Information Ready
Allocated
Availability Possible Values:
Available
Unavailable
Batch_ID Batch ID to which connection is allocated.
Campaign_ID Campaign ID to which connection is allocated.
Last_Recipe_ID ID of last recipe produced within connection.
Lot_ID Lot ID to which connection is allocated.

79
B0193YB – Rev C 5. Process Modeling

Table 5-6. Unit, Connection and Segment Information (Continued)

Description System Class Tagname Data/Information

Segment Allocation Possible Values:
Information Ready
Allocated
Batch_ID Batch ID to which segment is allocated.
Campaign_ID Campaign ID to which segment is allocated.
Last_Recipe_ID ID of last recipe produced within segment.
Lot_ID Lot ID to which segment is allocated.
Status Current status of segment. Possible values are defined
by user in the Equipment Status tab within the Process
Model Editor.

Using Process and Transfer Tags versus Unit and Connection

Tags
The following guideline can help you decide when to define a tag as a process, transfer, unit, or
connection tag.
1. Any data point that is common to all units in a process class can be entered as a pro-
cess tag.
2. Any data point that is common to all connections in a transfer class can be entered as
a transfer tag.
3. Any data point that is not common to all units in a process class must be entered as a
unit tag.
4. Any data point that is not common to all connections in a transfer class must be
entered as a connection tag.
5. Any data point that is to be used in recipe transition logic must be entered as either a
process or transfer tag.
6. Any critical phase logic data point must be entered as a process or transfer tag. The
critical phase logic data points are required by the batch management system to con-
trol, monitor, and configure a phase based on a recipe’s requirements. The following
table lists the critical phase logic data points.

Table 5-7. Critical Phase Logic Data Points

Item Data Point

Phase Control Bits Start
Hold
Restart
Abort
Reset

80
5. Process Modeling B0193YB – Rev C

Table 5-7. Critical Phase Logic Data Points (Continued)

Item Data Point

Phase Status Bits Ready
Run
Held
Done
Interlocked
Aborted
Control Buttons Control Button #1
Control Button #2
Formula Parameter Elements Target
- Process Variable Actual
High Deviation (%)
Low Deviation (%)
High Limit
Low Limit
Formula Parameter Elements Target
- Input Actual
High Deviation (%)
Low Deviation (%)
Preact
Lot Code
Material ID
Formula Parameter Elements Target
- Output Actual
Material ID

Tag Definition
A tag consists of a structured name. Each tagname must be unique within the batch control sys-
tem. The terms tagname and tag are used throughout the documentation to refer to tags in the
process model.

Tagname
A tagname is a unique, structured name that defines one data point. Tagnames have a hierarchical
structure. The highest level of the structure depends on the tag type. The Unit name is the highest
level for unit tags, the Process class name for process tags, the Connection name for connection
tags and the Transfer class name for transfer tags. Each is followed by Phase, Parameter and
Element.
The following table describes tagname structure.

81
B0193YB – Rev C 5. Process Modeling

Table 5-8. Tagname Structure

Name Number of Characters

Unit or Connection, Process Class or Transfer Class 12
Phase Name 12
Parameter Name 16
Element Name 16

You can use the following characters in a tagname.

A through Z (uppercase), 0 through 9, _ (underscore)

Table 5-9 describes tagname delimiters.

Table 5-9. Delimiters

Item Delimiter
Between Names . (period)

Some tagnames are automatically generated.

Table 5-10. Automatically Generated Tagnames

Automatically
Tag Appended
Classification Parameter Name Element Name Description
Unit System not used CAMPAIGN_ID Campaign ID
Tags LOT_ID Lot ID
BATCH_ID Batch ID
RECIPE_ID Recipe ID
RECIPE_NAME Recipe Name
BATCH_SIZE Batch Size
BATCH_STATUS Batch Status
BATCH_MODE Batch Mode
STATUS Unit Status
ALLOCATION Unit Allocation
LAST_RECIPE_ID Last Recipe ID
STATE Unit State
Connection not used CAMPAIGN_ID Campaign ID
System Tags LOT_ID Lot ID
BATCH_ID Batch ID
AVAILABILITY Connection Availability
ALLOCATION Connection Allocation
LAST_RECIPE_ID Last Recipe ID

82
5. Process Modeling B0193YB – Rev C

Table 5-10. Automatically Generated Tagnames (Continued)

Automatically
Tag Appended
Classification Parameter Name Element Name Description
Segment not used CAMPAIGN_ID Campaign ID
System Tags LOT_ID Lot ID
BATCH_ID Batch ID
STATUS Segment Status
ALLOCATION Segment Allocation
LAST_RECIPE_ID Last Recipe ID
Phase Control CONTROL_STATUS START Start
Tags HOLD Hold
RESTART Restart
ABORT Abort
RESET Reset
Phase Status CONTROL_STATUS READY Ready
Tags HELD Held
RUN Run
DONE Done
ABORTED Aborted
INTERLOCKED Interlocked
Unit Control not used UNIT_HOLD Unit Hold
Tags UNIT_RESTART Unit Restart
UNIT_ABORT Unit Abort
Phase Parameter Name ACTUAL Actual
Parameter Tags TARGET Target
HIGH_DEVIATION High Deviation
LOW_DEVIATION Low Deviation
HIGH_LIMIT High Limit
LOW_LIMIT Low Limit
PREACT Preact
LOT_CODE Lot Code
MATERIAL_ID Material ID

Tag Description
Each tag can be given a 120-character description. This allows for complete documentation of
every tag in the system.

Data Class
A tag can be classified as discrete, analog, string or enumeration. Discrete tags have two logical
states: zero (0) and one (1). Analog tags reflect the process status with a numerical value and may
have many states. String tags are identified by an alphanumeric value and can contain up to 80
characters. Enumeration tags are identified by an integer value which represents a textual enumer-
ation name.

83
B0193YB – Rev C 5. Process Modeling

Access Mode
Access Mode defines whether a tag is read-only or read/write. A checkbox is used to select the
access mode for a tag.

Process Modeling Summary

Figure 5-2. Process Modeling Summary

84
5. Process Modeling B0193YB – Rev C

Example: Process Phases and Tags

The example shown on the following pages illustrates how a Heat phase block can be developed
and interfaced to the batch control system for two reactors. The two reactors found in the exam-
ple plant are in the same Process Class called Reactors. The names of the reactors are Reactor A
and Reactor B.

Ramp Heat Phase Logic

A phase block must be developed for each reactor to perform the heat function. When instructed
to run, the heat phase block heats the contents of the reactor to a specified temperature and at the
specified rate. The target temperature and rate are parameters used to configure the phase block.
The parameters, which are both designated as process variables, are assigned a value in the recipe.
The value becomes part of the recipe formula.
The Heat phase blocks must be designed to be completely independent of each other.
Reactor A and Reactor B are identical to each other in every way, except that Reactor B utilizes a
special pressure probe, which Reactor A does not have.
To keep our example simple, only one input and one output are shown for each phase. In actual-
ity, there may be several inputs and outputs, as well as many other internal data points that may
be common to each phase.
For more information on Phase Logic, see Chapter 6 “Tag Management”.

Process Tags and Unit Tags

Reactor A and Reactor B are in the same Process Class. Therefore, process tags that define the
interface between the batch control system and the generic phase named Heat, must be defined.
The interface requires that process tags be defined for phase control, phase status, formula param-
eters, control buttons, and interlocks. If inputs, outputs, and internal data points are common to
each phase, which is the case in this example, they are also entered as process tags. Any tags that
are not common to both of the phase blocks are entered as unit tags. The only unit tag in this
example is the Reactor B Pressure Probe.
Each process class tag is a global tag that represents a set of unit tags; one unit tag for each reactor
in the class. For example,
REACTORS.HEAT.CONTROL_SYSTEM.START is a global tag that represents the
REACTOR_A.HEAT.CONTROL_SYSTEM.START and
REACTOR_B.HEAT.CONTROL_SYSTEM.START unit tags.

Process Classes and Generic Phases in Recipe Editor

Process tags are used to define the interface points between the batch control system and a generic
phase defined for a process class. In this example, Heat is the generic phase and Reactors is the
process class. Recipe Editor creates Master Recipes which are equipment independent. The Recipe
Editor references process classes (Reactors) and generic phases (Heat) instead of specific units
(Reactor A) and phases (Reactor A Heat).
For more information on Master Recipes and Recipe Editor, see Chapter 8 “Recipe Editor”.

85
B0193YB – Rev C 5. Process Modeling

Batch Manager Resolves Process Tags into Unit Tags

Process tags and process classes are of an abstract nature. This means that they are not associated
with a specific piece of process equipment. Rather, their association with actual equipment occurs
when a batch is defined, scheduled and then executed.
Batches are defined by specifying a Campaign ID, Lot ID, Batch ID, Recipe ID, and Train. Reci-
pes are equipment independent. Trains specify the process equipment (units) to be used. The
batch management system uses the Recipe and Train information to resolve which Heat phase,
and ultimately, the set of unit tags that is used.

86
5. Process Modeling B0193YB – Rev C

Figure 5-3. Example Plant

Model Editor
Use Model Editor (ModelEdit) to create and edit the process model. While you are using the
Model Editor, all additions and changes that you make to the model are dynamically updated in
the process model configuration database (CfgModelDB).

87
B0193YB – Rev C 5. Process Modeling

Model Editor guides and verifies, where possible, that entries and assignments are made correctly.
It is ultimately your responsibility to accurately define the process model.
Once all the configuration changes have been made, the Environment Display Update Runtime
menu option must be used to copy the process model configuration database (CfgModelDB) to
the process model run-time database (ModelDB). This allows the run-time system to access the
configuration changes. The Environment Display Update Configuration menu option should be
used to copy the process model run-time database (ModelDB) to the process model configuration
database (ModelDB).

! WARNING
Use caution when updating your configuration from Environment Display. When
you update the configuration, the process model configuration database is overwrit-
ten by the process model run-time database. All configuration changes are lost.

Figure 5-4. Copying the Process Model Configuration Database

As you read this section, please note that all editors and windows utilize the following conven-
tions:
Editors: Whenever you enter new elements, you must click the Add button. If you make changes
to an element, you must click the Change button. To remove elements, click Delete.
Assigning and Selecting: After selecting the item(s), you must click the Apply button. Clicking
OK applies your selections and closes the associated dialog box. Clicking the Close button closes a
window. List box items are selected and deselected by single-clicking the list item. When applica-
ble, multiple entries can be selected by holding down the control (or shift) key while simulta-
neously left-clicking the desired items.

Deleting Model Components

! WARNING
It is important to understand that when you delete a unit, process class, connection,
or transfer class, that other elements of the overall process model are also deleted.
Always back up your work before making changes. The following table describes the
effect of deleting model components.

88
5. Process Modeling B0193YB – Rev C

Table 5-11. Deleting Model Components

Element
Deleted Related Deletions
Unit All unit tags associated with the unit
All unit tags associated with the Process Class to which the unit is assigned
All connections in which the unit is a source or a destination
Process Class All process tags associated with the class
All unit tags resulting from the process tags
All process phases associated with the class
All transfers in which the class is a source or a destination
Connection All connection tags associated with the connection
All connection tags associated with the Transfer Class to which the connection
is assigned
Transfer Class All transfer tags associated with the transfer
All connection tags resulting from the transfer tags
All transfer phases associated with the class

NOTE
You cannot delete a Unit that is assigned to a train until you remove the unit from
each train. When you delete a unit that is assigned to a train(s), the train names in
which the unit has been assigned are displayed in the Batch Logger.

For more information on creating trains, see Chapter 9 “Train Editor”.

Using Model Editor

Use Process Modeling Editor to define and edit all your process model.

To Start Model Editor:

1. On Environment Display, double-click the ModelEdit icon.

NOTE
Model Editor does not start if you are running Train Editor or IA Link. You cannot
start more than one instance of Model Editor.

2. The Process Modeling Editor window appears.

89
B0193YB – Rev C 5. Process Modeling

File Menu
The Process Model Editor File menu provides system functions for the Process Modeling Editor.

File/Validate
Use the File/Validate menu to initiate a validation of the process model database. Validation con-
sists of a verification of the following elements.
♦ All Automatic phases have tag assignments for (minimally) the Start, Reset, Ready,
and Done phase control and status bits.
♦ All Semi-Automatic phases have tag assignments for (minimally) the Start, Reset,
Ready, and Done phase control and status bits.
♦ All tags assigned to an Edit Allowed or Edit Required actual element of a formula
parameter must have a read/write access mode.
♦ At least one equipment status has been defined.
♦ One of the defined equipment statuses has been assigned as the default status.

90
5. Process Modeling B0193YB – Rev C

To Validate the Process Model:

1. Click File on the Process Modeling Editor and then select Validate.
If the validation is successful, the Validation window indicates that the process model
configuration is valid. If validation errors exist, the associated phases and/or tags are
displayed along with a validation error message. You can use the information to trou-
bleshoot the process model configuration.
2. Click Close to close the Validate window.

File/Print
Use the File/Print menu to print one or more formatted reports. The reports allow you to select
the elements of your process model.

To Print Reports from the Model Editor:

1. Click File on the Process Modeling Editor and then select Print.
The Print window allows you to select one or more of the following reports from the
Select Report list box:
♦ Units
♦ Unit Tags
♦ Connections
♦ Connection Tags
♦ Enumerations
♦ Equipment Status
♦ Process Classes
♦ Process Tags
♦ Process Phases
♦ Segments
♦ Segment Tags
♦ Transfer Phases.
2. If you want to select a different printer than the one listed, click the Printer Name
drop-down box and specify a printer.
3. If you want to change any printer settings, click the Properties button and enter your
changes.
4. If you want to print your report(s) to a file, enable the Print to File checkbox. You are
prompted later for the name of the file to which you want to print.
5. If you want to print multiple copies of the report(s), enter the quantity in the Number
of Copies combo-box.
6. Click OK to print the report(s).

File/Print Preview
Use the File/Print Preview menu to view one or more formatted reports on the screen. The reports
allow you to select the elements of your process model.

91
B0193YB – Rev C 5. Process Modeling

To Preview Reports from the Model Editor:

1. Click File on the Process Modeling Editor and then select Print Preview.
2. Select one or more reports from the list box described earlier and click OK.
3. A preview of your report is displayed on the screen.

File/Print Setup
Use the File/Print Setup menu to set up your printer using the standard windows printer dialog
box. Refer to your Windows NT documentation for more information.

File/Exit
Use File/Exit to close the Process Modeling Editor window.

NOTE
All your work is automatically saved in the configuration process model database as
you edit the process model. You do not need to be concerned about saving your
changes.

Edit Menu
The Process Modeling Editor Edit menu contains a list of items that correspond to the Process
Modeling Editor tabs. Each of the associated Process Modeling Editor tabs are discussed later in
this section.

Edit/Units
Use the Edit/Units menu to display the Process Modeling Editor Units tab.

Edit/Processes
Use the Edit/Processes menu to display the Process Modeling Editor Processes tab.

Edit/Connections
Use the Edit/Connections menu to display the Process Modeling Editor Connections tab.

Edit/Transfers
Use the Edit/Transfers menu to display the Process Modeling Editor Transfers tab.

Edit/Segments
Use the Edit/Segments menu to display the Process Modeling Editor Segments tab.

Edit/Equipment Status
Use the Edit/Equipment Status menu to display the Equipment Status tab.

Edit/Units of Measure
Use the Edit/Units of Measure menu to display the Units of Measure tab.

92
5. Process Modeling B0193YB – Rev C

Edit/Enumeration
Use the Edit/Enumeration menu to display the Enumeration tab.

Help Menu
The Process Modeling Help menu contains commands that provide you with access to the online
Help system and information regarding product version and licensing.

Help/Help Topics
Use the Help/Help Topics menu to display the online Help for the Process Modeling Editor.

Help/About Process Modeling

Use the Help/About Process Modeling menu to view product version information.

Units Tab
Use the Units tab to define and edit process model units for the processing vessels in the plant.

To Display the Units Tab:

1. On the Process Modeling Editor window, click the Units tab.
The Units tab appears.

93
B0193YB – Rev C 5. Process Modeling

All the available units in your process model are listed in the Units list box. The
selected unit name appears in the Name box. Information regarding the Unit appears
in the Description box.

Adding Units
To Add a Unit:
1. In the Name box, enter a name for the unit (12-char max).
2. In the Description box, you can optionally enter text describing the unit (120-char
max).
3. Click Add to include the new unit in the Units list.
The editor verifies all unit names to ensure validity and uniqueness. You are prompted
to change the unit name in the event you enter a duplicate.

Changing Unit Names

To Change a Unit Name:
1. From the Units list, select the Unit that you want to change.
2. In the Name box, enter a name for the unit (12-char max).

94
5. Process Modeling B0193YB – Rev C

3. In the Description box, you can optionally enter text describing the unit (120-char
max).
4. Click Change to update the unit in the Units list.
The editor verifies all unit names to ensure validity and uniqueness. You are prompted
to change the unit name in the event you enter a duplicate.

Deleting Units
To Delete a Unit:

! WARNING
It is important to understand that deleting a unit affects other elements of the over-
all process model. Always back up your work before making changes.

1. From the Units list, select the Unit that you want to delete.
2. Click Delete.
If you attempt to delete a unit that is part of a train, the following Process Modeling
Editor warning appears, and the unit is not deleted. In this case, you must first delete
the unit(s) from the train, and then delete the unit from the model.

Editing Unit Tags

Each unit in a process model may have tags associated with it. Use Edit Unit Tags window to asso-
ciate tags with a unit. Tags that are associated with process phases must be entered as Process Tags.
A Unit tag consists of the following elements. Some elements are required, while others are
optional.
♦ Phase Name (optional, 12-char max)
♦ Parameter Name (optional, 16-char max)
♦ Element Name (required, 16-char max)
♦ Description (optional, 120-char max)
♦ Data Class (required, Enumeration, Analog, Discrete, or String)
♦ Access Mode (required, Either Read Only or Read/Write).

To Edit Unit Tags:

1. On the Units tab, click the Tags button.
2. The Edit Unit Tags window appears.

95
B0193YB – Rev C 5. Process Modeling

Processes Tab
Use the Processes tab to define and edit process class units for the processing vessels in the plant.

To Display the Processes Tab:

1. On the Process Modeling Editor window, click the Processes tab.
2. The Processes tab appears.

96
5. Process Modeling B0193YB – Rev C

All the available Process Classes (processes) in your process model are listed in the Pro-
cess Classes list box. When a process class is selected, its name appears in the Name
box. Information regarding the Process Class appears in the Description box.

Adding Process Classes

To Add a Process Class:
1. In the Name box, enter a name for the process (12-char max).
2. In the Description box, you can optionally enter text describing the process (120-char
max).
3. Click Add to include the new process in the Process Classes list.
The editor verifies all process names to ensure validity and uniqueness. You are
prompted to change the process name in the event you enter a duplicate.

Changing Process Class Names

To Change a Process Class Name:
1. From the Process Classes list, select the Process that you want to change.

97
B0193YB – Rev C 5. Process Modeling

2. In the Description box, you can optionally enter text describing the process (120-char
max).
3. Click Add to include the new process in the Process Classes list.
4. Click Change to update the Process in the Process Classes list.
The editor verifies all Process Class names to ensure validity and uniqueness. You will
be prompted to change the name in the event you enter a duplicate.

Deleting Process Classes

To Delete a Process Class:

! WARNING
It is important to understand that deleting a process class affects other elements of
the overall process model. Always back up your work before making changes.

1. From the Process Classes list, select the Process that you want to delete.
2. Click Delete.
3. When you delete a Process Class, the editor displays a warning message indicating the
relationship of the tags in process class to other batch system elements. Read any such
warning messages very carefully.

Unit Control/State Tags

Unit Control Tags are used by Batch Manager to inform the control system of an operator initi-
ated Batch Hold, Restart, or Abort. When a Hold, Restart, or Abort is initiated, Batch Manager
identifies the units involved in the batch and sets the appropriate tag(s) within the control system.
The control system manages control phase logic as required by an application. There are three
types of unit control tags: Unit Hold, Unit Restart, and Unit Abort.
Unit State Tags are discrete, and are used by Batch Manager to inform the control system that the
status of a unit is Alarm, Held, Run or Ready.
Unit Control/State Tags are automatically created for each unit in a class when you enable the Use
Unit Control/Status Tags checkbox.

To Enable Unit Control/State Tags for a Process Class:

1. From the Process Classes list, select the required Process.
2. Enable the Unit Control/State Tags checkbox.
3. Click Change to associate the unit control and unit state tags with the Process Class.

Assigning Units
A process class can have one or more units assigned to it. Use the Assign Units button on the Pro-
cesses tab to associate units to a process class.

To Assign Units to a Process Class:

1. On the Processes tab, select the required process from the Process Class list.

98
5. Process Modeling B0193YB – Rev C

2. All the units that are currently assigned to the selected Process Class are displayed in
the Units list.
3. You can select and deselect units appearing in the Units list.
4. If you want to add additional units to the Units list, and ultimately, the process class,
click the Assign Units button.
The Assign Units to Process window appears.

99
B0193YB – Rev C 5. Process Modeling

The Units list displays all the units (unassigned and previously assigned units) that can
be assigned to the process class. Units that were previously assigned are, by default,
selected.
5. In the Units list, select the appropriate items.
6. Click Apply.
The selected units appears in the Units list on the Processes tab.

Process Class Attributes

Attributes are process class characteristics that you define during recipe creation. Attributes allow
you to categorize, or narrow, the available units that can be selected from the process class. There
is no limit to the number of attributes that you can define for a class.
Use the Edit Attributes window to Add, Change and Delete Process Class Attributes.

To Assign Attributes to a Process Class:

1. On the Processes tab, click the Attributes button.
The Edit Attributes window appears.

100
5. Process Modeling B0193YB – Rev C

2. If Attributes have already been created for the process class, they appear in the Pro-
cess Attributes list.
3. If you are adding a new Attribute, enter a name in the Name box (16-char max).
4. Click Add.
5. The Process Attributes list displays the attributes.

NOTE
The editor verifies all new attribute names to ensure validity and uniqueness. You
are prompted to change the name in the event you enter a duplicate.

Assigning Unit Attribute Values

After an attribute(s) has been created, specific values for each attribute must be defined for each
unit that belongs to the process class. Only numeric values can be assigned. This may require
defining an external translation table so that value assignments can easily be related for the appro-
priate attribute. In the example plant referenced earlier, stainless steel reactors have been assigned
a value of 1 and glass lined reactors have been assigned a value of 2. Also, a separation type of 1
represents the presence of a liquid/oil separator, while a value of 2 represents the presence of a liq-
uid/solid separator.

To Assign a Unit Attribute Value:

1. On the Processes tab, from the Units list, select the required unit.
2. In the Value field, enter a value in accordance with your requirements.
3. Click the Change button.
The value appears in the unit’s Attribute/Value list.

101
B0193YB – Rev C 5. Process Modeling

Editing Process Class Tags

Each process class may have tags associated with it. All the tags that are associated with a process
phase, or that are common to all the units within the process class, must be entered using the Edit
Process Tags window.
Defining a process class tag requires the entry of the following information.
♦ Phase Name (optional, 12-char max)
♦ Parameter Name (optional, 16-char max)
♦ ElementName (required, 16-char max)
♦ Description (optional, 120-char max)
♦ Data Class (required, analog, discrete, string, or enumeration)
♦ Access Mode (required, either read-only or read/write).

NOTE
It is important to remember that for every process tag that is created, unit tags are
automatically generated for each unit assigned to the class. These unit tags, not the
process tags, are associated to data points in the control system. However, the pro-
cess class tags are available for assignment to formula parameters and to the recipe
builder through the transition logic expression builder.

102
5. Process Modeling B0193YB – Rev C

Use the Edit Process Tags window to add, change or delete process class tag properties.

To Edit a Process Class Tag:

1. On the Processes tab, click the Tags button.
The Edit Process Tags window appears.
All tags previously assigned to the Process Class are listed.

2. Enter/edit the Phase Name, Parameter Name, Element Name, Description, Data
Class and Access mode as described earlier in this section.
3. Click Add if you are creating a new tag, or click Change if you are modifying an exist-
ing tag.
4. Click Close to close the Edit Process Tags window.

Process Class Phases

Use the Edit Phases window to assign phases to a process class. Each process class can have any
number of phases. Process phase types can be automatic or manual. Automatic phases require
control system phase logic. Manual phases and Download phases are executed by the batch man-
agement system.

103
B0193YB – Rev C 5. Process Modeling

Defining a process class phase requires the entry of the following information.
♦ Phase Name (optional, 12-char max)
♦ Description (optional, 120-char max)
♦ Phase Type (required, automatic, manual or download)
♦ Control Buttons (optional, 2 available buttons)
♦ Interlocks (optional, available for all tags)
♦ Formula Parameters (optional, Assign as required for the Process Class)
♦ Save History (optional, Save Control/Status Activity, and/or Parameter Status).

To Edit a Process Class Phase:

1. On the Processes tab, click the Phases button.
The Edit Phases window appears.
All Phases previously assigned to the Process Class are listed.

2. Enter/edit the appropriate Name and Description as described earlier in this section.
3. Click the Phase Type drop-down arrow, and select Automatic, Manual or Download
as required.
4. Click Add to include the phase in the list or click Change if you have edited an exist-
ing phase.
5. Configure additional phase options as described in the following text.

Save History
Use the Save History Control/Status Activity and Parameter Status checkboxes to configure the
type of phase activity that will be stored in the history database. All data stored in the history data-
base is stamped with the time and date. You can enable both checkboxes if required. Use of this
History feature is optional.

104
5. Process Modeling B0193YB – Rev C

To Enable Save History Options:

1. In the Edit Phases window, enable the Control/Status Activity and/or
Parameter Status checkbox(es).
Enable the Control/Status Activity box to include all phase control and status bit
transitions.
Enable the Parameter Status box to include (when the phase is done) all parameter
element values, control button activity, and phase instructions.
2. Click Change.

Control Buttons
You can include Control Buttons as part of the user interface. The buttons are a part of the
selected process class phase. To use a control button, you must associate a tagname with the
desired button.
For more information on Control Buttons, see “Process Phase Configuration” and “Additional
Phase Configuration” later in this section.

To Configure Control Buttons:

1. On the Edit Phases window, click Control Buttons.
The Edit Phase Control Buttons window appears.

2. Enable Button 1 or Button 2 as required.

3. In the Label box, enter the text (8-char max) that you want to appear on the button.
4. Click Assign Tag.
If you want to remove a tag that is associated with the control button, click Clear Tag.
Remember that modifying any assignments may affect other parts of your overall pro-
cess model.
The Tag Selection window appears.

105
B0193YB – Rev C 5. Process Modeling

5. Select a tag from the list.

You can sort list items by clicking a column heading.
6. Click OK to assign the tag to the control button, and close the Tag Selection window.

Phase Control/Status Bits

Use the Edit Phase Control/Status window to configure Phase Control and Phase Status bits. To
configure phase control and phase status bits, you must associate tags from the process phase and
process class.
For more information on Phase Control/Status bits, see “Process Phase Configuration” and
“Additional Phase Configuration” later in this section.

To Configure Phase Control/Status Bits:

1. On the Edit Phases window, click Phase Control/Status.
The Edit Phase Control/Status window appears.
The window shows the configuration for the selected Process Class and Phase.

106
5. Process Modeling B0193YB – Rev C

2. Configure the Phase Control and Phase Status bits as required.

For more information on Phase Control/Status bits, see “Process Phase Configuration” and
“Additional Phase Configuration” later in this section.

Interlocks
Use the Edit Process Interlocks window to configure interlocks for a process class phase. To assign
interlocks, you must associate unit tags with the process phase and process class.
For more information on configuring Interlocks, see “Process Phase Configuration” and “Addi-
tional Phase Configuration” later in this section.

To Configure Interlocks:
1. On the Edit Phases window, click the Interlocks button.
The Edit Process Interlocks window appears.

107
B0193YB – Rev C 5. Process Modeling

The window shows all the available units in the process class and any tags (process
class/transfer) assigned to the selected unit.

2. Click the Assign Tags button.

The Tag Selection window appears.

108
5. Process Modeling B0193YB – Rev C

3. Select the required tag(s) from the list.

4. Click OK to assign the selected tag(s) to the Tags list on the Edit Process
Interlocks window.

Formula Parameters
Use the Edit Formula Parameters window to configure formula parameters for a process class
phase.
For detailed information on configuring Formula Parameters, see “Process Phase Configuration”
and “Additional Phase Configuration” later in this section.

To Configure Formula Parameters:

1. On the Edit Phases window, click the Formula Parameters button.
The Edit Formula Parameters window appears.

109
B0193YB – Rev C 5. Process Modeling

The window shows the Formula Parameter configuration of the selected Process Class
and Phase.
For detailed information on configuring Formula Parameters, see “Process Phase Configuration”
and “Additional Phase Configuration” later in this section.

Automatic Process Phases

Automatic process phases are executed in the control system. Operator interaction can be a nor-
mal part of the process or can occur only when abnormal situations arise. Operator actions could
involve putting the phase in hold or entering parameter values while the phase is running.
Enabling the operator to change parameter values is defined when the formula parameters are
configured.
Automatic process phases must have control system phase logic, and therefore, must have Phase
Control and Status Bits defined. Interlocks, Control Buttons, and Formula Parameters are
optional.
When the batch management system encounters an automatic process phase with an input type
parameter, the batch management system updates the material usage record in the materials data-
base based on the actual amount used.
For more information on material location assignments, see Chapter 7 “Materials Editor”.

110
5. Process Modeling B0193YB – Rev C

The batch control system can be configured to handle many different automatic process phases.
The following examples describes several examples of automatic phases. The phase names corre-
spond to the processing capabilities associated with the example plant referenced earlier.
1. Phase Name: Heat
Increase the temperature of the unit to a specified temperature at a specified rate.
2. Phase Name: Cool
Decrease the temperature of the unit to a specified temperature at a specified rate.
3. Phase Name: Soak
Maintain the temperature of the unit at a specified temperature for a specified time.
4. Phase Name: Agitate
Turn the agitator on for a specified time.
5. Phase Name: AgitOn
Turn the agitator on.
6. Phase Name: AgitOff
Turn the agitator off.
7. Phase Name: Charge
Co-ordinated with a source unit discharge phase, this phase represents one of the ways
in which materials can be moved and tracked. It is responsible for enabling the flow of
a material into the unit.
8. Phase Name: Discharg
Co-ordinated with a destination unit charge phase, this phase represents one of the
ways in which raw materials can be moved and tracked. It is responsible for enabling
the flow of a material out of the unit.
Possible phase parameter configurations for these automatic process phase examples are shown
below.

Table 5-12. Phase Parameter Configurations

Phase
Phase Control/Status Interlocks and
Phase Logic Parameters Formula Control
Name Required Required Parameters Buttons
Heat Yes Yes Rate Temp As Needed
Cool Yes Yes Rate Temp As Needed
Soak Yes Yes Time Temp As Needed
Agitate Yes Yes Time As Needed
AgitOn Yes Yes None As Needed
AgitOff Yes Yes None As Needed
Charge Yes Yes Quantity As Needed
Discharg Yes Yes Quantity As Needed

111
B0193YB – Rev C 5. Process Modeling

Formula Parameter Configuration of Automatic Process Phases

There are three types of Formula Parameters: Input, Output, and Process Variable. Process vari-
able parameters are used to represent setpoints, rates, and so forth. Input and output parameters
are used when material tracking is required. Also, a specific data class type must be assigned to
each formula parameter. The available data class options are Analog, Discrete, String, and Enu-
meration. Enumeration is only available for Process Variable type parameters. Tag assignments to
the elements associated with each parameter correspond to the assigned data class of the parame-
ter. For example, only analog tags can be assigned to the elements of an analog process variable
parameter.
Input parameters have seven elements. The parameter name defines a family of information while
Elements define the members of the family. The seven elements for input parameters are Target,
Actual, High Deviation, Low Deviation, Preact, Lot Code, and Material ID.
Output parameters have three elements. The parameter name defines a family of information
while Elements define the members of the family. The three elements for output parameters are
Target, Actual, and Material ID.
Process variables have six elements. The parameter name defines a family of information. Ele-
ments define the members of the family. The six elements for process variables are Target, Actual,
High Deviation, Low Deviation, High Limit, and Low Limit.
The configuration of the parameter type, data class, and elements is extremely important. The
batch management system controls a phase and interacts with both the control system and the
operator based on the configuration of the parameters. The following sections contain a detailed
explanation of the results that can you can achieve for different parameter configurations.

Target Element
The target element is available for all parameter and data class combinations and is configured as
follows:
1. Select the Enable Display checkbox if the target value is to be displayed during the
run-time execution of the phase. If a tag is assigned to the element, the value assigned
in the recipe will be written to the control system by the batch management system
prior to the start of the phase. Typically, the phase logic uses the target value to deter-
mine when to end the phase.
2. If the operator is allowed to modify the target, enable the Edit Allowed checkbox.
3. If the operator must modify the target, enable the Edit Required checkbox.
4. A Default Value can be assigned to the target element for process variable parameters
of any data class.

Actual Element
The actual element is available for all parameter and data class combinations and is configured as
follows:
1. Select the Enable Display checkbox if the actual value is to be displayed during the
run-time execution of the phase. If a tag is assigned to the element, the batch manage-
ment system reads the value of the tag, in real time, from the control system during
the execution of the phase.
2. If the operator is allowed to modify the actual value, enable the Edit Allowed check-
box.

112
5. Process Modeling B0193YB – Rev C

3. If the operator must modify the actual, enable the Edit Required checkbox.

High and Low Deviation Elements

High and low deviation elements are available for analog process variable parameters and analog
input parameters and are expressed as a percentage of the target value. If tags are assigned, the
batch management system calculates and writes the deviation values to the control system prior to
the start of the phase. Deviations are recalculated if changes are made to the target or deviation
elements. For example, if the target value is 100, the high deviation is 3%, and the low deviation
is 5%, the downloaded high and low deviation values are 3 and 5 respectively.
High and low deviation elements are configured as follows:
1. Select the appropriate Enable Display checkbox if either of the element values is to be
displayed during the run-time execution of the phase. Typically, the phase logic uses
the deviations to establish alarm limits or an acceptable phase completion range for
the actual value of the parameter.
2. If the operator is allowed to modify either of the deviation values, then enable the Edit
Allowed checkbox.
3. If the operator must modify either of the deviation values, then enable the Edit
Required checkbox.
4. A Default Value can be assigned to the high and low deviation elements for analog
process variable parameters only.

High and Low Limit Elements

The high and low limit elements are available for analog process variable parameters and are used
by the Recipe Editor and the batch management system to prevent the entry of out of range
values. If tags are assigned, the batch management system writes the limit values to the control
system prior to the start of the phase.
The high and low limit elements are configured as follows:
1. Select the appropriate Enable Display if either of the element values is to be displayed
during the run-time execution of the phase.
2. A Default Value can be assigned to the high and low limit elements.

Preact Element
The preact element is available for analog input parameters and is configured as follows:
1. Select the Enable Display if the preact value is to be displayed during the run-time
execution of the phase.
2. If a tag is assigned to the element, the preact value defined in the process model is
written to the control system by the batch management system prior to the start of the
phase.

Lot Code Element

The lot code element is available for analog input parameters and is configured as follows:
1. Select the Enable Display if the lot code value is to be displayed during the run-time
execution of the phase.
2. If the operator is allowed to modify the lot code, enable the Edit Allowed checkbox.

113
B0193YB – Rev C 5. Process Modeling

3. If the operator must modify the lot code, enable the Edit Required checkbox.
4. If a tag is assigned to the element, the value assigned by the operator or the control
system is written to the batch management system during the execution of the phase.

Material ID Element
The material ID element is available for analog input and output parameters and is configured as
follows:
1. Select the Enable Display if the material ID value is to be displayed during the run-
time execution of the phase.
2. If the operator is allowed to modify the material ID, enable the Edit Allowed check-
box.
3. If the operator must modify the material ID, enable the Edit Required checkbox.
Formula parameter configurations for the automatic process phase examples given earlier are
shown below.

Table 5-13. Formula Parameter Configurations

Phase Parameter Parameter Assign Enable/ Edit Edit

Name Name Type Tag Display Allowed Required
Target Element
a) Agitate SpeedTime Process Variable Yes Yes Yes No
Process Variable Yes Yes Yes No
b) AgitOff N/A N/A N/A N/A N/A N/A
c) AgitOn Speed Process Variable Yes Yes Yes No
d) Charge Quantity Input Yes Yes Yes No
e) Cool Temp Process Variable Yes Yes Yes No
Rate Process Variable Yes Yes Yes No
f) Discharg Quantity Output Yes Yes Yes No
g) Heat Temp Process Variable Yes Yes Yes No
Rate Process Variable Yes Yes Yes No
h) Soak Temp Process Variable Yes Yes Yes No
Time Process Variable Yes Yes Yes No
Actual Element
a) Agitate Speed Process Variable Yes Yes No No
a) Agitate Time Process Variable Yes Yes No No
b) AgitOff N/A N/A N/A N/A N/A N/A
c) AgitOn Speed Process Variable Yes Yes No No
d) Charge Quantity Input Yes Yes No No
e) Cool Temp Process Variable Yes Yes No No
Rate Process Variable Yes Yes No No
f) Discharg Quantity Output Yes Yes No No
g) Heat Temp Process Variable Yes Yes No No
Rate Process Variable Yes Yes No No
h) Soak Temp Process Variable Yes Yes No No
Time Process Variable Yes Yes No No
High and Low Deviation Element
a) Agitate Speed Process Variable Yes Yes No No

114
5. Process Modeling B0193YB – Rev C

Table 5-13. Formula Parameter Configurations (Continued)

Phase Parameter Parameter Assign Enable/ Edit Edit

Name Name Type Tag Display Allowed Required
Time Process Variable Yes Yes No No
b) AgitOff N/A N/A N/A N/A N/A N/A
c) AgitOn Speed Process Variable Yes Yes No No
d) Charge Quantity Input Yes Yes No No
e) Cool Temp Process Variable Yes Yes No No
Rate Process Variable Yes Yes No No
f) Discharg Quantity Output Yes Yes No No
g) Heat Temp Process Variable Yes Yes No No
Rate Process Variable Yes Yes No No
h) Soak Temp Process Variable Yes Yes No No
Time Process Variable Yes Yes No No
High and Low Limit Element
a) Agitate Speed Process Variable Yes Yes N/A N/A
Time Process Variable Yes Yes N/A N/A
b) AgitOff N/A N/A N/A N/A N/A N/A
c) AgitOn Speed Process Variable Yes Yes N/A N/A
d) Charge Quantity Input Yes Yes N/A N/A
e) Cool Temp Process Variable Yes Yes N/A N/A
Rate Process Variable Yes Yes N/A N/A
f) Discharg Quantity Output Yes Yes N/A N/A
g) Heat Temp Process Variable Yes Yes N/A N/A
Rate Process Variable Yes Yes N/A N/A
h) Soak Temp Process Variable Yes Yes N/A N/A
Time Process Variable Yes Yes N/A N/A
Preact Element
a) Agitate N/A N/A N/A N/A N/A N/A
b) AgitOff N/A N/A N/A N/A N/A N/A
c) AgitOn N/A N/A N/A N/A N/A N/A
d) Charge Quantity (LBS) Input No No No No
e) Cool N/A N/A N/A N/A N/A N/A
f) Discharg N/A N/A N/A N/A N/A N/A
g) Heat N/A N/A N/A N/A N/A N/A
h) Soak N/A N/A N/A N/A N/A N/A
Lot Code Element
a) Agitate N/A N/A N/A N/A N/A N/A
b) AgitOff N/A N/A N/A N/A N/A N/A
c) AgitOn N/A N/A N/A N/A N/A N/A
d) Charge Quantity (LBS) Input Yes Yes Yes Yes
e) Cool N/A N/A N/A N/A N/A N/A
f) Discharg N/A N/A N/A N/A N/A N/A
g) Heat N/A N/A N/A N/A N/A N/A
h) Soak N/A N/A N/A N/A N/A N/A
Material Id Element
a) Agitate N/A N/A N/A N/A N/A N/A
b) AgitOff N/A N/A N/A N/A N/A N/A

115
B0193YB – Rev C 5. Process Modeling

Table 5-13. Formula Parameter Configurations (Continued)

Phase Parameter Parameter Assign Enable/ Edit Edit

Name Name Type Tag Display Allowed Required
c) AgitOn N/A N/A N/A N/A N/A N/A
d) Charge Quantity (LBS) Input Yes Yes No No
e) Cool N/A N/A N/A N/A N/A N/A
f) Discharg Quantity (LBS) Output Yes Yes No No
g) Heat N/A N/A N/A N/A N/A N/A
h) Soak N/A N/A N/A N/A N/A N/A

Manual Process Phases

Manual process phases are primarily used to provide operator instructions. Many processes are not
completely automated and require the operator to perform manual operations or actions accord-
ing to the phase being executed, and to acknowledge phase completion.
Manual process phases do not have control system phase logic, and therefore, they do not have tag
assignments for Phase Control/Status Bits or Interlocks. Control Buttons and Formula Parameters
are optional.
Manual phases are executed by the batch management system. Manual process phases must be
acknowledged by the operator before they are considered done. Acknowledgment can only be
accomplished once all the phase edit requirements have been satisfied.
The batch control system can be configured to handle many different manual process phases.
Described below are several examples that can be configured. The phase names are used only for
example purposes.
1. Phase Name: QASample
The instruction is given to the operator to take a sample of product to QA for testing.
2. Phase Name: OpAction
This phase is a general purpose message phase. This phase can be used anytime the
operator must be instructed to perform a task. The instructions are entered as part of
the recipe.
3. Phase Name: Agitate
The operator is instructed to manually start the agitator, a timer, and adjust the agita-
tor speed.
Possible phase parameter configurations for the manual process phase examples are
shown below.

Table 5-14. Phase Parameter Configurations

Phase
Control/Status Interlocks and
Phase Logic Parameters Formula Control
Phase Name Required Required Parameters Buttons
QASample No No none N/A
OpAction No No none N/A
Agitate No No Time Speed N/A

116
5. Process Modeling B0193YB – Rev C

Formula Parameter Configuration of Manual Process Phases

The formula parameters that are available for manual process phases are exactly the same as those
described for automatic process phases. All the parameter types, data class options, and element
alternatives are the same for automatic and manual process phases.
For more information on Formula Parameter Configuration of Manual Process Phases, see “For-
mula Parameter Configuration of Automatic Process Phases” on page 112.

Connections Tab
Use the Connections tab to define all the material and product paths in the plant.

To Display the Connections Tab:

1. On the Process Modeling Editor window, click the Connections tab.
2. The Connections tab appears.

All the available Connections in your process model are listed.

117
B0193YB – Rev C 5. Process Modeling

Editing Connections
To Edit a Connection:
1. In the Name box, enter a name for the connection (12-char max).
2. In the Description box, you can optionally enter text describing the connection
(120-char max).
3. In the Preact box, enter the required value.
Preact is a value that is equal to the difference between the target quantity (preset) and
the actual quantity (actual) that is delivered when material is transferred through a
connection. Many times, there is dribble or free fall of product in the connection
when a transfer occurs. This results in overflow. The preact defines the anticipated
overflow; that is, the difference between the target and the actual. The preact value is
only used in transfer phases.
The control system phase logic must include appropriate logic in anticipation of
receiving a preact during the execution of a recipe. Also, there are no automatic adjust-
ments made to the preact value by the batch control system. Any calculations and
adjustments that are to be made to the preact must be done at the control system level.
This is explained further in the section associated with automatic transfer phases.

Assign Source and Destination Units

A connection requires a source unit and a destination unit. Use the Source Unit and Destination
Unit buttons to make these assignments. All units in the model are available for assignment. Only
one unit can be assigned as a source or destination unit. The source and the destination cannot be
the same unit.

To Assign Source and Destination Units:

1. Click the Source Unit button.
The Select Source Unit window appears.

118
5. Process Modeling B0193YB – Rev C

2. From the Units list, select an appropriate source unit.

3. Click OK.
4. Click the Destination Unit button.
The Select Destination Unit window appears.

5. From the Units list, select an appropriate destination unit.

6. Click OK.

119
B0193YB – Rev C 5. Process Modeling

NOTE
Because of the relationship that connections have with units and their parent trans-
fer class, the source and/or destination units may not be changed. In order to
change the source and/or destination unit for a connection, the existing connection
must be deleted and a new connection must be added.

Assigning Segments to Connections

Each connection may consist of zero, one, or more segments. A segment is a subsection of a con-
nection, and can be shared by more than one connection. The use of segments is optional.
Before you can assign segments you must create them using the Segment Editor.
For more information on creating segments, refer to “Edit Segments Tab” later in this section.

To Assign a Segment:

NOTE
If you have not assigned segments, the Segments list is empty.

1. On the Connections tab, click the Assign Segments button.

The Assign Segments to Connection window appears.

2. All available segments are displayed in the Segments list box. Segments that were pre-
viously assigned are selected by default. In the example shown, the selected segments
are being assigned to the Bulk Tank1 to ReactorA connection.
3. Select the appropriate Segment(s) from the list.
4. Click OK.

120
5. Process Modeling B0193YB – Rev C

Connection Tags
Each connection in a process model may have tags associated with it. Use the Edit Connections
Tags window to associate tags with a connection. Connection tags are virtually identical to unit
tags, except connection tags are associated with the connections between units. All the tags that
are associated with a connection must be entered using the Edit Connections Tags window.
A Connection tag consists of the following elements, some of which are required while others are
optional:
♦ Phase Name (optional, 12-char max)
♦ Parameter Name (optional, 16-char max)
♦ Element Name (required, 16-char max)
♦ Description (optional, 120-char max)
♦ Data Class (required, Analog, Discrete, String or Enumeration)
♦ Access Mode (required, Either Read-Only or Read/Write).

To Edit Connection Tags:

1. On the Connections tab, click the Tags button.
2. The Edit Connection Tags window appears.

121
B0193YB – Rev C 5. Process Modeling

Transfers Tab
Use the Transfers tab to define all the transfer classes in your process model. A transfer is a group
of connections in which all the source units have the same process class and all the destination
units have the same process class. Connections are assigned to transfers based on their source and
destination units. Unlike a connection, which cannot have the same source and destination unit
assigned, a transfer class may have the same source and destination process class assignment.

To Display the Transfers Tab:

1. On the Process Modeling Editor window, click the Transfers tab.
2. The Transfers tab appears.

122
5. Process Modeling B0193YB – Rev C

All the available transfers in your process model are listed.

Editing Transfers
To Edit a Transfer:
1. In the Name box, enter a name for the transfer (12-char max).
2. In the Description box, you can optionally enter text describing the transfer (120-char
max).

Assigning Source and Destination Process Classes

A transfer requires a source process class and a destination process class. Use the Source Process
Class and Destination Process Class buttons to make these assignments. It is important to define
descriptive transfer names. These names are referenced in the Recipe Procedure Editor. Therefore,
it is helpful if the selected names describe the purpose of the transfer.
There may be processing facilities where there is more than one type of connection between the
same two classes of equipment. This is shown in the example plant earlier in this section. Reactors
A and B are connected to their respective mix tanks directly, as well as through a separator and a
condenser. For all situations where two units have more than one connection between them, each
connection must be assigned to a different transfer class.

123
B0193YB – Rev C 5. Process Modeling

To Assign Source and Destination Process Classes:

1. Click the Source Process Class button.
The Select Source Process Class window appears.

2. From the Process Class list, select an appropriate process class.

3. Click OK.
4. Click the Destination Process Class button.
The Select Destination Process Class window appears.

124
5. Process Modeling B0193YB – Rev C

5. From the Process Class list, select an appropriate process class.

6. Click OK.

Assigning Connections
Each transfer class can have one or more connections assigned to it.

To Assign Connections to a Transfer:

1. On the Transfers tab, click the Assign Connections button.
The Assign Connections to Transfer window appears.

All unassigned connections, and any connections previously assigned to a transfer that
have source and destination units belonging to the transfer’s source and destination
process class assignments, are displayed in the list. All previously assigned connections
are selected.
2. Select the appropriate connection(s) from the list.
3. Click OK to assign the connections to the transfer.
In the above example, the source process class is “Bulk Tanks” and the destination
process class is “Reactors.” The assignment window displays all the connections
between the four bulk sources and both of the reactors because the bulk sources are in
the Bulk Tanks process class and the reactors are in the Reactors process class.

Transfer Tags
Each transfer class may have tags associated with it. Use the Edit Transfer Tags window to associ-
ate tags with a transfer class. All tags associated with a transfer phase or common to all connec-
tions in the class must be entered using the Edit Transfer Tags window.

125
B0193YB – Rev C 5. Process Modeling

NOTE
It is important to remember that for every transfer tag created, connection tags are
automatically generated for each connection assigned to the class. These connection
tags, not the transfer tags, are associated to data points in the control system. How-
ever, the transfer class tags are available to the recipe builder through the transition
logic expression builder.

A Transfer tag consists of the following elements, some of which are required, while others are
optional.
♦ Phase Name (optional, 12-char max)
♦ Parameter Name (optional, 16-char max)
♦ Element Name (required, 16-char max)
♦ Description (optional, 120-char max)
♦ Data Class (required, Analog, Discrete, String or Enumeration)
♦ Access Mode (required, Either Read Only or Read/Write).

To Edit Transfer Tags:

1. On the Transfer tab, click the Tags button.
2. The Edit Transfer Tags window appears.

126
5. Process Modeling B0193YB – Rev C

Editing Transfer Class Phases

Use the Edit Phases window to assign phases to a transfer class. Each transfer class can have any
number of phases. Process phase types can be automatic, manual or download. Automatic phases
require control system phase logic while manual phases and download phases are executed by the
batch management system. It is important to define descriptive phase names. These names are ref-
erenced in the Recipe Procedure Editor. Therefore, it is helpful if the selected names describe the
purpose of the phase.
Inputs (ingredients or raw materials) and outputs (intermediates, by-products, and finished
goods) are recorded to the historical database when transfers are executed. Not all transfers should
or need to be configured to record inputs or outputs. Some transfer phases are strictly used to
transfer product from one unit to another. Only transfer phases that result in a raw material being
added to a batch, or where finished product, intermediate, or by-products are produced, should
be configured to record input usage or production output.
Defining a transfer class phase requires the entry of the following information:
♦ Phase Name (optional, 12-char max)
♦ Description (optional, 120-char max)

127
B0193YB – Rev C 5. Process Modeling

♦ Phase Type (required, Automatic, Manual or Download)

♦ Control Buttons (optional, 2 available buttons)
♦ Interlocks (optional, Available for all tags)
♦ Formula Parameters (optional, Assign as required for the Process Class)
♦ Save History (optional, Save Control/Status Activity, and/or Parameter Status).

To Edit a Transfer Class Phase:

1. On the Transfers tab, click the Phases button.
2. The Edit Phases window appears.

All Phases previously assigned to the Transfer Class are listed.

3. Enter/Edit the appropriate Name and Description as described earlier in this section.
4. Click the Phase Type drop-down arrow and select Automatic, Manual or Download.
5. Click Add to include the phase in the list or click Change if you have edited an exist-
ing phase.
6. Configure additional phase options as described in the following text.

Saving History
Use the Save History Control/Status Activity and Parameter Status checkboxes to configure the
type of phase activity that will be stored in the history database. All data stored in the history data-
base is stamped with the time and date. You can enable both checkboxes if required. Use of this
History feature is optional.

To Enable Save History Options:

1. In the Edit Phases window, enable the Control/Status Activity and/or
Parameter Status checkbox(es).

128
5. Process Modeling B0193YB – Rev C

Enable the Control/Status Activity box to include all phase control and status bit tran-
sitions.
Enable the Parameter Status box to include (when the phase is done) all parameter
element values, control button activity, and phase instructions.
2. Click Change.

Control Buttons
You can include Control Buttons as part of the user interface. The buttons are a part of the
selected transfer class phase. To use a control button, you must associate a tagname with the
desired button. Control buttons are not available for download type phases.
For more information on Control Buttons, see “Transfer Phase Configuration” and “Additional
Phase Configuration” later in this section.

To Configure Control Buttons

1. On the Edit Phases window, click Control Buttons.
The Edit Phase Control Buttons window appears.

2. Enable Button 1 or Button 2 as required.

3. In the Label box, enter the text (8-char max) that you want to appear on the button.
4. Click Assign Tag.
If you want to remove a tag that is associated with the control button, click Clear Tag.
Remember that modifying any assignments may affect other parts of your overall pro-
cess model.
The Tag Selection window appears.

129
B0193YB – Rev C 5. Process Modeling

5. Select a tag from the list.

You can sort list items by clicking a column heading.
6. Click OK to assign the tag to the control button, and close the Tag Selection window.

Phase Control/Status Bits

Use the Edit Phase Control/Status window to configure Phase Control and Phase Status bits. To
configure phase control and phase status bits, you must associate tags from the transfer phase and
transfer class. Phase Control/Status Bits are not available for download type phases.
For more information on Phase Control/Status bits, see “Transfer Phase Configuration” and
“Additional Phase Configuration” later in this section.

To Configure Phase Control/Status Bits:

1. On the Edit Phases window, click Phase Control/Status.
The Edit Phase Control/Status window appears.

130
5. Process Modeling B0193YB – Rev C

The window shows the configuration for the selected Transfer Class and Phase.
2. Configure the Phase Control and Phase Status bits as required.
For more information on Phase Control/Status bits, see “Transfer Phase Configuration” and
“Additional Phase Configuration” later in this section.

Interlocks
Use the Edit Transfer Interlocks window to configure interlocks for a transfer phase. Interlocks are
not available for download type phases.
For more information on configuring Interlocks, see “Transfer Phase Configuration” and “Addi-
tional Phase Configuration” later in this section.

To Configure Interlocks:
1. On the Edit Phases window, click the Interlocks button.
2. The Edit Transfer Interlocks window appears.

131
B0193YB – Rev C 5. Process Modeling

The window shows all the available units in the transfer class and any tags (process
class/transfer) assigned to the selected unit.

3. Click the Assign Tags button.

The Tag Selection window appears.

132
5. Process Modeling B0193YB – Rev C

4. Select the required tag(s) from the list.

5. Click OK to assign the selected tag(s) to the Tags list on the Edit Transfer Interlocks
window.

Formula Parameters
Use the Edit Formula Parameters window to configure formula parameters for a transfer class
phase.
For detailed information on configuring Formula Parameters, see “Transfer Phase Configuration”
and “Additional Phase Configuration” later in this section.

To Configure Formula Parameters:

1. On the Edit Phases window, click the Formula Parameters button.
The Edit Formula Parameters window appears.

133
B0193YB – Rev C 5. Process Modeling

The window shows all the Formula Parameter configuration for the selected Transfer
Class and Phase.
For detailed information on configuring Formula Parameters, see “Transfer Phase Configuration”
and “Additional Phase Configuration” later in this section.

Transfer Phase Configuration

There are four types of transfer phases; Automatic, Semi-Automatic, Manual, and Download.
The following section describe the phase types and provides examples to help you understand
how to configure transfer phases.

Automatic and Semi-Automatic Transfer Phases

Automatic and semi-automatic transfer phases are executed in the control system. Operator inter-
action can be a normal part of the process or may occur only when abnormal situations arise.
Operator actions might involve putting the phase in Hold or entering parameter values while the
phase is running. Enabling the operator to change parameter values is defined when formula
parameters are configured.
Automatic and semi-automatic transfer phases must have control system phase logic, and there-
fore, must have Phase Control and Status Bits defined. Interlocks, Control Buttons, and Formula
Parameters are optional. The transfer phases that are used to record inputs or outputs must have
formula parameters configured.

134
5. Process Modeling B0193YB – Rev C

When the batch management system encounters an automatic transfer phase with an input type
parameter, a bulk material addition is (typically) being made to the batch. The batch management
system finds the storage unit that holds the material in the materials database, and determines
which connection (that is, which phase) to execute in order to successfully complete the transfer.
The batch management system updates the material usage record in the materials database based
on the actual amount used.
For more information on material location assignments, see Chapter 7 “Materials Editor”.
When the batch management system encounters a semi-automatic transfer phase with an input
type parameter, typically a non-bulk material addition is being made to the batch. Because the
phase is semi-automatic, the operator must acknowledge the start of the phase. Also, the batch
management system does not search for the location of the material in the materials database.
However, if the material has been assigned to a unit, the batch management system updates the
material usage record in the materials database based on the actual amount used.
The batch control system can be configured to handle many different automatic and semi-
automatic transfer phases. Described below are several examples that can be configured. Most of
the phase names correspond to the transferring capabilities associated with the example plant ref-
erenced earlier. The drum add and load bulk phases are used only for example purposes.
1. Phase Name: BulkAdd -Automatic
Raw materials stored in bulk units are transferred to other units in the plant. Measure-
ment of the actual amount transferred is made using a flowmeter, massflow meter, or
weigh scale. A record of the quantity added to the batch is required.
2. Phase Name: Separate -Automatic
Material is transferred through a separator from one unit to another unit. There is no
actual measurement of the by-product output of the separator, but a record of this
output is required.
3. Phase Name: Package -Automatic
Finished product is transferred from a processing unit to a finished goods package of
some form. The operator initiates the start of the fill for each package. Control of the
transfer and measurement of the actual amount is performed by the control system. A
record of the finished product and the number of packages is required.
4. Phase Name: Condense -Automatic
Material is transferred from one unit to another through a condenser. There is no
record of material usage or production output.
5. Phase Name: Transfer -Automatic
Material is transferred from one unit to another. There is no record of material usage
or production output.
6. Phase Name: LoadBulk -Automatic
Finished product is transferred from a processing unit to a bulk unit (railroad car,
tanker, and storage tank). The operator is responsible for starting the transfer. Control
of the transfer and measurement of the quantity transferred is performed by the con-
trol system. A record of the finished product output is required.
7. Phase Name: DrumAdd -Semi-Automatic

135
B0193YB – Rev C 5. Process Modeling

Material is transferred from a drum unload station to one unit. The operator must
acknowledge that the drum and pump are in place and properly connected before the
phase executes. The drum unload station is used to add many different materials.
Possible phase parameter configurations for the automatic and semi-automatic transfer phase
examples are shown in the following table.

Table 5-15. Phase Parameter Configurations

Phase
Phase Control/Status Interlocks
Phase Logic Parameters Formula and Control
Name Type Required Required Parameters Buttons
BulkAdd Automatic Yes Yes Quantity As Needed
Separate Automatic Yes Yes Quantity As Needed
Package Automatic Yes Yes Quantity As Needed
Size
Count
Condense Automatic Yes Yes None As Needed
Transfer Automatic Yes Yes None As Needed
LoadBulk Automatic Yes Yes Quantity As Needed
DrumAdd Semi-Automatic Yes Yes Quantity As Needed

Formula Parameter Configuration of Automatic and Semi-Automatic

Transfer Phases
There are three types of Formula Parameters: Input, Output, and Process Variable. Process vari-
able parameters represent setpoints, rates, and so forth. Input and output parameters are used
when material tracking is required. A specific data class type must be assigned to each formula
parameter. The available data class options are Analog, Discrete, String and Enumeration. Tag
assignments to the elements associated with each parameter correspond to the assigned data class
of the parameter. For example, only analog tags can be assigned to the elements of an analog pro-
cess variable parameter.
Input parameters have seven elements. The parameter name defines a family of information. Ele-
ments define the members of the family. The seven elements for input parameters are Target,
Actual, High Deviation, Low Deviation, Preact, Lot Code, and Material ID.
Output parameters have three elements. The parameter name defines a family of information.
Elements define the members of the family. The three elements for output parameters are Target,
Actual, and Material ID.
Process variables parameters have six elements. The parameter name defines a family of informa-
tion. Elements define the members of the family. The six elements for process variable parameters
are Target, Actual, High Deviation, Low Deviation, High Limit, and Low Limit.
The configuration of the parameter type, data class, and elements is extremely important. The
batch management system controls a phase and interact with both the control system and the
operator based on the configuration of the parameters. Described below is a detailed explanation
of the results that can be expected for different parameter configurations.

136
5. Process Modeling B0193YB – Rev C

Target Element
The target element is available for all parameter and data class combinations and is configured as
follows:
1. Select the Enable Display if the target value is to be displayed during the run-time
execution of the phase. If a tag is assigned to the element, the value assigned in the rec-
ipe is written to the control system by the batch management system prior to the start
of the phase. Typically, the phase logic uses the target value to determine when to end
the phase.
2. If the operator is allowed to modify the target, enable the Edit Allowed checkbox.
3. If the operator must modify the target, enable the Edit Required checkbox.
4. A default value can be assigned to the target element for process variable parameters of
any data class.

Actual Element
The actual element is available for all parameter and data class combinations and is configured as
follows:
1. Select the Enable Display if the actual value is to be displayed during the run-time
execution of the phase. If a tag is assigned to the element, the batch management
system reads the value of the tag, in real time, from the control system during the
execution of the phase.
2. If the operator is allowed to modify the actual value, enable the Edit Allowed check-
box.
3. If the operator must modify the actual, enable the Edit Required checkbox.

High and Low Deviation Elements

The high and low deviation elements are available for analog process variable parameters and ana-
log input parameters. If tags are assigned, the batch management system calculates and writes the
deviation values to the control system prior to the start of the phase. Deviations are recalculated
whenever changes are made to the target or to the deviation elements. The high and low deviation
elements are expressed as real numbers representing a percentage of the target value. For example,
assume that the target value is 200, the high deviation is 3%, and the low deviation is 5%. The
values that are downloaded to the control system are a high deviation value of 6 and a low devia-
tion value of 10.
The high and low deviation elements are configured as follows:
1. Select the appropriate Enable Display if either of the element values is to be displayed
during the run-time execution of the phase. Typically, the phase logic uses the devia-
tions to establish alarm limits or an acceptable phase completion range for the actual
value of the parameter.
2. If the operator is allowed to modify either of the deviation values, enable the Edit
Allowed checkbox.
3. If the operator must modify either of the deviation values, enable the Edit Required
checkbox.
4. A Default Value can be assigned to the high and low deviation elements for analog
process variable parameters only.

137
B0193YB – Rev C 5. Process Modeling

High and Low Limit Elements

The high and low limit elements are available for analog process variable parameters and are used
by the Recipe Editor and the batch management system to prevent the entry of out of range
values. If tags are assigned, the batch management system writes the limit values to the control
system prior to the start of the phase.
The high and low limit elements are configured as follows:
1. Set the appropriate Enable Display if either of the element values are to be displayed
during the run-time execution of the phase.
2. A Default Value can be assigned to the high and low limit elements.

Preact Element
The preact element is available for analog input parameters and is configured as follows:
1. Set the Enable Display if the preact value is to be displayed during the run-time exe-
cution of the phase.
2. If a tag is assigned to the element, the preact value defined in the process model is
written to the control system by the batch management system prior to the start of the
phase.

Lot Code Element

The lot code element is available for analog input parameters and is configured as follows:
1. Set the Enable Display if the lot code value is to be displayed during the run-time exe-
cution of the phase.
2. If the operator is allowed to modify the lot code, enable the Edit Allowed checkbox.
3. If the operator must modify the lot code, enable the Edit Required checkbox.
4. If a tag is assigned to the element, the value assigned by the operator or the control
system is written to the batch management system during the execution of the phase.

Material ID Element
The material ID element is available for analog input and output parameters and is configured as
follows:
1. Set the Enable Display if the material ID value is to be displayed during the run-time
execution of the phase.
2. If the operator is allowed to modify the material ID, enable the Edit Allowed check-
box.
3. If the operator must modify the material ID, enable the Edit Required checkbox.
Formula parameter configurations for the automatic and semi-automatic transfer
phase examples presented earlier are shown in the following table.

138
5. Process Modeling B0193YB – Rev C

Table 5-16. Formula Parameter Configurations

Parameter Parameter Assign Enable/ Edit Edit

Phase Name Name Type Tag Display Allowed Required
Target Element
a) BulkAdd Quantity Input Yes Yes Yes No
b) Separate Quantity Output No Yes Yes No
c) Package Quantity Output Yes Yes Yes No
Size Process Variable Yes Yes Yes No
Count Process Variable No Yes Yes No
d) Condense N/A N/A N/A N/A N/A N/A
e) Transfer N/A N/A N/A N/A N/A N/A
f) LoadBulk Quantity Output Yes Yes Yes No
g) DrumAdd Rate Process Variable Yes Yes Yes No
Actual Element
a) BulkAdd Quantity Input Yes Yes Yes No
b) Separate Quantity Output No No No No
c) Package Quantity Output Yes Yes No No
Size Process Variable Yes Yes No No
Count Process Variable Yes Yes No No
d) Condense N/A N/A N/A N/A N/A N/A
e) Transfer N/A N/A N/A N/A N/A N/A
f) LoadBulk Quantity Output Yes Yes No No
g) DrumAdd Rate Process Variable Yes Yes No No
High and Low Deviation Elements
a) BulkAdd Quantity Input Yes Yes No No
b) Separate Quantity Output Yes Yes No No
c) Package Quantity Output Yes Yes No No
Size Process Variable Yes Yes No No
Count Process Variable Yes Yes No No
d) Condense N/A N/A N/A N/A N/A N/A
e) Transfer N/A N/A N/A N/A N/A N/A
f) LoadBulk Quantity Output Yes Yes No No
g) DrumAdd Rate Process Variable Yes Yes No No
High and Low Limit Elements
a) BulkAdd Quantity Input N/A N/A N/A N/A
b) Separate Quantity Output N/A N/A N/A N/A
c) Package Quantity Output N/A N/A N/A N/A
Size Process Variable Yes Yes N/A N/A
Count Process Variable Yes Yes N/A N/A
d) Condense N/A N/A N/A N/A N/A N/A
e) Transfer N/A N/A N/A N/A N/A N/A
f) LoadBulk Quantity Output N/A N/A N/A N/A
g) DrumAdd Rate Process Variable Yes Yes Yes No
Preact Element
a) BulkAdd Quantity Input Yes Yes No No
b) Separate Quantity Output No No No No
c) Package Quantity Output N/A N/A N/A N/A

139
B0193YB – Rev C 5. Process Modeling

Table 5-16. Formula Parameter Configurations (Continued)

Parameter Parameter Assign Enable/ Edit Edit

Phase Name Name Type Tag Display Allowed Required
Size Process Variable N/A N/A N/A N/A
Count Process Variable N/A N/A N/A N/A
d) Condense N/A N/A N/A N/A N/A N/A
e) Transfer N/A N/A N/A N/A N/A N/A
f) LoadBulk Quantity Output N/A N/A N/A N/A
g) DrumAdd Rate Process Variable N/A N/A N/A N/A
Lot Code Element
a) BulkAdd Quantity Input No Yes Yes Yes
b) Separate Quantity Output No No No No
c) Package Quantity Output N/A N/A N/A N/A
Size Process Variable N/A N/A N/A N/A
Count Process Variable N/A N/A N/A N/A
d) Condense N/A N/A N/A N/A N/A N/A
e) Transfer N/A N/A N/A N/A N/A N/A
f) LoadBulk Quantity Output N/A N/A N/A N/A
g) DrumAdd Rate Process Variable No No No No
material ID Element
a) BulkAdd Quantity Input Yes Yes Yes No
b) Separate Quantity Output No No No No
c) Package Quantity Output Yes Yes No No
Size Process Variable Yes Yes No No
Count Process Variable Yes Yes No No
d) Condense N/A N/A N/A N/A N/A N/A
e) Transfer N/A N/A N/A N/A N/A N/A
f) LoadBulk Quantity Output N/A N/A N/A N/A
g) DrumAdd Rate Process Variable Yes Yes No No

Manual Transfer Phases

Manual transfer phases are primarily used to provide operator instructions. Many processes are
not completely automated and may require an operator to perform manual operations or actions
according to the phase being executed, and to acknowledge the completion of the phase.
Manual phases do not have control system phase logic and, therefore, do not have tag assignments
for Phase Control/Status Bits or Interlocks. The use of Control Buttons and Formula Parameters
is optional with manual phases.
Manual phases are executed by the batch management system. All manual transfer phases must be
acknowledged by the operator before they are considered done by the batch system. Acknowledg-
ment can only be accomplished once all the phase edit requirements have been satisfied.
The batch control system can be configured to handle many different manual transfer phases. The
following examples demonstrate several manual phase configurations. The phase names are used
only for example purposes.
1. Phase Name: ScaleAdd
Material is weighed on a scale that is attached to the control system. The operator is
required to enter the lot code for the material. When the weight, which is being

140
5. Process Modeling B0193YB – Rev C

updated on the Batch Display, is within the acceptable range, the operator depresses
the Acknowledge button. The operator then manually transfers the material to the
appropriate processing unit.
2. Phase Name: ManAdd
Material is weighed on a scale that is not attached to the control system. The operator
must enter the actual weight, press the Acknowledge button when the weight is
acceptable, and then manually transfer the material to the processing unit.
3. Phase Name: AckAdd
Materials are pre-weighed prior to the execution of the final production batch. As
materials are added, the operator acknowledges each addition. The Batch Manager
records the material usage by using the target value as the actual value.
4. Phase Name: PartsAdd
The material addition may have two parts. For example, 60 pounds of salt must be
added, and salt comes in 50 pound bags. A scale is attached to the control system.
One 50-pound bag is added to the batch. The operator enters 50 as the actual value,
enters the material lot code, and then acknowledges that the phase is complete. The
Batch Manager treats this as a partial addition.
The remaining material (10 lbs) is weighed on the scale. When the weight is within
the tolerances, the operator enters the material lot code and then acknowledges that
the phase is complete.
5. Phase Name: Fill
Material is transferred from a bulk source to a finished goods container where the
operator manually controls the transfer.
The following table shows the valid phase parameter configurations for the manual transfer phase
examples described in this section.

Table 5-17. Phase Parameter Configurations

Phase
Control/Status
Phase Logic Parameters Formula Interlocks and
Phase Name Required Required Parameters Control Buttons
ScaleAdd No No Quantity No Interlocks
Control Buttons
As Needed
ManAdd No No Quantity No Interlocks
Control Buttons
As Needed
AckAdd No No Quantity No Interlocks
Control Buttons
As Needed
PartsAdd No No Quantity No Interlocks
Control Buttons
As Needed

141
B0193YB – Rev C 5. Process Modeling

Table 5-17. Phase Parameter Configurations (Continued)

Phase
Control/Status
Phase Logic Parameters Formula Interlocks and
Phase Name Required Required Parameters Control Buttons
Fill No No Quantity No Interlocks
Control Buttons
As Needed

Formula Parameter Configuration of Manual Transfer Phases

The formula parameters that are available for manual transfer phases are exactly the same as those
described earlier for automatic and semi-automatic transfer phases.
For more information on configuring formula parameters for manual transfer phases, see “For-
mula Parameter Configuration of Automatic and Semi-Automatic Transfer Phases” on page 136.
All the parameter types, data class options, and element alternatives are the same for automatic,
semi-automatic, and manual transfer phases. Formula parameter configurations for the manual
transfer phase examples given earlier are shown in the following table.

Table 5-18. Formula Parameter Configurations

Parameter Parameter Assign Enable/ Edit Edit

Phase Name Name Type Tag Display Allowed Required
Target Element
a) ScaleAdd Quantity Input No Yes No No
b) ManAdd Quantity Input No Yes No No
c) AckAdd Quantity Input No Yes No No
d) PartsAdd Quantity Input No Yes No Yes
e) Fill N/A N/A N/A N/A N/A N/A
Actual Element
a) ScaleAdd Quantity Input Yes Yes Yes No
b) ManAdd Quantity Input No No No Yes
c) AckAdd Quantity Input No Yes No No
d) PartsAdd Quantity Input No No No Yes
e) Fill N/A N/A N/A N/A N/A N/A
High and Low Deviation Elements
a) ScaleAdd Quantity Input No Yes No No
b) ManAdd Quantity Input No Yes No No
c) AckAdd Quantity Input No Yes No No
d) PartsAdd Quantity Input No Yes No No
e) Fill N/A N/A N/A N/A N/A N/A
High and Low Limit Elements
a) ScaleAdd N/A N/A N/A N/A N/A N/A
b) ManAdd N/A N/A N/A N/A N/A N/A
c) AckAdd N/A N/A N/A N/A N/A N/A
d) PartsAdd N/A N/A N/A N/A N/A N/A
e) Fill N/A N/A N/A N/A N/A N/A
Preact Element

142
5. Process Modeling B0193YB – Rev C

Table 5-18. Formula Parameter Configurations (Continued)

Parameter Parameter Assign Enable/ Edit Edit

Phase Name Name Type Tag Display Allowed Required
a) ScaleAdd Quantity Input No No No No
b) ManAdd Quantity Input No No No No
c) AckAdd Quantity Input No No No No
d) PartsAdd Quantity Input No No No No
e) Fill N/A N/A N/A N/A N/A N/A
Lot Code Element
a) ScaleAdd Quantity Input No Yes Yes Yes
b) ManAdd Quantity Input No Yes No Yes
c) AckAdd Quantity Input No No No No
d) PartsAdd Quantity Input No Yes No Yes
e) Fill N/A N/A N/A N/A N/A N/A
material ID Element
a) ScaleAdd Quantity Input No No No No
b) ManAdd Quantity Input No No No No
c) AckAdd Quantity Input No No No No
d) PartsAdd Quantity Input No No No No
e) Fill N/A N/A N/A N/A N/A N/A

Segments Tab
Use the Segments tab to define, edit and delete segments in your process model. Segment names
must be unique. If you attempt to enter a duplicate segment name, a message box is displayed,
indicating that the segment already exists. If you attempt to delete a segment that is assigned to a
connection, a warning message is displayed. Deleting segments can affect other portions of your
process model.

To Display the Segments Tab:

1. On the Process Modeling Editor window, click the Segments tab.
2. The Segments tab appears.

143
B0193YB – Rev C 5. Process Modeling

All the segments that have been defined for the process model appear in the Segments
list.

To Edit a Segment:
1. On the Segment tab, enter or edit the Name (12-char max) and optional Description
(120-char max).
2. Click Add to include the segment in the process model or click Change if you are
editing an existing Name or Description.
For more information on assigning segments to connections, see “Assigning Segments to Connec-
tions” on page 120.

Equipment Status Tab

Use the Equipment Status tab to define, edit and delete process model statuses for units and seg-
ments. Equipment Status names must be unique. If you attempt to enter a duplicate name, a mes-
sage box will be displayed, indicating that the equipment status already exists. Deleting an
Equipment Status can affect other portions of your process model
Equipment statuses represent the various states that a unit or segment may possess at any point
during the process. You must define one default status. The default status defines the initial state
that the batch management system assumes for all the units and segments. All status changes are
recorded in the historical database.

144
5. Process Modeling B0193YB – Rev C

There is a system tag that is automatically generated for each unit and/or segment defined in the
process model. The equipment statuses define the possible values of this system tag. The statuses
are used by the batch management system when evaluating the availability of a unit or
connection.
The availability of a unit is determined by the current status. If the status is set to “available,” the
batch management system can allocate the unit. If the status is not available, the unit cannot be
allocated.
The availability of a connection is determined by the current status of all the segments that com-
prise the connection. If a connection does not contain one or more segments, the connection is
always available.

To Display the Equipment Status Tab:

1. On the Process Modeling Editor window, click the Equipment Status tab.
2. The Equipment Status tab appears.

All the statuses that have been defined for the process model appear in the Status list.

To Edit an Equipment Status:

1. On the Equipment Status tab, enter or edit a Name (16-char max) and optional
Description (120-char max).
2. Enable or disable the Available and/or Default checkbox(es) as required.

NOTE
You must define one default status.

3. Click Add to include the equipment status in the process model or click Change if
you are editing an existing Name or Description.

145
B0193YB – Rev C 5. Process Modeling

Units of Measure Tab

Use the Units of Measure tab to define, change, delete, and import or export the units of measure
that you want to define for your process model. Units of Measure are ultimately assigned to pro-
cess variable formula parameters that you defined using the Edit Formula Parameters window. If
you are going to assign Units of Measure to process variable formula parameters, you should
define them first. You can add, change or delete a Unit of Measure at any time during the devel-
opment of your process model. However, in the planning of your process model, you should con-
sider defining them before you create process classes. You can import and export a list of Units of
Measure to and from an ascii text file.

To Add or Change a Unit of Measure:

1. On the Process Modeling Editor window, click the Units of Measure tab.
The Units of Measure tab appears.

All the units of measure that have been defined for the process model appear in the
Units of Measure list.
2. Enter/Edit a Name (12-char max).
3. Click Add to include the unit of measure in the process model or click Change if you
are editing an existing Name or Description.

Import and Export Units of Measure

If you want to import a list of Units of Measure from an ascii text file, ensure that the
file is named UOM_IN.txt, and is located in the config_A folder of the batch system,

146
5. Process Modeling B0193YB – Rev C

and then click Import. If the import is successful, Units of Measure will be added to
the list.
If you want to export Units of Measure from your process model, click the Export
button. The exported file is named UOM_OUT.txt and is created in the config_A
folder of the batch system.
The format for the UOM_OUT.txt and UOM_IN.txt files is shown below. Note that
the line references enclosed in brackets (for example, <Line 1>) are not actually a part
of the file’s content. Each line in the text file represents one Unit of Measure consist-
ing of up to 12 alphanumeric characters. These files can be viewed and edited with
any ASCII text editor.
The file structure is:
<Line 1> ImportUOM1
<Line 2> ImportUOM2
<Line 3> ImportUOM3
|
|
|
<Line n> ImportUOMn

Enumeration Tab
Use the Enumeration tab to add, change, delete, import and export process model enumeration
set names and values. Enumeration Set Names must be unique within your process model. Enu-
meration Values must be unique for a given Set Name. You can use the same Enumeration Value
in another Set Name, or you can enable a checkbox to ensure that the Enumeration Values are
unique across all Set Names within your process model. It is important to remember that deleting
or changing Enumeration Set Names and Values affects the Enumerations list in the Formula
Parameter Editor.
Enumerations are used only with process variables and are available for selection using the For-
mula Editor.
Each Enumeration Set is defined by one or more enumeration integer values. And each enumera-
tion value is associated with an alphanumeric string. The enumeration value is used by the batch
system whenever the associated process variable is encountered as part of phase execution. The
alphanumeric string that is associated with the value is used for display purposes only. You can
modify the string without affecting the way that a process variable is used. However, before you
modify Set Names or assigned values, you should carefully consider how the process variable is
used and what the effect of changing the name will cause.

To Add or Change Enumerations:

1. On the Process Modeling Editor window, click the Enumeration tab.
The Enumeration tab appears.

147
B0193YB – Rev C 5. Process Modeling

All the enumeration sets that have been defined for the process model appear in the
Sets list.
2. Enter/edit a Set Name (16-char max).
3. Click Add to include the Set Name in the process model or click Change if you are
editing an existing Set Name.
4. In the Enumerations pane, enter a Name (16-char max) and a Value (Integer, 0-
32767). By default, the Value is automatically assigned.
5. Click Add to include the Name and Value in the process model or click Change if you
are editing an existing Enumeration.

Editing Control Buttons

Control buttons can be used to execute any special function required during a phase. The control
buttons become available to the operator on the Batch Display. Control buttons act as momen-
tary pushbuttons, therefore the phase logic must be written accordingly.
Use of control buttons is optional. Only the label for the button or buttons that have tag assign-
ments are displayed on the Batch Display. Only one label can be assigned to a control button, and
the label is displayed when the phase is executed.

148
5. Process Modeling B0193YB – Rev C

Assigning Tags to Buttons

Tag assignments are made by first selecting a control button (radio button) on the Edit Phase
Control button window, and then clicking the Assign Tag button. This causes the Tag Selection
window to appear. Available discrete process or transfer tags, which have been configured with an
access of read/write, are displayed in the list. Only one tag can be selected. Each control button
can be given a Label (8-characters maximum). The label appears on the Batch Display control
button when the phase is executed. The Clear Tag button clears the assigned tag from the selected
control button.

Phase Control/Status Bits

There are eleven possible phase control and status bits. These tags are created and assigned only
when defining automatic process phases and automatic or semi-automatic transfer phases. These
tags define the structured interface that exist between the selected phase and the control system.
The batch management system is responsible for manipulating the phase control tags. The con-
trol system is responsible for manipulating the phase status tags. The batch management system
and the control system must work together to successfully execute the phase. There are two
approaches to creating and assigning tags for the phase control and status tags: Automatic and
Manual.

Automatic Tag Creation and Assignment

There are several ways to automatically create phase control and status tags. The options are
described in this section.

149
B0193YB – Rev C 5. Process Modeling

♦ Select the desired control and status tags manually by enabling the appropriate check-
box for each option.
♦ Click the Select Required button to enable the checkbox for the Start, Reset, Ready,
and Done options. This represents the minimum set of tags that must be created.
♦ Press the Select All button to enable the checkbox for all the options.
After the checkboxes are enabled for the required control and status options, click the Create Tags
button to create and assign the appropriate tags.
Use the Clear All button to deselect the checkboxes for all the control and status options.
Use the Delete Tags button to remove the tags from the options selected. A warning message
must be acknowledged before you can delete the tags.
Use the Clear Tag button to remove the tags from the option selected.

Example – Automatic Tagnames

Process Class: Reactors

150
5. Process Modeling B0193YB – Rev C

Phase Name: Heat

Given the above Process Class and Phase Names, the tagnames shown in the following table are
created.

Table 5-19. Automatic Tagname Examples

Process Class Phase Tagname

Reactors Heat Reactors-Heat-CS.START
Reactors Heat Reactors-Heat-CS.HOLD
Reactors Heat Reactors-Heat-CS.RSTRT
Reactors Heat Reactors-Heat-CS.ABORT
Reactors Heat Reactors-Heat-CS.RESET
Reactors Heat Reactors-Heat-CS.READY
Reactors Heat Reactors-Heat-CS.RUN
Reactors Heat Reactors-Heat-CS.HELD
Reactors Heat Reactors-Heat-CS.DONE
Reactors Heat Reactors-Heat-CS.ABRTD
Reactors Heat Reactors-Heat-CS.INTLK

Manual Tag Creation and Assignment

Manually creating and assigning phase control and status tags involves two steps.
♦ Manually create the tag using the appropriate tag editor
♦ Manually assign the tag.
For more information on creating tags, see “Editing Process Class Tags” on page 102 or “Edit
Transfer Class Tags” earlier in this section.
Manually assign the tag by enabling the checkbox corresponding to the control or status parame-
ter that you want to configure. Click the Assign Tag button to display the Tag Selection window.
A list of all available read/write discrete process or transfer tags will be displayed in the list. Only
one tag can be selected. Click OK or Apply to assign the appropriate control or status bit.

Editing Interlocks
An interlock is a condition that prevents the execution of a phase. This could be a process alarm
condition or an open valve. A phase may have one or more interlocks. However, the batch system
does not perform the interlocking logic. The physical interlocking for safety and equipment dam-
age prevention is the responsibility of the control system. The batch control system does provide
the ability to display the interlocks for each phase on the Batch Display. This allows operators to
quickly and easily identify and fix the interlocks that are preventing a phase from executing.

Assigning Tags
Interlock assignments are made to each phase in a class using Unit and Connection tags.

151
B0193YB – Rev C 5. Process Modeling

An assignment is made by selecting the required unit or connection and then clicking the Assign
Tags or Assign Tags button.

152
5. Process Modeling B0193YB – Rev C

In the Tag Selection window, select Phase Interlock Tags. The Tags list in the Edit Processes (or
Transfers) window displays the assigned tag(s).

Editing Formula Parameters

Formula parameters represent all the configurable information that a phase needs to execute prop-
erly. Formula parameters are placeholders for values. Values are assigned in the Recipe Editor
when the phases are used in a recipe procedure. Values are used by the batch management system
in specific ways when recipes are executed. Phase information that does not change for different
recipes, does not need to be defined as a formula parameter.
Formula parameter configurations consist of the following information:
♦ Name (required, 16-char max)
♦ Description (optional, 120-char max).
♦ Type (required - Input, Output, or Process Variable).
Process and Transfer phases can have any number of input, output, or process variable
formula parameters.
♦ UOM (optional - Process Variables Only)

153
B0193YB – Rev C 5. Process Modeling

♦ Data Class (required - Analog, Discrete, String, or Enumeration).

Each formula parameter must be assigned a data class type. This assigned data class
determines what data class of tags are available for assigning to the elements of each
parameter type. For example, only analog tags can be assigned to the elements of an
analog parameter. Process variable parameters can be defined as either analog, discrete,
string, or enumeration. Input and output parameters are defined as analog and cannot
be changed.

Parameter Type Assignable Data Classes

Process Variable Analog, Discrete, String, Enumeration
Input Analog
Output Analog

♦ Parameter Elements (Optional)

Each type of formula parameter has associated elements as shown in this table.

Table 5-20. Formula Parameter Elements

Elements Elements Elements Elements

(Analog Data (Discrete Data (String Data (Enumeration
Parameter Type Class) Class) Class) Data Class)
Process Variable Target Target Target Target
Actual Actual Actual Actual
High Deviation%
Low Deviation%
High Limit
Low Limit
Input Target Not Allowed Not Allowed Not Allowed
Actual
High Deviation%
Low Deviation%
Preact
Lot Code
Material ID
Output Target Not Allowed Not Allowed Not Allowed
Actual
Material ID

Each parameter element can be assigned to a tag. Tags are either automatically created
and assigned, or they are manually created and assigned.
Each element can be further configured for operator interaction. The Enable Display
checkbox specifies whether or not the element is displayed to an operator. The Edit
Allowed checkbox specifies whether or not an operator is allowed to modify the ele-
ment at run time. The Edit Required checkbox specifies whether the operator is
required to modify the element at run time. However, the Edit Required option
applies only to the end of the phase. An Acknowledge on Entry setting used in con-

154
5. Process Modeling B0193YB – Rev C

junction with an Edit Allowed target element can be used to effectively represent an
edit that is required prior to the start of the phase.
♦ Element Default Values (optional)
Default values can only be defined for process variable formula parameter elements.
The default value is set to zero if it is not explicitly defined. These values are used by
the batch management system unless changed in the recipe.
The High Limit and Low Limit default values are used by the Recipe Editor to pre-
vent the user from entering an out-of-range value. When an out-of-range value is
entered into a recipe, an error message is displayed and the Recipe Editor clamps the
value to the default limit.

Entering and Configuring Formula Parameters

A formula parameter is defined by first entering a name, optional description and selecting the
data type. After the name, description and type are defined, parameter elements must be config-
ured. This includes creating and assigning tags to elements, defining the operator display and edit
capabilities for each element, and if the parameter is a process variable, defining the default values.

Automatic Tag Creation and Assignment

Tags are created and assigned to the elements by selecting all appropriate checkboxes for each ele-
ment and then clicking the Create Tags button. The created tagnames are displayed in the tag
assignment field.
When you attempt to delete tags, you must acknowledge a warning message.

Manual Tag Creation and Assignment

Tags can be manually created and assigned to the elements by selecting an element name check-
box and then clicking the Assign Tags button. You can then select tags from the Tag Selection
window. The selected tagname is displayed in the tag assignment field. The tags available for
selection from the Tag Selection window consist of only process tags if you are configuring a pro-
cess phase. If you are configuring a transfer phase, the list only includes transfer tags. The tags that
are available for selection have the same data class as those assigned to the parameter. For example,
the system tags, as well as all defined string tags, are available when assigning tags to a parameter
with a string data class assignment.

Operator Display and Edit Configuration

Each element must be configured for operator display and editing. This is done by selecting the
appropriate checkbox and clicking the Apply button.

Default Values for Process Parameters

Process parameters can be assigned default values by editing the appropriate fields and clicking the
Apply button. The defaults are displayed as default values when the phase is used in a recipe
procedure.

Formula Parameter Examples

This section provides several examples of formula parameter configurations.
The following example is an Analog Process Variable parameter.

155
B0193YB – Rev C 5. Process Modeling

Figure 5-5. Analog Process Variable Parameter Example

156
5. Process Modeling B0193YB – Rev C

The following example is a Discrete Process Variable parameter.

Figure 5-6. Discrete Process Variable Parameter Example

157
B0193YB – Rev C 5. Process Modeling

The following example is a String Process Variable parameter.

Figure 5-7. String Process Variable Parameter Example

158
5. Process Modeling B0193YB – Rev C

The following example is an Input parameter.

Figure 5-8. Input Parameter Example

159
B0193YB – Rev C 5. Process Modeling

The following example is an Output parameter.

Figure 5-9. Output Parameter Example

160
6. Tag Management
The Tag Management system consists of editors, tools and run-time components that
automatically manage tags in I/A Series Batch. This chapter describes how the Model Editor,
Tag Interface Management (TIM) System, I/A Series Linker, TIM Shared Variable Utility,
I/A Series Batch Tag Driver (IADriver) and the ProcStatus Tool work.
I/A Series Batch interfaces to the I/A Series Control Suite using tags. There are several I/A Series
Batch components that create, edit, link, validate, communicate and, in general, manage tags.
These components are: Model Editor, Tag Interface Management (TIM) System, I/A Series
Linker, TIM Shared Variable Utility, I/A Series Batch Tag Driver (IADriver) and the ProcStatus
Tool.
The Model Editor is used to construct the plant model consisting of units, connections, phases,
phase parameters and segments. Tags are automatically created using these names and are used by
the I/A Series Batch to communicate with the I/A Series Control Suite.

Tag Map TIM Tag Map String Map

(TagMap.txt) (TIMMap.txt) (STRMap.txt)

cfgModelDB
Model Editor
(ModelEdit)

cfgTIMDB I/A Series Tag Linker

(IALink)

TIM Editor
(TIMEdit)
cfgLinkDB

IATIM.hostname1
I/A Series TIMSV Utility
(IATIM)
IATIM.hostname N

Figure 6-1. I/A Series Batch Tag Management System

The Tag Interface Management (TIM) system is a tag-based interface to the Batch Manager and
the Security Manager. TIM utilizes the Batch Talk API and Security API. TIM does not use C
functions to interact with the Batch Manager and Security Managers, but rather, uses tags. The
TIM system is flexible and allows functionality to be enabled or disabled. You can also use the sys-
tem to define any number of client nodes.
The tags created by Model Editor and TIM Editor are linked to I/A Series
Compound:Block.Parameter and Shared Variable tags using I/A Series Linker. I/A Series Linker
provides the capability to automatically link tags using the default links that are defined in the Tag

161
B0193YB – Rev C 6. Tag Management

Map file. TIM tags are also automatically linked using the default links that are defined in the
TIM Map file. Additionally, you can manually link Model and TIM tags when the default links
are not applicable. I/A Series Linker is also used to validate Model and TIM tags to verify that the
links are valid I/A Series Control Suite tags.
The TIM Shared Variable Utility creates a system startup file that is used to create and register
Shared Variables with the I/A Series control system. The utility eliminates the need to manually
create these tags. The TIM Shared Variable Utility is described later in this section.

Process Model Editor (ModelEdit)

Use Model Editor to construct the physical and abstract model of a process area in a plant. As the
model is defined, tags are generated for units, connections, segments, phases and phase parame-
ters. Tags and other important model information are stored in the Configuration Model database
(cfgModelDB).
For more information, see Chapter 5 “Process Modeling”.

Tag Interface Management (TIM) Editor

Use TIM Editor to define I/A Series workstation and Control Processor Nodes, and the Interface
functionality required for each Node. Based upon the selected Interfaces, a unique set of TIM tags
is created for each node. Interface functionality defines the actions and information that are avail-
able through Batch Manager and Security Manager.

Interfaces
There are three primary interface groups available. Tags are available for providing access to the
action groups included within each interface. The following table summarizes the interface groups
and the action groups within each.

Table 6-1. Interface Groups and Action Groups

Interface Group Action Groups

Batch Management System Manipulate the Batch Schedule
Monitor and Control Active Batches
Manipulate Recipe Focus
Monitor and Respond to Batch Questions
Enter Batch Comments
Monitor and Control Active Phases
Select Equipment for Allocation
Monitor Batch Messages
Edit Phases and Parameters
Monitor and Control Equipment
View/Force Transition Logic
Save Control Recipe
Monitor and Respond to Errors
Security System Interact with Batch Security System

162
6. Tag Management B0193YB – Rev C

Table 6-1. Interface Groups and Action Groups (Continued)

Interface Group Action Groups

Batch Functions Phase Prepare/Complete
Evaluate Equipment for Allocation
Log Equipment Status
Equipment Allocation Changes

Nodes
A Node is any logical entity, such as an I/A Series workstation or Control Processor. A Node can
also be a processing environment defined by an application. In other words, any application can
have a unique set of interface tags for communicating with Batch Manager and/or Security Man-
ager. This means that two different applications can each have an independent set of TIM tags
even though they may be executing on the same workstation.
Each Node has a unique set of TIM tags that are associated with the interfaces that are enabled for
the Node. Use TIM Editor to enable or disable interface functions for each Node.

NOTE
For those functions that support the display of list data, list length can be changed.

For more information on TIM tags, their functionality and how to use them, see Chapter 17 “Tag
Interface Management (TIM) System”.

Using TIM Editor

TIM Editor defines the tag generation requirements for each node in the system.

To Start TIM Editor:

1. On Environment Display, double-click the TIMEdit icon.

The TIM Editor window appears.

In the TIM Editor window, the Node names, Interfaces, and Configuration informa-
tion are displayed.

163
B0193YB – Rev C 6. Tag Management

2. Enter a Node name (12-char max) and optionally, a Description (120-char max). The
editor verifies that all node names are unique.
3. Define the Node configuration by selecting the Node and then selecting the required
Interface.
4. Click the Enable radio button for each Interface that you select.
As each Interface is enabled, TIM tags are automatically created. The applicable con-
figuration items associated with each Interface are listed in the TIM Editor window.
5. If you need to change the default Value for a selected Interface and Configuration,
enter the Value and then click Apply.

164
6. Tag Management B0193YB – Rev C

NOTE
Configuration items are typically used to define the length of a list of data.

For more information on TIM tags, their functionality and how to use them, see Chapter 17 “Tag
Interface Management (TIM) System”.

I/A Series Linker (IALink)

Use I/A Series Linker to define the links between both the Process Model Tags (Model Tags) and
TIM Tags, and I/A Series Compound:Block.Parameters and Shared Variables (I/A Series Tags).
I/A Series Linker accesses the Process Model and TIM databases so that it can retrieve and syn-
chronize the databases whenever you add, delete, or change tags.

NOTE
Model Editor and I/A Series Linker cannot run concurrently. Only one editor at a
time can access the Model database.

You can use I/A Series Linker to either manually link I/A Series Tags, or automatically link
I/A Series Tags to Model Tags or TIM Tags. Automatic linking of Model Tags is based on the
mapping configuration defined in the I/A Series Batch Tag Map file (TagMap.txt). Automatic
linking of TIM Tags is based on the mapping configuration defined in the TIM Map file
(TIMMap.txt). These mapping files are ASCII text files that can be edited to provide automation
linking configuration. Default tag mapping configurations are provided in the file. I/A Series
Linker stores information in the cfgLinkDB database.

Default Map File & Links

I/A Series Batch provides default link assignments between I/A Series Batch and I/A Series Con-
trol. Default configuration files are described in the following table.

Table 6-2. Default Map File

I/A Series Batch I/A Series Control

File Name Component Suite Component Function
TagMap.txt Model Editor Tags: I/A Series Control Provides standard mapping of Model
Unit Control and Processor: Editor tags with
Status Tags Unit blocks Compound:Block.Parameters in the
Phase Control and Phase blocks Control Processor for Phase Block
Status Tags Control/Status signals, Unit Block
Batch Parameters, Unit Batch Con-
trol Signals.
TIMMap.txt I/A Series TIM Tags Sequence Blocks Provides standard mapping of TIM
Shared Variables tags to Sequence Blocks and Shared
Variables for each node configured in
TIM.

165
B0193YB – Rev C 6. Tag Management

Table 6-2. Default Map File (Continued)

I/A Series Batch I/A Series Control

File Name Component Suite Component Function
StrMap.txt Model Editor Tags: Unit block integer Maps integer values used I/A Series
Any string tag data Control with strings used by
I/A Series Batch.

Listings of these files are provided in the following detailed descriptions.

TagMap File
The TagMap file (TagMap.txt) defines how I/A Series Batch unit and phase tags are mapped to
I/A Series Control unit and phase blocks. Based on the configuration parameters in this file,
I/A Series Linker automatically creates I/A Series tag assignments for all phases and units in the
process model. Automatic generation reduces the need for extensive manual input. The TagMap
file contains a default configuration that can be edited using I/A Series Linker.

Default TagMap Functionality

The I/A Series Batch Tag Map Configuration file is located in the configuration (config_A) direc-
tory. The file (TagMap.txt) is an ASCII text file that can be edited. The first column defines the
name of the Model Tag extension. A tag with a pound (#) sign in front of the tag name is not
mapped.

NOTE
To avoid errors when you link, do not change the names of the Model Tag
extensions.

The second column defines I/A Series Batch Parameter mapping. Discrete type tags can be
mapped to bits of an integer parameter or to a Boolean parameter.

Control Signals
Using the default TagMap file, all control signals are sent by I/A Series Batch directly to II0007 of
the corresponding phase block. The PHASE_EXEC sequence block (located immediately follow-
ing the unit block in every compound) then performs the required control operations on the par-
ticular sequence block.

166
6. Tag Management B0193YB – Rev C

# TagMap
# Revision History
# csz 8/10/95 Initial Release
# csz 10/ 2/95 Changed two strings to integers
# csz 10/23/95 Changed data types for BATCH_MODE and STATUS
# csz 2/22/99 Added Unit Status Tag Extensions and STATE
#
# PHASE CONTROL/STATUS PARAMETER EXTENSIONS (Discrete)# START SENT TO PHASE
BLOCK CONTROL WORD
START II0007 7
# HOLD SENT TO PHASE BLOCK CONTROL WORD
HOLD II0007 1
# RESTART SENT TO PHASE BLOCK CONTROL WORD
RESTART II0007 2
# ABORT SENT TO PHASE BLOCK CONTROL WORD
ABORT II0007 3
# RESET SENT TO PHASE BLOCK CONTROL WORD
RESET I00007 8
#
READY II0008 1
HELD II0008 2
RUN II0008 3
DONE II0008 4
ABORTED II0008 5
INTERLOCKED II0008 6
#
# EQUIPMENT SYSTEM TAG EXTENSIONS (String)
# CAMPAIGN_ID
# LOT_ID
BATCH_ID SN0010
RECIPE_NAME SN0009
# RECIPE_ID
# BATCH_SIZE
BATCH_STATUS II0003
BATCH_MODE SN0007
STATUS II0004
ALLOCATION SN0008
# LAST_RECIPE_ID
# AVAILABILITY
# UNIT_STATE
#
# UNIT CONTROL TAG EXTENSIONS (Discrete)
UNIT_HOLD II0007 1
UNIT_RESTART II0007 2
UNIT_ABORT II0007 3
#
# UNIT STATUS TAG EXTENSIONS (Discrete)
#UNIT_READY II0006 1
#UNIT HELD II0006 2
#UNIT_RUN II0006 3
#UNIT_ALARM II0006 4

Figure 6-2. I/A Series Batch Default TagMap File

167
B0193YB – Rev C 6. Tag Management

Equipment system tag extensions correspond to batch information that is downloaded to unit
blocks when the corresponding unit is allocated to any batch. All items are downloaded from
I/A Series Batch to the corresponding unit blocks, except for STATUS, which is read (checked) by
I/A Series Batch for an acceptable status value before I/A Series Batch allocates the corresponding
unit.

NOTE
When Batch Manager is started, I/A Series Batch downloads the STATUS word
with the model default status value (Batch Manager environment parameter). With
this parameter enabled, sequence logic code should continually update the STATUS
word to ensure the value does not represent an undesirable status.

The unit control tag extensions correspond to batch HOLD, RESTART, and ABORT control
signals that are sent by I/A Series Batch to the corresponding unit blocks. As a default configura-
tion, the PHASE_EXEC block is configured to process these signals.
CAMPAIGN_ID and LOT_ID are not included as defaults to conserve string allocations; how-
ever, they can be reconfigured for inclusion. All unit control tag extensions must be included in
the II000n word (the default is II0007) for compatibility with PHASE_EXEC functionality.

Phase Block Interface

The standard interface at the Phase Level involves six status signals and five control signals as
listed in the following table.

Table 6-3. Phase Level Signals

Phase Status Phase Control

READY START
HELD HOLD
RUN RESTART
DONE ABORT
ABORTED RESET
INTERLOCKED

The following figure shows a general phase block diagram. I/A Series Batch reads the phase block
phase status word. Every phase block requires a designated status word.
The phase status word is a dependent/independent block configurable II000n input. (The default
is II0008.) The status word value is either 1, 2, 4, 8, 16, or 32, corresponding to one of the mutu-
ally exclusive phase status values (refer to FB_CONST.inc).
The phase control word is a dependent/independent block configurable II000n input. (The
default is II0007.) (Refer to FB_CONST.inc for assigned values.)

168
6. Tag Management B0193YB – Rev C

Figure 6-3. Phase-Block Function Diagram

A phase block, initially inactive, has a READY status. When I/A Series Batch issues a START
control signal the PHASE_EXEC activates the corresponding sequence block and sets the Block
Status to RUN. If this RUN status is not received by I/A Series Batch within a short interval of
time (about 15 seconds), I/A Series Batch re-issues the START control signal.

169
B0193YB – Rev C 6. Tag Management

Figure 6-4. Phase Block Control State Diagram

I/A Series Batch reads the RUN status and indicates this status on the appropriate display. When
the phase block is done, the HLBL or SFC logic sets the status word to DONE. This is done by
the TO_INACTIVE SBX function of the corresponding phase. TO_INACTIVE SBX processing
is initiated by having an HLBL Abort statement as the last statement in the phase.
If HLBL or SFC logic determines that the phase has not executed successfully, the control word
can be set to HOLD. The PHASE_EXEC processes this phase control signal by putting the phase
in Manual which activates the TO_MANUAL SBX function in the phase. This puts the Phase in
a Manual/Active condition and allows a phase to maintain a HELD status without the necessity
of activating an I/A Series Batch Exception Block. The functionality of a phase block in HELD
status is dependent upon whether or not Exception Block processing is enabled, and whether or
not the particular dependent Sequence Block is using TO_MANUAL SBX processing for a phase
HOLD condition.

170
6. Tag Management B0193YB – Rev C

On a RESTART control signal to the phase, the PHASE_EXEC processes this phase control
signal by initiating an Auto/Active condition. The TO_MANUAL SBX then continues its pro-
cessing and sets the phase status to RUN.
On an ABORT control signal to the phase, the PHASE_EXEC processes this phase control signal
by initiating an (HLBL) Abort for the phase. This activates the TO_INACTIVE SBX processing
of the phase which sets the status word to ABORTED.
After reading a DONE or an ABORTED status, the I/A Series Batch issues a RESET control
signal directly to the corresponding phase block control word. PHASE_EXEC then sets the corre-
sponding block status to READY.
In the Phase Block Control State Diagram, the rectangles show the five control signals that
I/A Series Batch sends to phase blocks. The ellipses indicate the six status values that I/A Series
Batch expects to see in response to control signals. The lines between the Run and Held states
indicate that I/A Series logic can initiate transfers between these two states, independent of
I/A Series Batch control actions. However, if I/A Series logic initiates these transitions, it must
ensure that correct values for the status words are maintained.

NOTE
If the status word is not maintained correctly, I/A Series Batch displays incorrect
phase block states which could result in batch processing errors.

The PHASE_EXEC acts as an interface between I/A Series Batch and I/A Series equipment logic.
The PHASE_EXEC is an independent sequence block positioned after every unit block in every
compound. Every compound must have a PHASE_EXEC block to process all sequence block
control operations.

Unit Block Interface

The following figure shows the unit block interface between I/A Series Batch and I/A Series Con-
trol Processor unit blocks. I/A Series Batch does not turn unit blocks on and off. Note that there is
no START control signal in the following figure as there is for phases in the Phase Block Control
State Diagram.

Figure 6-5. Unit Block Function Diagram

Before allocating a unit, I/A Series Batch checks the unit block status word. If it is an acceptable
value, I/A Series Batch allocates the unit and downloads all recipe parameters to the unit block.

171
B0193YB – Rev C 6. Tag Management

Figure 6-6. Unit Control State Diagram

On I/A Series Batch displays, when a batch (not a phase) Hold, Restart, or Abort action is initi-
ated, I/A Series Batch sends the corresponding unit control signal to all the units allocated for the
corresponding batch. I/A Series Batch does not verify that these unit control signals are used.
I/A Series logic is responsible for setting the unit block unit status word, which is monitored by
I/A Series Batch for a satisfactory status before allocating the particular unit block. During batch
execution, I/A Series Batch sends batch status information (Run, Held, and Aborting) to all the
unit blocks associated with the batch.

TIMMap File
The TIMMap file defines how the TIM tags that are defined for each TIM node are mapped to
the I/A Series Control Suite. The TIMMap file contains a default configuration that can be edited
using I/A Series Linker.

Default TIMMap Functionality

The TIM Map file (TIMMap.txt) is located in the configuration (config_A) directory. The fol-
lowing figure shows the I/A Series Batch default configuration file.
The default TIMMap configuration allows sequence logic to schedule and start batches using the
configured TIM interface described in Chapter 17 “Tag Interface Management (TIM) System”.
Sequence block integer and string data assignments must be allocated in sequence blocks for the
TIM communications interface. In the TIMMap listing shown, allocations are made using
sequence block integers and strings following the :C designation. Allocations are made using
shared variables following the :S designation.

172
6. Tag Management B0193YB – Rev C

:H {Host Designation for the TIM Node}

Z_ {Replace Z_ with TIM Node Name} AW7001
:S
BT.SCHEDULE.SCHED_LIST.ITEM# @@ITEM##
BT.SCHEDULE.SELECT.SCHED_ITEM @@SELITEM
BT.SCHEDULE.SELECT.SCHED_CAMPAIGN @@SELCAMP
BT.SCHEDULE.SELECT.SCHED_LOT @@SELLOT
BT.SCHEDULE.SELECT.SCHED_BATCH @@SELBATCH
BT.SCHEDULE.SELECT.SCHED_RECIPEID @@SELRECIPE
BT.SCHEDULE.SELECT.SCHED_SIZE @@SELSIZE
BT.SCHEDULE.SELECT.SCHED_TRAIN @@SELTRAIN
BT.SCHEDULE.SELECT.SCHED_MODE @@SELMODE
BT.SCHEDULE.COMM.HANDSHAKE @@SHAKE
:C
BT.BATCH.SELECT.SCHED_ITEM @@:DATA2.II0001
BT.BATCH.SELECT.SCHED_CLB @@:DATA2.SN0001
BT.BATCH.SELECT.SCHED_RECIPEID @@:DATA2.SN0002
BT.BATCH.SELECT.SCHED_SIZE @@:DATA2.II0002
BT.BATCH.SELECT.SCHED_TRAIN @@:DATA2.SN0003
BT.BATCH.SELECT.SCHED_MODE @@:DATA2.II0003
BT.BATCH.SELECT.SCHED_EDIT_MASK @@:DATA2.II0004
BT.BATCH.COMM.HANDSHAKE @@:DATA2.II0005
#
BT.EQUIPMENT.FOCUS.UNIT @@:DATA3.SN0001
BT.EQUIPMENT.SELECT.EQUIPMENT_ITEM @@:DATA3.II0001
BT.EQUIPMENT.SELECT.EQUIPMENT_NAME @@:DATA3.SN0002
BT.EQUIPMENT.SELECT.EQUIPMENT_TYPE @@:DATA3.II0002
BT.EQUIPMENT.SELECT.EQUIPMENT_ALLOC @@:DATA3.SN0003
BT.EQUIPMENT.SELECT.EQUIPMENT_STATUS @@:DATA3.SN0004
BT.EQUIPMENT.INSTANCE_LIST.NUM_ITEMS @@:DATA3.II0003
BT.EQUIPMENT.SELECT.INSTANCE_ITEM @@:DATA3.II0004
BT.EQUIPMENT.SELECT.INSTANCE_NAME @@:DATA3.SN0005
BT.EQUIPMENT.COMM.HANDSHAKE @@:DATA3.II0005

Figure 6-7. I/A Series Batch Default TIMMap File

StrMap File
The StrMap file defines how I/A Series Control Suite integer values are mapped I/A Series Batch
strings. Any number (32,000 plus) of integer-string combinations can be defined. Integer-string
combination must be unique. Uniqueness is the responsibility of the user. The StrMap file is pro-
vided with a default configuration that can be edited using I/A Series Linker.

Default StrMap Functionality

The default configuration for the StrMap file is shown below. This configuration file allows Inte-
ger to ASCII conversions for batch data transferred between I/A Series Batch and unit blocks.
I/A Series Batch has five string items that can be downloaded to unit blocks on batch initiation.
Additionally, there is one item that I/A Series Batch reads back in integer format (STATUS) that
is converted to string format using the StrMap.txt file.

173
B0193YB – Rev C 6. Tag Management

4 Run
5 Held
6 Aborting
7 Locking
8 Locked
100 OK
101 NOT_OK

Figure 6-8. Default StrMap File

If StrMap conversions are not used, all the available string assignments for any particular unit
block are used. Converting some of these parameters to integer values reduces the number of
string allocations.

NOTE
Integer values in this StrMap file cannot be duplicated. Each integer value can only
be used once in the StrMap file.

In the default StrMap configuration shown in the previous figure, the second, third and fourth
lines relate to batch Status. These values are dynamically downloaded to II0003 of the unit block
at run time. Corresponding unit block assignments for all integer and string values must also be
configured in the equipment system tag extensions of the TagMap file.
The last two lines in the StrMap file relate to status II0004. I/A Series Batch reads the unit block
status word for an acceptable status prior to allocating the unit for a batch. The status word must
be an integer for it to be automatically updated by the I/A Series Object Manager on all I/A Series
Batch displays.
If the status word is configured as a string, this automatic updating (for string values) does not
take place. There is no limit to the number of status word assignment values that can be used.
However, all the corresponding integer/ASCII combinations used must be specified in the
StrMap file and also entered as Equipment statuses in the process model.

Using I/A Series Linker

To Start I/A Series Linker:
♦ On Environment Display, double-click the I/A Series Linker (IALink) icon.

NOTE
IALink can only be started if the Process Model Editor (ModelEdit) is not running.
Only one editor can open and access the Process Model database at a time. A lock-
file error message is displayed if the Process Model Editor is running when attempt-
ing to run IALink.

174
6. Tag Management B0193YB – Rev C

Database Synchronization
Assuming that no errors are detected at startup, the configuration Link database (cfgLinkDB) is
synchronized with the Process Model and TIM configuration databases. The first time IALink is
started, synchronization can take several minutes. Any time thereafter, the time is significantly
reduced.
During synchronization, each Model and TIM Tag is retrieved and verified against the Link data-
base. If a Model Tag does not exist in the Link database, it is added. If a Model Tag exists in the
Link database, but is deleted from the Model database, the corresponding tag also is deleted from
the Link database.
As each tag is added to the Link database, I/A Series Linker determines what tag mapping cate-
gory should be assigned and stored with the tag. When the Link database is synchronized with the
Model and TIM databases, the I/A Series Linker window appears.

175
B0193YB – Rev C 6. Tag Management

Figure 6-9. I/A Series Linker

File Menu
Use the File menu to access the I/A Series Linker system functions.

File/Export Tags
Use this option to display the Export File Selection window. You must enter the name of the file
to which the I/A Series Linker configuration data is to be written. The default location of this file
is the current configuration (config_A) directory. The file format is comma-separated variable
(csv) and is described later in this section. If the specified file exists, a message is displayed asking
you whether or not to overwrite the file.

NOTE
The filename must include a complete pathname.

The tag list is not filtered. The exported file contains an exact image of the configuration
I/A Series Linker (CfgIALinkDB) database. Once exported, tag configuration information can be
modified as a spreadsheet, text file, and so forth.

176
6. Tag Management B0193YB – Rev C

! WARNING
Do not add tags to, or remove tags from, the exported file. If you delete tags from
the file and then import the file, none of the tags that you deleted from the file is
deleted from the configuration link database. Any changes that were made however,
result in the modification of the link database. If you add tags to the file and then
perform an import, the additional tags are ignored since they do not currently exist
in the database.

File/Import Tags
Use this option to import tags into the Link database. You must specify the name of the file from
which the I/A Series Linker will import tags. The default location of this file is the configuration
(config_A) directory. The file format is comma-separated variable (csv) and is shown later in this
section.

CSV File Format

The following table describes the format of each line in the csv file except for the first line. The
first line of the csv file contains a text header which describes each column in the file.

Table 6-4. CSV Format

Range/
Column Identity Length Type Description
1 Tag ID long_min, long I/A Batch internal tag id (READ-
long_max ONLY)
2 Equipment 16 characters string I/A Batch Equipment Name (READ-
ONLY)
3 Phase 16 characters string I/A Batch Phase Name (READ-ONLY)
4 Parameter 16 characters string I/A Batch Parameter Name (READ-
ONLY)
5 Element 16 characters string TIM List Item (READ-ONLY)
6 Compound 12 characters string Compound Name (READ-WRITE)
7 Block 12 characters string Block Name (READ-WRITE)
8 Parameter 12 characters string Parameter Name (READ-WRITE)
9 Shared 14 characters string Shared Variable Name (READ-WRITE)
10 Hostname 6 characters string Shared Variable Hostname (READ-
WRITE)
11 Bit 1 -16 Integer Control Status Bits (READ-WRITE)
2 characters
12 TIMNode 16 characters string I/A Batch TIM Node Name (READ-
ONLY)
13 Equipment- 0-3 enum Equipment Type (READ-ONLY)
Type 1 character

177
B0193YB – Rev C 6. Tag Management

Table 6-4. CSV Format (Continued)

Range/
Column Identity Length Type Description
14 Data Class 1-4 enum Data Class Type (READ-ONLY)
1 character
15 Data Access 1-2 enum Data Access Type (READ-ONLY)
1 character
16 OMType 1 - 10 enum Object Manager Type (READ-ONLY)
2 characters

File/Validate
Use this command to initiate a validation of the Link database.

NOTE
All shared variable type tags must be created prior to validation.

The validation ensures that:

♦ All I/A Series Tags (Compound:Block.Parameter or Shared Variables) exist in the
I/A Series system.
♦ Model Tag Data Class and I/A Series Tag Data Class are compatible. Valid Classes
are listed in the following table.

Table 6-5. Valid Tag Data Classes

I/A Series Batch Tag Class I/A Series Control Suite Tag Class
Discrete OM_BOOL
INTEGER (Bit)
OM_LNG_INT (Bit)
OM_S_PKBOL (Bit)
OM_L_PKBOL (Bit)
Analog INTEGER
FLOAT
OM_LNG_INT
CHARACTER
SHORT INTEGER (8 Bits)
String STRING
INTEGER
OM_LNG_INT

♦ Model Tag and I/A Series Tag Data Access configuration are compatible. Data
Access refers to whether tags are Read/Write or Read Only.

File/Generate
Use this command to display the Generate I/A Series Tags window. From this window, you can
select the type of tags that you want to generate as shown in the following table.

178
6. Tag Management B0193YB – Rev C

Table 6-6. Generate Tag Options

Option Description
Control/Status Tags All Phase Control/Status and Unit Control tags are linked.
Parameter Tags All Phase Parameter tags are linked.
System Tags All Equipment System tags are linked.
TIM Tags All TIM tags are linked.

Figure 6-10. The Generate Menu

Generate Errors
When a Generate command is executed, the Tag Mapping files are verified. If the files are incor-
rect or do not exist, an error message window is displayed. After you correct the problem, you can
again attempt to regenerate the tags.

Generate Links
I/A Series tags are created by using a UNIT or Transfer name to create a COMPOUND name,
and a PHASE name to create a BLOCK name. The I/A Series PARAMETER is created by an
automatic process which determines if the Model tag is a Phase Control/Status, Phase Parameter,
Unit Control or an Equipment System tag.
If the tag is a Phase Control/Status, Unit Control or Equipment System tag, the I/A Series
PARAMETER is retrieved from the Tag Map file. If the tag is a Phase Parameter tag, the
I/A Series Linker automatically increments the I/A Series PARAMETER value and assigns it to
I/A Series Parameters based on the following rules:
♦ Analog Type Tags: Mapped to I/A Series Real Input Parameters
♦ Discrete Type Tags: Mapped to I/A Series Boolean Input Parameters
♦ String Type Tags: Mapped to I/A Series String Input Parameters
♦ Enumeration Type Tags: Mapped to I/A Series Integer Input Parameters.

NOTE
The tag used for a parameter must have a phase name for automatic generation to
function properly.

179
B0193YB – Rev C 6. Tag Management

When a duplicate I/A Series parameter assignment is identified, I/A Series Linker ignores the
parameter and continues until it finds an unused parameter.

Batch Suite Model Tag: UNIT.PHASE.PARAMETER.EXTENSION

I/A Series Control Suite Tag: COMPOUND:BLOCK.PARAMETER

TagMap
Configuration
File

Figure 6-11. I/A Series Batch Link Editor Parameter Linking

File/Print
Use this command to select a printer and then print pre-formatted reports.

File/Print Preview
Use this command to preview pre-formatted reports.

File/Print Setup
Use this command to set up a printer.

File/Exit
Use this command to close I/A Series Linker.

Edit Menu
Use this menu to access the I/A Series Linker tag map editors.

Edit/Tag Mapping
Use this command to edit the Tag Mapping file. For more information, see “I/A Series Batch
Configuration Procedures” on page 189.

Edit/TIM Mapping
Use this command to edit the TIM Mapping file. For more information, see “I/A Series Batch
Configuration Procedures” on page 189.

Edit/String Mapping
Use this command to edit the String Mapping file. For more information, see “I/A Series Batch
Configuration Procedures” on page 189.

View Menu
Use this menu to modify the layout of the I/A Series Linker window.

180
6. Tag Management B0193YB – Rev C

View/Filter
Use this command to filter the I/A Series Linker tag list. The filter options are shown in the Filter
Options table.

Table 6-7. Filter Options

Option Description
All Tags All tags in the Link database are displayed.
Unit Tags Units Tags are displayed. Select one or more units from the list and then click
OK. Only the tags associated with the selected units are displayed.
Connection Tags Connection Tags are displayed. Select one or more connections from the list
and then click OK. Only the tags associated with the selected connections are
displayed.
Segment Tags Segment Tags are displayed. Select one or more segments and then click OK.
Only tags associated with selected segments are displayed.
TIM Tags All TIM Tags in the Link database are displayed.
Unlinked Tags All tags in the Link database that do not have an I/A Series Tag assignment
are displayed.

Figure 6-12. Filter Window

The Filter Dialog Box

View/Toolbar
Use this command to enable or disable the display of the I/A Series Linker toolbar.

181
B0193YB – Rev C 6. Tag Management

View/Status Bar
Use this command to enable or disable the display of the I/A Series Linker status bar.

View/Gridlines
Use this command to enable or disable the display of gridlines in the I/A Series Linker window.

Help Menu
Use this menu to view on-line help topics and information about I/A Series Linker.

TIM Shared Variable Utility

The TIM Shared Variable Utility generates a system startup file that creates shared variable names
and then registers them with the I/A Series batch system. Use the following guidelines when con-
figuring shared variables.
1. Use TIMEdit to create the node names and associated interface parameters.
2. Edit the TIMMap file in the configuration directory for the required shared variables
as it corresponds to the example contained in the default TIMMap file described ear-
lier in this section.
3. Use IALink to generate the TIM tags.
4. Run IATim from the config_A directory to generate the corresponding IATIM.host-
name.bat files.
5. After the batch file (script) is executed and the shared variables are created, use
I/A Series Linker to perform a Validation.
A different batch file (script) is created for each hostname (workstation) specified in the
TIMMap configuration file. These scripts must be executed on the corresponding workstation.
The recommended location for each of these files on their associated stations is in the config_A
directory. These shared variable files must be started on each workstation when it is started up so
that all the corresponding shared variables are created (restored). To accomplish this, the file name
must be added to the Windows Registry on the associated workstation. Use the following guide-
lines to modify the registry on each workstation.

! WARNING
Modification of the system registry should only be performed by personnel who are
fully trained in Windows NT system management. Unintentional editing of regis-
try entries can cause your system to become unusable.

Workstation Registry Modification

1. Start the Registry Editor (Regedit).
2. Open the following key:
HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\
FoxNTAppService\Applications
3. Select Edit/Add Key.
4. Enter the Key Name and click OK.

182
6. Tag Management B0193YB – Rev C

IATIM_Script [OK]
5. Select the key name IATIM_Script that was added to the Applications area.
6. Select Edit/Add Value for each of the values shown in the Workstation Registry Entries
table:
Value Name Data Type
AppDir REG_EXPAND_SZ [OK]
D:\IASERI~1\cfg\config_A [OK]
Application REG_EXPAND_SZ [OK]
D:\IASERI~1\cfg\config_A\IATIM.AW7003.bat [OK]
AppParameters REG_EXPAND_SZ [OK]
[OK]
Mode REG_DWORD [OK]
1 [OK] Do not restart if application exits.
Order REG_DWORD [OK]
5
Requires I/A REG_DWORD [OK]
1 [OK] Wait for I/A Series initialization.

NOTE
When entering the string value for AppDir and Application, use the MS-DOS™
name “IASERI~1” that is associated with the “I/A Series Batch” folder. You can
view the MS-DOS name by using Windows Explorer to locate and then view the
Properties of the “I/A Series Batch” folder.

Refer to 6.1 Windows NT Operational Recommendations (B0193XQ), Section 2 - Model 70

Stations, 2.23 Starting User Applications Automatically.

NOTE
Shared variable type tags can only be validated after they are created.

Tag Communications Overview

IADriver
The I/A Series Batch Tag Driver (IADriver) utilizes the FoxAPI. The Tag Driver is responsible for
reading and writing tags between Batch components and I/A Series Control Suite applications
such as FoxView and Control Processor.

Process Status (ProcStatus) Display

ProcStatus is used to view and write to any I/A Series Batch tag. ProcStatus provides filters so that
specific tag groups, like TIM or System Tags, can be monitored. Any tag in the view can be
selected and assigned a different value.

183
B0193YB – Rev C 6. Tag Management

NOTE
ProcStaus does not start unless the I/A Series batch system is started.

Figure 6-13. ProcStatus Display Window

Using Process Status Display

Use ProcStatus Display to access all the tags configured for a particular node. These tags can be
viewed and/or changed depending on the input/output status of the tag. Output tags can be read-
only. Input/Output tags can be read and/or written to. You can also use ProcStatus to view enu-
meration tags, phase tags and TIM tags.
There are several sets of tags available, depending on how the node has been configured within the
TIM Editor. The tags can be altered as described in the previous sections to perform the required
functionality. The current value of each tag is displayed in the Value column.

To Change a Tag Value:

1. Select a tag from the list.
If the tag can be written to, the Write button is available.

184
6. Tag Management B0193YB – Rev C

2. Click Start Update and then enter the required information in the text box adjacent
to the Write button.
3. Click Write.
The changes that you made to the tag are displayed in the Value column.

NOTE
Note that in the ProcStatus Display window shown, integer entries can be entered
directly, while string entries must be placed within quotation marks.

PHASE_EXEC Sequence Block

All the compounds with which I/A Series Batch interfaces require a PHASE_EXEC Block (an
independent sequence block). In every compound, this block is positioned immediately after the
unit block. The PHASE_EXEC block handles the I/A Series Batch and I/A Series Control inter-
face for the following operations:
♦ Batch HOLD, ABORT, and RESTART control operations (to Unit blocks)
♦ All Phase control operations
♦ Phase INTERLOCKED operations.
The default PHASE_EXEC is located in the <Installation directory>\templates directory.
Using the Integrated Control Configurator (ICC), a copy of this default PHASE_EXEC should
be extracted and positioned immediately following the unit block in the selected compound.
Then you can configure PHASE_EXEC specifically for that compound. Refer to the
PHASE_EXEC Configuration File that follows and the notes that accompany it. As you config-
ure the file, follow these guidelines.
♦ The number (NUM_ID) and names of all compounds (IDNAMn) that are to use the
Batch ID data in their LOOPID register must be specified.
♦ The number (NUM_OP) and names of all sequence blocks (OPNAMn) in the com-
pound being controlled by I/A Series Batch must be specified.
♦ PSTATUS - Assignment for each phase block status word. Every phase block must
have status word assignment. II0008 is the default assignment. This must also corre-
spond to the default assignment for this status word in the FB_CONST.inc file
(assignment for READY, HELD, RUN, DONE, ABORTED, and
INTERLOCKED).
♦ UNITAVAIL - Unit Availability indicator. II0008 is the default assignment that the
PHASE_EXEC uses. In the PHASE_EXEC block, this item should be ICC con-
nected to :UNIT.II0008. If this item is non-zero, the PHASE_EXEC enables the
INTERLOCKED status for all phase blocks that are in a READY status. This pre-
vents all these phase blocks from being started.
♦ UNITCONTROL - Unit Control assignment. All batch HOLD, RESTART, and
ABORT control signals are addressed to this designation in the unit block. If the
PHASE_EXEC is to be configured to respond to these signals, this item in the
PHASE_EXEC should be ICC-connected to :UNIT.II0007. The PHASE_EXEC
correspondingly operates on all currently active phase blocks in the compound that
require a corresponding operation for these batch control signals. This configuration

185
B0193YB – Rev C 6. Tag Management

must also correspond to the default assignment for unit control tag extensions in the
TagMap file.
♦ PCONTROL - Assignment for each phase block control word. Every phase block
must have a control word assignment. II0007 is the default assignment. This must
also correspond to the default assignment for this control word in the
FB_CONST.inc file (assignment for HOLD, RESTART, ABORT, START and
RESET).
♦ ABORT_STEP - This is the parameter assigned for the termination step of each
phase. II0006 is the default assignment in each phase. This assignment is made in the
FB_CONST.inc file along with all control and status phase block assignments.

PHASE_EXEC Configuration File Description

Default configurations for Phase Block Status values should correspond in both the Physical
Model (Properties) and PHASE_EXEC files as shown in the following table.

Table 6-8. Default Configurations for Phase Block Status Values

Physical Model PHASE_EXEC Value Bit Position Comment

READY PREADY 1 1 S88 IDLE
RUN PRUN 4 3 S88 RUNNING
DONE PDONE 8 4 S88 COMPLETE
ABORTED PABORTED 16 5
HELD PHELD 2 2
INTERLOCKED PINTERLOCKED 32 6 EXTENSION TO S88

Default configurations for Unit and Phase Block Batch Control values should correspond in both
the TagMap and PHASE_EXEC files as shown in the following table.

Table 6-9. Default Configurations for Unit and Phase Block Batch Control Values

Physical Model PHASE_EXEC Value Bit Position

HOLD UHOLD/PHOLD 1 1
RESTART URESTART/PSTART 2 2
ABORT UABORT/PABORT 3 4
START PSTART 7 64
RESET PRESET 8 128

186
6. Tag Management B0193YB – Rev C

INDEPENDENT_SEQUENCE
CONSTANTS
#define NUM_ID 0 /* Adjust for additional equipment compounds */
#define IDNAM1 “ /* Enter Names of equipment compounds */
#define BATCHID SN0010 /* Assign Unit Block Batch ID for LOOPID use */

#define NUM_OP 2 /* Adjust for Phase Blocks */

#define OPNAM1 "SFC_PHASE" /* Enter Names of Sequence Blocks */
#define OPNAM2 "HLBL_PHASE"

/* Assign Batch Control Word */

#define UNITCONTROL II0007 /* ICC connect to :UNIT.II0007 */
#define UHOLD 1 /* Assign Batch Control Bits */
#define URESTART 2
#define UABORT 4

#define ABORT_STEP II0006 /* Assign Phase Block Abort Step Word */

#define PCONTROL II0007 /* Assign Phase Block Control Word */

#define PHOLD 1 /* Assign Batch Control Bits */
#define PRESTART 2
#define PABORT 4
#define PSTART 64
#define PRESET 128

#define PSTATUS II0008 /* Assign Phase Block Status Word */

#define PREADY 1 /* Phase Block Status Word values */
#define PHELD 2
#define PRUN 4
#define PDONE 8
#define PABORTED 16
#define PINTERLOCKED 32
#define UNITAVAIL II0008 /* ICC connect to :UNIT.II0008 */
/* Not available <> 0 */

#define MAN_SBX 4 /* TO_MANUAL SBX NUMBER */

Figure 6-14. I/A Series Batch PHASE_EXEC Configuration File*

NOTE
Default configurations for phase block status values and for unit block batch con-
trol values should correspond to both the TagMap and PHASE_EXEC files as
shown in the following table.

187
B0193YB – Rev C 6. Tag Management

Table 6-10. Phase Block Status/Unit Block Control Values

TagMap Phase_Exec
Status/Control Value (bit position from right) (decimal)
Phase Block Status Values
READY (PREADY) 1 1
HELD (PHELD) 2 2
RUN (PRUN) 3 4
DONE (PDONE) 4 8
ABORTED (PABORTED) 5 16
INTERLOCKED (PINTERLOCKED) 6 32
Unit Block Batch Control Values
UNIT_HOLD (UHOLD) 1 1
UNIT_RESTART (URESTART) 2 2
ABORT (UABORT) 3 4

Using TIM Tags with a Control Processor

This section describes how to configure the I/A Series Batch TIM system for use with a Control
Processor. A Control Processor uses Compound Block Parameters for its operation, and relies on a
tag mapping file (TIMMap.txt) which defines an I/A Series Control Suite Node Name and tag
list. TIM tags are generated by the batch system. The following guidelines identify the basic steps
that you should follow to properly configure TIM tags for use with a Control Processor.
1. Use TIM Edit to:
♦ Define a Node Name
♦ Enable the required TIM interfaces.
2. Create Compounds and Blocks in the Control Processor.
3. Use IALink to:
♦ Edit TIMMap.txt and enter the Node Name
♦ Save TIMMap.txt
♦ Generate TIM tags
♦ Validate TIM tags.
4. Use Environment Editor to:
♦ Update the Runtime to make TIM Tags available.
♦ Add TIMBatch to the I/A Series Batch Environment
♦ Update the Environment to start TIMBatch.

188
6. Tag Management B0193YB – Rev C

I/A Series Batch Configuration Procedures

This section contains a guideline which shows the minimum steps that are required to establish
communication between the I/A Series Batch system and the I/A Series Control system for
models and recipes.
1. Start Environment Display.
2. Model Configuration - Use Model Editor to build your process model. To make
I/A Series Batch operational using the default configuration directory, it is necessary
to configure at least one equipment status. After you build the model, validate it.
Remember that the default equipment status that you define is downloaded from
I/A Series Batch to all unit blocks when Batch Manager becomes active (Batch Man-
ager environment parameter). When the parameter is enabled, sequence code (possi-
bly associated with the unit block) should continually update the unit status value to
ensure that it contains the current value.
3. Recipe Configuration - After the process model is completed and validated, build and
validate each recipe. Ensure that the recipes are “approved for production.”
4. Simulation Mode - After the model and recipes are configured, you can view their exe-
cution in Simulation Mode.
5. StrMap File Configuration - Start the I/A Series Linker to edit the StrMap configura-
tion file. Process model equipment status should be configured in the StrMap file.
ASCII values with their associated unique integer values should also be configured.
I/A Series Batch reads the unit block status value (TagMap file default: II0004). If this
value is acceptable at batch run time (as compared to equipment status values),
I/A Series Batch allocates the particular unit. Equipment status values should be con-
figured as corresponding values in the StrMap file, the TagMap file and the
model/equipment status. The integer value associated with the default equipment sta-
tus value should also be configured as a default value in II0004 of all corresponding
unit blocks using the ICC.
6. TagMap File Configuration - Use the I/A Series Linker to edit the Tag Map configura-
tion file. The default configuration can be used. Possible modifications might include
adding a CAMPAIGN_ID and LOT_ID as equipment system tag extensions (that is,
by removing #’s and assigning unit block string parameters.
7. PHASE_EXEC File Configuration - Install a copy of this block immediately after the
unit block and then configure the following parameters:
♦ NUM_ID – Number of compounds to receive Batch ID data in their LOOPID
register.
♦ IDNAMn – Names of all the compounds to receive LOOPID data.
♦ NUM_OP – Number of all sequence blocks in the compound being controlled
by I/A Series Batch.
♦ OPNAMn – Names of all sequence blocks in the compound being controlled by
I/A Series Batch.
♦ PSTATUS – Assignment for all phase block status words (default: II0008). This
status word assignment is required for each sequence block being controlled by
I/A Series Batch. This status word physically resides in each sequence block that is
controlled by I/A Series Batch. This assignment must be the same for every

189
B0193YB – Rev C 6. Tag Management

sequence block. If not, the PHASE_EXEC sequence code requires modifications.

This integer assignment should also correspond to the assignment made in the
TagMap file (II0008).
♦ UNITAVAIL – Unit availability indicator. Default: II0008. In the PHASE_EXEC
block this item should be ICC-connected to :UNIT.II0008.
♦ UNITCONTROL – Unit control assignment. Default: II0007. In the
PHASE_EXEC block, this item should be ICC-connected to :UNIT.II0007.
8. TIMEdit – Use the TIM Editor from Environment Display to specify the node names
for the TIM interface. As a minimal configuration, it may be desirable to use the
HLBL code from a specified sequence block to act as a batch scheduler that can create
and start batches. To minimize I/A Series Linker editing, designate the node name as
the name of the I/A Series compound that has the HLBL code and data storage loca-
tions to be used for the TIM interface. Additionally, you can use TIM Editor to select
an interface and enable all the batch management item.
9. TIMMap File Configuration – Use the I/A Series Linker to edit the TIMMap
configuration file. The TIMMap file is used to configure all the default I/A Series tag
assignments. The symbols, @@, represents the node names previously specified using
TIMEdit. (Actual node names replace the @@.) In the default TIMMap configura-
tion file, DATA1, DATA2, and DATA3 represent three sequence blocks whose input
areas are used for data transfers between sequence code and I/A Series Batch. These
sequence blocks are structured in a CP compound with the same node name as
defined in TIMEdit. The I/A Series Linker is used to generate the I/A Series Batch
tags specified in the TIMMap file automatically.
10. Link I/A Series Batch Tags to I/A Series Control Tags – Using the I/A Series Linker,
select the Generate function. The Generate function uses the configuration data in
the TagMap and TIMMap configuration files to automatically generate all the
required I/A Series Control Suite Compound:Block.Parameter assignments. The
I/A Series Linker must be used to modify any of the default assignments that require
additional definition or modification. The following items require modification.
♦ I/A Series Batch Recipe Parameters – Some recipe parameters may require modifi-
cation. Recipe parameters are designated in four categories: String, Discrete, Ana-
log and Enumeration. As a default, string assignments are converted to I/A Series
SN000n assignments, discrete assignments are converted to I/A Series BI000n
assignments, analog assignments are converted to I/A Series RI000n assignments,
and enumeration assignments are converted to I/A Series II000n assignments.
Assignments are made in alphabetical order (order as shown on the I/A Series
Linker display) starting with an assignment of RI0001. Assignments progress
incrementally for all unused RI locations. This assignment rule should be consid-
ered whenever manual sequence code assignments are made since utilizing similar
sequence code assignments will reduce link editing requirements. If sequence
block integer assignments are required for any I/A Series Batch analog type tags,
then these configuration assignments must be performed manually using
I/A Series Linker assignments.

190
6. Tag Management B0193YB – Rev C

NOTE
I/A Driver String Mapping Note – If you have two batch tags; one analog and one
string, and both are linked to the same I/A Series integer tag, it is possible for the
system to assign improper values to one of the batch tags. Therefore, whenever you
link multiple batch tags to a single I/A Series tag, ensure that the data class (Analog,
Discrete, String or Enumeration) is the same.

11. Sequence Block Configuration – ICC configuration of sequence blocks should follow
these guidelines:
♦ UNIT Block Unit Available configuration (default II0008) should be configured
to zero as the default. A non-zero value is used to trigger INTERLOCKED status
for all phase blocks in a READY state.
♦ UNIT Block Unit Control configuration (default II0007) should be configured to
zero as the default.
♦ UNIT Block STATUS (default II0004) should be configured to the default inte-
ger value as specified in the StrMap file and model/equipment status.
♦ The PHASE_EXEC block should have II0008 (UNITAVAIL) ICC-connected to
:UNIT.II0008. The PHASE_EXEC block should have II0007 (UNITCON-
TROL) ICC-connected to :UNIT.II0007.
♦ All sequence blocks being controlled by I/A Series Batch should have their status
word assignment (default II0008) set to a READY status (value of 1).
The following steps describe additional configuration procedures required to run
I/A Series Batch with models and recipes on your I/A Series control system.
12. Use the FB_HLBL code template (HLBL_PHASE.s) for phase logic implementation
with the standard HLBL language. The template includes all required phase com-
mand/state handling and indicates where application specific logic must be added.
13. Use the SFC_PHASE code template for phase logic implementation with FoxSFC.
This template (SFC_PHASE) is functionally identical to the HLBL template. Steps
are identified where application specific logic must be added
14. For each phase logic sequence, identify the ABORT_STEP by either letting the code
run to completion and then referencing the II0006 parameter value, or by using the
following procedure.
♦ From the default CODE display, set the block to Manual and Active. Write a large
value (for example, 200) into the entry field and then select EXEC STEP. The
logic immediately jumps to the end and indicates the last step number in the STP
field. The required ABORT_STEP is one less than the last step indicated in the
STP field.
♦ Write the ABORT_STEP into the II0006 parameter using the Control
Configurator.

191
B0193YB – Rev C 6. Tag Management

192
7. Materials Editor
Use the Materials Editor to define materials, assign material locations, and track the usage and
production of materials in a batch processing facility.
The Materials Editor provides a graphical user interface to the Materials Database. All the materi-
als that are used during recipe creation must be defined within this database. Use the Materials
Editor to define the following material types:
♦ Ingredients (Raw Materials)
♦ Intermediates (Premixes)
♦ Finished Goods
♦ By-Products
♦ Other.
In addition to the defining materials to be stored in the Materials Database, you can use the Mate-
rials Editor to configure tracking the location of materials that are stored in units. This is typically
associated with bulk ingredients and intermediate materials. The batch management system uses
the unit assignments to determine where an ingredient is located when a batch is executed. This
capability allows ingredient locations to be independent of recipes and control system logic, and
permits ingredients to change locations without affecting recipe execution.
The Materials Editor can also be used to track material quantities. When materials are received,
the shipment information and quantity can be entered into the materials database by plant per-
sonnel. The batch management system updates the database when ingredients are used and when
intermediates and finished goods are produced. The database provides for easy access to work-in-
progress information and can be used to update higher level material management and MRP sys-
tems with ingredient usage information and intermediate and finished goods production.

NOTE
The Materials Editor is not, within itself, an inventory management system. How-
ever, it can be used to complement existing systems.

The following diagram provides an overview of the Material Editor and its relationship with other
system components.

193
B0193YB – Rev C 7. Materials Editor

Figure 7-1. Materials Editor

Using the Materials Status Window

Managing materials requires three components; the Materials Status window, the Materials Edi-
tor, and the Material Location Assignment Editor. The Materials Status window is used for view-
ing the name, unit of measure, total quantity, and characteristics of all materials defined in the
database. The Materials Editor window is used to define and/or edit materials in the database.
The Material Location Assignment Editor window is used to assign unit storage locations and
production tracking information to materials in the database.

To Start the Materials Status Window:

1. Double-click the MtlEdit icon in Environment Display.
2. The Materials Status window appears.

194
7. Materials Editor B0193YB – Rev C

The status of all the materials in the Materials Database is displayed. If there are no materials
defined in the database, the list is empty.

To View Material Status:

1. Click the Materials drop-down arrow and select the material type that you want to
view.
Five material types are listed: Ingredients, Intermediates, Finished Goods, By Prod-
ucts, and Other. The default material type is Ingredients.
2. From the Materials list, select a Material ID.
The Material ID, Material Name, Unit of Measure and Total Quantity are displayed.
The material characteristic and default value are also displayed.

File Menu
The Materials Status File menu provides access to the system functions for materials
management.

File/Validate
Use the File/Validate menu to validate materials database entries. Validation consists of verifying
that all the units assigned to the materials exist within the process model.
If the validation is successful, a message is displayed indicating that the materials configuration is
valid. If validation errors exist, the associated tags are displayed as an error message.

195
B0193YB – Rev C 7. Materials Editor

Correcting Validation Errors

A validation error occurs when a unit to which a material had been previously assigned no longer
exists in the process model. This is corrected by reassigning a valid unit or by removing the invalid
unit assignment from the associated material(s). The necessary steps for these corrections are
described below.

To Reassign a Valid Unit

1. Select the Material ID from the Materials Status window.
2. Use the Edit/Materials Locations menu to access the Material Location Assignment
Editor. When the invalid unit is selected, you see a Record Not Found! error message.
3. Acknowledge the error.
4. Click the Delete button to remove the invalid unit assignment.
5. Click the Add button and then select a valid unit from the Unit Selection window.
6. If other materials have invalid unit assignments, perform the above steps for each
material.

To Remove a Unit Assignment

1. Select the Material ID from the Materials Status window.
2. Use the Edit/Materials Locations menu to access the Material Location Assignment
Editor. When the invalid unit is selected, you see a Record Not Found! error message.
3. Acknowledge the error.
4. Click the Delete button to remove the invalid unit assignment.

File/Print
Use the File/Print command to select from one or more pre-formatted reports, and then print the
materials status. The print window also provides standard Windows printer options.

To Print a Configuration:
1. On the menu bar, click File and select Print.
2. The Print window appears.

196
7. Materials Editor B0193YB – Rev C

3. In the Select Reports list, select item(s) that you want.

4. Select other printer options as required.
5. Click OK to print the report and close the window.

NOTE
If you want to print several reports, press and hold the control or shift key, while
selecting from the list with the left mouse button.

File/Print Preview File/Print Preview

Use the File/Print Preview command to select one or more formatted reports, and then view the
report(s) on the screen.

To Preview a Materials Status Report:

1. On the menu bar, click File and select Print Preview.
2. The Select Reports window appears.

197
B0193YB – Rev C 7. Materials Editor

3. Select the report(s) from the list

4. Click OK.

NOTE
If you want to preview several reports, press and hold the control or shift key, while
selecting from the list with the left mouse button.

File/Print Setup
Use the File/Print Setup command to select and configure a printer. Refer to your printer manu-
facturer’s documentation for more information.

To Set Up Your Printer:

1. On the menu bar, click File and select Print Setup.
2. The Print Setup window appears.

File/Exit
Use the File/Exit command to close the Materials Editor.

To Close the Materials Editor:

On the menu bar, click File and select Exit.

NOTE
All your work is dynamically saved in the materials database as you edit and make
changes. Therefore, you do not need to be concerned with saving your work.

Edit Menu
Use the Edit menu to access the Materials Editor and the Materials Location Assignment Editor.

Edit/Materials Editor
Use the Edit/Materials Editor command to display the Materials Editor window.

198
7. Materials Editor B0193YB – Rev C

For more information on the Materials Editor, see “Using the Materials Editor” on page 201.

Edit/Material Locations
Use the Edit/Material Locations command to display the Material Location Assignment Editor
window.
For more information on editing Material Locations, see “Using the Material Location Assign-
ment Editor” on page 203.

View Menu
Use the Materials Status View menu to view a list of the materials that are assigned to units. You
can also use the menu to filter the materials ID list by specifying a portion of a material ID. A find
option is also provided for a direct search of a Material ID.

View/Assigned Units
Use the View/Assigned Units menu to display a list of all the Unit to Material assignments.

To View Assigned Units:

1. On the menu bar, click View and select Assigned Units.
2. The Assigned Units window appears.

All the Unit assignments, material Type and Material ID are listed.
3. Click Close to close the Assigned Units window.

View/Partial List
Use the View/Partial List menu to filter the list of available Unit Assignments. This option is espe-
cially useful in helping you narrow your focus when there is a large number of Material IDs for a
given ingredient type.

To Filter the Unit Assignments List:

1. On the menu bar, click View and select Partial List.
2. The View Partial Filter window appears.

199
B0193YB – Rev C 7. Materials Editor

3. In the Partial ID text box, enter the first portion of the Material ID (16-char max) that
you want to use as your filter.
4. Click OK.
5. The Material ID list now shows all the Material IDs that include the filter.

View/Full List
Use the View/Full List command to display a list of all the materials in the Materials database.

To View All Materials:

1. On the menu bar, click View and select Full List.
2. The Material ID list now shows all the Materials in the Materials Database.

View/Find
Use the View/Find command to search for a specific Material ID.

To Filter a the Unit Assignments List:

1. On the menu bar, click View and select Find.
2. The Find Material window appears.

3. In the Material ID text box, enter the Material ID (16-char max) for which you want to
search.
4. Click OK.
5. The Material ID list now shows only the Material that you entered.
If you enter a non-existent Material ID, an error message is displayed.

Help Menu
Use the Materials Status Help menu to access to the on-line Help system and information regard-
ing product version.

Help/Help Topics
Use the Help/Help Topics command to display the help contents for Materials Status.

200
7. Materials Editor B0193YB – Rev C

To View the Help Topics for Materials Status:

1. From the Materials Status Display file menu, select Help and then click Help Topics.
2. The Help Topics window appears.

Help/About Materials Status

Use the Help/About command to view version information.

To View Help About Topics for Materials Status:

1. On the Materials Status menu bar, select Help and then click Help About
Materials Status.
2. The About Materials Status window appears.
3. Click OK to close the window.

Using the Materials Editor

Use the Materials Editor to define, edit and delete the processing materials used in your plant. As
you enter materials, the editor verifies that each Material ID is unique. You can enter as many
materials as your process requires.

! WARNING
Deleting materials from the materials database can affect recipe execution. Before
you delete or modify a material, ensure that you understand how your particular
application manages materials.

Material definition requires the assignment of the following characteristics, some of which are
required while others are not.
♦ Type (required)
Each material must be defined as an Ingredient, Intermediate, Finished Good, By-
Product, or Other.
♦ Material ID (required, 16-char max)
♦ Name (optional, 40-char max)
This name can be used to represent the actual name of the material.
♦ Description (optional, 120-char max)
♦ Unit of Measure (optional, 12-char max)
♦ High Deviation (optional, value between 0.00 and 100.00 inclusive)
This value represents the General or default, high deviation when the material is used
in a recipe.
♦ Low Deviation (optional, value between 0.00 and 100.00 inclusively)
This value represents the General, or default, low deviation when the material is used
in a recipe.
♦ Characteristics (optional)

201
B0193YB – Rev C 7. Materials Editor

Each material can have an unlimited set of characteristics. Characteristics help distin-
guish materials from one another. They also allow you to separate lots of the same
material. A characteristic consists of a Name (16-char max), Data Type (Real, Integer
or String) and a Default Value. Examples of characteristics include potency, density,
color, and brix.

NOTE
Additions, deletions, and changes must first be made to the material before the
characteristics can be updated.

To Start the Materials Editor:

1. On the Materials Status menu bar, click Edit, and then select Materials Editor.
2. The Materials Editor window appears.

202
7. Materials Editor B0193YB – Rev C

To Define a Material:
1. In the Materials Editor, click the Materials drop-down arrow and select a material type
(Ingredient, Intermediate, Finished Good, By-Product, or Other.)
You can use the Find button and View Partial List checkbox to search all the defined
materials in the database. This is useful when you want to enter new materials that are
similar to existing entries.
2. Enter a Material ID, Name, Description, Unit of Measure, and High and Low Devia-
tions as described earlier in this section.
3. Click Add to include the entry in the Materials database.

To Define Characteristics for a Material:

1. In the Materials Editor, select a Material Type and Material ID.
2. In the Characteristics pane, enter a Name, Default Value, and select an appropriate
Data Type as described earlier in this section.
3. Click Add to associate the characteristic with the material.

NOTE
When you change the default characteristic Data Type, the corresponding Actual
Value is reset with the Default characteristic value. Therefore, before you change a
Material Characteristic Data Type, you should consider how this affects your
material definitions.

Using the Material Location Assignment Editor

Use the Material Location Assignment Editor to log the location of bulk ingredients as they are
received and unloaded into storage units, such as silos or tanks. This requires the assignment of a
process model unit, the entry of production tracking information, and the definition of specific
characteristic values for each production tracking record.
The information displayed on the Materials Location Assignment Editor is for a specific Material
ID which is selected from the Materials Status window.
The Material Location Assignment Editor provides the capability to essentially layer materials on
top of one another within a unit. By default, materials are used on a first-in, first-out (FIFO)
basis. During batch execution, the batch management system decrements the quantity used and
stores the usage and tracking identification data to history for all phases with input formula
parameters. If the usage involves more than one lot of material, each lot and its respective usage
are logged. When a lot of material is consumed, its lot tracking record is automatically removed
from the database.

NOTE
The default FIFO material usage can be changed to last-in, first-out (LIFO) by assign-
ing the LIFO Materials application parameter to Batch Manager in the Environment
Editor.

203
B0193YB – Rev C 7. Materials Editor

The batch management system also adds lot tracking records for all materials produced in batches
by phases that have output formula parameters. This information can then be consumed by fur-
ther phases with input parameters.

NOTE
The Materials Editor does not require that lot tracking information be defined for
all materials used in production. The batch management system records the lot
tracking information to the historical database if this information is defined; but if
the information is not defined, the batch management system still executes all
batches using the material.

Assigning a Material to a Unit

Each material in the materials database may be assigned to one or more units defined in the pro-
cess model. Normally, this assignment is made only for the bulk ingredients and intermediates
that are associated with a location. The batch management system uses the unit assignments to
obtain the location of a material during automatic transfer phases.

Define Lot Tracking Information

You can enter lot tracking information for each unit assigned to a material. Lot tracking informa-
tion consists of the following elements.
♦ Campaign Lot Batch (16-chars max) – You must define at least one of these fields.
♦ Date Received – By default, this is the current date. You can change it as required.
♦ Quantity – Less than or equal to 9,999,999,999,999,999.
♦ Characteristics – For every lot tracking record, a Name (16-char max) and an Actual
Value may be entered for any characteristic defined for the material. In actual produc-
tion this allows each shipment of a material to have a specific characteristic value
assigned. You can use the Materials Editor to change the default characteristic value.

To Start the Material Location Assignment Editor:

1. On the Materials Status menu bar, click Edit, and then select Material Locations.
2. The Material Location Assignment Editor window appears.

204
7. Materials Editor B0193YB – Rev C

To Assign a Material to a Unit:

1. On the Materials Status window, select a Material ID.
2. On the Material Location Assignment Editor, click the Add button.
3. The Unit Selection window appears.

205
B0193YB – Rev C 7. Materials Editor

4. Select a unit from the list.

The listed items are units that have been previously entered in the process model and
that are not currently assigned to a material.
5. Click Add.
The selected unit appears in the Unit Assignment list of the Material Location
Assignment Editor.

NOTE
The Materials Editor uses the contents of the run-time process model database. It
may be necessary to perform an Update/Runtime from Environment Display in
order for the Unit Selection window to show the correct list. If the list is empty, it is
likely that you need to perform an Update/Runtime.

To Assign Lot Tracking Information:

1. Enter a Campaign, Lot and Batch (16-char max) as required for the selected Unit
Assignment.
You must specify at least one of the above elements.
2. Enter the Date Rcvd and Quantity.
3. Click Add.

To Assign an Actual Value to a Unit Assignment:

1. In the Actual Value field, enter a value for the Characteristic.
If the selected unit in the Unit Assignments list does not have a defined characteristic,
you are not able to enter an Actual Value.
2. Click Change to apply your entry.

206
8. Recipe Editor
This chapter explains how to use the Recipe Editor to create and edit recipes. It describes the
various components of recipes, and how to define, edit and use them. Procedures for saving,
retrieving, printing, exporting and importing recipes are provided.
The batch control system co-ordinates the construction and management of recipes in accordance
with the guidelines outlined in the Instrument Society of America (ISA) S88.01 Flexible Batch
Specification. Consistent with this standard, Recipe Editor supports all three levels of the recipe
procedure.
The batch control system provides a recipe management system that enables Master Recipes to be
constructed and edited. Master recipes are not process line specific. They can be assigned to any
process line that has the classes of process equipment defined in the recipe. A master recipe
becomes a Control Recipe when it is assigned to a Train and it is initialized by the batch manage-
ment system. A control recipe is process line specific.
A master recipe may or may not be size specific. All formula quantities for ingredients, intermedi-
ates, by-products, and finished goods are entered as either actual quantities or as a percent of the
batch size. Quantities expressed as percentages are scaled by the batch management system when
the batch is scheduled and initialized.
The batch control system provides several table driven and graphical editors to construct and edit
recipes. Recipes can be saved, retrieved, and printed. Recipes can also be imported and exported.
A revision history capability enables users to enter, save, and review the change history for each
recipe.
A recipe consists of four parts: the Header, the Equipment Requirements, the Formula, and the
Procedure.

Figure 8-1. Four Parts of a Recipe

Header
A recipe Header identifies and documents each recipe. The header consists of a Recipe ID, Recipe
Name, Recipe State, Recipe Type, Product ID, Product Name, Minimum Batch Size, Maximum
Batch Size, Default Batch Size, and Comment.

207
B0193YB – Rev C 8. Recipe Editor

Equipment Requirements
Equipment requirements specify the process classes and attributes required by a recipe. When
defining attributes, you must specify the minimum and maximum values for each attribute. For
example, if a recipe requires a 500 or 1000 pound reactor, the minimum and maximum values for
the attribute “Capacity” would be 500 and 1000, respectively. When a very specific characteristic
is required, the minimum and the maximum should be assigned the same number.
When trains are defined, it is possible to have multiple destination units available for a given
transfer. There may be times when you want to give an operator the flexibility to select a destina-
tion unit and other times when this selection is automatic. You can enable this feature when you
define equipment requirements for a recipe.
The Recipe Editor automatically inherits all process and transfer phases associated with the pro-
cess classes defined in the equipment requirements. These are the only phases that you can use to
build a recipe procedure.
In addition to specifying process classes, specific instances of each process class can be defined.
You must define process multiple instances when your recipe procedure uses more than one unit
of the same class. Each process instance corresponds to an actual unit when the recipe is executed.
You may assign a specific unit to a process instance, or you can allow the unit to be selected when
the recipe executes using automatic or manual selection. When one or more process instances
have specific units assigned to them, the recipe is called an “equipment dependent” recipe. This
means that the recipe, by design always uses specific equipment for its execution. When process
instances are not assigned to specific units, the recipe is called an “equipment independent”
recipe.
Normally, whenever you define process instances, you would also define all the resulting transfer
instances. Defining multiple instances allows the recipe builder to simultaneously process-in or
transfer-to multiple units within the same process class. A process instance can have a specific
attribute range or it can have a specific unit assignment. This gives the recipe builder the ability to
create equipment independent or dependent recipes.

Formula
The formula specifies the inputs (raw materials, ingredients), outputs (intermediates, finished
goods, and by-products), and process variables for a recipe. Input and output quantities can be
entered as actual values or as percentage value. Process variable values are entered as actual quanti-
ties. Default tolerances for ingredients and process variables are automatically displayed. However,
the default tolerances can be changed for the current recipe or can be disabled altogether.

208
8. Recipe Editor B0193YB – Rev C

Figure 8-2. Architecture of a Formula

Procedure
The procedure defines the sequence of process actions needed to execute one batch of a recipe. A
procedure is constructed using unit procedures, operations, phases, transition logic, branch
objects, and loop objects. Unit procedures are associated with a process instance and are defined
in the recipe. Operations provide a convenient way of grouping the phases that are associated with
the recipe. Operations are defined during recipe construction. Phases are defined when you create
the process model.
Phases are defined with parameters. A parameter is assigned a value when the recipe formula is
entered. Parameter types are either input, output, or process variable. When the recipe is executed
by the batch management system, the values assigned to the parameters are written to the control
system.
Transition logic provides the ability to redirect the execution of a procedure based on the result of
a Boolean expression. Expressions can be constructed using process class and/or instance tags,
transfer class and or instance tags, and predefined functions such as questions that prompt an
operator. These questions are displayed and then answered by an operator when the recipe proce-
dure is executed.
Branch Objects allow the recipe builder to execute simultaneous unit procedures, operations and
phases, execute one of many unit procedures, operations or phases, and execute operations simul-
taneously on two or more units.
Loop Objects allow the recipe builder to re-execute unit procedures, operations and phases based
on an evaluated transition logic expression.

209
B0193YB – Rev C 8. Recipe Editor

Unit Procedures
A unit procedure is a process action consisting of one or more operations. The unit procedure
names are defined by the recipe builder. A process instance must be assigned to each unit proce-
dure created. All process phases associated with the assigned process instance, and all transfer
phases associated with a transfer instance that has the assigned process class as either its source or
destination class, can be used to define the unit procedure. Some examples of unit procedures and
associated process class instances are provided in the following table.

Table 8-1. Examples of Unit Procedures and Process Class Instances

Unit Procedure Name Process Instance Assignment

Blend Blenders
Process Reactors
Process ReactorA
Sample Reactors
Sample ReactorA
Manual Addition Mix Tanks
Bulk Addition Bulk Tanks
Liquid Addition Blenders
Discharge Pack Stations

Operations
An operation is an independent process action which identifies one or more phases. The opera-
tion names are defined by the recipe builder. Defining an operation simply requires the assign-
ment of a name. Some examples of operations are provided in the following table.

Table 8-2. Example Operations

Operation Name
Add and Process
Transfer-MixTank
Fill and Package
Transfer-RecvTank

Phases
A phase is an independent processing action. Automatic and semi-automatic phases are executed
by the control system using phase logic. Phase logic is constructed in a manner where it is auto-
matically configured through phase parameters and enabled and monitored by the batch manage-
ment system when recipes are executed.
Manual phases have no phase logic and are executed by the batch management system. Typically,
a manual phase is used to instruct an operator to perform a function such as manually adding an
ingredient, or performing a test sample.

210
8. Recipe Editor B0193YB – Rev C

Some recipe procedures require the acknowledgment of certain conditions by an operator before a
phase can be executed. A recipe procedure may also require an operator to acknowledge the com-
pletion of a phase. Additionally, a recipe procedure may require the entry of operator comments
before batch execution can continue. All these situations can be configured as part of the recipe
procedure. Several examples of process and transfer phases are provided in the following table.

Table 8-3. Examples of Process and Transfer Phases

Class Category Phase Type

Blenders Process Blend Automatic
Reactors Process Heat Automatic
Cool Automatic
Soak Automatic
Agitate Automatic
Q/A Test Manual
ManAdd Manual
Mix Tanks Process MixerOn Automatic
MixerOff Automatic
MixerTimed Automatic
ManAdd-Reactors Transfer ManualAdd Manual
Drums-Reactors Transfer DrumAdd Semi-Automatic
Bulks-Reactors Transfer BuldAdd Automatic
Reactors-Pack Transfer Pack Automatic

In addition to the types of phases previously described, there are two special phases that can be
used at any time in a recipe procedure to reserve ownership of specific units or connections to a
batch. These phases are named Allocate and Release. When a unit or connection is allocated, it is
owned by the batch until it is either released automatically as part of the recipe procedure or when
the batch finishes or released manually by an operator.
All process and transfer classes and/or instances defined in the recipe equipment requirements can
be allocated or released. There are no parameters associated with allocate and release phases.

Parameters
You can use formula parameters to further define the execution of a phase. Formula parameters
are defined in the process model editor. There are three types of parameters: Inputs, Outputs, and
Process Variables.
Parameters act as mailboxes for data. Input parameters hold ingredient quantities based on the
formula. Process variable parameters hold process variable values. Output parameters hold output
quantities based on the formula. As a procedure is constructed, each element of the formula is
assigned to a parameter.

Table 8-4. Examples of Formula Parameters

Class Category Phase Parameters Type

Blenders Process Blend Speed Process Variable
Time Process Variable

211
B0193YB – Rev C 8. Recipe Editor

Table 8-4. Examples of Formula Parameters

Class Category Phase Parameters Type

Reactors Process Heat Rate Process Variable
Temp Process Variable
Process Cool Rate Process Variable
Temp Process Variable
Process Soak Time Process Variable
Temp Process Variable
Process Agitate Time Process Variable
Speed Process Variable
Process Q/A Test None N/A
Process ManAdd Qty_Lbs Input
Mix Tanks Process MixerOn None N/A
Process MixerOff None N/A
Process MixerTimed Time Process Variable
Sample Process Q/A Test None N/A
Drums-Reactors Transfer DrumAdd Quantity Input
Bulks-Reactors Transfer BulkAdd Quantity Input
Reactors-Pack Transfer Pack Quantity Output

Transition Logic
In addition to defining process actions and the sequence of execution, there is a way to control
(enable/inhibit) the execution of the parts of a recipe procedure based on operator decisions or
process conditions, unit status, and batch information. This is achieved through the use of transi-
tion logic.
With transition logic, a Boolean expression is constructed and evaluated. If the expression evalu-
ates to TRUE, the execution of the recipe moves to the point below the transition logic. If the
expression evaluates to FALSE, the recipe execution stops and waits for the transition logic to
evaluate to TRUE.
Transition logic is constructed with the expression builder using:
1. Process Class and/or Instance Tags
2. Transfer Class and/or Instance Tags
3. Pre-defined Functions (Ask, Not, WaitSec, WaitMin, WaitHour)
4. Constants.
The following table shows all the available transition logic operators.

Table 8-5. Transition Logic Operators

Operator Symbol
Negate -
Multiply *
Divide /

212
8. Recipe Editor B0193YB – Rev C

Table 8-5. Transition Logic Operators (Continued)

Operator Symbol
Modulus %
Add +
Subtract -
Less Than <
Greater Than >
Less Than or Equal To <=
Greater Than or Equal To >=
Equal To =
Not Equal To <>
AND &
Or ¾
Assign :=
Not Not

For more information on building expressions, see Chapter 15 “Expression Editor”.

Using Recipe Editor

Use Recipe Editor to create all the recipes that are to be executed in the batch control system.
Recipe Editor uses the information in the process model and materials databases as part of recipe
procedure development. Therefore, recipes should be created only after your process model and
materials databases have been defined.
The procedure for creating a new recipe procedure requires the following basic steps:
1. Enter Header Information.
2. Define Equipment Requirements.
3. Define Formula Inputs.
4. Define Formula Outputs.
5. Create a Procedure.
6. Validate the Recipe.
7. Save the Recipe.
8. Approve the Recipe.

To Start the Recipe Editor:

1. Double-click the RecipeEdit icon in the Environment Display.

213
B0193YB – Rev C 8. Recipe Editor

2. The Recipe Editor window appears.

File Menu
The Recipe Editor File menu provides system functions for the Recipe Editor. The File menu
items are described in the following sections.

File/New
Use the File/New command to create a new recipe and clear an open recipe from memory. If prior
editing had been done and not saved, a message box is displayed providing the option to discard
the changes before clearing the recipe.

214
8. Recipe Editor B0193YB – Rev C

To Create a New Recipe:

♦ Click File, and then select New.
You can also click the New icon in the main toolbar.

File/Open
Use the File/Open command to open an existing recipe and clear an open recipe from memory. If
prior editing had been done and not saved, a message box is displayed providing the option to dis-
card the changes before opening the recipe.

To Open a Recipe:
1. Click File, and then select Open.
You can also click the Open icon in the main toolbar.

2. The Recipes – Open window appears.

All the recipes in the recipe database are listed. You can sort the list by clicking a list
heading.
3. Click Open.
4. Double-click the required list item.
You can also open a recipe by double-clicking an item.
5. The recipe that you selected appears in the Recipe Editor window.

Using Recipe Find and Filter

If your facility uses many recipes that makes finding the recipe difficult, you can use the Find and
Filter buttons to help you search for a specific recipe in the recipe database.

To Find a Recipe:
1. Click the Find button.
2. The Recipe Find window appears.

215
B0193YB – Rev C 8. Recipe Editor

3. In the Search For text box, enter the text for which you want to search.
The space character acts as a wildcard entry. Entering a space character in the Search
For text box causes every item in the list to be searched.
4. From the In drop-down list, select whether you want to search the Recipe ID, Recipe
Name, State or Type, or all these fields.
5. Enable the Case Sensitive checkbox as required.
6. Click Find Next.
The first Recipe that matches your criteria is highlighted in the Recipes – Open list
box. You can click Find Next to continue searching and scrolling through the list.
7. When you identify the recipe that you want, click Open on the Recipes – Open
window.
8. Recipe Editor displays the selected recipe.

To Filter the Recipe List:

1. Click the Filter button.
2. The Recipe Filters window appears.

3. Select as many States and/or Types as required.

4. Click OK.

216
8. Recipe Editor B0193YB – Rev C

5. The Recipes – Open list now displays only those recipes that match the States and/or
Types that you specified.
6. When you identify the recipe that you want, click Open on the Recipes – Open
window.
7. Recipe Editor displays the selected recipe

File/Save
Use the File/Save command to save changes to an open recipe. The File/Save can also be used as a
Save As function by specifying a different Recipe ID when you are prompted to save the recipe.
The first time that you save a recipe, you are required to enter a Recipe ID (16-char max) and an
Author (30-char max). You can also enter optional Comments that describe any changes or details
that you want to document. All subsequent changes to a recipe require the entry of an Author.
You can effectively copy a recipe simply by saving it with a unique Recipe ID.
If you attempt to enter a Recipe ID that is not unique, a warning message is displayed prompting
you to overwrite the current version.
There may be occasions when either the Recipe ID and/or the Author is automatically supplied.
The Recipe ID is supplied when the current recipe has already been assigned an ID. You can
change this information at any time as explained earlier. The Author field is supplied when the
batch security system is enabled and the Recipe Editor Author function has been assigned to
require security clearance. In this case, security clearance is required whenever the save menu
option is selected. The corresponding Done By user entered in the security clearance request is
automatically assigned to the Author field. This field may not be changed.

To Save a Recipe
1. Click File, and then select Save.
You can also click the Save icon in the main toolbar.

2. The Save Recipe window appears.

217
B0193YB – Rev C 8. Recipe Editor

3. Enter a Recipe ID, Author and Comments as described earlier in this section.
4. Click Save.

File/Delete Recipes
Use the File/Delete Recipes command to remove a recipe from the recipe database. Any recipe
defined in the database can be deleted; however, you can only delete one recipe at a time. If you
delete the recipe that is currently open, you must use the File/New command to clear the deleted
recipe from the display.

To Delete a Recipe
1. Click File, and then select Delete Recipe.
2. The Recipes – Delete window appears.

3. Select a recipe from the list.

218
8. Recipe Editor B0193YB – Rev C

4. Click Delete.

File/Validate
Use the File/Validate command to initiate a validation of the current recipe. The validation pro-
cess consists of the following elements.
♦ Verify that the process model database information used in the recipe exists. This
includes process classes, phases, parameters, and tags.
♦ Verify that the material database information used in the recipe exists.
♦ Verify that the minimum, maximum, and default batch sizes defined in the recipe
header are appropriate. (Minimum <= Default <= Maximum)
♦ Verify that all formula parameters defined in the recipe procedure are linked to the
appropriate information.
♦ Verify that all reports triggered by phases exist in the reporting database.
♦ Verify that all transition logic, including loop logic, is valid.

NOTE
The validation procedure only verifies user-configured information. Because of the
flexibility provided in constructing recipe procedures, it is impossible to verify a rec-
ipe design. This verification is the responsibility of the user.

To Validate a Recipe
1. Click File, and then select Validate.
You can also click the Validate icon in the main toolbar.

2. If the validation is successful, Recipe is Valid is displayed in the Validate window. If

validation errors exist, the associated tags are displayed along with a validation error
message.

File/Approvals
Use the File/Approvals command to approve any recipe in the database for production or for test-
ing. Approvals are required before the Approved for Production checkbox can be set. A recipe can-
not be scheduled as part of a batch unless the Approved for Production or Approved for Test
checkbox has been enabled. The levels of approval required are configured in the Security Editor.
If security is not enabled, the Approved for Production or Approved for Test checkbox must be
manually enabled each time the recipe is saved. There are five levels of recipe approval permitted.
The first level corresponds to the author. The remaining levels of approval are numbered two
through five and can be assigned based on your requirements.

NOTE
In order to prevent the same person from approving recipes at different levels, each
level of approval should be assigned a different security level.

219
B0193YB – Rev C 8. Recipe Editor

You approve the recipe by selecting the appropriate level command button on the Approvals and
entering information required by the security request windows. Levels may be approved in any
order, but the Approved for Production or Approved for Test checkbox cannot be enabled until all
the required levels have been satisfied. The Approved for Production or Approved for Test check-
box can be enabled or disabled at any time for recipes in which all levels of approval have been sat-
isfied.
For more information on configuring security, See Chapter 14 “Security System”.

To Approve a Recipe
1. Click File, and then select Approvals.
You can also click the Approvals icon in the main toolbar.

2. The Approvals window appears.

3. Select the required options as described earlier.

For more information on configuring security, See Chapter 14 “Security System”.
4. Click Close.

File/History
Use the File/History command to view the construction history for any recipe in the database.
You can view the Version, Date of creation, and recipe Author for each entry.

220
8. Recipe Editor B0193YB – Rev C

To View Recipe History:

1. Click File, and then select History.
You can also click the History icon in the main toolbar.

2. The History window appears.

All the history for the open recipe is listed.

NOTE
Old versions of recipes cannot be executed. If multiple recipe versions are required,
It is recommended that you enter the version identification in the Recipe ID.

221
B0193YB – Rev C 8. Recipe Editor

3. Click Close when you are finished viewing.

File/Import/Export
Use the File/Import/Export command to export recipes to files and import recipes from a file. You
can copy and/or move recipes between local recipe databases (those on your server) and across a
network.

To Open the Import/Export window:

1. Click File, and then select Import/Export.
2. The Import/Export window appears.

The Import/Export window is described above.

To Export a Recipe:
1. In the Import/Export window, enter a directory or select it from the Directories list.
2. From the Recipe IDs list, select the required recipe(s).
3. Click Export.
This creates the recipe file(s) (.rcp extension) in the directory that you selected. If the
recipe file exists, the Duplicate Recipe window appears prompting you to overwrite
the existing file. Acknowledge the prompt as required. You can also specify a different
filename in the text box.

222
8. Recipe Editor B0193YB – Rev C

NOTE
The file that is created contains information in a proprietary format. Do not
attempt to view or edit the contents.

To Import a Recipe:
1. In the Import/Export window, enter a directory or select it from the Directories list.
2. From the Recipe IDs list, select the required recipe(s).
3. Click Import.
This creates the recipe file(s) (.rcp extension) in the directory that you selected. If the
recipe file exists, the Duplicate Recipe window appears prompting you to overwrite
the existing file. Acknowledge the prompt as required. You can also specify a different
file name in the text box.

NOTE
After you import a recipe, you should validate and approve it using the Recipe
Editor.

! WARNING
Do not attempt to import files that were not created by performing a recipe export.
An application error occurs.

File/Save View Settings

Use the File/Save View Settings command to store the current layout of the Recipe Editor
window. Because the Recipe Editor is very flexible, you may, for a given recipe, scale the editor
windows or have need for different zoom levels for specific windows. By default, when you close
Recipe Editor and then restart it, the layout is set to its default settings. By saving the view settings
before you exit, you are able to restart the editor with the custom settings.

File/Synchronize Recipes
Use the File/Synchronize Recipes command to automatically synchronize the phase parameters in
one or more recipes with the phase parameters in the process model. When phase parameters are
added, deleted or changed in a process model, all recipes that are associated with the parameters
are affected.

223
B0193YB – Rev C 8. Recipe Editor

When the synchronization process starts, it first initiates a synchronization of the phase parame-
ters in the recipe with those in the process model. When differences are encountered, the Recipe
phase parameter information is updated using the process model phase parameter information.
After the synchronization stage is completed, the recipe is validated.
Since the process can be set to execute automatically, security can be configured for the Sync &
Validate function to limit access. For more information on configuring security, see Chapter 14
“Security System”. Approvals are required whenever changes are made to a recipe. You can choose
to retain the approvals that are already assigned to a recipe, or you may require the entry of
approvals as part of the synchronization process. The process can be set to execute in a semi-
automatic mode that requires operator acknowledgement before the recipe synchronization
occurs. The synchronization process can be interrupted if necessary.
The following procedure assumes that you have already made changes to process model phase
parameters and that your process model is valid.

NOTE
It is recommended that you back up your recipe databases prior to using the Syn-
chronize Recipe feature.

To Synchronize Recipes:
1. On the menu bar, click File and select Synchronize Recipes.
The Sync & Validate Recipes window appears.

224
8. Recipe Editor B0193YB – Rev C

NOTE
If you have a recipe open, you must close it before you can use the synchronization
feature.

2. Enter an Author (30 char max).

3. Enable the Retain Recipe Approvals checkbox to retain the approvals that are cur-
rently assigned to each recipe in the database.
If you disable the Retain Recipe Approvals checkbox, you are required to enter new
approvals.
4. Enable the Acknowledgement Required checkbox to require confirmation of each
recipe synchronization before it begins.
If you disable the Acknowledgement Required checkbox, recipes are synchronized
and/or validated without the need of confirmation.
5. Enable the Validate Only checkbox if you only want to verify whether or not recipes
are synchronized.
6. After making your selections, click the Execute button to begin the validation and/or
synchronization process.
7. Use the Pause button to interrupt the process.
After you pause the process, you can use the Skip Recipe button to ignore the current
recipe and proceed to the next. Once paused, you can completely stop the process by
clicking Cancel.
When you click Pause, the button label changes to Continue. If after a pause, you
want to resume, click Continue.
8. When the process is complete, you can click the Validation Results button to view the
status of the synchronization and validation process.

File/Print
Use the File/Print command to select one or more pre-formatted reports, and then print the sec-
tion(s) to a printer or a file. Printed output supports the use of PostScript formatting for graphical
representation as well as a standard format that is text-only. You can optionally print your reports
on a grey background. The Print window also allows you to select and configure the properties of
the printer.

To Print a Recipe:
1. On the menu bar, click File and select Print.
You can also click the Print icon in the main toolbar.

2. The Print window appears.

225
B0193YB – Rev C 8. Recipe Editor

3. In the Select Reports list, select item(s) that you want.

File/Print Preview
Use the File/Print Preview command to select one or more pre-formatted reports, and then pre-
view them on the screen.

To Preview a Recipe:
♦ On the menu bar, click File and select Print Preview.
You can also click the Print Preview icon in the main toolbar.

File/Print Setup
Use the File/Print Setup command to select and configure a printer. Refer to your printer manu-
facturer’s documentation for more information.

To Set Up Your Printer:

1. On the menu bar, click File and select Print Setup.
2. The Print Setup window appears.
3. Configure your printer as required.

File/Exit
Use the File/Exit command to close the Recipe Editor.

To Close the Recipe Editor:

♦ On the menu bar, click File and select Exit.

226
8. Recipe Editor B0193YB – Rev C

NOTE
If you have edited a recipe and did not save it, you are prompted to save or discard
the changes prior to closing the Recipe Editor.

Edit Menu
The Recipe Editor Edit menu provides system functions for the Recipe Editor.

Header
Use the Edit/Recipe Header menu to create and edit recipe header information.

Edit/Recipe Header
Use the Edit /Recipe Header command to define the name and other identification information
for a recipe. A recipe header contains the elements show in the following list. Not all the elements
are required.
♦ Recipe ID (required; display only; defined when recipe is saved)
♦ Recipe Name (optional, 16-char max)
♦ Recipe State (required, defaults to the default state defined in the recipe state editor)
♦ Recipe Type (optional, defaults to the default type defined in the recipe type editor)
♦ Product ID (optional, 16-char max)
♦ Product Name (optional, 16-char max)
♦ Minimize Batch Size (required, defaults to zero if left blank)
♦ Maximize Batch Size (required, defaults to zero if left blank)
♦ Default Batch Size (required, defaults to zero if left blank)
♦ Comments (optional, no size restrictions).
The Recipe ID is the only field that cannot be edited from the header. The Recipe ID is the
unique identifier for the recipe and is defined when the recipe is saved.

To Edit a Recipe Header

1. Click Edit, and then select Recipe Header.
You can also click the Header icon in the main toolbar.

2. The Recipe Header window appears.

227
B0193YB – Rev C 8. Recipe Editor

3. Enter information for the header as described in earlier of this section.

To Assign a Recipe State:

1. Click the States button.
2. The Assign Recipe States window appears.

228
8. Recipe Editor B0193YB – Rev C

3. Select a State from the list.

NOTE
Assignment of a state is optional.

For more information on defining Recipe States, see “Recipe State Editor” later in this
section.
4. Click OK.
5. The State appears in the Recipe Editor window.

To Assign a Recipe Type:

1. Click the Types button.
2. The Assign Recipe Types window appears.

229
B0193YB – Rev C 8. Recipe Editor

3. Select a Type from the list.

NOTE
Assignment of a Type is required.

For more information on defining Recipe Types, see “Recipe Type Editor” later in this
section.
4. Click OK.
5. The State appears in the Recipe Editor window.

Equipment Requirements
Use the Edit/Equipment Requirements menu to define the equipment requirements for your
recipe. Use the Edit/Equipment Requirements command to access the Equipment Requirements
Editor which you use to edit recipe equipment requirements. Equipment requirements identify
the process classes and/or process and transfer instances from which process and transfer phases
can be used while building the procedure. The equipment requirements are also used by the batch
management system to verify train selection during batch scheduling, and also which units are
selected from the train when the batch is executed. You must define recipe equipment require-
ments before you can construct a recipe procedure.
The equipment requirements for a recipe consist of the following items.
♦ Process Classes (required, one or more selected from the process model)
♦ Process Instances (Optional, one process instance is created by default for each
selected process class. At least one process instance is required for a recipe.)
♦ Transfer Instances (optional)
♦ Unit Selection Mode (required, defined for each process class and/or instance)
♦ Attributes (optional, available for each process class and/or instance for which process
class attributes were defined in the process model)
♦ Unit Assignments (optional, required for equipment dependent recipes only)

230
8. Recipe Editor B0193YB – Rev C

♦ Comments (optional, no size restrictions).

Recipe Editor gives you the ability to define equipment independent or equipment dependent
recipes. An equipment independent recipe does not have units assigned to its process instances.
An equipment dependent recipe is associated with specific units assigned to one or more process
instances. In actuality, the recipe procedure is associated with instances within a class. For exam-
ple, the process class “Reactors” might have two process instances: “ReactorA” and “ReactorB.”
ReactorA and ReactorB are still class based, but can be independently referenced in the recipe.
Multiple process instances must be defined when more than one unit from a process class is
needed for producing the product defined in the recipe. By default, one process instance is created
for each process class. The process instance name defaults to the process class name. However, if
multiple units from the same process class are required, the appropriate number of process
instances must be defined. Likewise, the appropriate transfer instances must be defined so that
there is a differentiation between the resulting transfer instances.

NOTE
It is very important for you to remember that editing process instances is not neces-
sary if your requirements need only one unit from within the same process class.

Using Process and Transfer Instances:

Example 1 illustrates the necessary equipment requirements for a recipe that uses one process
instance per class. Example 2 illustrates the equipment requirements for a recipe that uses two
reactor and hold tank process instances. In example 1, all process and transfer instances automati-
cally default to the class name. In example 2, four process class instances are defined and four
transfer instances must be defined.

Figure 8-3. Transfer and Process Instance Examples

To Open the Equipment Requirements Editor:

1. On the Recipe Editor menu, click Edit, and then select Equipment Requirements.
2. The Equipment Requirements Editor window appears.

231
B0193YB – Rev C 8. Recipe Editor

All previously assigned process classes are listed.

Assigning Process Classes

You must select at least one process class from the process model and assign it to the recipe proce-
dure. The phases that are available in the recipe procedure correspond to the process phases of the
selected classes. They also correspond to the transfer phases for the transfer classes in which the
source and destination classes are included in the equipment requirements.

NOTE
You can delete process class assignments with the Equipment Requirements Editor.
Deleting a process class removes all the process and transfer instances that are associ-
ated with the deleted class. Phases previously assigned to instances associated with
the deleted process class must be manually deleted from the recipe procedure. Until
you delete these phases, the recipe is invalid. Should this condition arise, a message
box is displayed.

To Assign Process Classes:

1. On the Equipment Requirements Editor, click Add Processes.
2. The Process Classes window appears.

232
8. Recipe Editor B0193YB – Rev C

All the process classes in your process model are listed.

3. Select the required process class(es) and then click OK.

Editing Process Instances

Process Instances
Use the Process Class Instance Editor to define the specific process instances necessary for recipe
construction. Instance names must be unique. The editor verifies the name to ensure validity and
uniqueness.
A process class instance consists of the following:
♦ Name (16-char max)
♦ Selection Mode – (Automatic or Manual) the manner in which runtime unit selection
is made for the instance. The default is Automatic. If you assign units to the process
instance, the Selection mode is unavailable, and is, by default, Automatic.
♦ Attributes – All attributes defined for the selected process class are available.
♦ Unit Assignment – Required for equipment dependant recipes.
You use the instance names when you assign phases to an operation during recipe procedure
development.

NOTE
Deleting a process instance also removes all transfer instances that were defined
using the deleted process instance. If you delete all the instances for a process class,
there are no instances available for assigning operations in the Procedure Editor.
New instances can be defined, or the process class can be deleted and reassigned
using the Equipment Requirements Editor in order to return the default instance
name. All the phases that were assigned to a deleted process instance must be manu-
ally deleted from the recipe procedure. The recipe is invalid until the phases are
removed.

If your recipe procedure requires multiple process instance names, you should first change the
name of the default instance, and then add the required instances. Remember that if you delete

233
B0193YB – Rev C 8. Recipe Editor

default process instances, then the default transfer instances are deleted as well. Also, if you retain
the default instance and name, and do not use it in the procedure, the batch management system
requires an extra unit in the train in order to initialize the recipe.

NOTE
Multiple process instances are not required unless you have a batch execution
requirement for the simultaneous allocation of more than one unit from the same
process class.

To Assign Process Instances:

1. On the Equipment Requirements Editor, click Process Instances.
2. The Process Class Instances Editor appears.

The Name box in the Process Class Instance Editor window displays a default
instance name which is the same as the selected process class name. If you only need
one unit from the class for the recipe, then you can use the default name. If more than
one unit is required from the process class, you must define multiple instance names.
3. In the Name box, enter an appropriate process instance name.
4. Click Add.

Assigning Units to Process Class Instances

You must assign units to a process class if you are developing an equipment dependent recipe. A
specific unit can be assigned to each process instance.

234
8. Recipe Editor B0193YB – Rev C

Making a specific unit assignment for a process instance requires that the selected unit be allo-
cated at run time. The recipe builder uses the instance name when building the procedure. The
specific unit is allocated when the recipe is assigned and then executed as part of a batch.

NOTE
If you remove an assigned unit assignment from a process instance, it is also
removed from the selected instance. If an instance has no unit assignments, then all
the units in the selected process class that are part of the train assigned to the batch,
are available for allocation when the batch is executed.

To Assign Process Instances:

1. On the Process Class Instances Editor, enter a Name (16-char max) for the process
instance.
2. Click Assign Unit.
3. The Units window appears.

All the units assigned to the selected process class in the process model are displayed.
4. Select a Unit from the list and click OK.
The unit that you select is assigned to the instance. The unit name is displayed in the
Process Class Instance Editor window along with the appropriate process instance
name.

Unit Selection Mode

Use the Selection Mode drop-down list to define how a single unit is selected during batch
execution when multiple units within the process class are available in the associated train. The
Selection Mode has two settings; Automatic and Manual. The Automatic mode requires the batch
management system to select the specific unit. The Manual mode requires the operator to manu-
ally select the specific unit from a list of available units. The actual unit selection is made during
the run-time execution of the recipe.

235
B0193YB – Rev C 8. Recipe Editor

NOTE
If a specific unit has been assigned to a process instance, you cannot set the selection
mode. In this case, the batch management system allocates the assigned unit when
the recipe executes.

Attributes
Use the Attributes list and, Min and Max text boxes, to provide additional equipment require-
ments for a recipe.

NOTE
Use of attributes is optional.

The batch management system uses attributes to allocate units in the train assigned to a batch
only if the unit attribute values satisfy the corresponding recipe attribute requirements. Attributes
are defined for the process class in the Process Modeling Editor
For more information on process class attributes, see Chapter 5 “Process Modeling”.
The assigned attributes are valid only for the selected process instance and the recipe that you are
creating. The attribute range consists of a minimum value (Min) and a maximum value (Max).
If you do not define a range, the attribute is ignored by the batch management system. If a recipe
requires a unit with an attribute range, the minimum and maximum attribute values must be
entered to include the value range needed for the recipe. If the attribute must be a specific value,
the minimum and maximum values must be the same.
Several examples of attribute range definitions are presented in the following table. Included with
each definition is the action on the part of the batch management system.

Table 8-6. Examples of Attribute Range Definitions

Minimum Value Maximum Value Batch Management Action

0 0 Attribute ignored by the batch management system.
10 100 Only units in the process class that have an attribute value
greater than or equal to 10 and less than or equal to 100
can be used by the batch management system.
50 50 Only units in the process class that have an attribute value
of 50 can be used by the batch management system.

NOTE
If a specific unit has been assigned to a process instance, an attribute range cannot
be defined. The batch management system is required to allocate the assigned unit
when the recipe is executed as part of a batch.

236
8. Recipe Editor B0193YB – Rev C

Example Equipment Requirements

The following example demonstrates how the equipment requirements can be configured for a
recipe and how the requirements are used by the batch management system during the execution
of a batch.
For this example, suppose that a transfer phase is to be conducted from a bulk tank to a reactor, as
shown in the following diagram. Also, assume that the train assigned to the batch includes the
three units displayed, and the bulk can be transferred to both reactors simultaneously.

Figure 8-4. Equipment Requirements Diagram Example

The Process Class Instance Editor window shown below represents a possible configuration for
this example.

Figure 8-5. Process Class Instance Editor Window

237
B0193YB – Rev C 8. Recipe Editor

In the example, the batch management system must allocate a reactor as the destination unit in
order to execute the bulk addition. The unit selection mode and the capacity attribute range
defined in the recipe are evaluated by the batch management system and compared with the unit
attribute values defined in the Process Model Editor. The following table shows variety of
scenarios and the result of the batch management system for the previous example.

Table 8-7. Example of Batch Management System Results

Minimum Maximum
Process Unit Capacity Capacity
Instances Assigned Selection Attribute Attribute
Defined Units Mode Value Value Resultant Unit Selected
Reactors None Automatic 0 0 Reactor A or Reactor B
Reactors None Automatic 0 2000 Reactor A or Reactor B
Reactors None Automatic 0 1000 Reactor A
Reactors None Automatic 2001 3000 Batch cannot be initial-
ized because train does
not contain an acceptable
unit.
Reactors None Manual 0 0 Select Reactor A or
Reactor B
Reactors None Manual 0 2000 Select Reactor A or
Reactor B
Reactors None Manual 0 1000 Reactor A is automati-
cally selected because it is
the only reactor satisfying
the attribute range.
Reactors ReactorA N/A N/A N/A Reactor A
Reactors ReactorB N/A N/A N/A Reactor B
First_Reactor None Automatic 0 2000 Reactor A or Reactor B
First_Reactor None Manual 0 2000 Reactor A or Reactor B
First_Reactor None Manual 0 2000 Reactor A or Reactor B
Second_Reactor None Manual 0 2000 selected for the
First_Reactor instance.
The other reactor is
selected for the
Second_Reactor instance.
First_Reactor None Manual 0 2000 Manually select Reactor A
Second_Reactor None Manual 0 2000 or Reactor B for the
First_Reactor instance.
The other reactor is auto-
matically selected for the
Second_Reactor instance.

238
8. Recipe Editor B0193YB – Rev C

Table 8-7. Example of Batch Management System Results (Continued)

Minimum Maximum
Process Unit Capacity Capacity
Instances Assigned Selection Attribute Attribute
Defined Units Mode Value Value Resultant Unit Selected
First_Reactor ReactorA N/A N/A N/A Reactor A is allocated for
Second_Reactor None Automatic 0 2000 the First_Reactor
instance. Reactor B is allo-
cated for the
Second_Reactor instance.
First_Reactor ReactorA N/A N/A N/A Reactor A is allocated for
Second_Reactor ReactorB N/A N/A N/A the First_Reactor
instance. Reactor B is allo-
cated for the
Second_Reactor instance.

Editing Transfer Instances

Transfer
Use the Transfer Class Instance Editor to define the specific transfer instances necessary for recipe
construction. Instance names must be unique. The editor verifies the name to ensure validity and
uniqueness.
A transfer class instance consists of the following:
♦ Name (16-char max)
♦ Source Instance
♦ Destination Instance.
You use the names defined for the instances while you are building a recipe and are assigning
phases to an operation.

NOTE
Multiple transfer instances are not required unless more than one process instance
has been defined for a process class, or if multiple connections require simultaneous
allocation from the same transfer class during batch execution.

The default transfer instance name is the same as the name of the transfer class. The source and
destination instances associated with the default transfer instance correspond to the first process
instances defined for the source and destination process classes. If multiple process instances have
been defined for a process class, then multiple transfer instances must be defined so that the recipe
builder can differentiate the transfer phases into and out of each process instance.
If your recipe procedure requires multiple transfer instance names, you should first change the
name of the default instance, and then add the required instances.
If multiple transfer instance names are required, change the name of the default instance first,
then add any other required instances.

239
B0193YB – Rev C 8. Recipe Editor

NOTE
If you delete a transfer class instance, you must manually delete the phases that were
previously assigned. The recipe becomes invalid until the phases are removed.

To Assign Transfer Instances:

1. On the Equipment Requirements Editor, click the Transfer Instances button.
2. The Transfer Class Instance Editor appears.

All available transfer classes along with their source and destination classes defined in the process
model are listed. Note, in the lower pane of this window, that there is a single transfer instance
displayed for each transfer class.

Assigning Source and Destination Instances

Use the Source Instance and Destination Instance windows to assign source and destination
instances to the transfer instance. Only one instance can be selected at a time. Either the default

240
8. Recipe Editor B0193YB – Rev C

or the user-defined process instances is available. The proper instance must be selected from the
appropriate dialog box and assigned to the transfer instance.

NOTE
If multiple transfer instances are being created from process classes that contain
multiple process instances, it is possible for a transfer instance to be defined for
which a connection does not exist in the process model. Therefore, the recipe
builder must be sure that the physical process model contains a connection that is
represented by the defined transfer instances.

To Assign a Source Instance:

1. On the Transfer Class Instance Editor window, click the Source Instance button.
2. The Source Instance window appears.

3. Select the required Source Instance from the list.

4. Click OK.

To Assign a Destination Instance:

1. On the Transfer Class Instance Editor window, click the Destination Instance
button.
2. The Source Instance window appears.

241
B0193YB – Rev C 8. Recipe Editor

3. Select the required Source Instance from the list.

4. Click OK.

Example Transfer Instance Selection

The window display shows how you to use two transfer instances for the bulk-to-reactor addition
example shown earlier in this section. After definition, the instances are available within the recipe
procedure, allowing the recipe builder to select the appropriate transfer phase depending on the
process instance operation being defined.

242
8. Recipe Editor B0193YB – Rev C

Figure 8-6. Transfer Class Instance Editor Window

Formula
A recipe formula consists of the inputs, outputs, and process variables that are used in the recipe
procedure. You define these parameters using the Formula Inputs Editor, the Formula Outputs
Editor, and the Process Variables editors described in the following section.
Input and output materials are assigned from the materials defined in the materials database prior
to development of the recipe. Inputs and outputs must be selected for a recipe before they can be
used in the procedure. Once defined, the inputs and outputs are available for assignment in
phases that have input or output parameters defined. Value assignments for each material can be
made from the respective editor or locally at each phase. The process variable editor displays all
the process variable type parameters that are used in phases in the recipe procedure. Phases with
process variable parameters must be edited in the Procedure Editor before they can be displayed in
the Process Variable Editor. Value assignments for each process variable can be made while con-

243
B0193YB – Rev C 8. Recipe Editor

structing the recipe procedure or from the Process Variable Editor after the procedure is
constructed.

Edit/Formula Inputs
Use the Edit/Formula Inputs command to access the Formula Inputs Editor window which you
use to define the input materials that are used in the recipe.
Formula inputs are the materials that are used as raw materials in the recipe procedure. All phases
that have an input parameter defined must have an input material assigned.
The same material can be added to the recipe with as many configurations as you require. Inputs
that you define and add do not necessarily need to be used in the recipe procedure.

NOTE
The single instance of a material may be assigned to the input parameter of more
than one phase, and unique quantity values may be assigned to each parameter.
However, one material may not be used as both a percent value and an actual value
within different phases in a recipe. If this is desired, the material must be added
twice to the Formula Inputs Editor Inputs list.

To Edit Formula Inputs:

1. Click Edit, and then select Formula Inputs.
You can also click the Formula Inputs icon in the main toolbar.

2. The Formula Inputs Editor window appears.

244
8. Recipe Editor B0193YB – Rev C

To Add Input Materials:

1. On the Formula Editors window, click the Add Inputs button.
2. The Materials window appears.

245
B0193YB – Rev C 8. Recipe Editor

All the materials in the materials database of the selected Type are listed. The material
types include Ingredients, Intermediates, Finished Goods, By-Products, and Other.
3. Click the Type drop-down arrow, and select the applicable material type.
4. Select the required material(s) from the list.
5. Click OK.

To Change Input Materials:

1. On the Formula Editors window, click the Change Inputs button.
2. The Materials window appears.

All the materials in the materials database of the selected Type are listed. The material
types include Ingredients, Intermediates, Finished Goods, By-products, and Other.
3. Click the Type drop-down arrow, and select the applicable material type.
4. Select the required material from the list.

246
8. Recipe Editor B0193YB – Rev C

5. Click OK.
The new material retains the values and phase assignment that were assigned to previ-
ous input.

To Add or Change Input Materials - Alternate Method:

In the event that the materials database grows very large, you may notice an increasing delay when
opening the Materials window. To avoid the this, you can use an alternate method to add or
change input materials.
1. Disable the Add Materials From List checkbox in the Formula Inputs Editor window.
When enabled, materials are entered as described earlier in this section.
2. When you click the Add Inputs or Change Input button the Material window appears.

3. In the Material ID text box, enter the required material ID and then click OK or Apply.
If the material is located in the materials database, then the material is added to the list
in the Formula Inputs Editor window. If the material does not exist in the materials
database, an error message is displayed.

To Edit Input Material Settings:

1. On the Formula Inputs Editor window, in the Material Settings pane, enter a quantity
in the Value text box.
For each material assigned as a recipe formula input, you can define a Value which
represents the material quantity. This value is entered as either a percentage of the
total batch size or as an actual value.
2. Click the Type drop-down arrow and select Percent or Actual as required for the
entered value.
3. Enable the Total checkbox if you want the value to be included as part of the inputs
total in the Inputs Summary list.
The sum of all values assigned to inputs that have the total checkbox selected is dis-
played in the Inputs Summary pane. This totalizing feature only functions for inputs
that have values of the same type. If there is a mix of input materials with actual values
that have the total checkbox selected and input materials with percent values that have
the total checkbox selected, the Value displays N/A.
The totalizing function is provided merely as a convenience for totaling selected
inputs when a recipe can be constructed, and, therefore, produced, in more than one
way. The Recipe Editor does not require that the total of inputs is equal to exactly
100%. An example of this is a recipe that varies in batch size from 100 to 5000
pounds. When the batch size is below 500 pounds, a specific group of inputs (ingredi-
ents) are assembled in advance as a premix and then added to the batch as an interme-
diate. When the size is equal to or above 500 pounds, all inputs are added

247
B0193YB – Rev C 8. Recipe Editor

individually. If the total intermediate is 25% of the batch and is included in the total,
the total would be 125%. If the Total checkbox is disabled for the intermediate, the
total would be 100%. In this example, the procedure would include parallel opera-
tions or phases for adding the inputs in question, with only the appropriate operations
or phases being executed. Transition logic evaluating the batch size would be used to
determine which operations or phases to execute.
4. Click the Tolerance drop-down arrow and select General, Recipe or None as
required.
General (default) tolerances are defined for each input as part of its entry into the
materials database. These tolerances are displayed in the high and low deviation fields
as percentages. The tolerances can be also be assigned as Recipe specific. If you do not
want to assign a tolerance, use the None option. You can change input material toler-
ances by using the Formula Inputs Editor window or by directly editing the phase in
the recipe procedure.
5. If you specified Recipe as the Tolerance, enter a High Deviation and Low Deviation.
6. In the Unit of Measure text box, enter an appropriate term (16-char max) (for
example, Kgs, Liters, Gallons).
7. Click Change.

Edit/Formula Outputs
Use the Edit/Formula Outputs command to access the Formula Outputs Editor window which
you use to define the materials that the recipe produces.
All phases that have output parameter definitions must have an output material assigned. A single
instance of a material may be assigned to the output parameter of more than one phase, and
unique quantity values may be assigned to each parameter. However, the same material cannot be
used as both a percent value and an actual value within different phases of a recipe. If this is
required, you must add the material twice.

To Edit Formula Outputs:

1. Click Edit, and then select Formula Inputs.
You can also click the Formula Inputs icon in the main toolbar.

2. The Formula Outputs Editor window appears.

248
8. Recipe Editor B0193YB – Rev C

To Add Output Materials:

1. On the Formula Editors window, click the Add Outputs button.
2. The Materials window appears.

249
B0193YB – Rev C 8. Recipe Editor

All the materials in the materials database of the selected Type are listed. The material
types include Ingredients, Intermediates, Finished Goods, By-Products, and Other.
3. Click the Type drop-down arrow, and select the applicable material type.
4. Select the required material(s) from the list.
5. Click OK.

To Change Output Materials:

1. On the Formula Editors window, click the Change Output button.
2. The Materials window appears.

All the materials in the materials database of the selected Type are listed. The material
types include Ingredients, Intermediates, Finished Goods, By-Products, and Other.
3. Click the Type drop-down arrow, and select the applicable material type.
4. Select the required material from the list.

250
8. Recipe Editor B0193YB – Rev C

5. Click OK.
The new material retains the values and phase assignment that were assigned to previous input.

To Add or Change Output Materials - Alternate Method:

In the event that the materials database grows very large, you may notice an increasing delay when
opening the Materials window. To avoid the this, you can use an alternate method to add or
change input materials.
1. Disable the Add Materials From List checkbox in the Formula Inputs Editor window.
When enabled, materials are entered as described earlier in this section.
2. When you click the Add Outputs or Change Output button, the Material window
appears.

3. In the Material ID text box, enter the required material ID and then click OK or Apply.
If the material is located in the materials database, then the material is added to the list
in the Formula Inputs Editor window. If the material does not exist in the materials
database, an error message is displayed.

To Edit Output Material Settings:

1. On the Formula Outputs Editor window, in the Material Settings pane, enter a quan-
tity in the Value text box.
For each material assigned as a recipe formula output, you can define a Value which
represents the material quantity. This value is entered as either a percentage of the
total batch size or as an actual value.
2. Click the Type drop-down arrow and select Percent or Actual as required for the
entered value.
3. Enable the Total checkbox if you want the value to be included as part of the inputs
total in the Inputs Summary list.
The sum of all the values assigned to outputs that have the total checkbox selected is
displayed in the Outputs Summary pane. The totalizing function only works on out-
puts that have values of the same type. If there is a mix of output materials with Actual
values that have the total checkbox selected and output materials with Percent values
that have the total checkbox selected, the Value displays N/A.
The totalizing function is provided as a convenience for totaling selected outputs
when a recipe can be constructed, and, therefore, produced, in more than one way.
The Recipe Editor does not require the outputs to total exactly 100%.
4. In the Unit of Measure text box, enter an appropriate term (16-char max) (for exam-
ple, Kgs, Liters, Gallons).
5. Click Change.

251
B0193YB – Rev C 8. Recipe Editor

Process Variables
Formula process variables correspond to all process variable formula parameters defined for the
phases used in the construction of the recipe. Process variable formula parameters are defined in
the Process Modeling Editor. Use the Process Variables window to redefine the names or values
assigned to process variable parameters.
When you construct a procedure, you can use the same phase more than once. If you do this, the
associated process variable parameters are used as many times as the phase is used. Because of this,
the parameter names are listed in the Process Variables window more than once. To prevent con-
fusion when viewing the list, you can change the process variable names so that they are more
descriptive. Changing the name in this way only affects the specific instance of the parameter in
the recipe. Also, as you build the procedure, you can change the names.

Edit/Process Variables
Use the Edit/Process Variables command to edit formula process variables.

To Edit Process Variables:

1. On the Recipe Editor window, click Edit and then select Process Variables.
You can also click the Process Variables icon in the main toolbar.

2. The Process Variables window displays.

The list shows all the process variables used in the phases of the recipe procedure. The
list is empty until you use phases that contain process variable parameters in the recipe
procedure. Following recipe procedure creation, you can change process variable
parameter in the Process Variables window or directly in the specific phase.
For each process variable displayed in the list, the phase Type, Name, Value, Toler-
ances, and Description are displayed. This information is derived from the process
model database.

252
8. Recipe Editor B0193YB – Rev C

3. Select a process variable from the list.

4. In the Name text box, enter an appropriate name (16-char max).
5. In the Value text box, enter an appropriate value.

NOTE
The Value must be within the range of the High and Low Limit values defined for
the parameter in the process model database.

6. Click the Tolerances drop-down arrow and select General, Recipe, or None as
required.
7. In the High Deviation and Low Deviation text boxes, enter values that are consistent
with the Tolerance that you specified.
8. Click Change.

Unit Procedures Library

You create and initially save unit procedure operations during recipe construction.
For more information on saving unit procedures, see “Building a Recipe” later in this section.
Use the Edit/Unit Procedures Library command to edit the name and description of recipe unit
procedures that were created during recipe development and then store them for future use.
A stored unit procedure consists of an Unit Procedure Name (16-char max) and optional com-
ments of unlimited length. The Unit Procedure Library is recipe independent and there is no
limit to the number of unit procedures that you can store.

To Edit the Unit Procedures Library:

1. Click Edit, and then select Unit Procedures Library.
You can also click the Unit Procedures icon on the main toolbar.

2. The Unit Procedure Library window appears.

253
B0193YB – Rev C 8. Recipe Editor

All the unit procedures that have been previously saved appear in the list.
3. In the Unit Procedure Name text box, enter an appropriate name.
4. In the Comments box, enter a description for the unit procedure (optional).
5. Click Change and then Close.

Operations Library
Edit/Operations Library
You create and initially save recipe operations during recipe construction.
For more information on saving operations, see “Building a Recipe” later in this section.
Use the Edit/Operations Library command to edit the name and description of recipe operations
that were created during recipe development and then store them for future use.
A stored operation consists of an Operation Name (16-char max) and optional comments of
unlimited length. The Operation Library is recipe independent and there is no limit to the num-
ber of operations that you can store.

To Edit the Operations Library:

1. Click Edit, and then select Operations Library.
You can also click the Operations Library icon in the main toolbar.

2. The Operations Library window appears.

254
8. Recipe Editor B0193YB – Rev C

All the operations that have been previously saved appear in the list.
3. In the Operation Name text box, enter an appropriate name.
4. In the Comments box, enter a description for the operation (optional).
5. Click Change and then Close.

Edit/Recipe States
Use the Edit/Recipe States menu to access the Edit Recipe States window.
Recipe states are defined on a global basis throughout the entire recipe management system and
are available for every recipe created. Examples of recipe states might include test, production and
archive.
Recipe states consists of Name (16-char max) and an optional description. All recipes must con-
tain a state assignment in order for the recipe to be valid.

To Edit a Recipe State:

1. On the Recipe Editor menu, click Edit and then select Recipe States.
2. The Edit Recipe States window displays.

255
B0193YB – Rev C 8. Recipe Editor

3. Select the required State from the list.

4. In the Name text box, enter a name for the state.
5. In the Description box, enter text describing the state (optional).
6. Enable the Default, Schedule and Read Only checkboxes as required.
Any of the available states can be selected as the default. The assignment of a default
state to a recipe is optional and does not prevent validation or approval of a recipe.
However, once it is set as the default, it is automatically assigned to all new recipes.
Enabling the Schedule checkbox allows the recipe to be scheduled for execution by the
batch system. Enabling the Read Only checkbox prevents saving of the recipe during
editing.
7. Click Add if you are creating a new state or click Change if you are editing an existing
state.

Edit/Recipe Types
Use the Edit/Recipe Types menu to access the Edit Recipe Types window.
Recipe types are defined on a global basis throughout the entire recipe management system and
are available for every recipe created.
Using the Recipe Type Editor, you can essentially create categories that you can assign to the rec-
ipe header. Examples of recipe types might include CIP, barbecue, salad dressing, and so forth.
Once defined, recipe types are available for every recipe in the recipe management system.
A recipe type consists of a Name (16-char max) and an optional description. The assignment of a
type to a recipe is optional and does not prevent validation or approval of a recipe. Recipe types
can be changed at any time by a user.

To Edit a Recipe Type:

1. On the Recipe Editor menu, click Edit and then select Recipe Types.
2. The Edit Recipe Types window displays.

256
8. Recipe Editor B0193YB – Rev C

3. Select the required type from the list.

4. In the Name text box, enter a name for the type (16-char max).
5. In the Description box, enter text describing the type (optional).
6. Enable the Default checkbox if you want to set the current type as the default. The
assignment of a default type to a recipe is optional and does not prevent validation or
approval of a recipe. However, once it is set as the default, it is automatically assigned
to all new recipes.
7. Click Add if you are creating a new type or click Change if you are editing an existing
type.

View Menu
Use the Recipe Editor View menu to show or hide toolbars, change the magnification (zoom-in or
zoom-out) of the unit procedures, operation and phase displays, show or hide the unit procedures,
operations and phases views.

View/Main Toolbar
To View the Main Toolbar:
♦ Click View and then enable the Main Toolbar menu item.

View/Unit Procedure Toolbar

To View the Unit Procedure Toolbar:
♦ Click View and then enable the Unit Procedure Toolbar menu item.
You can also use the Show/Hide Unit Procedures View icon in the Main toolbar.

257
B0193YB – Rev C 8. Recipe Editor

View/Operation Toolbar
To View the Operations Toolbar:
♦ Click View and then enable the Operation Toolbar menu item.
You can also use the Show/Hide Operations View icon in the Main toolbar.

View/Phase Toolbar
To View the Operations Toolbar:
♦ Click View and then enable the Phase Toolbar menu item.
You can also use the Show/Hide Phases View icon in the Main toolbar.

View/Status Bar
To View the Status Bar:
♦ Click View and then enable the Status Bar menu item.

View/Unit Procedure View

Use the View/Unit Procedure View menu item to show or hide the Unit Procedures pane and
toolbar.

View/Unit Procedure Zoom In

To Zoom In on Unit Procedures:
♦ Click View and then select Unit Procedure Zoom In to increase the displayed size of
objects in the recipe unit procedure pane.
You can also use the Unit Procedure Zoom In icon in the Unit Procedures toolbar.

View/Unit Procedure Zoom Out

To Zoom Out on Unit Procedures:
♦ Click View and then select Unit Procedure Zoom Out to increase the displayed size of
objects in the recipe unit procedure pane.
You can also use the Unit Procedure Zoom Out icon in the Unit Procedures toolbar.

View/Operation View
Use the View/Operation View menu item to show or hide the Operations pane and toolbar.

258
8. Recipe Editor B0193YB – Rev C

View/Operation Zoom In
To Zoom In on a Recipe Operation:
♦ Click View and then select Operation Zoom In to increase the displayed size of objects
in the recipe operation pane.
You can also use the Operation Zoom In icon in the Main toolbar.

View/Operation Zoom Out

To Zoom Out of a Recipe Operation:
♦ Click View and then select Operation Zoom Out command to decrease the displayed
size of objects in the recipe operation pane.
You can also use the Operations Zoom Out icon in the Main toolbar.

View/Phase View
Use the View/Phase View menu item to show or hide the Phases pane and toolbar.

View/Phase Zoom In
To Zoom In on Recipe Phases:
♦ Click View and then select Phase Zoom In command to increase the displayed size of
phases in the recipe phase pane.
You can also use the Phase Zoom In icon in the Main toolbar.

View/Phase Zoom Out

To Zoom Out of a Recipe Phase:
♦ Click View and then select Phase Zoom Out command to decrease the displayed size
of phases in the recipe phase pane.
You can also use the Phase Zoom Out icon in the Main toolbar.

Help Menu
The Recipe Editor Help menu contains commands that provide you with access to the on-line
Help system and information regarding product version.

Help/Help Topics
Use the Help/Help Topics command to display Help contents for Recipe Editor.

259
B0193YB – Rev C 8. Recipe Editor

Help/About Recipe Editor

Use the Help/About command to view product version information.

Building a Recipe Procedure

A recipe procedure defines the sequence in which operations and phases are executed when the
recipe is scheduled and executed by the batch management system. Use the Recipe Editor window
to create the recipe’s sequence of events. An overview of the Recipe Editor window and all the
major components is shown below. Each of these items is described in more detail in the this
section.

Figure 8-7. Recipe Editor

Procedure Layout
The Recipe Editor Procedure window is divided into three resizeable panes: Unit Procedures,
Operations and Phases.

Unit Procedures
The Unit Procedures pane is used to layout the sequence of user-defined unit procedures that are
executed when the recipe is scheduled as part of a batch. Each unit procedure should contain at
least one phase. The operation sequence can be constructed using any of the procedure objects
described later.

260
8. Recipe Editor B0193YB – Rev C

Sequence of Operations
The Sequence of Operations pane is used to create a sequence of user-defined operations that are
executed when the recipe is scheduled as part of a batch. Each operation should contain at least
one phase. The operation sequence can be constructed using any of the procedure objects
described later.

Sequence of Phases
The Sequence of Phases section of the Procedure window is used to create a sequence of phases
that are executed within an operation. The phases are defined in the process modeling editor. The
phase sequence can be constructed using any of the procedure objects described later.

Procedure Objects
Recipe procedures are constructed using one or more of the various objects that are available
within the editor. These objects are accessed from one of the dockable toolbars.

Unit Procedures Toolbar

♦ Add Unit Procedures

The Add Unit Procedures icon is used to enter a user-defined unit procedure. The
unit procedure name and the associated process instance name are displayed on the
object.

♦ Load Unit Procedure

The Load Unit Procedures icon is used to load a pre-defined unit procedure from the
Unit Procedures Library.

♦ Add Unit Procedure Transition

The Add Unit Procedures Transition icon is used to enter a transition logic object.

♦ Add Unit Procedure Branch

The Add Unit Procedures Branch icon is used to enter a branch object.

♦ Add Unit Procedure Loop

The Add Unit Procedures Loop icon is used to enter a loop object.

♦ Cut Unit Procedure

261
B0193YB – Rev C 8. Recipe Editor

The Cut Unit Procedure Object icon is used to remove an object from the Unit Proce-
dure pane and store it in the Windows clipboard.

♦ Copy Unit Procedure

The Copy Unit Procedure Object icon is used to copy an object.

♦ Paste Unit Procedure

The Copy Unit Procedure Object icon is used to paste an object.

♦ Delete Unit Procedure Object

The Delete Operation Object icon is used to delete an object.

♦ Undo
The Undo icon is used to undo the most recent change.

NOTE
There is only one level of undo available. Undo is only applicable to the creation
and deletion of objects.

♦ Zoom In
The Zoom In icon is used to enlarge the Unit Procedure pane. There are 10 levels of
magnification available.

♦ Zoom Out
The Zoom Out icon is used to reduce the sequence of operations display. There are 10
levels of reduction available.

Operations Toolbar

♦ Add Operation
The Add Operation icon is used to enter a user-defined operation. The operation
name is displayed on the object.

♦ Load Operation

262
8. Recipe Editor B0193YB – Rev C

The Load Operation icon is used to load a pre-defined operation from the Operation
Library.

♦ Add Operation Transition

The Add Operation Transition icon is used to enter a transition logic object into the
sequence of operations.

♦ Add Operation Branch

The Add Operation Branch icon is used to enter a branch object into the sequence of
operations.

♦ Add Operation Loop

The Add Operation Loop icon is used to enter a loop object into the sequence of
operations.

♦ Cut Operation
The Cut Operation Object icon is used to remove an object from the Operations pane
and store it in the Windows clipboard.

♦ Copy Operation
The Copy Operation Object icon is used to copy an object.

♦ Paste Operation
The Paste Operation Object icon is used to paste an object.

♦ Delete Operation Object

The Delete Operation Object icon is used to delete an object.

♦ Undo
The Undo icon is used to undo the most recent change.

NOTE
There is only one level of undo available. Undo is only applicable to the creation
and deletion of objects.

♦ Zoom In

263
B0193YB – Rev C 8. Recipe Editor

The Zoom In icon is used to enlarge the sequence of operations display. There are 10
levels of magnification available.

♦ Zoom Out
The Zoom Out icon is used to reduce the sequence of operations display. There are 10
levels of reduction available.

Phases Toolbar

♦ Add Phase
The Add Phase icon is used to add a phase to the procedure. The phases that are
available are read from the process model. The phase name and the associated process
or transfer instance name are displayed on the object.

♦ Add Phase Transition

The Add Phase Transition icon is used to enter a transition logic object into the
sequence of phases.

♦ Add Phase Branch

The Add Phase Branch icon is used to enter a branch object into the sequence of
phases.

♦ Add Phase Loop

The Add Phase Loop icon is used to enter a loop object into the sequence of phases.

♦ Cut Phase
The Cut Phase Object icon is used to remove an object from the Phase pane and store
it in the Windows clipboard.

♦ Copy Phase
The Copy Phase Object icon is used to copy a object.

♦ Paste Operation

264
8. Recipe Editor B0193YB – Rev C

The Paste Phase Object icon is used to paste an object.

♦ Delete Phase Object

The Delete Phase Object icon is used to delete an object.

♦ Undo
The Undo icon is used to undo the most recent change.

NOTE
There is only one level of undo available. Undo is only applicable to the creation
and deletion of objects.

♦ Zoom In
The Zoom In icon is used to enlarge the sequence of phases display. There are 10 levels
of magnification available.

♦ Zoom Out
The Zoom Out icon is used to reduce the sequence of phases display. There are 10 lev-
els of reduction available.

Storing Unit Procedures

As you create your recipe you can use one of two methods to store a unit procedure in the library.
♦ You can double-click the target operation to display the Unit Procedures Properties
window and use its Save Unit Procedures button to store the operation.
♦ You can click the Unit Procedures Library icon on the toolbar to open the Unit
Procedures Library window. You can then drag the target unit procedure into the
library dialog box.

The unit procedure is added to the library list along with the Process Class, Process Instance, the
Date the unit procedure was added, and all phases and configuration information.

NOTE
Unit procedures in the library may have the same name. However, each operation is
individually maintained. Also, the unit procedure in the library can be sorted
according to each field by clicking the appropriate column header.

265
B0193YB – Rev C 8. Recipe Editor

Loading a Unit Procedure

As you create your recipe you can use one of two methods to load a unit procedure from the main
toolbar.

To Load an Operation:
1. On the Unit Procedures toolbar, click the Load Unit Procedure icon.

2. The Load Unit Procedure window appears. Select the Unit Procedure that you want
to load from the list.
3. Click OK.
The unit procedure is added to the procedure beneath the location of the cursor.
You can also add an operation by clicking the Unit Procedures Library icon and then dragging the
target operation into the recipe procedure.

Unit Procedure
When you attempt to load a unit procedure into a recipe procedure, the following checks are per-
formed to ensure the validity of the unit procedure.
♦ The Process Class assigned to the unit procedure must exist in the Equipment
Requirements Editor. If the class does not exist, an error message is displayed and the
load fails.
♦ If the process class exists, the process instance is automatically added to the recipe
equipment requirements. A message must be acknowledged for each instance.
♦ Materials included in the unit procedure definition can optionally be added to the
recipe formula. A message must be acknowledged for each material.

NOTE
Remember that adding unit procedures from the library may result in the addition
of process and transfer instances to the recipe equipment requirements. You must
ensure sure that the recipe equipment requirements have only the required instances
defined. When the recipe is scheduled as a batch, the train must have equipment for
each instance regardless of whether the instance is called in the procedure. If not,
the batch cannot be initialized

Storing Operations
As you create your recipe you can use one of two methods to store the operation in the library.
♦ You can double-click the target operation to display the Operation Properties window
and use its Save Operation button to store the operation.

266
8. Recipe Editor B0193YB – Rev C

♦ You can click the Operations Library icon on the toolbar to open the Operations
Library window. You can then drag the target operation into the library dialog box.

The operation is added to the library list along with the Process Class, Process Instance, the Date
the operation is added, and all phases and configuration information.

267
B0193YB – Rev C 8. Recipe Editor

NOTE
Operations in the library may have the same name. However, each operation is indi-
vidually maintained. Also, the operations in the library can be sorted according to
each field by clicking the appropriate column header.

Loading an Operation
As you create your recipe you can use one of two methods to load an operation from the main
toolbar.

To Load an Operation:
1. On the Operations toolbar, click the Load Operation icon.

2. The Load Operation window appears.

3. Select the Operation that you want to load from the list.
4. Click OK.
The operation is added to the procedure beneath the location of the cursor.
You can also add an operation by clicking the Operations Library icon and then dragging the tar-
get operation into the recipe procedure.

Operation Validity
When you attempt to load an operation into a recipe procedure, the following checks are per-
formed to ensure the validity of the operation.

268
8. Recipe Editor B0193YB – Rev C

♦ The process class assigned to the operation must exist in the Equipment Requirements
Editor. If the class does not exist, an error message is displayed and the load fails.
♦ If the process class exists, the process instance is automatically added to the recipe
equipment requirements. A message must be acknowledged for each instance.
♦ Materials included in the operation definition can optionally be added to the recipe
formula. A message must be acknowledged for each material.

NOTE
Remember that adding operations from the library may result in the addition of
process and transfer instances to the recipe equipment requirements. You must
ensure sure that the recipe equipment requirements have only the required instances
defined. When the recipe is scheduled as a batch, the train must have equipment for
each instance regardless of whether the instance is called in the procedure. If not,
the batch cannot be initialized

Recipe Procedure Mechanics

Inserting Procedure Objects
The Unit Procedures, Operations and Phases panes of the Recipe Editor window utilize a cursor
which is displayed as a grey rectangle. Whenever you add an object, it is always inserted below the
cursor. When you insert an object always position the cursor immediately above the location of
where the object is to be inserted. The only exception to this occurs when a branch is expanded
beyond the default size. In this case, the insertion of the additional branches is made to the right
of the last leg of the branch.

To Insert a Unit Procedure:

1. On the Unit Procedure toolbar, click the Add Unit Procedure icon.

2. The Add Unit Procedure window appears.

269
B0193YB – Rev C 8. Recipe Editor

The Process Instances in the list correspond to the process class selections and
instance definitions that you defined using the Equipment Requirements Editor.
For more information on equipment requirements, see “Equipment Requirements
Editor” earlier in this section.
3. Select a Process Instance from the list.
4. Enter a Name (16-char max).
5. Click OK to insert the operation object into to the sequence of operations.

To Insert an Operation:
1. On the Operations toolbar, click the Add Operation icon.

2. The Add Operation window appears.

3. Enter a Name (16-char max).

4. Click OK to insert the operation object into to the sequence of operations.

To Insert a Phase:
1. On the main toolbar, click the Add Phase icon.

2. The Add Phases window appears.

All the phases for the selected type are listed.

270
8. Recipe Editor B0193YB – Rev C

3. Click the Type drop-down arrow and select a phase type from the list. The Phase
Type corresponds to the process class instance selection made for the corresponding
unit procedure. There are six types of phases available which are described in the fol-
lowing table.

Table 8-8. Phase Types

Phase Type Description

Process This option displays the process phases defined in the Process Modeling Editor
for the process instance that was assigned to the operation currently being
defined.
Transfer This option displays the transfer phases from the Process Modeling Editor in
which the assigned process instance for this operation is either a source instance
or a destination instance.
Allocate Process This option displays and allows the user to Recipe Allocate any process instance
defined in the recipe Equipment Requirements Editor.
Release Process This option displays and allows the user to Recipe Release any process instance
defined in the recipe Equipment Requirements Editor.
Allocate Transfer This option displays and allows the user to Recipe Allocate any transfer instance
defined in the recipe Equipment Requirements Editor.
Release Transfer This option displays and allows the user to Recipe Release any transfer instance
defined in the recipe Equipment Requirements Editor.

4. Click OK to add the phase object.

Transition Objects
Use the Add Unit Procedure Transition, Add Operation Transition and Add Phase Transition
icons to insert a transition object into the respective procedure sequence beneath the current loca-
tion of the cursor.

Transition objects control the execution of a procedure. Transition logic consists of an expression
that is evaluated by the batch management system when the object is encountered. The result of
an expression is Boolean. If the result is FALSE, then execution stops at the transition. If the result
is TRUE, then the operations or phases following the transition are executed. There is no limit on
the number or transition objects in a procedure.

To Insert a Transition Object:

1. In the Recipe Editor window click the operation or phase to which you want to add a
transition.
2. Click the Add Unit Procedure Transition, Add Operation Transition or Add Phase
Transition icon for the unit procedure, operation or phase that you selected earlier.

The transition is added to the procedure.

3. Double-click the transition object.

271
B0193YB – Rev C 8. Recipe Editor

The Transition Properties window appears.

You can also insert an operation by double-clicking the operation or phase object, and
then clicking the Add Unit Procedure Transition, Add Operation Transition or Add
Phase Transition icon. This inserts the transition object and then immediately opens
the Transition Properties window.

4. On the Transition tab, enter a Label (8-char max), Name (16-char max) and optional
Description (120-char max).
When a transition is added, it is automatically assigned a unique Label (numeric
value). The Name is initially the same as the Label. You can edit these as required. The
Label however, must be unique. If it is not, a warning message is displayed.
5. On the Expression tab, click the Expression button.
6. The Expression Editor window appears.

272
8. Recipe Editor B0193YB – Rev C

Use the Expression Editor to construct transition expressions. You can build expres-
sions using process and transfer instance tags, mathematical operators, and pre-
defined functions. Several examples of valid expressions are shown in the following
tables.
For more information on building expressions, see Chapter 15 “Expression Editor”.
7. After you have entered the required expression, close the Expression Editor window.
8. On the Transition Properties window, click Close.

Table 8-9. Transition Expression Examples

Expression Result
{TAG A} TRUE if TAG A is greater than 0.
FALSE if TAG A is 0.
Not({TAG A}) TRUE if TAG A is 0.
FALSE if TAG A is greater than 0.
{TAG A}>100 TRUE if TAG A is greater than 100.
FALSE if TAG A is less than 101.
{TAG A}&{TAG B} TRUE if TAG A and TAG B are both greater than 0.
FALSE if TAG A or TAG B is 0.
Ask(“Continue?”) A question is displayed to the operator. The result is TRUE if the
operator answers Yes. The result is FALSE if the operator answers No.
AskDoneBy(“Continue?”) Same as the Ask question except that the question can only be
answered by a user with the proper security clearance.

273
B0193YB – Rev C 8. Recipe Editor

Table 8-9. Transition Expression Examples (Continued)

Expression Result
AskCheckBy(“Continue?”) Same as the Ask question except that the question can only be
answered by a user with the proper security clearance, and the ques-
tion must be verified by another qualified user.
WaitSec(s) Batch execution is delayed the specified amount of seconds.
WaitMin(m) Batch execution is delayed the specified amount of minutes.
WaitHour(h) Batch execution is delayed the specified amount of hours.

NOTE
When entering questions, you are limited to 40 characters. The Expression Editor
allows you to enter more than 40 characters. However, during execution, the entry
is truncated and only the first 40 characters are displayed.

Branch Objects
The Add Unit Procedure Branch, Add Operation Branch and Add Phase Branch icons insert a
branch object into the respective procedure sequence beneath the current location of the cursor.

Branch objects are used to execute multiple operations or phases at the same time, or to make a
choice between running one of several operation or phases. There is no limit to the number of
branch objects that you can use in a procedure.
There are two types of branches: All and One.

To Insert a Branch Object:

1. In the Recipe Editor window, click the Unit Procedure, Operation or Phase to which
you want to add a branch.
2. Click the Add Unit Procedure Branch, Add Operation Branch or Add Phase Branch
icon for the unit procedure, operation or phase that you selected above.

The branch is added to the procedure.

3. Double-click the Branch.
The Branch Properties window appears.
You can also insert a branch by double-clicking an operation or phase object, and then
clicking the Add Unit Procedure Branch, Add Branch Transition or Add Branch
Transition icon. This inserts the branch object and then immediately opens the
Branch Properties window.

274
8. Recipe Editor B0193YB – Rev C

4. In the Branch Size text box, enter the number of branches you want to add (maxi-
mum of 20).
While you are limited to 20 branches, you can nest branches for added flexibility. By
default, the Branch Size is 2.
5. Click the Execute Type drop-down arrow and select All or One.
For more information on branch types, see “Branch Execute Types” on page 275.
6. Click Change and then Close.
7. The branch is inserted into the recipe procedure.

NOTE
Branches cannot be added around an existing unit procedure, operation or phase.
However, you can add a branch object and then drag-and-drop objects into a
branch object.

Branch Execute Types

Use the “Execute Type: All” branch object when simultaneous execution of operations or phases is
required. The batch management system evaluates the branch beginning with the left-most leg. If
the transition logic is TRUE, or if there is no transition logic, operations or phases in the leg are
executed. Any transitions that are not on the first iteration, are continuously evaluated until their
state becomes TRUE and all legs are executed. The batch management system does not continue
beyond the Branch Return object until all the legs have been executed.
The Execute All Branch object is graphically displayed as two parallel horizontal lines.

275
B0193YB – Rev C 8. Recipe Editor

NOTE
Batch Manager does not continue past the Branch Return object until all transition
logic and operations or phases in all the legs are executed. Therefore, when con-
structing procedures you must ensure that all legs associated with the “Execute
Type: All” branch can be executed.

Use the “Execute Type: One” branch object when the execution of a single leg of a branch is
required. The batch management system evaluates the branch beginning with the left-most leg. If
the transition logic is TRUE, or there is no transition logic, operations or phases in the branch are
executed. All other branches are ignored. If all legs of a branch have transition logic that is FALSE,
the batch management system continues the evaluation of each transition until one of the legs
changes to a state of TRUE.
The Execute One Branch Object is graphically displayed as a single horizontal line.

Execute Type:All

Branch Return
Object

Execute Type: One

Branch Return
Object

Figure 8-8. Branch Execute Types

Loop Objects
The Add Unit Procedure Branch, Add Operation Loop and Add Phase Loop icons insert a loop
object into the respective procedure sequence beneath the current location of the cursor.

276
8. Recipe Editor B0193YB – Rev C

Loop objects are used to re-execute unit procedures, operations or phases that are built inside of
the object. Any procedure object, including other loops, can be placed inside a loop structure
Objects are inserted within the loop by positioning the cursor on the top portion of the object
and following the normal insertion directions described earlier. The bottom portion of the loop
object contains a transition object that must be defined with the Expression Editor. The result of
the evaluation of the expression determines whether the objects contained within the loop are re-
executed or not. If the expression is TRUE, loop execution returns to the top of the loop. If the
expression is FALSE, then execution proceeds below the loop.

To Insert a Loop Object:

1. In the Recipe Editor window, click the unit procedure, operation or phase to which
you want to add a branch.
2. Click the Add Unit Procedure Loop, Add Operation Loop or Add Phase Loop icon
for the operation or phase that you selected above.

The loop is added to the procedure.

3. Double-click the lower portion (transition) of the loop object.
4. The Transition Properties window appears.
For more information on using the Transition Properties window, see “Transition
Objects” on page 271.
5. Define the transition using a unique Label (8-char max), Name (16-char max), an
optional description (120-char max), and an Expression.
By default, all new loop objects are assigned an automatically defined Label (numeric
value). Also, a default name is defined which is the same as the label. You can edit
these as required.
For more information on building expressions, see Chapter 15 “Expression Editor”.

NOTE
You cannot add a loop around an existing operation or phase. However, you can
drag-and-drop existing objects into a loop object.

Cutting and Copying Procedure Objects

Use the Cut Unit Procedure Object, Cut Operation Object and Cut Phase Object icons to cut
objects from the respective procedure sequence. Cutting a unit procedure, operation, or phase
object is done by simply selecting the object and then clicking the cut icon. When you cut or copy
a branch, ensure that you properly select the appropriate leg. When you cut or copy a loop, ensure
that you properly select the transition object or exit point of the loop. Otherwise you may not
achieve the intended result.

To Cut or Copy a Procedure Object:

1. Click the procedure object that you want to cut or copy.
2. Click the Cut or Copy icon.

277
B0193YB – Rev C 8. Recipe Editor

To Cut or Copy a Loop including its Procedure Object:

1. Click the transition object (lower portion) of the loop that you want to cut or copy.
2. Click the Cut or Copy icon.
The loop itself, including all transition logic, and any other objects within the loop are
included.

To Cut or Copy a Loop without its Procedure Object:

1. Click the entry point of the loop (denoted by arrowhead) that you want to cut or
copy.
2. Click the Cut or Copy icon.
Only the loop (including the transition object and any associated transition logic) is
copied. If you performed a Cut, the object that was previously associated with the loop
remains in the procedure, but no longer has transition logic associated with it.

To Cut or Copy a Branch:

1. Click the top of the leg of the branch that you want to cut or copy.
2. Click the Cut or Copy icon.
All procedure objects, loops, transition logic and other branches that are in the
selected leg are included.

Pasting Procedure Objects

Use the Paste Unit Procedure Object, Paste Operation Object and Paste Phase Object icons to
paste objects into the respective procedure sequence. Pasting objects into a unit procedure, opera-
tion, or phase object is done by simply selecting the insertion point within the procedure and then
clicking the paste icon. When you paste objects into a branch, ensure that you properly select the
appropriate leg. When you paste objects into a loop, ensure that you select the appropriate entry
or exit point of the loop before you paste. Otherwise, you may not achieve the result that you
expect.

To Paste a Procedure Object:

1. Click the point in the procedure where you want to insert the object.
2. Click the Paste icon.

To Paste Objects into a Loop:

1. Click the entry point (top) of the loop into which you want to paste.
2. Click the Paste icon.

To Paste Objects after a Loop:

1. Click the transition object (bottom) of the loop into which you want to paste.
2. Click the Paste icon.

To Paste Objects into a Branch:

1. Click the leg of the branch or existing object within the branch in which you want to
paste.
2. Click the Paste icon.

278
8. Recipe Editor B0193YB – Rev C

To Paste Objects after a Branch:

1. Click the exit point of the branch.
2. Click the Paste icon.

Deleting Procedure Objects

Use the Delete Unit Procedure Object, Delete Operation Object and Delete Phase Object icons
to remove objects from the respective procedure sequence. Deleting a unit procedure, operation,
phase, branch, loop, or transition object is done by selecting the object and then clicking the
delete icon. The Undo icon can be used to undo the most recent deletion.

Use the examples provided to understand the effects of deleting objects.

NOTE
Use the Undo icon to undo the most recent deletion. Only one level of undo is
provided.

To Delete a Unit Procedure, Operation, Phase, or Transition Object:

1. Click the object that you want to delete.
2. Click the Delete icon.

This example shows the deletion of the Heat Phase.

279
B0193YB – Rev C 8. Recipe Editor

Figure 8-9. Deleting a Heat Phase

280
8. Recipe Editor B0193YB – Rev C

To Delete a Branch Leg:

1. Click the top of the branch object that you want to delete.
2. Click the Delete icon.

This example shows the deletion of ManAdd Phase.

281
B0193YB – Rev C 8. Recipe Editor

Figure 8-10. Deleting the ManAdd Phase

282
8. Recipe Editor B0193YB – Rev C

To Delete the Entire Branch:

1. Click the bottom of the branch object that you want to delete.
2. Click the Delete icon.

This example shows the deletion of an entire branch that includes one BulkAdd and
two ManAdd Phases.

Figure 8-11. Deleting an Entire Branch

283
B0193YB – Rev C 8. Recipe Editor

To Delete a Loop:
1. Position the cursor on the loop return object of the loop that is to be deleted.
2. Click the Delete icon.

This example shows the deletion of a loop which includes a Heat phase, an Agitate
phase, and two phase transitions.

Figure 8-12. Deleting a Loop

284
8. Recipe Editor B0193YB – Rev C

Moving and Nesting Procedure Objects

Unit procedure, operation, phase, and transition objects can be dragged and dropped into the
procedure. This enables recipe procedure changes to be made quickly and easily. For example, if
you forget to add a branch, simply add a new branch and then drag any existing unit procedures,
operations or phases into the appropriate legs. The Recipe Editor also allows you to nest branch
and loop objects to create very complex procedures.

Unit Procedure Properties

Use the Unit Procedure Properties window to edit the properties of any unit procedure object.

To Edit Unit Procedure Properties:

1. Double-click on the unit procedure object.
2. The Unit Procedure Properties window appears.

To Change a Unit Procedure Name:

The Unit Procedure Name can be changed by typing the new name in the text box and then click-
ing the Change button.

To Save a Unit Procedure in the Unit Procedure Library:

1. On the Unit Procedure Properties window, click the Save Unit Procedure button.
2. The Save Unit Procedure window displays.

285
B0193YB – Rev C 8. Recipe Editor

3. Enter an Operation Name (16-char max) and an optional Comments (unlimited

length).
For more information on the use of the operation library, see “Unit Procedure
Library” earlier in this section.

Operation Properties
Use the Operation Properties window to edit the properties of any operation object.

To Edit Operation Properties:

1. Double-click on the operation object.
2. The Operation Properties window appears.

To Change an Operation Name:

♦ The Operation Name can be changed by typing the new name in the text box and
then clicking the Change button.

286
8. Recipe Editor B0193YB – Rev C

To Save an Operation in the Operations Library:

1. On the Operation Properties window, click the Save Operation button.
2. The Save Operation window displays.

3. Enter an Operation Name (16-char max) and an optional Comments (unlimited

length).
For more information on the use of the operation library, see “Operation Library”
earlier in this section.

Phase Properties
Use the Phase Properties window to edit specific elements of the phase including its Phase defini-
tion, Instructions, Parameters and Document properties.

To Open the Phase Properties Window:

1. In the Recipe Editor’s phase display, double-click the phase that you want to edit.
2. The Phase Properties window appears.

287
B0193YB – Rev C 8. Recipe Editor

The Phase Properties window initially displays the Phase tab.

Phase Tab
Use the Phase Tab to configure how the phase interacts with the batch system and operators.

To Edit Phase Configuration:

1. On the Phase Properties window, click the Phase tab.
2. The Phase tab appears.

288
8. Recipe Editor B0193YB – Rev C

3. In the Label field, enter a unique name.

By default, the Label is automatically assigned (as a unique numeric value) when the
phase is created.
4. If you want a report to be generated at the end of the phase, click the Report button,
and select a report.
You can only select one report.
For more information on reports, see Chapter 12 “Reporting System”.
5. In the On Entry pane, enable the Acknowledge, Done By and Check By checkboxes as
required.
Acknowledge – Enable this checkbox if you want to require an operator to press the
acknowledge button.
For more information on the Batch Display, see Chapter 10 “Batch Management
System”.
Done By - Enable this checkbox if you want to require an operator, or person with a
comparable security level, to verify the start of the phase. During recipe execution, the
option requires the operator to press the Acknowledge button on the Batch Display
and then enter a security identification number and password before the phase is
started. Enabling Done By automatically enables the Acknowledge checkbox. Config-
uration of the appropriate Done By security levels is performed in the Security Editor.
Check By - Enable this checkbox if you want to require an operator and the supervi-
sor, or person with a comparable security level, to verify and confirm the start of the
phase. During recipe execution, the option requires the operator to press the
Acknowledge button on the Batch Display and then enter a security identification
number and password, and the security identification and password of a supervisor,

289
B0193YB – Rev C 8. Recipe Editor

before the phase is started. Enabling Done By automatically enables the Acknowledge
checkbox. Configuration of the appropriate Check By security levels is performed in
the Security Editor.
For more information on the configuring security, see Chapter 14 “Security System”.
6. In the On Exit pane, enable the Acknowledge, Done By and Check By checkboxes is
required.
Acknowledge - Enable this checkbox if you want to require an operator to press the
acknowledge button prior to the end of a phase. The Acknowledge command button
is part of the Batch Display.
For more information on the Batch Display, see Chapter 10 “Batch Management
System”.
Done By - Enable this checkbox if you want to require an operator, or person with a
comparable security level, to verify the end of the phase. During recipe execution, the
option requires the operator to press the Acknowledge button on the Batch Display
and then enter a security identification number and password before the phase can
end. Enabling Done By automatically enables the Acknowledge checkbox. Configura-
tion of the appropriate Done By security levels is performed in the Security Editor.
Check By - Enable this checkbox if you want to require an operator and the supervi-
sor, or person with a comparable security level, to verify and confirm the end of the
phase. During recipe execution, the option requires the operator to press the
Acknowledge button on the Batch Display and then enter a security identification
number and password, and the security identification and password of a supervisor,
before the phase ends. Enabling Done By automatically enables the Acknowledge
checkbox. Configuration of the appropriate Check By security levels is performed in
the Security Editor.
For more information on the configuring security, see Chapter 14 “Security System”.
7. In the Comment pane, enable the Required checkbox if you want to require the entry
of operator comments during phase execution.
This causes the Edit Comment button to be displayed on the Batch Display and
pauses recipe execution until the entry is completed.
For more information on the Batch Display, see Chapter 10 “Batch Management
System”.
8. In the Execution pane, enable the Continue Mode checkbox if you want the batch
management system to allow recipe execution to continue when a Run status is
received from the phase.
If Continue Mode is disabled, recipe execution does not continue until a Done status
is received from the phase.
For more information on the batch management, see Chapter 10 “Batch Manage-
ment System”.
9. Click Change and then Close.

Instructions Tab
Use the Instructions tab to enter specific work instructions that display to an operator as part of
phase execution.

290
8. Recipe Editor B0193YB – Rev C

To Edit Phase Instructions:

1. On the Phase Properties window, click the Instructions tab.
2. The Instructions tab appears.

3. Enter Instructions as required.

The instructions that you enter display to an operator when the phase is executed.
4. Enable the Append Unit/Connection Description checkbox if you want to append the
description of the unit or connection (as found in the process model) to the instruc-
tion display when the phase is executed. This feature is important when there are may
manual type connections in that it allows you to define all the instructions in the
model instead of having to enter the instruction into the procedure for each recipe.
5. Click Change and then Close.

Parameters Tab
Use the Parameters tab to display and define specific formula parameter values. These parameters
were initially defined using the Process Modeling Editor.
There are three types of formula parameters: Input, Output, and Process Variable. Process
Variable parameters require the assignment of a value if the default value is not acceptable. In
addition, if the phase is used more than once in the procedure, the parameter name may be
changed in order to associate each parameter with its respective phase. Input and Output
parameters require a material assignment.

To Edit Phase Parameters:

1. On the Phase Properties window, click the Parameters tab.
2. The Parameters tab appears.
The specific Parameter tab display varies according to the type (Input, Output or
Process Variable) of phase that you are editing. Use the Sort By Name checkbox to
sort the parameter list. An example of each type is provided in the following sections.

291
B0193YB – Rev C 8. Recipe Editor

Input Phase Parameters

Figure 8-13. Input Phase Parameters

For more information on input parameters, see “Edit/Formula Inputs” earlier in this section.

292
8. Recipe Editor B0193YB – Rev C

Output Phase Parameters

Figure 8-14. Output Phase Parameters

For more information on output parameters, see “Edit/Formula Outputs” earlier in this section.

293
B0193YB – Rev C 8. Recipe Editor

Process Variable Parameters

Figure 8-15. Process Variable Parameters

For more information on process variable parameters, see “Edit/Process Variables” earlier in this
section.

Document Tab
Use the Document tab to assign the file name of a document or program that you want operators
to view and optionally acknowledge as part of a phase’s execution. Acknowledgment can be speci-
fied to occur at the start of the phase (On Entry) or as the last step (On Exit) of the phase. When
the phase executes, Windows launches a program based on the file extension. For example, if the
extension is “.html,” Windows could launch a browser.

NOTE
The program that is launched is based on Windows settings.

For more information on associating file extensions with programs see your Windows user
references.
An example of how you might implement the Document Viewing feature could be based on a
requirement that operators must view material safety data and then acknowledge the action. Fur-
thermore, you might have the material safety data stored in an HTML document on a network at
the address http://Material_Safety.html.

294
8. Recipe Editor B0193YB – Rev C

NOTE
If you are using batch clients in your system, and intend to execute a recipe that uses
the Document Viewing feature, make certain that each client is properly configured
to access the document. One way to ensure this is to place all your document files in
a folder that is shared for your client systems.

Actual document viewing and acknowledgment is a function of the View Doc and View Doc Ack
buttons on Batch Display.
For more information on the Batch Display, see Chapter 10 “Batch Management System”.
On Entry - Enable this radio button if you want to require an operator and/or supervisor, or per-
son with a comparable security level, to verify and confirm viewing of the document as the first
step of the phase. During recipe execution, the option requires the operator to press the View Doc
and View Doc Ack buttons on the Batch Display. You can configure the buttons to require the
entry of security identification numbers and passwords as the first step of the phase. Configura-
tion of the appropriate Done By and Check By security levels is performed in the Security Editor.
Prior To Edit - Enable this radio button if you want to require an operator and/or supervisor, or
person with a comparable security level, to verify and confirm viewing of the document as the last
step of the phase. During recipe execution, the option requires the operator to press the View Doc
and View Doc Ack button on the Batch Display. You can configure the buttons to require the
entry of security identification numbers and passwords as the first step of the phase. Configura-
tion of the appropriate Done By and Check By security levels is performed in the Security Editor.
For more information on the configuring security, see Chapter 14 “Security System”.

Viewing Documents on Clients

If you are using batch clients in your system, and intend to execute a recipe that uses the Docu-
ment Viewing feature, make certain that each client is properly configured to the document. One
way to ensure this is to place all your document files in a folder that is shared for each of your
client systems.

Building Recipes in a Connectionless Process Model

Constructing recipes from a connectionless process model requires more attention to details on
the part of the recipe builder when defining the sequence of operations and phases. Connection-
less transfers require complementary process phases co-ordinated in the recipe and by the operator
or the control system to move material from one unit to another. Parallel operations must be
constructed in the procedure with the source and destination instances assigned to the appropri-
ate operation. Within each operation, the appropriate discharge or charge phase must be defined.
If multiple units are available for the source instance, manual unit selection must be defined in the
recipe equipment requirements and the recipe allocate process instance phase must be included in
the phase procedure in order to have the operator manually select the appropriate source unit for
the transfer.
If material tracking is required, any input material being transferred must be assigned to a param-
eter of the source process phase and any output material being transferred must be assigned to a
parameter of the destination process class phase. The following example shows a material transfer
operation and phase procedure from a bulk tank to a reactor. The Discharge BulkTks phase has
an input parameter defined for the phase that is not shown in the diagram. This parameter is used

295
B0193YB – Rev C 8. Recipe Editor

to track the amount of material transferred from the manually allocated bulk tank to the automat-
ically allocated reactor.

Figure 8-16. Material Transfer Operation and Phase Procedure

Recipe Procedure Summary

You construct recipe procedures by combining unit procedures, operations and phases. Addition-
ally, the examples shown here show some of the configuration options described earlier. The fol-
lowing summary shows the fundamental associations between the various editors and how you
might use them as you create a recipe. These diagrams serve as road maps, which you can refer-
ence as you construct recipe procedures.

296
8. Recipe Editor B0193YB – Rev C

Figure 8-17. Operation and Phases

297
B0193YB – Rev C 8. Recipe Editor

Figure 8-18. Operation Library

298
8. Recipe Editor B0193YB – Rev C

Figure 8-19. Branch and Transition Objects

299
B0193YB – Rev C 8. Recipe Editor

Figure 8-20. Phase Properties

300
9. Train Editor
This chapter explains how to use Train Editor to create and edit lines of production that will be
used when you schedule batches.
Use the Train Editor to create lines of production that are assigned to scheduled batches. The
batch management system is responsible for scheduling and executing batches. Batches include a
recipe and a train assignment. A recipe is typically equipment independent. The train provides a
list of potential equipment to the batch engine for dynamic selection during batch execution. If a
unit is not in the assigned train, then it is not available to be used for the scheduled batch.
A train can contain one or more units, and a unit can be a part of multiple trains. Trains provide a
way to represent various paths through the process.
The train data is maintained in the process model database. The Train Editor writes to both the
configuration process model database and the run-time process model database. Trains can be
added at any time during batch system execution.

Figure 9-1. Train Editor

Using Train Editor

Use Train Editor to create the trains that are available to the batch scheduling system. A train con-
sists of one or more units. The batch system does not impose a limit on the number of trains that
you can create, or the number of units that you can assign to a train. Also, a unit can belong to
more than one train. A train consists of a Name (16-char max) and an optional Description
(1201-hchar max). The editor verifies all new train names to ensure uniqueness. You can also
assign Attributes to further define a train. Attributes consist of a Name (16-char max), a Value
(16-char max) and a predefined Unit of Measure. Attributes are used by the Foxboro Intelligent
Scheduler for train scheduling.

301
B0193YB – Rev C 9. Train Editor

To Start Train Editor:

1. In the Environment Display, double-click the TrainEdit icon.

2. The Train Editor window appears.

NOTE
Only one instance of the Train Editor can be running. You cannot start Train Editor
if the Process Modeling Editor or Tag Linker application is running.

302
9. Train Editor B0193YB – Rev C

File Menu
Use the File menu to access system functions for Train Editor.

File/Print
Use this command to display the Print window to appear. The Print window contains a Select
Reports list box with several pre-formatted reports. It also allows you to output to a printer or a
file, as well as select number of copies that you want to print.

File/Print Preview
Use this command to display the Select Reports window.

303
B0193YB – Rev C 9. Train Editor

Select the report(s) that you want in the list. If you want to preview several reports, press and hold
the Control (or shift) key while selecting.

File/Print Setup
Use this command to display the Print Setup window. Refer to your Windows documentation for
more information.

File/Exit
This command is used to close the Train Editor.

NOTE
All your work is saved in the configuration process model database and the run-time
process model database as you edit and make changes to the trains. Therefore, you
do not need to be concerned with saving your work.

Help Menu
The Train Editor Help menu contains the commands that are used to access the main Help
screen, and information about the version and licensing of the application.

Help/Help Topics
Use this command to display online Help for Train Editor.

Help/About Train Editor

Use this command view version information.

Assigning Units to Trains

A train can be created at any time during the execution of the batch system. The following steps
are necessary to create trains.

304
9. Train Editor B0193YB – Rev C

To Create a Train or Add Units to a Train:

1. In the Train Editor window, define a train Name (16-char max) and an optional
Description (120-char max).
2. Click Add.
The train is added to the Trains list.
3. Click Assign Units.
The Assign Units to Train window appears.

4. Select the appropriate units from the list and then click OK or Apply to add the units
to the train.

To Delete Units from a Train:

Click Assign Units and then deselect the unit(s) that you want to remove.

Assigning Attributes to Trains

You can assign attributes to a train to facilitate the scheduling of trains using the Foxboro
Intelligent Scheduler.

To Add Train Attributes:

1. In the Train Editor window, select the Train to which you want to assign Attributes.
2. In the Attributes pane, click Add.
The Add Attribute window appears.
3. Select or enter an attribute Name (16-char max).
4. Enter a Value (16-char max)
5. Select a Unit of Measure (optional) from the drop down list.
Each Unit of Measure in the list is assigned using the Process Modeling Editor.
6. Click Add.
The train attribute is added to the Trains list.

305
B0193YB – Rev C 9. Train Editor

306
10. Batch Management System
The Batch Management system consists of scheduling, initializing, co-ordinating the execution
of batches with the control system, interfacing with operators, and directing batch activity to
the historical database. The functions that are provided by the Batch Management system are
available through the Batch Scheduler, Batch View, Batch Display and Batch Manager
applications. By applying these applications, you achieve a flexible, reliable, and intuitive
solution to managing all your batch processes.
Scheduling: Batch Scheduler prepares the batches to be executed. Scheduling involves the manual
entry of the batch identification, master recipe identification, quantity to be produced, and train
identification into the schedule window. Once entered, the batch can be initialized.
Initialization: Each batch must be initialized before it can be executed. The initialization process
involves validation of the recipe, verifying that the train exists, the bulk materials defined in the
recipe are found in the Materials database, the recipe equipment requirements are satisfied by the
Train, and the Process model database is compatible with the recipe. Initialization is performed
using Batch Scheduler.
Batch and Unit Management: Batch Manager directs and supervises the execution of each batch.
Batch Manager is a recipe interpreter and control system enabler. Based on the recipe procedure,
blocks of control software, referred to as phases, are signaled to execute by Batch Manager. Auto-
matic and semi-automatic phases are programmed logic blocks existing in the control system.
They are responsible for controlling functions associated with a unit or a connection. Prior to
enabling each phase, Batch Manager verifies that the phase is ready to be executed. If it is, phase
parameter values are downloaded to the phase, and the phase is started.
Batch Manager also interfaces with the Batch Display application. Batch Display provides opera-
tors with information on all batches running in the system. Using this display, operators can put a
batch or phase in hold, restart and abort batches or phases, and change the batch execution mode.
Batch Manager also has a Jump mode that allows the execution point of an active batch that is in
hold to be changed. Operators can use this feature to either jump ahead during recipe execution
or repeat phases that have already executed. In addition, operators can change phase parameter
values, acknowledge the execution of phases, review phase interlock status, and enter comments.
All these can be done while a batch is executing.
Batch Manager co-ordinates the usage of process units for each batch. Each batch is a separate
entity and contends along with other batches to own the process unit(s) it needs. Batch Manager
assigns (Allocates) ownership of units to batches as units become available and releases (Releases)
units when no longer required by the batch.
Flexible batch control systems must be designed with the supervisory workstation being an active
participant in the execution of a batch. The reason for this is that unit management is very sophis-
ticated in a flexible batch system. Most control systems do not have the ability to program a unit
manager capable of interpreting and executing complex recipe procedures.
A Master Recipe uses classes of process units, not specific units. This means phases pertain to a
class of units, not a specific unit. When Batch Manager executes a Master Recipe, each phase
encountered is converted into a unit or connection specific phase. This process is called Master
Recipe to Partial Control Recipe conversion. The Train assigned to produce the batch contains all
the units that can be used. Batch Manager automatically converts the Master Recipe to a Control

307
B0193YB – Rev C 10. Batch Management System

Recipe based on the units in the Train and whether or not they are available.
Once a batch is done, the operator has the option of saving the As-Built recipe to the recipe data-
base. All final formula targets, and optionally all the specific equipment used for the recipe, can be
saved. These capabilities allow the recipe, which may have produced a high quality batch, to be re-
executed at a later date.
History: Batch Manager captures all batch execution events and operator activity during the exe-
cution of a batch and sends this information to the historical database.
For more information on the data that is stored and the format in which it is stored, see
Chapter 11 “History System”.
Only one instance of Batch Manager can be active in your batch management system. There are
no restrictions on the number of Batch Runtime Clients that you can have in a system. Batch
Manager interfaces with several databases as well as with the clients. The interaction is described
below.
♦ Master Recipes are retrieved from the Recipe Database (RecipeDB) when a batch is
started.
♦ The Process model Database is used to transform the Master Recipe to a Control
Recipe.
♦ The Materials Database is used to retrieve the location and Tracking IDs of materials
that are stored in units. The Materials Database is updated by Batch Manager when
materials are used and when materials are produced.
♦ All batch execution events and operator activity are logged to the Historical Database.
♦ Batch Scheduler manipulates the Batch Database through Batch Manager. Several
Batch Schedulers can be running in a system, but there is only one Schedule database.
♦ Batch Runtime Clients and Batch Display provide a window into Batch Manager.
From these, operators can select a batch, start a batch, put a batch in hold, restart a
batch, and abort a batch. All information needed to monitor and interact with the
process during the execution of a batch is provided.
♦ Batch Manager interacts with Phase Logic (Phases) located in the control system. As
each phase is to be executed, Batch Manager checks if the phase is ready. If the phase
status is ready, any configured phase parameter values are written to the phase, then
the phase is started. When the phase completes its task, it informs Batch Manager by
setting the Done status. Batch Manager responds by enabling the Reset command and
returning the phase to Ready.

308
10. Batch Management System B0193YB – Rev C

Batch Management

Batch
Client

Batch Scheduler

Recipe
Editor Batch View
Recipe
Database Batch
Manager Batch Display
Materials
Editor Batch
Material Database
Database

Process Modeling Historical

Database
Editor
Process Model
Batch Database

Contr ol
Control System
PhaseLogic

Figure 10-1. Batch Management

Using Batch Scheduler

Use Batch Scheduler to manually schedule and dispatch batches to be executed by Batch Man-
ager. Batch Scheduler is not designed to optimize a schedule. The batch database can be accessed
by external scheduling applications such as those that utilize the Batch ActiveX controls.
Batch Scheduler is designed to work as an integral part of FoxView software. From FoxView,
Batch Scheduler is started using properties to either change the mode of Batch Scheduler or to
reconfigure its settings.
Batch Scheduler supports two modes of operation: configuration and run-time. When Batch
Scheduler is in configuration mode, its location on the display, size, the desired run-time toolbar
buttons and their location, filter, and several other parameters are configured using the Properties
dialog box.

NOTE
Batch Manager must be running prior to the start of Batch Scheduler.

Starting Batch Scheduler

Batch Scheduler is started either from the Batch Server Environment Display or started as an exe-
cutable from FoxView. The run-time operation is the same regardless of where Batch Scheduler is
started.

309
B0193YB – Rev C 10. Batch Management System

Configuration of Batch Scheduler and invoking the configurations is only possible from
FoxView. The following describes Batch Scheduler standard run-time operation followed by how
Batch Scheduler is configured.

Batch Scheduler Operation

Use this window to schedule, initialize and monitor batches. Use the menu or the toolbar to
access system functions and options for Batch Scheduler.

Figure 10-2. Batch Scheduler Window

File Menu
Use this menu to access system functions for Batch Scheduler.

File/Print
Use this command to display the Print window which allows you to set up your print device,
assign one or more reports, and then print to the selected device.

310
10. Batch Management System B0193YB – Rev C

Figure 10-3. Print Screen Window

File/Print Preview
Using this command to select one or more reports and then preview the report(s) on the screen
causes the Select Reports window box to appear.

Figure 10-4. Select Reports Window

File/Print Setup
Use this command to set up your print. Refer to your Windows documentation for more
information.

File/Exit
Use this command to close Batch Scheduler.

311
B0193YB – Rev C 10. Batch Management System

NOTE
If you have a Batch Alert button enabled, the File/Exit menu is disabled. In this
case, the only way that Batch View can be closed is to issue a FoxView command
using the -q property.

Edit Menu
Use this menu to access commands that you can use to modify the schedule list in Batch Sched-
uler. Complementary toolbar buttons also provide the same capability as the menu item. The
toolbar button icons are shown below.

Delete Batch
Use this command to remove the selected batch from the schedule. Only batches with a status of
Open, Ready, Done, or Aborted can be deleted. A message box is displayed requiring confirma-
tion of the deletion.

Edit/Cleanup
Use this command to remove all the batches from the schedule list that have a status of Done or
Aborted. It is recommended that you use this command on a regular basis, to minimize the size of
the Batch Scheduler list.

Move Up
Use the Move Up command to move the selected batch one row toward the top of the schedule
list. This option is typically used in conjunction with the Execute in Order option to sequence the
scheduled batches for production.

NOTE
If you sorted the Batch Schedule list using the Filter option, batches are executed in
the order defined by your sort preferences. In this case, Move Up option is not avail-
able.

Move Down
The Move Down button moves the selected batch one row toward the bottom of the schedule list.
This option is typically used in conjunction with the Execute in Order option to sequence the
scheduled batches for production.

312
10. Batch Management System B0193YB – Rev C

NOTE
If you sorted the Batch Schedule list using the Filter option, batches are executed in
the order defined by your sort preferences. In this case, the Move Down option is
not available.

View Menu
Use this menu to access the commands that allow you to sort the batch schedule list, display error
messages, and enable or disable Batch Scheduler's status bar.

View/Batch Editor
Use this command to edit existing batches or to add new batches to the schedule list.

View/Undo Sorting
Use this command to undo any sorting that you applied to the Batch Schedule list. By default,
batches are listed in the order in which they were initially scheduled.

View/Filters
Use this command to display the Schedule Filters window.

CLB
Use the CLB tab to sort the list of scheduled batches based on any combination of campaign, lot
and batch.

Figure 10-5. Schedule Filters Window - CLB Tab

313
B0193YB – Rev C 10. Batch Management System

Recipe
Use the Recipe tab to sort the list of scheduled batches based on any combination of Recipe IDs,
Types and States.

Figure 10-6. Schedule Filters Window - Recipe Tab

Train
Use the Train tab to sort the list of scheduled batches based on one or more train assignments.

Figure 10-7. Schedule Filters Window - Train Tab

Mode/Status
Use the Mode/Status tab to sort the list of scheduled batches based on any combination of batch
execution mode and status.

314
10. Batch Management System B0193YB – Rev C

Figure 10-8. Schedule Filters Window - Mode/Status Tab

View/Errors
Use this command to view the Errors window. The Errors window lists all the batch errors that
are associated with the list of scheduled batches.

Figure 10-9. Errors Window with Error Message

View/Toolbar
Use this command to enable or disable Batch Scheduler’s toolbar.

View/Status Bar
Use this command to enable or disable Batch Scheduler’s status bar.

315
B0193YB – Rev C 10. Batch Management System

Initialize Menu
The Batch Scheduler Initialize menu contains the commands that you use to prepare scheduled
batches for execution.

Initialize/Batch
Use this command to initialize the selected batch. The command is not available unless the
selected batch has an Open status.

Initialize/All
Use this command to initialize all the batches in the schedule that have an Open status.
The initialization process performs the following checks to ensure that the batch can be properly
executed.

Recipe Verification
Use this to verify that the recipe assigned to the batch exists. If the recipe does not exist, an error is
displayed. The recipe must be created or another recipe must be assigned to the batch.

Recipe Validation
The recipe assigned to the batch is validated with the process model database and the materials
database. If the recipe is not valid, an error is displayed. The recipe must be changed, or the pro-
cess model database and/or the materials database must be checked and corrected.

Train Verification
This verifies that the train assigned to the batch exists. If the train does not exist, an error is dis-
played. The train must be added using the Train Editor or another train must be assigned to the
batch.

Recipe Equipment Requirements Verification

This verifies that units defined in the recipe equipment requirements are in the assigned train.
This includes having at least one unit in the train for each process instance, as well as having at
least one unit in the train that satisfies the required attribute range. Errors are displayed if either of
these conditions is not satisfied. The train must be altered using the Train Editor or another train
must be assigned to the batch. If the attribute range is not satisfied, the recipe equipment require-
ments must be changed or the value of the unit attribute in the process model must be changed.

Quantity Verification
This verifies that the quantity assigned to the scheduled batch is greater than the recipe minimum
batch size specification, and less than the recipe maximum batch size specification. If the quantity
is less than the minimum batch size, an error is displayed. The quantity assigned to the batch or
the recipe minimum batch size must be changed.
When the batch has been successfully initialized, the status changes from Open to Ready. A
selected batch can be “un-initialized” by clicking on the Change button. The batch status changes
from Ready to Open. This can only be done to batches that are Ready.

316
10. Batch Management System B0193YB – Rev C

! WARNING
Batch Manager verifies that all units required by the recipe are available in the train.
Connections and possible paths through the train are not verified. Thus, if a con-
nection is not available in the train, it is possible to take a path through a train that
results in a dead-end situation.

In this example, the recipe requires a transfer from Process Class A to Process Class C. The recipe
initializes properly on either Train 1 or Train 2, but does not execute properly on Train 2. The rea-
son for this is that although Train 2 has the correct unit, it does not have the connections needed
to execute the recipe.

Process Class A
Unit 1 Unit 4

Process Class B
Unit 2 Unit 5

Process Class C
Unit 3 Unit 6

Train 1 Train 2

Figure 10-10. Unexecutable Recipe

Therefore, it is extremely important, when multiple paths are possible through a train, to deter-
mine if the recipe can execute properly for all possible paths. If not, a change in the train must be
made.

Options Menu
Use the Batch Scheduler Options menu to access commands that you can use to modify the exe-
cution of batches in the schedule list.

Options/Execute in Order
Use this command to enable or disable the Execute in Order mode. When disabled, batches can
be randomly selected and started. When enabled, batches can only be started for each train in the
order in which they are displayed in the schedule.

317
B0193YB – Rev C 10. Batch Management System

NOTE
If you sorted the Batch Schedule list using the Filter option, batches are executed in
the order defined by your sort preferences. In this case, the Execute in Order option
is not available.

Help Menu
The Batch Scheduler Help menu contains the commands that are used to access the main Help
screen, and information about the version and licensing of the application.

Defining a Batch
Use the Batch Editor to define a new batch or to edit an existing batch that has not been started.
The editor has features to save and retrieve default setting, clear all fields, create new batches or
edit a batch in the schedule. The editor itself can be either a floating dialog box, as shown below,
or an integral part of the schedule list. Refer to “Configuring Batch Scheduler” on page 321 for
more information.

Figure 10-11. Batch Editor Window

Batch Identification
A batch is defined by a Campaign ID (16-chars max), Lot ID (16-char max), Batch ID (16-char
max), Recipe, Quantity (8-char max), Train, and Mode of operation. The scheduler verifies all
new batch names to ensure validity and uniqueness.
Each batch is identified by a unique three-part hierarchical name. The highest level is the Cam-
paign ID, followed by the Lot ID, and finally the Batch ID. The Batch ID must be entered man-
ually by an operator. It is not necessary to use all three of the identification fields. The Campaign
field is required. The Lot and Batch fields are optional.

NOTE
If the Batch ID is not defined or if the Batch ID that you enter begins with the
numeric value ‘0’ (zero), alarms and alarm comments for these batches will not be
stored in batch history. If you intend to store alarms and alarm comments, you must
enter a valid Batch ID.

All historical information about a batch is logged to history using the batch identification. If the
batch identification is not unique, duplicates can exist in the historical database. Batch Scheduler
can only verify that the batch identification is unique among the batches currently in the schedule

318
10. Batch Management System B0193YB – Rev C

window. Batch Scheduler does not verify that the identification for a batch is unique throughout
the history database.

Recipe Assignment
The Recipe button displays the Recipes window.

Figure 10-12. Recipes Window

A recipe can be selected by double-clicking a list item. The list contains the recipes in the recipe
database that have been Approved For Production or Approved For Test. You can use the Find
button to search for a specific recipe in the database. The find options allow you to search all the
recipes, or select a recipe based on Recipe ID, Name, State or Type. Use the Filter button to filter
recipes based on their ID, Name, State or Type. After you select a recipe, it appears in the Recipe
field of the Batch Scheduler window.
Recipe filtering is only applied when the Recipes window is open, and you have defined specific
filtering criteria. When you close the Recipes window, any previous filtering criteria is no longer
applicable.

Quantity Assignment
The Quantity field defines the size of the batch to be produced. The quantity must be manually
entered by you. Input and output quantities that have been specified as percentages in the selected
recipe are automatically scaled to the appropriate actual quantities based on the batch size entered.

Train Assignment
The Train button displays the Trains window. A train can be selected by double-clicking on the
desired entry in the list. The selected train name is displayed in the Train field of the Batch Sched-
uler window.

319
B0193YB – Rev C 10. Batch Management System

Figure 10-13. Trains Window

Batch Execution Mode

Use the Mode combo-box to define the mode of batch operation when the batch is started. There
are three modes of execution available for starting batches: Automatic, Semi-Automatic, and
Manual. The mode can be changed at any time during batch execution from the Batch Display
application. More information concerning changing batch modes is presented in a later section.

Table 10-1. Batch Execution Modes

Mode Description
Automatic The recipe procedure is executed exactly as defined in the recipe.
Semi-Automatic Each phase must be acknowledged by the operator before it is executed.
Prior to acknowledging the phase, phase parameter values can be edited.
Manual Any phase in the recipe defined for equipment that is allocated to the
batch can be manually executed.

For more information on dynamically changing the batch mode, see “Batch Execution Modes” on
page 359 in this section.

Status
Each batch in the schedule list has a Status. The status shows the current state of the batch. There
are nine possible statuses as shown here.

Table 10-2. Batch Statuses

Status Description
Open Batch has been added to the schedule list, but has not been initialized.
Ready Batch has been successfully initialized.
Run Batch has been started and is running.
Held Batch has been held.
Done Batch has completed normally.

320
10. Batch Management System B0193YB – Rev C

Table 10-2. Batch Statuses (Continued)

Status Description
Aborting Batch is in the process of being aborted.
Aborted Batch has been aborted.
Locking Batch is in the process of aborting phases and entering Jump Mode.
Locked Batch has been successfully locked and Jump Mode is enabled.

Changing the Batch Schedule List

Use the buttons on the bottom of the Batch Scheduler editor window to alter the list of scheduled
batches.

Add
The Add button places an entry in the schedule list with the defined batch information. The
batch is displayed in the list of scheduled batches with a status of Open. When a batch is added in
which the quantity is greater than the recipe maximum batch size, the Scheduler displays a win-
dow asking the operator to confirm the addition of multiple batches each with the recipe default
value as its quantity assignment. If Yes is selected, the number of batches needed to produce the
entered quantity is automatically generated, and all the batches are added to the list. If No is
selected, no batches are added to the list. If no quantity is specified, the default batch size is used.

Figure 10-14. Batch Scheduler

Change
The Change button is used to record modifications that are made to any of the fields for the
selected batch. Only batches with a status of Open or Ready can have their schedule information
changed. Batches that are Ready and are changed return to an Open status and require re-
initialization.

Configuring Batch Scheduler

Batch Scheduler is put into configuration mode when it is started from FoxView with the config-
uration parameter set. Each Batch Scheduler configuration is identified using a configuration
instance name that is defined when Batch Scheduler is started. There are no limits on the number
of Batch Scheduler configuration instances in a system.
When in configuration mode, the following elements can be configured:
♦ Startup Size
♦ Startup Location

321
B0193YB – Rev C 10. Batch Management System

♦ Location to Toolbar
♦ Add, Delete and Define the Order of Toolbar Buttons
♦ Permanently Dock Toolbar
♦ Set Toolbar Buttons Icons as Large or Small.
♦ Location of Batch Editor
♦ Set Display to Always Be on Top
♦ Batch View Parameters.

Batch Scheduler Parameters

Batch Scheduler is started from FoxView with one or more parameters that set the mode to con-
figuration, define its instance name, set the batch focus or terminate execution. Batch Scheduler
has the following parameters.

Table 10-3. Batch Scheduler Parameters

-Iname Defines the configuration instance name. Valid characters for instance
names are: A-Z, a-z, 0-9 and _ (underscore). Names are case sensitive.
-Ahost Defines the name of the Batch Server node. Not required when Batch
Scheduler is running on the Batch Server.
-c Sets Batch Scheduler to configuration mode.
-q Terminates execution of Batch Scheduler.
-bc/l/b Defines the batch that is automatically selected when Batch Scheduler
is started.

The following example launches Batch Scheduler in configuration mode using instance ABC:
BatchSched –IABC -c
The following example terminates execution of Batch Scheduler instance ABC:
BatchSched –IABC –q
The following example launches Batch Scheduler instance ABC and automatically selects batch
identified as: CAMPAIGN: KAZ1 LOT: LOT1 BATCH: BATCH3
BatchSched –IABC –bKAZ1/LOT1/BATCH3
The following example launches Batch Scheduler in configuration mode using instance XYZ and
points the Batch Scheduler to NODE1, that is, the Batch Server.
BatchSched –ANODE1–IABC -c

Setting Batch Scheduler Properties

When the Batch Scheduler is in configuration mode, that is, started with the -c argument, the
Properties dialog box is displayed using File/Properties pull-down menu. The Properties dialog
box is used to configure some functions of Batch Scheduler.

322
10. Batch Management System B0193YB – Rev C

Figure 10-15. Batch Scheduler Properties

Always on Top
This defines whether or not Batch Scheduler is always displayed to you. Batch Scheduler is not
hidden by other displays when Always on Top is set.

User can change – Schedule Filter

This defines whether or not you can change the filter configuration of the Batch Scheduler when
it is in run-time mode.

Customize Main Toolbar

This window is used to configure which toolbar buttons are available and in what order they are
displayed when the Batch Scheduler is in run-time mode.

323
B0193YB – Rev C 10. Batch Management System

Figure 10-16. Customize Toolbar Window

Permanently Dock Toolbar

When selected, the toolbar cannot be moved from its designated position. When unset, the tool-
bar can be moved and anchored to the left, right, top or bottom of the window or can be left
floating. The display shown below has the toolbar docked to the bottom of the Batch Scheduler.
Once in the desired location, set the Permanently Dock Toolbar radio button to prevent users at
run time from relocating the toolbar. If you want the flexibility to move the toolbar, do not set the
radio button.

Figure 10-17. Batch Scheduler Toolbar with Large Icons

Large Icons
When set, the large icons are displayed in the toolbar. The screen capture shown above has large
toolbar icons.

324
10. Batch Management System B0193YB – Rev C

Batch View Startup Parameters

This field is used to define the parameters used by Batch View when it is started from the Batch
Scheduler. For instance, -IBV1 starts Batch View using instance BV1. See more on “Batch View
Parameters” on page 327 in this chapter.

Starting Batch View from Batch Scheduler

Batch View is started from Batch Scheduler in one of three possible ways: the Batch View toolbar
button, double-clicking the batch in the list, or selecting the Batch View menu. When Batch
View is started, the Batch View Startup Parameters are used to specify the Batch View instance
and any other parameters required. The Batch Scheduler also automatically appends the –b
parameter and the batch identification of the batch based on the batch that is selected from the
schedule list. Batch View is automatically focused on the selected batch. If the selected batch has
an Open status, the Batch View focuses on the batch that was last displayed or the first batch in
the schedule list.

Batch View Toolbar Button

Launch Batch View by selecting a batch from the schedule list and clicking on the Batch View
toolbar button.

Double Click Batch in Schedule List

Start Batch View by double-clicking on a batch in the schedule list.

Batch View Menu Selection

Start Batch View by selecting a batch from the schedule list and then clicking the Batch View
menu.

Save Configuration
When all settings on the Properties dialog box are final, when the toolbar is located in the desired
position, when the Batch Schedule startup display position and size are set and the Batch Editor is
located in the desired position, click the Save button to save all configuration settings.

Set Batch Schedule to Run Mode

When Batch Scheduler is started without the -c parameter, the Batch Scheduler retrieves and uses
the configuration defined by the -I instance name.

Using Batch Schedule with Optimization Software

Batch Scheduler can be used with third-party optimization software. If you use these packages, it
is important that you follow the procedure below. Some optimization packages apply certain rules
to the schedule and optimize it to improve plant performance. If an optimized schedule is modi-
fied even slightly, the performance improvement that you were trying to achieve may be compro-
mised. To prevent modification of the schedule, configure the Batch Scheduler as follows:
1. Start Batch Scheduler in configuration mode, for example, -c switch.
2. Detach the editor from the window and close the editor.

325
B0193YB – Rev C 10. Batch Management System

3. Enable the Execute in Order mode.

4. Display the Properties dialog box by selecting Properties from the File menu.
5. Select the Customize Main Toolbar button from the Properties dialog box.
6. Disable/remove the following capabilities from the toolbar.
♦ Batch Editor
♦ Delete Batch
♦ Move Up
♦ Move Down
♦ Execute in Order.
7. Exit and save the configuration.

Using Batch View

Batch View has the same functionality for interfacing with the Batch Manager as Batch Display.
Refer to “Using Batch Display” on page 336 for more information. This section focuses primarily
on the configuration of Batch View.
Batch View is designed to function as an integral part of FoxView. From FoxView, Batch View is
started using parameters to either change the mode of Batch View or to reconfigure its settings.
Batch View supports two modes of operation: configuration and run-time. When Batch View is
in configuration mode, its location on the display, size, desired run-time toolbar buttons and loca-
tion, filter and several other parameters are configured using the Properties dialog box.

NOTE
Batch Manager must be running prior to the start of Batch View.

Configuring Batch View

Batch View’s configuration mode is enabled when it is started from FoxView with the configura-
tion parameter <-c> set. Each Batch View configuration is identified using a configuration
instance name that is defined when Batch View is started. There are no limits on the number of
Batch View configuration instances in a system.
When in configuration mode, the following can be configured:
♦ Unit Filter
♦ Unit Focus
♦ Startup View
♦ Startup Size
♦ Startup Location
♦ Location to Toolbars
♦ Add, Delete and Define the Order of Toolbar Buttons
♦ Permanently Dock Toolbar
♦ Set Toolbar Buttons Icons as Large or Small.

326
10. Batch Management System B0193YB – Rev C

♦ Location of Batch Editor

♦ Set Display to Always Be on Top.

Batch View Parameters

Batch View has the following parameters.

Table 10-4. Batch View Parameters

Parameter Description
-Iname Defines the configuration instance name. Valid characters for instance
names are: A-Z, a-z, 0-9 and _ (underscore). Names are case sensitive.
-Ahost Defines the name of the Batch Server node. Not required when Batch
View is running on the Batch Server.
-c Sets Batch View to configuration mode.
-m Enables Manual Operation Button
-fUNIT1/UNIT2 Defines/re-defines the unit_filter configuration defined for the
instance. Delimiter between names is a /. The Unit Filter is used to
find the trains and any batches executing in the unit. For example, if
there are two trains, Train A and B. Unit 1A, 2A and 3A are in Train A
and unit 1B, 2B and 3B are in Train B. If the Unit filter is -f2A/2B
then all batches running on Train A and Train B are viewed. If the
Unit Filter is –F2A then all batches running on Train A are viewed.
The Schedule select is used to set focus on the batch when multiple
batches result from the filter.
-uUNITNAME Defines/re-defines the unit focus for the instance.
-q Terminates execution of Batch View.
-bc/l/b Defines the batch that is automatically selected when Batch View is
started.

The following example launches Batch View instance BV1 in configuration mode:
BatchView –IBV1 -c
The following example terminates execution of Batch View instance BV1:
BatchView –IBV1 –q
The following example launches Batch View instance BV1 and automatically selects batch identi-
fied as: CAMPAIGN: KAZ1 LOT: LOT1 BATCH: BATCH3
BatchView –IBV1 –bKAZ1/LOT1/BATCH3
The following example launches Batch View instance BV2 in configuration mode and points
Batch View to NODE1, that is, the Batch Server.
BatchView –ANODE1 –IBV2 -c
The following example launches Batch View using instance BV1, points Batch View to NODE1,
that is, the Batch Server and defines the unit filter as UNIT1 and UNIT2.
BatchView –ANODE1 –IBV1 –fUNIT1/UNIT2 -c

327
B0193YB – Rev C 10. Batch Management System

The following example redefines the unit filter for Batch View instance BV1, which is already
running, points Batch View to NODE1, the Batch Server.
BatchView –ANODE1 –IBV1 –fUNIT3/UNIT4
The following example launches Batch View using instance BV1, points Batch View to NODE1,
the Batch Server node and sets the unit focus to UNIT1.
BatchView –ANODE1 –IBV1 –uUNIT1
The following example redefines the unit focus for Batch View instance BV1, which is already
running, to UNIT2 and points Batch View to NODE1, the Batch Server.
BatchView –ANODE1 –IBV1 –uUNIT2

Setting Batch View Properties

When Batch View is in configuration mode, that is, started with the -c argument, the Properties
dialog box is displayed using the File/Properties pull-down menu. The Properties dialog box is
used to configure some functions of Batch View.

328
10. Batch Management System B0193YB – Rev C

Figure 10-18. Properties Window

Always on Top
This defines whether or not the Batch View is always displayed to you. Batch View is hidden by
other displays when Always on Top is enabled.

View Type
This defines the view that is displayed when Batch View is started. The default view is the SFC
view as shown below.

329
B0193YB – Rev C 10. Batch Management System

Figure 10-19. Batch View - SFC

330
10. Batch Management System B0193YB – Rev C

Figure 10-20. Batch View - Equipment Allocation

Figure 10-21. Batch View - Batch Detail

331
B0193YB – Rev C 10. Batch Management System

Figure 10-22. Batch View - Phase Control

Figure 10-23. Batch View - Batch Messages

User Options Check Boxes

Set Scheduler Filter
This defines whether or not you can change the unit filter configuration of the Batch View in
run-time mode. Batch View’s Unit Filter can be set using the –f property from FoxView and if this
Schedule Filter property checkbox is enabled, you can modify the unit-filter at run time.
Redefine the Unit Filter by selecting the Schedule toolbar button which displays the Sched-
ule list dialog box shown in Figure 10-24. Select the Filter menu to display the Unit Filter dialog
box. From this dialog box, select one or more units. Select one unit by clicking on the unit in the
list. Selecting additional units by holding the Ctrl key down and then selecting the additional
units.

332
10. Batch Management System B0193YB – Rev C

Figure 10-24. Unit Filter

Change Focus Type

This defines whether or not you can switch Batch View to a Unit Focus or a Batch Focus mode of
operation. The Schedule display shown above provides you with the capability to switch between
a Unit Focus and a Batch Focus by selecting the appropriate radio button. When in Unit Focus
only the batch that is in the unit as defined by the unit focus can be viewed. When in Batch
Focus, only the batches in the units defined by the Unit Filter can be viewed.

Set Unit Focus

This defines whether or not you can redefine the unit focus. The display shown below shows the
Unit Focus radio button set and the Unit Focus defined as Mixer 1. Additionally, the Unit: button
has been selected to display the Unit Focus dialog box. You can switch to view the batch in a new
unit using this dialog box.

Figure 10-25. Unit Focus

Exit_Applications
This allows you to use the File/Exit command, the system X button, or the Close command to
shut down BatchView.

333
B0193YB – Rev C 10. Batch Management System

Customize Toolbars
Customize Toolbar Buttons
When selected, a Customize Toolbar dialog box is displayed. The dialog box is used to insert or
remove toolbar button and to arrange the order in which they are displayed.

Customize Main Toolbar

The Customize Main Toolbar button provides configuration of the following buttons.

Batch Scheduler
Errors
Active Transitions
Offline Phase Editor
Equipment Allocation
Messages
Schedule
Save Recipe
Manual Operation

Figure 10-26. Customize Main Toolbar Buttons

Customize Fox Toolbar

The Customize Fox Toolbar button provides configuration of the following buttons.

FoxSFC
FoxAlert

Figure 10-27. Customize for Toolbar Buttons

Customize SFC Toolbar

The Customize SFC Toolbar button provides configuration of the following buttons.

Zoom Out on Phases

Zoom In on Phases
Zoom Out on Operations
Zoom In on Operations
Figure 10-28. Customize SFC Toolbar Buttons

334
10. Batch Management System B0193YB – Rev C

Customize Batch Toolbar

The Customize Batch Toolbar button provides configuration of the following buttons.

Figure 10-29. Customize Batch Toolbar Buttons

Permanently Dock Toolbar

When set, toolbars cannot be moved and relocated from their designated positions. When unset,
toolbars can be moved and anchored to the left, right, top or bottom of the window or can be left
floating. The display shown below has the toolbar docked to the bottom and to the right side of
Batch View. Once it is in the desired location, set the Permanently Dock Toolbar radio button to
prevent other users at run time from relocating the toolbar. If users want the flexibility to move
the toolbar, then do not set the radio button.

Figure 10-30. Toolbars Docked at Bottom and Right of Screen

335
B0193YB – Rev C 10. Batch Management System

Large Icons
When set, the large icons are displayed in the toolbar. The screen capture shown above has large
toolbar icons.

Batch Scheduler Startup Parameters

This field is used to define the parameters used by Batch Scheduler when it is started from the
Batch View. For instance, -IABC starts Batch Scheduler using instance ABC. See more on Batch
Scheduler parameters on page 322.

Batch Alert

When the Batch Alert radio button is set, the button icon shown above displays. The Batch Alert
button can be positioned anywhere on the display, is always be on top, and flashes red when oper-
ator action is required, even if Batch View has been minimized.

Starting Batch Scheduler from Batch View

Batch Scheduler is started from Batch View by selecting the Batch Scheduler button on the main
toolbar. When Batch Scheduler is started, the Batch Scheduler Startup Parameters are used to
specify the Batch Scheduler instance and any other parameters required. Batch View also auto-
matically appends the -b parameter and the batch identification of the batch on which Batch
View is focused. Batch Scheduler uses this information to select the batch in the schedule list
automatically.

Save Configuration
When all setting on the Properties dialog box are final, when the toolbars are located in the
desired position, when the View is selected and the startup position and size are set, click the Save
button to save all configuration settings.
Use the Restore button to retrieve the last saved configuration for the Batch View instance.

Set Batch View to Run Mode

When Batch View is started without the -c parameter, Batch Scheduler retrieves and uses the con-
figuration defined by the -I instance name.

Using Batch Display

Batch Display is a batch server and run-time client application that provides an operator interface
to Batch Manager. Batch Manager is responsible for managing the execution of recipes and also
provides information, instructions, and the statuses of all batch activity in the system. It also
allows you to monitor the execution of the procedure, enter comments and parameter values,
acknowledge the start or completion of phases, review phase interlocks, display and execute

336
10. Batch Management System B0193YB – Rev C

instructions, and answer questions pertaining to the batch. Batch Display also provides the neces-
sary interface for external document viewing and acknowledgement.
Batch execution data is accessible to external applications by way of ActiveX controls and the
Toolkit.

NOTE
Batch Manager must be running prior to the start of Batch Display. The batch sys-
tem supports the operation of multiple instances of Batch Display. This requires
you to configure multiple instances of Batch Scheduler using Environment Editor.

For more information on setting up multiple Batch Scheduler instances, see Chapter 4 “Environ-
ment Management System”.

To Start Batch Display:

1. On Environment Display, double-click the BatchDspl icon.
2. The Batch Display window appears.

3. Use the Batch Display window to monitor and modify batch execution. Batch Dis-
play displays the execution of a single batch.
4. Use the menu bar to access system functions for Batch Display.

337
B0193YB – Rev C 10. Batch Management System

File Menu
The File menu provides system functions for Batch Display.

File/Exit
Use this command to close Batch Display.

Actions Menu
The Batch Display Actions menu contains the commands that are used to access Batch Display
options.

Actions/Manual Operation
Use this command to initiate the scheduling of the selected batch in a fully manual operation
mode. This type of batch is called a phantom batch. Within the batch management system, a
phantom batch is identified as follows.

Table 10-5. Phantom Batch

Field Value
Campaign ID <MANUAL OPER>
Lot ID <MANUAL OPER>
Batch ID <MANUAL OPER>
Mode Manual

Manual Operation provides the capability to execute the phases for all the units and connections
in the process model. Manual Operation is especially helpful during startup and system verifica-
tion. Manual Operation option is available only when is configured to use the Manual Operations
application parameter is configured for Batch Display using the Environment Editor.
The execution mode for a phantom batch is always Manual.
When the phantom batch is selected, all the phases for any allocated units can be executed. Units
must be manually allocated from the Equipment Allocation window in order to have phases to
execute. There is no history of activity associated with the phantom batch. A phantom batch is
removed from the schedule by putting the Batch in Hold and then selecting Abort.
For more information on Manual Operation, see “Manual Operation” on page 376.

Actions/Save Control Recipe

Use this command to display the Save Control Recipe window.

338
10. Batch Management System B0193YB – Rev C

Figure 10-31. Save Control Recipe Screen

This window allows you to save the recipe associated with a completed batch to the recipe data-
base. All final target values for formula parameters are saved. You also have the option to save the
recipe as an equipment-dependent recipe by enabling the Save Runtime Equipment checkbox.
Additionally, recipe approvals can be retained by enabling the Retain Recipe Approvals checkbox.
This allows the recipe to be immediately scheduled. You also have the option of overwriting the
existing recipe or changing the Recipe ID and saving it as a new recipe. If the existing recipe is
overwritten the version number is incremented. Regardless of the options selected, you must enter
your name in the Author field and optionally enter a comment. The comment is saved as part of
the version history.

NOTE
If the recipe was created as read-only, you are not able to save it with the same
Recipe ID. You can however, save it using a different Recipe ID.

Actions/Activate Jump Mode

Use this command to activate the Jump mode for an active batch. The Jump mode allows an
operator to move the procedure execution pointer for a batch and then restart the batch at the
selected execution point. Security can also be configured for the Jump Mode to limit access to spe-
cific operators.
For more information on Jump mode, see “Runtime Recipe Procedure Jumps - Jump Mode” on
page 370.

To Use Jump Mode:

1. On the Batch Display window, click Batch Hold.
This places an active batch into Held.
2. Click the Jump Mode button.

339
B0193YB – Rev C 10. Batch Management System

NOTE
A message is displayed advising you that all Held phases is aborted if you continue.
Interrupting recipe execution using this feature should be carefully planned to avoid
undesirable results.

3. Click Yes to enter Jump mode.

The mouse pointer is replaced with a Jump mode cursor.
4. Position the cursor to the unit procedure, operation or phase at which you want recipe
execution to restart.
5. Click the Jump Mode button to complete the repositioning.
The Jump mode cursor is replaced with the normal mouse pointer.
6. Click the Restart Batch button.
When the batch restarts, recipe execution begins at the point you selected.

Windows Menu
Use the Batch Display Windows menu to access the batch configuration windows.

Windows/Schedule
Use this command to display the Schedule window. The Schedule window provides a list of all
batches that are scheduled and active in the system. Any batch with a status of Ready, Run, Held,
Done, Aborting or Aborted is considered active. The list also indicates which batch requires
action by displaying double-asterisks (**) in the Action column of the list. Double-clicking a
batch in the Schedule list changes the Batch Display to show information for the selected batch.
This option is also available from the Schedule icon in the Batch Display Toolbar.

Figure 10-32. Schedule Window

Windows/Batch Messages
Use this command to display the Batch Messages window.

340
10. Batch Management System B0193YB – Rev C

Figure 10-33. Batch Messages Window

The Batch Messages window contains all messages associated with the batch that you are currently
viewing. It also displays messages to alert operators of other batches that require operator action.
The messages are summarized in the following section.
♦ Waiting for the operator to answer a transition logic question.
♦ Waiting for a transition logic expression or wait function to conclude.
♦ Waiting for the operator to manually select a unit to allocate to an instance. The
instance name is provided in the message.
♦ Waiting for equipment to become available for allocation to the current batch. The
instance name is provided in the message.
♦ Waiting for the operator to acknowledge the beginning of a phase. The equipment,
operation, and phase requiring the acknowledge is provided in the message.
♦ Waiting for the operator to acknowledge the end of a phase. The equipment, opera-
tion, and phase requiring the acknowledge is provided in the message.
♦ Waiting for the operator to edit one or more phase parameters. The equipment, oper-
ation, and phase requiring the parameter editing is provided in the message.
♦ Waiting for the operator to enter a comment for a phase. The equipment, operation,
and phase requiring the comment is provided in the message.
♦ Waiting for an operator action on another batch. The campaign, lot, and batch iden-
tification information is provided for the batch requiring the action.
This option is also available from the Batch Messages icon in the Batch Display Toolbar.

Windows/Equipment Allocation
Use this command to display the Equipment Allocation window. This option is also available
from the Equipment Allocation icon in the Batch Display Toolbar.

341
B0193YB – Rev C 10. Batch Management System

Figure 10-34. Equipment Allocation Window

Use this window to view the status and availability of the units and/or connections in the train
assigned to the selected batch. The Equipment Allocation window is only available for batches
that have a status of Run, Held, or Aborting.
Each unit in the train has a Status corresponding to one of the statuses defined in the Process
Modeling Editor. Each connection in the train has a status of Available or Unavailable. This status
corresponds to the status of any segments that were assigned to the connection in the process
model. If segments were not assigned to a connection, the status of the connection is always
Available. The status of a connection is Unavailable if any one of the segments assigned to the
connection has an equipment status that has not been marked as Available in the process model.
The Allocation of a unit or connection relates to the ability of the unit or connection to be allo-
cated by Batch Manager. The Ready allocation value means that the unit or connection is avail-
able to be allocated. The Allocated value means that the unit or connection is allocated by a batch.
A Busy value indicates that the unit or connection has been allocated by another batch.
Any unit or connection in the train, if Ready, can be manually allocated by selecting the unit or
connection, selecting the proper instance, and then clicking on the Allocate button. The instance
names correspond to those defined in the recipe assigned to the selected batch. This allocates the
chosen instance to the selected unit or connection. Any unit or connection in the train, if Allo-
cated, can be manually released by selecting the unit or connection and clicking on the Release
button. Manual allocation and release overrides automatic and recipe allocation.

342
10. Batch Management System B0193YB – Rev C

The Allocation Queue button allows you to display a list of the batches that are waiting for the
selected equipment. The list is displayed in the order in which the batch executes in the unit.
Using the arrow buttons provided in the Equipment Allocation Queue window, you can, after
selecting a batch from the list, move it up or down in the queue. The batch at the top of the list is
the next batch to execute.
The View Filter options allow you to enable and disable the display of Units and/or
Connections in the equipment list.
The Unit Control options enable the particular Unit Control tags for the selected unit. This pro-
vides individual control over each unit in the process. There are two Hold Propagation Modes
available. In addition to the Hold Propagation modes, Unit Control can be further enhanced by
using Unit State system tags.

NOTE
Hold Propagation Mode 1 is enabled by default. In order to enable Hold Propaga-
tion Mode 2, you must enable the Phase/Batch Status parameter name using Envi-
ronment Editor. In order use Unit State system tags, you must enable the Unit
States parameter using Environment Editor.

Hold Propagation Mode 1 - Unit State Enabled

This mode is the default mode of operation and allows a unit to be allocated only if it is Unallo-
cated, has an Available status and has a Ready state. During normal execution, if unit state goes to
Alarm or Held or if the batch is held by the operator, then the Unit Hold is set for all units allo-
cated by the batch. The batch state goes to Held when all allocated units transition to either the
Held or the Alarm state. The operator can restart the batch only if all allocated units are in the
Held state. If any units are in the Alarm state, they must transition to the Held state before the
batch Restart command is available. After a Restart command is written and all allocated units
transition to either the Run or Ready state, the batch status returns to Run.

NOTE
There is an assumption that a unit in a Held state can be restarted and then imme-
diately changes to a Run or Alarm state. If this mode does not appear to function as
described, you should review the Restart logic that you are utilizing.

Hold Propagation Mode 1 - Unit State Disabled

This mode allows unit allocation only if it is Unallocated and has an Available Status. During nor-
mal execution, if the batch is held by the operator, then the Unit Hold is set for all units allocated
by the batch. The batch state goes to Held. The operator can Restart at any time. After a Restart
command is written, the batch status returns to Run.
Hold Propagation Mode 2 - Unit State Enabled
This mode allows unit allocation only if it is Unallocated, has an Available status, and has a Ready
state. During normal execution, if unit state changes to Alarm or Held, if any running phase
change to Held, or if the batch is held by the operator, then Unit Hold is set for all units allocated
by the batch and phase Hold is set for all running phases. The batch state goes to Held when all
allocated units transition to either the Held or the Alarm state. The operator can restart the batch
only if all allocated units are in the Held state. If any units are in the Alarm state, they must tran-
sition to the Held state before the batch Restart command is available. After a Restart command is

343
B0193YB – Rev C 10. Batch Management System

written and all allocated units transition to either the Run or Ready state, the batch status returns
to Run.
Hold Propagation Mode 2 - Unit State Disabled
This mode allows unit allocation only if it is Unallocated and has an Available Status. During nor-
mal execution, if any running phase changes to Held, or if the batch is held by the operator, then
Unit Hold is set for all units allocated by the batch and phase Hold is set for all running phases.
The batch state goes to Held. The operator can restart the batch at any time. After a Restart com-
mand is written, the batch status returns to Run.

NOTE
There is an assumption that a unit in a Held state can be restarted and immediately
changes to a Run or Alarm state. If this mode does not appear to function as
described, you should review the restart logic that you are utilizing.

Windows/Phase Parameter Editor

Use this command to display the Phase Parameter Editor window.
For more information on dynamically changing phase parameter information, see “Phase Parame-
ter Editor” on page 354 in this section.
This option is also available from the Offline Phase Editor icon in the Batch Display
Toolbar.

Windows/Transition Logic
Use this command to display the Active Transitions window.
For more information on viewing active transitions, see “Active Transition Objects” on page 356.
This option is also available from the Active Transitions icon in the Batch Display Toolbar.

Windows/FoxAlert
Use this command to display Alarm Manager.
For more information on Alarm Manager, see your Foxboro documentation.
This option is also available from the Alarm Manager icon in the Batch Display Toolbar.

Windows/Phase Sequence
Use this command to display Foxboro SFC/ST Display Manager.
For more information on using Foxboro SFC/ST Display Manager, see your Foxboro
documentation.
This option is also available from the Display Phase Sequence icon in the Batch Display
Toolbar.
You can enable security for the Display Phase Sequence button by editing the Launch FoxSFC
function for a Batch Client.
For more information on using the Security Editor, see Chapter 14 “Security System”.

344
10. Batch Management System B0193YB – Rev C

View Menu
The Batch Display View menu contains the commands that are used to toggle the display of the
application toolbars and status bar, as well as to change the focus of the unit procedure, operations
and phases displays. The menu options are described below.

View/Errors
Use this command to display the Errors window. All batch errors are contained in this list.
This option is also available from the Errors icon in the Batch Display Toolbar.

View/Main Toolbar
To View the Main Toolbar:
♦ Click View and then enable the Main Toolbar menu item.

View/SFC Toolbar
To View the SFC Toolbar:
♦ Click View and then enable the SFC Toolbar menu item.

View/Fox Toolbar
To View the Fox Toolbar:
♦ Click View and then enable the Fox Toolbar menu item.

To View the Status Bar:

♦ Click View and then enable the Status Bar menu item.

View/Unit Procedure View

Use the View/Unit Procedure View menu item to show or hide the Unit Procedures pane and
toolbar.

View/Unit Procedure Zoom In

To Zoom In on Unit Procedures:
♦ Click View and then select Unit Procedure Zoom In to increase the displayed size of
objects in the unit procedure pane.
You can also use the Unit Procedure Zoom In icon in the Unit Procedures toolbar.

View/Unit Procedure Zoom Out

To Zoom Out on Unit Procedures:
♦ Click View and then select Unit Procedure Zoom Out to increase the displayed size of
objects in the unit procedure pane.

345
B0193YB – Rev C 10. Batch Management System

You can also use the Unit Procedure Zoom Out icon in the Unit Procedures Toolbar.

View/Operation View
Use the View/Operation View menu item to show or hide the Operations pane and toolbar.

View/Operation Zoom In
To Zoom In on Operations:
♦ Click View and then select Operation Zoom In to increase the displayed size of objects
in the operation pane.
You can also use the Operation Zoom In icon in the Main toolbar.

View/Operation Zoom Out

To Zoom Out of a Recipe Operation:
♦ Click View and then select Operation Zoom Out command to decrease the displayed
size of objects in the operation pane.
You can also use the Operations Zoom Out icon in the Main Toolbar.

View/Phase View
Use the View/Phase View menu item to show or hide the Phases pane and toolbar.

View/Phase Zoom In
To Zoom In on Recipe Phases:
♦ Click View and then select Phase Zoom In command to increase the displayed size of
phases in the phase pane.
You can also use the Phase Zoom In icon in the Main Toolbar.

View/Phase Zoom Out

To Zoom Out of a Recipe Phase:
♦ Click View and then select Phase Zoom Out command to decrease the displayed size
of phases in the recipe phase pane.
You can also use the Phase Zoom Out icon in the Main Toolbar.

346
10. Batch Management System B0193YB – Rev C

View/Large Icons
To View Large Icons:
♦ Click View and then enable the Large Icons menu item to increase the size of the
icons on the toolbars.

Help Menu
The Batch Display Help menu contains the commands that are used to access the main help
screen, and information about the version and licensing of the application.

Help/Help Topics
Use this command to display the online Help for Batch Display.

Help/About Batch Display

Use this command to view version information.

Batch Display Layout

The Batch Display window is divided into several functional areas as shown.

347
B0193YB – Rev C 10. Batch Management System

Phase Phase Batch Batch Question Phase Batch

Paramater List Display Identification List Control Control
List Toolbar SFC Toolbar Buttons Buttons

Sequence of Operations Instruction List Sequence of Phases View/Ack

Document
Viewing

Figure 10-35. Batch Display Window

Batch Display Toolbar

♦ Manual Operation
The Manual Operation icon is used to display a phantom batch.
♦ Save Recipe
The Save Recipe icon is used to display the Save Control Recipe window.
♦ Schedule
The Schedule icon is used to display the Schedule window.
♦ Batch Messages
The Batch Messages icon is used to display the Batch Messages window.
♦ Equipment Allocation

348
10. Batch Management System B0193YB – Rev C

The Equipment Allocation icon is used to display the Equipment Allocation window.
♦ Offline Phase Editor
The Offline Phase Editor icon is used to display the Phase Parameter Editor window.
♦ Active Transitions
The Active Transitions icon is used to display the Active Transitions window.
♦ Errors
The Errors icon is used to display the Errors window.

SFC Toolbar

♦ Zoom In
The Zoom In icon is used to enlarge the sequence of operations display. There are
10 levels of magnification available.
♦ Zoom Out
The Zoom Out icon is used to reduce the sequence of operations display. There are
10 levels of reduction available.
♦ Zoom In
The Zoom In icon is used to enlarge the sequence of phases display. There are 10
levels of magnification available.
♦ Zoom Out
The Zoom Out icon is used to reduce the sequence of phases display. There are 10
levels of reduction available.

Batch Identification
Across the top of the Batch Display main window is the batch identification information.
Included here are the Campaign ID, Lot ID, Batch ID, Mode, Status and Action.

Phase List
The Phase List contains a dynamic list of active phases. The equipment allocated for each phase
and the status of each phase are also included in the list.

Question List
The Question List contains a dynamic list of active questions. Answering a question requires the
selection of the question and the appropriate answer button.

Batch Control Buttons

The Batch Control buttons give you the ability to start the batch, hold the batch, restart the
batch, abort the batch, and change the batch mode.

349
B0193YB – Rev C 10. Batch Management System

Phase Parameter List

The Phase Parameter List provides a dynamic list of all formula parameters for active phases, as
well as the ability to change parameters.

Instruction List
The Phase List provides a list of instructions associated with the phase selected in the Phase List.

View Doc/Ack Doc Button

The View Doc button provides the necessary operator interface to view a document that is speci-
fied as part of a phase. Once the document is viewed, the button label changes to Ack Doc,
requiring operator acknowledgement in order to continue execution.

Phase Control Buttons

The Batch Control Buttons give you the ability to start a phase, hold a phase, restart a phase,
abort a phase, acknowledge a phase, satisfy phase control buttons, enter a phase or batch com-
ment, view phase interlocks, and manually select equipment for phase execution.

Sequence of Unit Procedures and Operations

The Sequence of Procedures and Operations dynamically show the current Procedure and Opera-
tion that are executing in the selected batch. The status of each operation in the SFC is repre-
sented with colors.

Table 10-6. Status Color Codes

Color Description
Cyan Continue Mode Execution
Gray Inactive
Green Active
Yellow Completed

Sequence of Phases
The Sequence of Phases dynamically shows the current phases executing in the selected batch for
the selected operation. The status of each phase in the SFC is represented with colors.

Table 10-7. SFE Phase Status Color Codes

Color Description
Gray Inactive
Green Active
Red Interlocked, Held, or Waiting for Operator Action
Yellow Completed

350
10. Batch Management System B0193YB – Rev C

Batch Display Functionality

Batch Display is used by operators to monitor and control the execution of batches. Batch Dis-
play's main window provides the functionality described in the following:
♦ A list of all active batches in the schedule that can be viewed at any time. An active
batch is any batch that has a status of Ready, Run, Held, Done or Aborted
♦ A list of all phases for the selected batch that can be viewed
♦ The recipe procedure that can be viewed for each batch, showing the status of each
phase
♦ Batch control buttons including Start, Hold, Restart, and Abort
♦ Phase control buttons including Start, Hold, Restart, and Abort
♦ View and control of current Phase Status, Parameters, and Instructions
♦ Ability to enter Comments associated with a phase or with the batch
♦ Ability to View and Acknowledge external document viewing
♦ Ability to view Interlocks for each phase
♦ A list of Transition Logic Questions and the ability to answer the questions
♦ A Message Line that displays Operator commands
♦ View Transition Logic Status
♦ Force Transition Logic
♦ Edit phase parameter values when a batch is active.
♦ Edit phase parameter values when a batch is not active (Phase Parameter Editor
window).
More detailed information on many of these features is provided later in this chapter.

Batch Control
Batches that are initialized have a status of Ready. If a batch is Ready, it can be selected from the
Schedules window and started using the Batch Start button. Batches that are running have a sta-
tus of Run. If a batch has a status of Run, the batch can be put in Held. If a batch has a status of
Held, the batch can be Restarted or Aborted.

Table 10-8. Batch Status

Batch Status Description Active Button(s)

Ready Batch is ready to be started. Batch Start
Run Batch is executing; Batch can be put in Hold. Batch Hold
Held Batch is in Hold; Batch can be restarted or aborted. Batch Restart
Batch Abort
Aborting Batch is being aborted. N/A
Aborted Batch was aborted. N/A
Done Batch is finished. N/A
Locking Batch is aborting phases to enter into Jump Mode. N/A
Locked Batch is locked and in Jump Mode. N/A

351
B0193YB – Rev C 10. Batch Management System

Batch Execution Mode

The Edit Mode button displays the Batch Mode window. Selecting the desired mode with the
combo box changes the Batch Execution Mode.

Figure 10-36. Batch Mode Window

For more information on dynamically changing the batch mode, see “Batch Execution Modes” on
page 359.

Phase Comments
The Edit Comment button displays the Comment window.

Figure 10-37. Comment Window

The Comment window can be used at any time. While a phase is executing, a comment associ-
ated with the selected phase can be entered. The comment is stored in the historical database. If
phases are not executing and a comment is entered, it is stored as a general comment associated
with the batch. If a phase is active, the operator can change the comment type to Batch if the
comment is not related to the phase.

NOTE
A batch must be initialized in order for comments to be written to history.

Phase Interlocks
The Interlocks button displays the Interlocks window. This is used to view the status of the inter-
lock tags for any active phase in the procedure.

Equipment Selection
The Select Equipment button displays the Equipment Selection window.

352
10. Batch Management System B0193YB – Rev C

Figure 10-38. Equipment Selection Window

This window contains a list of possible units that can be allocated for a particular recipe instance.
Whenever Manual Unit Selection is configured for a process instance in the recipe Equipment
Requirements Editor, the operator must select the equipment to be allocated and used by the cur-
rent batch. In the Equipment Selection window shown, the operator must choose which one of
two units is to be allocated for the first reactor process instance.
The Equipment Selection window is dynamic. The current status of units that are available for
selection is displayed in the window. If the status of any equipment changes while the window is
displayed, the status displayed updates accordingly. The status of units displayed in the Equip-
ment Selection window corresponds to those statuses defined in the process model. As long as the
new unit status represents an available status, the unit remains displayed in the list.

Phase Control and Status

All active phases and their current statuses are displayed in the Phase List. Any phase that requires
operator action is displayed with ** in the Action column. Any active phase can be selected in
order to display its parameters, instructions, and interlocks. In addition, the phase can be Held,
Restarted, and Aborted with the Phase Control buttons if the phase has been properly configured
in the process model. Shown below are the various phase statuses and an explanation of operation.

Table 10-9. Phase Statuses

Phase
Status Description Action
Wait Phase is waiting for operator action. Message line indi- Acknowledge or Edit
cates whether a comment or an acknowledge is Comment.
required.

353
B0193YB – Rev C 10. Batch Management System

Table 10-9. Phase Statuses

Phase
Status Description Action
Wait Phase is currently running. Phase can be run after Acknowledge “Unex-
acknowledging the message. Batch Manager waits pected Status Window.”
until the phase is Ready.
Run Phase is executing. Phase Hold
Held Phase is in Hold; Phase can be Re-started or Aborted. Phase Restart or
Phase Abort
Done Phase execution is complete. N/A
Interlocked Interlocks are preventing the phase from executing. Select Interlocks button.
Aborted Phase has been Aborted. N/A

Editing Formula Parameters

Any phase that has parameters configured in the Process Model with Edit Allowed or Edit
Required may be altered during the execution of the phase. The operator must first select the
desired phase in the Phase List, select the parameter in the Phase Parameter List, click within the
text entry field (adjacent to the Change button) and enter an appropriate value, and then click the
Change button. The edit field and Change button are not available when the selected parameter
cannot be edited.

Answering Questions
Transition objects that have been configured in the recipe to ask a question of the operator are in
the Questions List box. The operator must select the question that is to be answered and click the
Yes button.
Depending on the recipe, there may only be one question or there may be several. For an Execute
All branch, all the questions must be answered. If the branch is an Execute One, then only one
question must be answered.
If the question applies to a loop object, then the question is a Yes or No question. If the answer is
Yes, then the loop back is executed.

Phase Acknowledgment
Any phase in the recipe that has been configured with an Acknowledge On Entry or Acknowledge
On Exit option, as well as all semi-automatic phases requires the operator to acknowledge the
phase when executed. A message is displayed in the Message box when an acknowledgment is
required. The Acknowledge button must be selected when required.

Phase Parameter Editor

The Phase Parameter Editor is used to edit or modify phase execution and phase parameters any
time a batch has a status of Ready, Done or Aborted. The editor provides the following
capabilities.
♦ Add an Instruction to a phase.
♦ Enable or Disable Acknowledge on Entry configuration for a phase.
♦ Enable or Disable Acknowledge on Exit configuration for a phase.

354
10. Batch Management System B0193YB – Rev C

♦ Enable or Disable Comment Required for a phase.

♦ Enable or Disable Batch Execution Continue Mode.
♦ Modify Parameter Target Values for a phase.

NOTE
Phase parameter changes are dynamic and are used during the execution of the
batch if made for a phase that has not yet executed. Phases that are not running are
not displayed in the list.

Figure 10-39. Phase Parameter Editor Window

355
B0193YB – Rev C 10. Batch Management System

Active Transition Objects

Use the Active Transitions window to view the expressions associated with all active transition
objects. The display lists each Active Transition and includes the label and Wait (time remaining)
for the transition.

Figure 10-40. Active Transitions Window

When a transition is selected, its expression is displayed and if tags are associated with the expres-
sion, they are displayed along with their current value.
Any active transition object must have a result of False. The Transition can be forced to True by
selecting the active transition and selecting the Force to True button.

Using Batch View

Batch View provides a similar functional interface as Batch Display, but is more flexible, config-
urable and easier to use. Batch View is designed to work seamlessly with FoxView software. Batch
View has two modes; (1) as a batch server and (2) as a batch run-time client application that pro-
vides an operator interface to Batch Manager. Batch Manager is responsible for managing the exe-
cution of the recipes, and also provides information, instructions, and the statuses of all batch
activity in the system. It allows you to monitor the execution of the procedure, enter comments
and parameter values, acknowledge the start or completion of phases, review phase interlocks, dis-
play and execute instructions, and answer questions pertaining to the batch. Batch View does not

356
10. Batch Management System B0193YB – Rev C

provide the necessary interface for external document viewing and acknowledgement. This fea-
ture is available in Batch Display.
Batch execution data is accessible to external applications by way of ActiveX controls and the
Toolkit.
For more information on setting up multiple Batch Scheduler instances, see Chapter 4 “Environ-
ment Management System”.

To Start Batch View:

1. Click the BatchView icon in Batch Scheduler.
2. The Batch View window appears.

Starting Batch Manager

Batch Manager is the most fundamental and integral part of the batch management system. The
execution of every batch is controlled and monitored by Batch Manager. Another of its responsi-
bilities is the management of multiple batch executions and the dissemination of all the batch
information to Batch Scheduler and Batch Display. Each batch server supports a single instance of
Batch Manager.
Batch Manager is started by the Environment Manager when the run-time applications are initi-
ated. There is no icon displayed for Batch Manager. Batch Manager executes as an operating sys-
tem service.

Batch Execution
Batch Manager is responsible for the execution of all the batches running in the system at any
point in time. There are many different areas of functionality that Batch Manager must co-
ordinate while executing batches. These include allocation of equipment, batch execution modes
and mode changes, unit selection, process phase execution, and transfer phase execution.
There are three types of equipment allocation that are available: Automatic, Recipe, and Manual.
There are three modes of batch execution: Automatic, Semi-Automatic, and Manual. There are
two methods for selecting units for a batch: Automatic and Manual. There are two categories of
phases: Process and Transfer. There are three types of phases: Automatic, Semi-Automatic, and
Manual. Each of the batches may have any combination of the above options. Each of the areas is
described below.

Equipment Allocation
In order to execute any phase as part of a batch, equipment must be allocated to the batch. If suit-
able equipment has been previously allocated to the batch, then that equipment is used. If equip-
ment has was not previously allocated, then the batch management system must allocate suitable
equipment to the batch before proceeding with phase execution. There are three approaches to
allocating equipment for a batch: Automatic Allocation, Recipe Allocation, and Manual Alloca-
tion. Each allocation approach is described below.

Automatic Allocation and Release

Automatic Allocation is performed by default by Batch Manager. Automatic Allocation occurs
whenever a phase needs to be executed and appropriate equipment (unit and/or connection) is

357
B0193YB – Rev C 10. Batch Management System

not currently allocated to the batch. Batch Manager allocates the equipment required and releases
the equipment automatically when it thinks it no longer needs the equipment. For process phases,
only the unit is allocated. For transfer phases, both the destination unit and the connection are
allocated. Source units are never automatically allocated when a transfer phase is executed.
As part of the evaluation criteria for unit allocation, Batch Manager uses the equipment status
(that is, Clean, Dirty), equipment availability (that is, in use by another batch), train definition
(that is, is the unit in the train assigned to the batch), equipment attribute requirements (that is,
capacity, material of construction), and the equipment state (that is, Ready, Run, Held, Alarm).
When there are multiple units from which to select, Batch Manager makes the selection based on
the manner in which unit selection has been defined in the recipe. If no units are available, Batch
Manager continuously evaluates the possible units and waits until one becomes available.
Connection allocation is a result of source and destination unit allocation. When multiple con-
nections are available between two units, Batch Manager selects the first connection encountered.
For cases when the source unit has not been allocated, either a material is used for connection
selection or Batch Manager selects the first connection encountered. Connection allocation is also
influenced by any segments that are assigned to the connection in the process model. Segments
with an unavailable status render all connections to which the segments are assigned unavailable
for allocation.
Segment allocation occurs when a connection to which the segment is assigned is allocated to exe-
cute a transfer phase.
Allocated equipment is automatically released when no longer needed or at the end of the batch.
Therefore, units are automatically released after a transfer phase in which the unit is the source is
complete or at the end of the batch. Connections and segments are automatically released after
the transfer phase in which the connection and segment(s) were allocated to execute is complete.

Recipe Allocation and Release

Recipe Allocation takes precedence over Automatic Allocation. Recipe Allocation refers to the
allocation of units or connections by way of the inclusion of an Allocate Process Instance or Allo-
cate Transfer Instance phase in the recipe procedure.
With recipe allocation, equipment (unit and/or connection) is reserved for exclusive use by the
batch in which the phase is executed. The recipe Allocate Process Instance phase allocates and
reserves a unit. The recipe Allocate Transfer Instance phase allocates both a destination unit and a
connection, but it only reserves the connection. The destination unit is allocated using the rules
of automatic allocation. If it is required to also reserve the destination unit, then the Allocate Pro-
cess Instance phase must be used in conjunction with the Allocate Transfer Instance phase in the
recipe procedure. In addition, source units are never recipe-allocated when an Allocate Transfer
Instance phase is executed.
The same selection criteria defined for automatic allocation is true for recipe allocation with the
additional requirement that recipe allocated equipment remains allocated to the batch until a cor-
responding recipe release phase is encountered in the recipe procedure or until the batch is
complete.
Recipe allocation phases are treated the same as other phases in a recipe. Recipe execution does
not proceed until a unit or connection defined by the Allocate Phase is assigned to the batch.

358
10. Batch Management System B0193YB – Rev C

Manual Allocation and Release

Manual Allocation takes precedence over Automatic Allocation and Recipe Allocation. Manual
Allocation refers to the allocation of equipment (unit and/or connection) by a user by way of the
Equipment Allocation window within Batch Display. Any unit or connection defined in the train
assigned to the batch can be allocated using this window. However only equipment that has an
available equipment status (for example, Clean, Dirty), an available equipment state (for example,
Ready), and is not allocated to another batch can be manually allocated.
Manually allocating a unit allocates and reserves only the selected unit. Manually allocating a con-
nection allocates and reserves only the selected connection. Neither the source nor the destination
unit is allocated when a connection is manually allocated. Units and connections that are manu-
ally allocated are released when the operator manually releases the unit or connection from the
Equipment Allocation window or when the batch is complete.
Manual Allocation is especially important when executing batches in Manual mode. Only the
phases associated with manually allocated units and/or connections can be executed. Further-
more, if a batch is started in Manual mode, there are no units or connections allocated. Units
and/or connections must be allocated manually before any phases are available for execution.

Batch Execution Modes

There are three different modes of batch execution: Automatic, Semi-Automatic, and Manual.
Batch Manager responds to batch control commands differently depending on the mode. Each
option is presented below.

Automatic Batch Mode

Starting a Batch
When the Batch Start button is selected, recipe procedure execution begins. Equipment must be
allocated in order to execute phases. The allocation takes place according to the rules defined in
the allocation section. If the required equipment cannot be allocated, the phase(s) go to the Wait
status. While in Wait, the availability of the equipment is continually monitored. As soon as
equipment is available, it is allocated to the batch and the phase(s) are started. Only the equip-
ment in the assigned train is available to Batch Manager for allocation.
Once the correct equipment is allocated, the status of the phase to be executed is evaluated. If the
phase status is Ready, Batch Manager downloads the values of the formula parameters to the con-
trol system and sets the phase Start tag. If the phase status is Interlocked, Batch Manager monitors
the phase until the status becomes Ready before proceeding. If the phase status is Held or Run, an
“Unexpected Status” Error window is displayed. The operator must acknowledge the error, and
Batch Manager waits for the phase status to become Ready before proceeding. If the phase status
is Done or Aborted, the phase Reset tag is set by Batch Manager, and Batch Manager waits for the
Ready status before proceeding.
If IADriver encounters a failure while attempting to read or write to a tag in the control system,
the batch that is associated with the failure is placed on hold by the Batch Manager and an error
message is displayed. Examples of conditions that can cause tag read and write failures include
BAD IO points or the unintentional deletion of a block parameter in the control system. When
failures occur, you need to take the necessary action to correct the problem and then initiate a
Batch Restart to resume operation. If the failure cannot be resolved, but you want batch execution
to continue, you can abort the phase associated with the failed tag and then initiate a Batch
Restart to resume batch execution.

359
B0193YB – Rev C 10. Batch Management System

Hold a Batch
When the Batch Hold button is selected, Batch Manager puts the batch in Held. The actions
taken in response to a Batch Hold depend on the way in which Batch Manager is configured in
the Environment Editor. If configured by default (that is without any application parameters in
the Environment Editor), when the Hold is initiated, the batch status changes to Held and the
Unit Hold tag for each unit allocated to the batch is set. It is the responsibility of the control sys-
tem logic to alter the status of the phases associated with the unit(s). Typically, the phases are put
in the Held status. However, the results of a batch hold can be unique for each phase.

NOTE
When the Batch Hold button is clicked it is possible that the Batch Abort may
become available before all phases are in the Held status. If you quickly press the
Batch Abort button before all phases are in the Held status, any phase not in the
Held state will not respond to the Phase Abort command issued by the Batch Abort
command. In this situation the phases remain in Held or the last status. The Batch
status remains Aborting until all phases have completed. Phases in Run complete
normally, or can be manually held and aborted. To resolve this situation, verify all
phases are in Held before pressing the Batch Abort, manually abort all phases in
Held, or assign security to the Batch Abort button. In most cases this allows enough
time for all phases to go to the Held state.

If Batch Manager is started with the Phase/Batch Status application parameter defined in the
Environment Editor, Batch Manager manages all phase hold activity. As above, when a Batch
Hold is triggered the batch status changes to Held and the Unit Hold tag for each allocated unit is
set. In addition, a phase hold signal is sent to any phase in the batch that has a status of Run. Also,
if any phase becomes held during the execution of a batch, Batch Manager places the batch in
held and sends a phase hold signal to all other phases in the batch that are in run. This applies
whether the held condition was the result of an operator initiated hold or generated internally to
the phase logic.
The batch hold concept is further advanced if the Unit States application parameter is defined for
Batch Manager in the Environment Editor. If this parameter is defined by itself without also
defining the Phase/Batch Status application parameter, Batch Manager monitors the unit state
tags for each allocated unit. If any unit state tag changes to the Held or Alarm state, Batch Man-
ager puts the batch that has the unit allocated in Held. No other units or phases are held by Batch
Manager, and the response of the phases to the unit state change is the responsibility of the con-
trol system. If both the Unit States and Phase/Batch Status application parameters are defined,
Batch Manager uses the unit states to determine when to propagate phase hold commands. In this
case, if a unit goes into the Held or Alarm state, Batch Manager recognizes this and sets the Unit
Hold tag and Phase Hold tags for each unit and phase associated to the batch. Whenever the Unit
States parameter is defined, a batch cannot be restarted until the unit state returns to Run.
Regardless of the manner in which Batch Manager is configured, transition logic Wait functions
are not put in Held. The Wait function continues to execute and time out if the Held time
exceeds the time of the function. When a Wait function times out, execution continues to the
next phase but the phase does not start until the batch is restarted.

360
10. Batch Management System B0193YB – Rev C

Restart a Batch
When the Batch Restart button is selected, Batch Manager restarts the batch. The actions taken in
response to a Batch Restart depend on the way in which Batch Manager is configured in the Envi-
ronment Editor. If configured by default (that is without any application parameters in the Envi-
ronment Editor), when the Restart is initiated, the batch status changes to Run and the Unit
Restart tag for each unit allocated to the batch is set. It is the responsibility of the control system
logic to alter the status of the phases associated with the unit(s). Typically, the phases are put in
the Run status. However, the results of a batch restart can be unique for each phase.
If Batch Manager is started with the Phase/Batch Status application parameter defined in the
Environment Editor, Batch Manager manages all phase restart activity. As above, when a Batch
Restart is triggered, the batch status changes to Run and the Unit Restart tag for each allocated
unit is set. In addition, a phase restart signal is sent to any phase in the batch that has a status of
Held. However, unlike hold commands, an individual phase restart does not cause the batch and
all other phases to restart.
The batch restart concept is further advanced if the Unit States application parameter is defined
for Batch Manager in the Environment Editor. If this parameter is defined by itself without also
defining the Phase/Batch Status application parameter, Batch Manager monitors the unit state
tags for each allocated unit. Batch Manager does not permit a Batch Restart for any batch which
has allocated units and these units are in a state other than Held (that is, the Alarm state must be
cleared). Typically, units are in the Held state from the batch hold command. All allocated units
must be changed to Held in order to restart the batch. Unit state changes are the responsibility of
the control system. Once the required unit states are in Held, the Unit Restart tag is set for each
allocated unit. If both the Unit States and Phase/Batch Status application parameters are defined,
Batch Manager uses the unit states to determine when to propagate phase restart commands. In
this case, a batch and all held phases are not automatically restarted if any unit is in a state other
than Held.

Abort a Batch
When the Batch Abort button is selected, Batch Manager aborts the batch. The actions taken in
response to a Batch Abort depend on the way in which Batch Manager is configured in the Envi-
ronment Editor. If configured by default (that is without any application parameters in the Envi-
ronment Editor), when the Abort is initiated, the batch status changes to Aborting and the Unit
Abort tag for each unit allocated to the batch is set. It is the responsibility of the control system
logic to alter the status of the phases associated with the unit(s). Typically, the phases are put in
the Aborted status. However, the results of a batch abort can be unique for each phase. Once all
phases have completed or aborted, the batch status changes to Aborted. The batch status remains
Aborting as long as phases are active.

NOTE
When Batch Abort is selected, a window appears prompting you to confirm the
Abort. When Yes is clicked, Batch Manager aborts the batch.

If Batch Manager is started with the Phase/Batch Status application parameter defined in the
Environment Editor, Batch Manager manages all phase abort activity. As above, when a Batch
Abort is triggered, the batch status changes to Aborting and the Unit Abort tag for each allocated
unit is set. In addition, a phase abort signal is sent to any phase in the batch that has a status of
Held. However, unlike hold commands, an individual phase abort does not cause the batch and

361
B0193YB – Rev C 10. Batch Management System

all other phases to abort. Also, once all phases have completed or aborted, the batch status changes
to Aborted.
The batch abort concept is not as affected as the hold and restart if the Unit States application
parameter is defined for Batch Manager in the Environment Editor. If this parameter is defined
by itself without also defining the Phase/Batch Status application parameter, Batch Manager
monitors the unit state tags for each allocated unit. However, Batch Manager does not require a
particular unit state in order to abort a batch. The Unit Abort tag is set for each allocated unit
regardless of its state. If both the Unit States and Phase/Batch Status application parameters are
defined, Batch Manager propagates phase abort commands regardless of the state of the allocated
units.

NOTE
Error messages are not displayed when unexpected unit states are received when one
of the following conditions apply:

If a unit is not allocated and has an Available status, the unit should have a state of
Ready. A unit state of Run, Held, or Alarm is not permitted.

If a unit is allocated and phases for that unit are active, the unit should have a state
of Run, Held, or Alarm. A unit state of Ready is not permitted.

It is your responsibility to avoid the conditions that are described. If either condi-
tion exists, you must manually change the unit state.

Semi-Automatic Batch Mode

When Batch Manager is executing in semi-automatic mode, operation is exactly the same as auto-
matic mode, except that the operator is required to acknowledge the start of each phase.

Manual Batch Mode

When Batch Manager is executing in manual mode, any phase in the recipe for any unit or con-
nection allocated to the batch can be executed. When a batch is started in Manual mode, no
equipment is allocated to the batch. The operator must manually allocate the desired units and/or
connections using the Equipment Allocation window. Any manually allocated equipment must
be released manually or it remains allocated to the batch until the batch is complete.
When equipment is allocated, the phases associated with the instance of that equipment that is
used in the recipe procedure are available for execution. For process phases, only the specific unit
must be allocated. For transfer phases, the source unit, destination unit, and connection must be
allocated. The operator must select the desired phase, change the parameter values if desired, and
manually start the phase. Several phases can be run simultaneously, if desired.

Batch Execution Mode Changes

Automatic to Semi-Automatic
Operation continues normally except that any new phase encountered requires the operator to
Acknowledge the start of the phase.

362
10. Batch Management System B0193YB – Rev C

Batch Manager can be configured to switch from Automatic to Semi-Automatic after a phase is
aborted. The batch then continues to execute in Semi-Automatic Mode. To enable this feature
you must use Environment Editor to assign the “Semi-Auto On Abort” parameter to Batch Man-
ager. If this feature is enabled, both the phase abort and the mode change from Automatic to
Semi-Automatic are logged to history.
For more information on configuring the Environment Editor, see Chapter 4 “Environment
Management System”.

Automatic to Manual
Any active phases continue to run to completion. Batch Manager monitors these phases and resets
the phases when they are done. No new phases are executed. Batch Manager maintains its posi-
tion in the recipe procedure, and the operator may manually execute any phases associated with
allocated equipment.

Semi-Automatic to Manual Mode

Any active phases continue to run to completion. Batch Manager monitors these phases and resets
the phases when they are done. No new phases are executed. Batch Manager maintains its posi-
tion in the recipe procedure, and the operator may manually execute any phases associated with
allocated equipment.

Semi-Automatic to Automatic
Any phases that are running continue to run. Any phase waiting for an operator Acknowledgment
or any new phase encountered automatically starts. This assumes that the phase is not configured
for Acknowledge on Entry in the recipe procedure. If this is the case, the Acknowledge is still
required.

Manual to Automatic
Execution of the recipe begins from the point where Manual mode was started. Phases start as
configured in the recipe procedure. Any phases started in Manual mode complete and are reset by
Batch Manager. Any equipment that was manually allocated stays allocated until a Release phase
for the equipment is encountered or the batch completes.

Manual to Semi-Automatic
Execution of the recipe begins from the point where Manual Mode was started. Phases require an
Acknowledge before they can be started. Any phases started in Manual Mode complete and are
reset by Batch Manager. Any equipment that was manually allocated stays allocated until a
Release phase for the equipment is encountered or the batch completes.

Unit Selection Modes

Unit Selection defines how a unit is selected by Batch Manager when there is more than one unit
from which to choose. There are two Unit Selection options: Automatic and Manual. The selec-
tion mode is defined for a process instance in the Recipe Editor. Each selection mode option is
described below.

Automatic Unit Selection

Using Automatic Unit Selection, Batch Manager selects the first unit encountered in the assigned
train that satisfies the recipe equipment requirements, has a Ready allocation status, has an avail-

363
B0193YB – Rev C 10. Batch Management System

able equipment status, and has a Ready unit state (if defined). If all possible units are not avail-
able, Batch Manager re-evaluates potential units as they become available and waits until the
availability of one of the units changes.

Manual Unit Selection

Using Manual Unit Selection, a list of available units and their current equipment status are pre-
sented to the operator. Unit statuses correspond to those defined in the process model. The oper-
ator must select one unit. The list is populated using the criteria defined for automatic unit
selection.
The only time that Manual Unit Selection is not enforced, is when one of the available units is
already allocated to the batch or when only one unit that satisfies the recipe equipment require-
ments is located in the train. Batch Manager either uses the unit that is allocated or uses the only
unit in the train that satisfies the requirements.

Process Phases
Automatic Phases
When an automatic process phase is encountered, Batch Manager first checks if a suitable unit is
allocated. If so, Batch Manager evaluates the status of the phase. If the phase is Ready, the formula
parameter values are downloaded to the control system and the phase is started. Typically, the
phase status changes to Run. Batch Manager monitors the status of the phase waiting for it to
change. Under normal circumstances, the phase status eventually goes to Done. Upon seeing the
Done, Batch Manager resets the phase. The phase status returns to Ready. When Batch Manager
evaluates the phase and finds a status of Interlocked, Batch Manager waits indefinitely until the
interlock has cleared. When Batch Manager finds a status of Run, Held, Done, or Aborted, Batch
Manager displays an error message for an unexpected phase status.

Manual Phases
Manual Type Process Phases require unit allocation and also require the operator to Acknowledge
the completion of the phase. Manual Process Phases typically include instructions which the oper-
ator must perform. When the instructions have been performed, the operator Acknowledges the
phase.
Manual phases can also be used to write data to the control system. This is accomplished by
assigning a tag to the Target element in the process model. When the phase is executed, Batch
Manager writes the Target Value, that was assigned in the recipe, to the control system.

Process Phases with Material Input Parameters

Automatic Process Phases
When an automatic process phase with an input parameter is encountered in a recipe, Batch
Manager evaluates the units available in the train and allocates a unit using the rules of allocation.
The phase status is then evaluated and executed when possible. The material information is stored
in the historical database, but Batch Manager does not interact with the materials database for lot
tracking information.

364
10. Batch Management System B0193YB – Rev C

Manual Process Phases

When a manual process phase is encountered, Batch Manager is responsible for the execution of
the phase. The phase does not execute in the control system, although Batch Manager may use
information, such as the Actual Value as measured by the control system in executing the phase.
The material information is stored in the historical database, but Batch Manager does not interact
with the materials database for lot tracking information. Depending on how the phase is config-
ured in the process model, operator interaction with the phase varies. Listed below are various
approaches that can be configured in the process model for manual process phases.

Manual Addition using a Connected Scale

Material is weighed by a scale that is attached to the control system. The operator is required to
enter the material lot code for the material if it is configured in the process model. When the
weight is within the material deviations, the operator acknowledges the completion of the phase.
Batch Manager logs the material ID, target quantity, actual quantity, and lot code to history.
When the addition requires multiple lots of the same material, the operator must enter the lot
code for the first lot and acknowledge the completion of the phase. Batch Manager decrements
the actual quantity from the target, recalculates the target quantity, and re-executes the phase.
This occurs until the original target is achieved.

Manual Addition Using an Unconnected Scale

Material is weighed on a scale that is not attached to the control system. The operator is required
to enter the material lot code if configured in the process model, the actual weight, then Acknowl-
edge the completion of the phase.
When the addition requires multiple lots of same material, the operator must enter the lot code
for the first lot and acknowledge the completion of the phase. Batch Manager decrements the
actual quantity from the target, recalculates the target quantity, and re-executes the phase. This
occurs until the original target is achieved.

Acknowledge Addition of Material

In this approach, materials are pre-weighed prior to the final production. As materials are added,
the operator acknowledges the addition of the material. Batch Manager records the material usage
by using the target quantity as the actual quantity.

Manual Addition - with Scale and without Scale

The addition may have two parts (for example 60 pounds of salt must be added. Salt comes in 50
pound bags). A scale is attached to the control system. A 50 pound bag is added to the batch. The
operator enters 50 as the actual quantity and the material lot code then acknowledges the comple-
tion of the phase. Batch Manager decrements the actual quantity from the target, recalculates the
target quantity, and re-executes the phase. The remaining material (10 pounds) is weighed on the
scale. When the weight is within tolerances, the operator must enter the material lot code and
then acknowledge the completion of the phase.
In order for the above manual addition to function properly, control system logic must be
designed to disable the scale input when the operator enters the actual bag weights. A Control
Button could be assigned to do this. The Control Button would disable the scale from overwriting
the entered value.

365
B0193YB – Rev C 10. Batch Management System

Process Phases with Material Output Parameters

When Batch Manager encounters a process phase that has an output type parameter, the appro-
priate unit is allocated. The actual quantity of product transferred may or may not be measured
automatically. In some cases it is desirable for the operator to enter in the actual quantity. Either
of these situations can be handled and is determined by how the phase is configured in the process
model. Batch Manager logs to history the target and measured or operator entered actual value, if
the phase is configured as such. If the actual is not measured or the operator is not required to
enter the actual, Batch Manager assumes the actual is equal to the target and both are logged.
For automatic process phases, Batch Manager assigns the unit to the material and increments the
material quantity in the materials database. The quantity produced and the associated batch iden-
tification (Campaign ID, Lot ID, and Batch ID) are logged to history.

Transfer Phases
Automatic Transfer Phases
When an automatic transfer phase is encountered, Batch Manager first checks if a suitable desti-
nation unit is allocated. Once the destination unit is decided, Batch Manager must determine the
source of the transfer. If material input parameters are defined, Batch Manager uses the material
database configuration for the required source unit. For non-material transfer phases, either a pre-
viously allocated source unit is used or the first source unit encountered in the model is selected.
In both cases, the source unit is not automatically allocated. Once the source and destination
units have been determined, the connection is allocated. Following allocation, Batch Manager
evaluates the status of the phase. If the phase is Ready, the formula parameter values are down-
loaded to the control system and the phase is started. Typically, the phase status changes to Run.
Batch Manager monitors the status of the phase waiting for it to change. Under normal circum-
stances, the phase status eventually goes to Done. Upon seeing the Done, Batch Manager resets
the phase. The phase status returns to Ready. When Batch Manager evaluates the phase and finds
a status of Interlocked, Batch Manager waits indefinitely until the interlock has cleared. When
Batch Manager finds a status of Run, Held, Done, or Aborted, Batch Manager displays an error
message for an unexpected phase status.

Manual Transfer Phases

Manual Type Transfer Phases require unit and connection allocation and also require the operator
to Acknowledge the completion of the phase. Manual Transfer Phases typically include instruc-
tions which the operator must perform. When the instructions have been performed, the operator
acknowledges the phase.

Transfer Phases with Material Input Parameters

Automatic Transfer Phases
When an automatic transfer phase with an input parameter is encountered in a recipe, Batch
Manager performs a search of the Materials database in order to find the unit containing the
material to be transferred. The connection phase that is executed has a source unit corresponding
to the unit found in the materials database and the allocated unit as the destination.
When the material transfer is complete, Batch Manager decrements the material quantity from
the materials database if material tracking information has been defined. The quantity used and
the associated lot number(s) are logged to history. When the material has multiple tracking lots

366
10. Batch Management System B0193YB – Rev C

defined, it is possible to use material from more than one lot in a batch. When this occurs, Batch
Manager uses a first-in, first-out (FIFO) approach and decrement the first lot to zero, removes the
lot from the material database, and decrements the remaining quantity from the second lot. Both
quantities and their respective lot numbers are logged to history.

NOTE
The FIFO approach can be changed to last-in, first-out (LIFO) by using the LIFO
Materials application parameter for Batch Manager in the Environment Editor.

Semi-Automatic Transfer Phases

When a semi-automatic transfer phase is encountered, Batch Manager requires an Acknowledge
from the operator before the “automatic” part of the phase is executed. However, Batch Manager
does not search the Materials database for the location of the material. A common semi-automatic
transfer phase is a Drum Addition. Typically, the phase requires the operator to prepare the drum
and delivery system before the “automatic” part of the phase can be executed. Also, the operator
may be required to enter a material lot code before recipe execution continues. The lot code
requirement is set when the phase is defined in the process model.

Manual Transfer Phases

When a manual transfer phase is encountered, Batch Manager is responsible for the execution of
the phase. The phase does not execute in the control system, although Batch Manager may use
information, such as the Actual Value as measured by the control system in executing the phase.
The material information is stored in the historical database, but Batch Manager does not interact
with the materials database for lot tracking information. Additionally, Batch Manager writes the
Target Value to the control system if a tag is assigned to the Target element in the process model.
By default, when a phase executes, material information is stored in the historical database when-
ever the Lot Code tag and requirement are enabled in the process model. In this case, Batch Man-
ager does not interact with the materials database for lot tracking information.
If a material is assigned to a unit in the Material Location Assignment Editor, then the associated
Lot Tracking Information is stored to the historical database.
Depending on how the phase is configured in the process model, operator interaction with the
phase varies. Listed below are various approaches that can be configured in the process model for
manual transfers.

Manual Addition Using a Connected Scale

Material is weighed by a scale that is attached to the control system. The operator is required to
enter the material lot code for the material if configured in process model. When the weight is
within the material deviations, the operator acknowledges the completion of the phase. Batch
Manager logs the material ID, target quantity, actual quantity, and lot code to history.
When the addition requires multiple lots of the same material, the operator must enter the lot
code for the first lot and acknowledge the completion of the phase. Batch Manager decrements
the actual quantity from the target, recalculates the target quantity, and re-executes the phase.
This occurs until the original target is achieved.

367
B0193YB – Rev C 10. Batch Management System

Manual Addition Using an Unconnected Scale

Material is weighed on a scale that is not attached to the control system. The operator is required
to enter the material lot code if configured in the process model and the actual weight, then
Acknowledge the completion of the phase.
When the addition requires multiple lots of same material, the operator must enter the lot code
for the first lot and acknowledge the completion of the phase. Batch Manager decrements the
actual quantity from the target, recalculates the target quantity, and re-executes the phase. This
occurs until the original target is achieved.

Acknowledge Addition of Material

In this approach, materials are pre-weighed prior to the final production. As materials are added,
the operator acknowledges the addition of the material. Batch Manager records the material usage
by using the target quantity as the actual quantity.

Manual Addition - With Scale and Without Scale

The addition may have two parts, For example, 60 pounds of salt must be added. Salt comes in 50
pound bags. A scale is attached to the control system. A 50 pound bag is added to the batch. The
operator enters 50 as the actual quantity and the material lot code then acknowledges the comple-
tion of the phase. Batch Manager decrements the actual quantity from the target, recalculates the
target quantity, and re-executes the phase. The remaining material (10 pounds) is weighed on the
scale. When the weight is within tolerances, the Operator must enter the material lot code and
then acknowledge the completion of the phase.
In order for the above manual addition to function properly, control system logic must be
designed to disable the scale input when the operator enters the actual bag weights. A Control
Button can be assigned to do this. The Control Button disables the scale from overwriting the
entered value.

Transfer Phases with Material Output Parameters

When Batch Manager encounters a transfer phase that has an output type parameter, the appro-
priate destination unit and connection are allocated. The actual quantity of product transferred
may or may not be measured automatically. In some cases it is desirable for the operator to enter
in the actual quantity. Either of these situations can be handled and is determined by how the
phase is configured in the process model. Batch Manager logs to history the target and measured
or operator-entered actual value, if the phase is configured as such. If the actual is not measured or
the operator is not required to enter the actual, Batch Manager assumes the actual is equal to the
target and both are logged.
For automatic transfer phases, Batch Manager assigns the unit to the material and increment the
material quantity in the materials database. The quantity produced and the associated batch iden-
tification (Campaign ID, Lot ID, and Batch ID) are logged to history.

Continue Mode Execution

As described previously, under normal circumstances Batch Manager waits until a process or
transfer phase becomes Done or Aborted before executing the next phase in the recipe. This
behavior can be changed by enabling the Continue mode property for a phase in the recipe.
When encountered in a batch, Batch Manager starts the phase as it normally does. However,
Batch Manager does not wait for the phase to complete before moving on in the batch. As soon as
the phase returns a status of Run or Held, Batch Manager continues on in the recipe. Any phase

368
10. Batch Management System B0193YB – Rev C

with the Continue mode property enabled and executing remains in the active Phase List and can
be monitored and controlled just as any other active phase. If the recipe execution has moved on
to a subsequent operation, the operation with a phase running with the continue mode property
enabled is displayed in cyan. This allows the operator to identify unfinished operations easily.

NOTE
Use caution when enabling the continue mode property for any phase within a loop
object. Because of the risk of re-executing an active phase, batch execution does not
proceed into the loop in which a phase with the continue mode property enabled is
active. As soon as the phase completes, batch execution proceeds into the loop.

Because the phase is executing normally, it also must finish like a normal phase. Batch execution
does not end until all phases have completed. Therefore, any phase with the Continue mode
property enabled is required to complete either normally according to the internal phase logic or
based upon some external signal. An example of the use of the Continue mode is vessel agitation.
It is not unusual for agitation to span multiple operations. When this is required, the recipe
builder is forced to use “one-shot” phases that start the agitator and then complete, or to use com-
plex branching to keep the agitator running throughout the course of the multiple operations.
Using one-shot phases is undesirable because even though the agitator remains running, the phase
is no longer active and cannot be controlled. The branching option is also undesirable if the recipe
builder does not have experience with the process. The Continue mode option allows the agita-
tion phase to be placed in the recipe as required without complex branching and remains active
until it ends on its own or until another phase or external signal tells the phase to end. Thus, it is
always visible and can be controlled.

Contention for Shared Equipment

In most plants, there are situations where one piece of equipment is shared by many units. In the
example process shown below, Pump 1 is used to transfer product from Unit 1 to Unit 3, Unit 1
to Unit 4, Unit 2 to Unit 3, and Unit 2 to Unit 4.

Unit 1 Unit 2

Pump 1

Unit 3 Unit 4

Figure 10-41. Units Sharing Equipment

There are several methods for managing the contention of the use of the pump. One of the meth-
ods defines each source unit/destination unit combination as a connection in the process model.
With this method only one of the transfers (one connection) can be functioning at any one time
because there is only one pump. For this method in the above example, there is one connection

369
B0193YB – Rev C 10. Batch Management System

phase for each connection. Therefore, in this example, there are four phase logic blocks in the
control system. Since there is only one pump to handle all four connections, the four phase logic
blocks must be interlocked with one another.
Using this method, contention for use of the pump is handled as follows. When the batch in Unit
1 or Unit 2 is ready to transfer to either Unit 3 or Unit 4 and the destination unit is Ready, then
Batch Manager allocates the destination unit. Knowing the source unit and the destination unit,
Batch Manager can determine which phase logic block to enable to execute the transfer. If a trans-
fer phase is executing between Unit 1 and Unit 3, the phase blocks associated with the three other
connections are inhibited because of the interlocking done in the control system. If Batch Man-
ager needs to execute a transfer between Unit 2 and Unit 4, it waits until the Unit 1 to Unit 3
transfer is complete. When the transfer is complete, the interlocks are released on the three other
connection phases. The phase status changes from Interlocked to Ready, and Batch Manager is
then able to proceed with the transfer.
Another method requires defining segments, as well as connections, in the Process Modeling Edi-
tor. The segments assume one of the statuses defined in the model. The availability of each of the
connections corresponds to the status of all the segments that have been assigned to the connec-
tion. Batch Manager is only able to utilize connections that are available.
Using this method, contention for use of the pump is handled as follows. When the batch in Unit
1 or Unit 2 is ready to transfer to either Unit 3 or Unit 4 and the destination unit is Ready, then
Batch Manager evaluates the availability of the connection from the status of each segment
assigned to the connection. If an available connection is found, the destination unit and connec-
tion are allocated, and the proper connection phase is enabled. This method requires no extra
control system interlocking. When the transfer is complete, the segment statuses changes accord-
ingly, and the availability of the connection is automatically updated.
If connections and/or segments are not defined in the process model and transfers are performed
by co-ordinating the simultaneous execution of multiple process phases, Batch Manager evalua-
tion process is different. Batch Manager insures that a suitable source unit and destination unit are
allocated. However, the control system is responsible for interlocking the remaining process
phases from executing until the transfer of material has been completed.

Runtime Recipe Procedure Jumps - Jump Mode

Run-time recipe procedure jumps, or the Jump mode, is a feature of the batch management sys-
tem that offers the flexibility to allow an operator to reposition the execution pointer within a
batch and then restart it at that point. The Jump mode is available in Batch Display and Batch
View. This feature, along with the flexibility it provides, can also produce undesired results with-
out careful consideration. The following selection describes the actions taking place within the
batch management system related to the Jump mode.
When a batch is put in Held, Batch Manager sets the Hold bit for all units allocated to the batch
and all phases that are executing in the batch. Therefore, all allocated units and all active phases
are in Held. When the Jump Mode is initiated, you are notified by a dialog box that all Held
phases are aborted. Upon acknowledgement, the Batch Status changes from Held to Locking, and
then to Locked. What essentially occurs when a batch changes from Held to Locking is a batch
Abort. Specifically, all the phases associated with the batch are aborting. When the status changes
from Locking to Locked, all phases are aborted and all activity is logged to History.
When the batch status is “Locked”, the batch no longer has an execution pointer. If, at this point,
a user attempts to close Batch Display or View or exit Jump mode, an error message is displayed

370
10. Batch Management System B0193YB – Rev C

disallowing the action. If Jump mode has been entered and an abnormal termination of the Batch
Display or Batch View occurs, the batch is placed in Held (as if Jump mode had not yet been ini-
tiated) and a message indicating that the batch does not have and execution pointer is displayed.
In this case, if a user attempts to restart the batch (which has no execution pointer), a message is
displayed advising you to go to Jump mode, define a pointer, and then restart the batch.
Abnormal termination of a batch that has not been started results in the batch changing from a
Locked to Ready status. Under these circumstances, the execution pointer is at the start of the rec-
ipe procedure and allows a batch to start. A batch that does not have an execution pointer can be
aborted. The execution pointer is always at the start of the recipe procedure for a batch with a
Ready status.

Jump Mode Security

The Jump mode can be implemented using batch system security. Configuring security for the
Jump mode can help prevent untrained or unauthorized operators from unknowingly entering
the Jump mode and causing undesired results to recipe execution. Using the Security Editor, you
can configure the Done_By and Check_By security levels to limit access to the Jump mode. In
this case, the entry of an operator name and password as well as a supervisor name and password is
required in order to access the Jump mode.
If Done_By security is configured, a security dialog box is displayed when the operator attempts
to enter Jump mode. If a valid ID and Password are entered, the operator is allowed to use the
mode. If both Done_By and Check_By security are enabled, then the operator and a second user
(perhaps a supervisor) is required to enter a valid ID and Password.
All Done_By and Check_By security information is logged to History.
For more information on the Security Editor, see Chapter 14 “Security System”.

Report Triggering
Reports can be linked to any phase in a recipe procedure. The report is triggered when the phase
is complete. Also, if an end of batch report is defined, Batch Manager signals the Information
Server upon completion of the batch. Batch Manager passes the name of the report, the Cam-
paign ID, Lot ID, and Batch ID.

End Of Batch Operation

When the recipe procedure has executed to completion or a batch is Aborted, Batch Manager
releases any allocated units and triggers an End of Batch Report if configured to do so.

Batch Runtime Errors

The following errors may be displayed during batch execution. In all cases, when an error occurs,
an error message is displayed.

Error: Cannot change mode of <MANUAL OPERATION> batch!

Reason: Manual mode is the only valid Batch Execution mode when in Manual
Operation.
Corrective Action: Acknowledge Error Window.
Error: Unexpected phase status of READY!
Error: Unexpected phase status of RUN!

371
B0193YB – Rev C 10. Batch Management System

Error: Unexpected phase status of HELD!

Error: Unexpected phase status of DONE/ABORTED!
Error: Unexpected phase status of INTERLOCK!
Reason: #1 - You are trying to execute the same phase in parallel in your recipe pro-
cedure, or there is a problem with the phase logic.
Corrective Action: Correct the recipe procedure or the phase logic.
Reason: #2 - Batch Manager was shut down and phase logic has been left in an
improper state.
Corrective Action: Manually reset the phase and restart Batch Manager.
Error: Cannot access material “material ID”! - Hold Batch; Correct Problem;
Restart.
Reason: Phase is an Automatic Transfer. Batch Manager cannot find the material in
the Train assigned to the batch.
Corrective Action: Put the batch in Hold, correct the problem, then Restart the batch. The
problem may require one or both of the following corrections.
1. Change the train to include the appropriate units containing the material
in question.
2. Make the appropriate material-unit assignment using the Material Editor.
Error: Cannot access transfer “transfer name”! - Hold Batch; Correct Problem;
Restart.
Reason: #1 - A connection associated with the transfer cannot be found in the train.
Corrective Action: Put the batch in Hold. Modify the Train to include the appropriate unit
that would support the transfer. Restart the batch.
Reason: #2 - The batch is assigned to a train that cannot properly execute the recipe.
Corrective Action: Make sure the batch is assigned to a train that can properly execute the
recipe.
Reason: #3 - The connection has not been entered in the process model.
Corrective Action: Abort the batch. Stop execution of the Batch Management System. Add and
assign the connection to the appropriated transfer class using the Process
Model Editor. Restart the Batch Management System.
Error: Cannot access process “process name”! - Hold Batch; Correct Problem;
Restart.
Reason: A unit associated with the process cannot be found in the train. The unit
needed for the process was most likely deleted from the train after the batch
was started.
Corrective Action: Put the batch in Hold. Modify the Train to include the appropriate unit
that would support the transfer. Restart the batch.
Error: Invalid Query Data
Reason: An InBatch database is incompatible or corrupt. This error is related to the
security system.
Corrective Action: Verify/correct database.

372
10. Batch Management System B0193YB – Rev C

Batch Schedule Errors

The following errors may be displayed during batch scheduling. In all cases, when an error occurs,
an error window is displayed. Corrective action must be taken and the window acknowledged by
the operator before the batch execution returns to normal.

Error: Entry is not next in schedule!

Reason: Schedule Execution mode is set for Execute in Order and the
selected batch is not the next READY batch in the schedule.
Corrective Action: Select the next batch that is READY in the schedule.
Error: Cannot find entry!
Reason: The batch that was selected from the schedule was deleted by
another operator using the Batch Scheduler just prior to selection.
Corrective Action: Select another batch.
Error: Batch Status is not READY!
Reason: You are attempting to start a batch that appears to have a status of
READY. Just prior to starting the batch, another operator either
Started it from another Batch Display or the status of the batch was
changed to OPEN, using the Batch Scheduler.
Corrective Action: Select another batch.
Error: Cannot find recipe!
Reason: You are attempting to start a batch whose recipe has been deleted
from the recipe database.
Corrective Action: Re-schedule the batch with a valid recipe.

Warm Restart
Batch Manager has the capability to recover from abnormal events such as system shutdowns due
to hardware failures and other unanticipated failures. This functionality is known as Warm
Restart. As the batch management system executes batches, all batch execution and equipment
allocation information is written to multiple data files. In the event of a system failure, these files
are read by the batch management system when restarted. The data in these files allows the batch
management system to resume batch operation.

Starting Batch Manager with Warm Restart Function

Batch Manager is started in the usual manner to enable the Warm Restart functionality. There are
no special startup commands necessary. The only requirement for Warm Restart is the presence of
a .BatchWR folder located in the configuration folder (config_A). The .BatchWR folder is auto-
matically loaded in the configuration directory following system installation
(…\Batch\cfg\config_A\.BatchWR).

373
B0193YB – Rev C 10. Batch Management System

Batch
Manager
Warm Restart
Data Files

Control System
Phase Logic

Figure 10-42. Warm Restart Function

Batch Execution
As the batch management system executes batches and allocates equipment, Batch Manager stores
each event in data files residing in the .BatchWR folder. By retaining all batch execution and
equipment allocation actions, Batch Manager can resume batch execution following a system fail-
ure. In the event of a failure, the sequence of operation in the following list occurs. Operator
interaction is denoted where applicable.
1. Upon the occurrence of a system failure, the batch control system must be completely
shut down if the failure did not automatically accomplish this.
2. The batch control system must then be restarted.
3. All equipment allocated by any of the previously active batches remains allocated.
4. All batches previously in the Batch Scheduler are returned to the scheduler with their
previous status. The exceptions are that the Execute in Order option in the Batch
Scheduler is not set upon restarting the system and all batches that were in the run
state prior to the failure are in the Held state when the system is restarted.
For more information on changing the mode in which batches are resumed, see
“Batch Restart Mode” below.
5. The statuses of all phases are unchanged during a system failure that does not involve
the control system. In other words, phases that were executing before the failure con-
tinue to execute during the failure. However, phases that previously had changed to a
status of Held, Done, or Aborted remain in that state until the batch management sys-
tem is restarted. Batch Manager resumes the batches controlling these phases, and
upon resuming these batches, Batch Manager restarts or resets the affected phases.
6. The mode of all batches and the value of all phase parameters are unchanged follow-
ing the restart of a failed system.

Batch Restart Mode

The default action of the batch management system upon restarting the system after a failure is to
resume all previously active batches with a status of held. This ensures that all unit allocation is
resolved properly and that no new phases are started automatically, causing a possible operator

374
10. Batch Management System B0193YB – Rev C

safety issue. However, this default batch-held state may be overridden when Batch Manager is
restarted. If it is the intention of the personnel with the proper authority to resume system opera-
tion with all batches retaining the state each was in when the failure occurred, then Batch Man-
ager application must be configured with the Restarting Batches application parameter in the
Environment Editor.
For more information on configuring the Environment Editor, see Chapter 4 “Environment
Management System”.
When Batch Manager is started with the Restarting Batches option, all batches that were in run
resume with a status of run. This applies for all possible batch states.

! WARNING
It is strongly recommended that the Restarting Batches option be used only by per-
sonnel that are very familiar with the operation of the batch system, the operation
of the control system, and the process itself.

Control System Synchronization

In cases where the control system phase logic is reset or executed manually during a failure of the
batch control system, it is possible for the two systems to disagree on a phase status when the
batch control system is restarted. In most situations, the batch management system is able to
recover from such a failure. However, there are times when the batch management system is
unable to resolve the phase transition, or it is unsafe for the phase to be initiated.
The table below provides a summary of the possible states that could be experienced by a system
shutdown. The rows refer to the current status of the phase in the control system following a shut-
down and restart. The columns refer to the status of the phase in the batch control system
following a shutdown and restart. Valid entries correspond to situations from which the batch
management system can recover. Re-Sync entries correspond to situations from which the batch
management system receives an unexpected status from the control system and must re-sync itself.
In the re-sync cases, Batch Manager assumes the status of the control system phase status is correct
and re-syncs with the control system and continues operation.

Table 10-10. Possible States at System Shutdown

Last Known Phase Status as Viewed by Batch Manager

Current Control System
Phase Status Ready Run Held Interlock None
Ready Valid Re-Sync Re-Sync Valid Valid
Interlock Valid Re-Sync Re-Sync Valid Valid
Run Valid Valid Valid Re-Sync Re-Sync
Held Valid Valid Valid Re-Sync Re-Sync
Done Valid Valid Valid Re-Sync Valid
Aborted Valid Valid Valid Re-Sync Valid

For example, suppose the batch management system is controlling a phase that previously had a
status of Run. If the batch control system is shut down and the phase in the control system con-
tinues execution and becomes Done before the batch control system is restarted, the batch man-

375
B0193YB – Rev C 10. Batch Management System

agement system recognizes this as a valid status transition, updates the status of the phase to
Done, and initiates a phase Reset. However, if the control system is also shut down and the status
of the phase becomes Ready, then Batch Manager assumes the control system and possible human
intervention caused the phase to go to Ready. Batch Manager assumes the phase is done and con-
tinues on to the next phase.

Manual Operation
The flexibility that Manual Operation provides does present the possibility of some unusual phase
states. This section describes the precautions and considerations of which you should be aware
when using phantom batches. If you need to access Manual Operation, you must be aware of the
phases that are executing manually, and must be able to resume or abort the phases after a system
failure. You should also be aware of how Batch Manager initializes Batch Display for Target, Hi
Dev, and Lo Dev values when tags are assigned to them.
If Manual Operation is being utilized and a system failure occurs, the following sequence of
events occurs:
1. All equipment that was manually allocated in order to execute phases through the
manual operation batch is not allocated when the system is restarted.
2. All phases that were active prior to the system shutdown are active while the system is
shut down. However, the state of the phases is unknown to the system when it is
restarted.
3. The operator using Manual Operation is responsible for returning to the Manual
Operation batch, manually allocating the equipment that was previously manually
allocated, and starting the phases that were previously active.
4. Upon restarting the previously active phases, the status of the phase is the current sta-
tus of the phase in the control system. Thus, the phase may go to Run, Held, Done,
or Aborted, depending on the actual state of the phase in the control system.
5. The operator can continue manual operation as normal.
Operator actions are required to rectify the manual operation status.

NOTE
Manual Operation can be made accessible only by personnel with the proper secu-
rity clearance. Therefore, it is their responsibility to clean up the manual operation
phases following a system failure. Failure to properly clean up the manually operat-
ing phases can cause problems when scheduled batches require the use of the “stray”
phases. It is also recommended that when Manual Operation is in use and a system
failure occurs, that Batch Manager be restarted without the Restarting Batches
option. This ensures that all batches are resumed in Held and that none of these
batches can automatically allocate equipment that is needed to clean up any phase
executed using manual operation.

Batch Display Attribute Considerations

If you are using Manual Operation and have created and configured tags for the Target, Hi Dev,
and/or Low Dev elements in your process model, you must be aware that the elements displayed
in Batch Display, regardless of how they are configured in the process model database may not
appear as you expect. For example, in your process model, you may have created a tag for an ana-

376
10. Batch Management System B0193YB – Rev C

log data class. For the Hi Dev element, you may have disabled the Edit Allowed attribute. When
you schedule and execute a phantom batch, the Edit Allowed attribute of the tag is enabled. Batch
Display, therefore, allows the Hi Dev value to be edited even though your process model was con-
figured to disable it.
The following table shows the relationship between each tag data class and element, and how the
Enable Display and Edit Allowed attributes are forced in Batch Display.

Table 10-11. Tag Data Class and Element Relationships

Tag Display Attribute

Tag Data Class and Element Enable Display Edit Allowed
Analog Target Hi Dev Low Dev Always Always
Discrete Target N/A N/A Always Always
String Target N/A N/A Always Always
Enumeration Target N/A N/A Always Always

377
B0193YB – Rev C 10. Batch Management System

378
11. History System
The History System databases are located on an I/A Series Batch Information Server. The
Information Server uses Microsoft SQL Server which stores and archives all information
related to the production of a batch. This includes events, process data, production information,
material usage, operator comments, operator actions, equipment used, and so forth. Historical
data can be accessed with Seagate Crystal Reports to develop comprehensive reports for your
batch system requirements.
Historical batch information is stored on an I/A Series Batch Information Server. The Informa-
tion Server uses Microsoft SQL Server, and is dedicated to the task of providing all database
requirements for the batch system. At the Batch Server and Batch Runtime Client levels,
Microsoft Access formatted databases are used for local storage in the event of a communications
failure with the Information Server during batch execution. These local databases are used by
Batch Manager whenever a connection to the Information Server is interrupted. When the con-
nection is restored, the local database content is read by the Information Server and the SQL
Server database is updated.
This User’s Guide is not intended to describe how to use Microsoft SQL Server. However, you
may want to use such tools as Microsoft Enterprise Manager for maintaining and viewing infor-
mation about the historical databases. For more information on using Microsoft SQL Server, refer
to the appropriate user references.
For more information on maintaining your history databases, including History Archiving proce-
dures, see Chapter 20 “System Administration”.
For more information regarding the Information Server and how to use Seagate Crystal Reports,
see Chapter 12 “Reporting System”.

History Database Tables

Use the following tables to understand the history data structure and facilitate custom report gen-
eration using Crystal Reports.
For more information on reporting, see Chapter 12 “Reporting System”.

AlarmComment
The AlarmComment table contains one record for each I/A Series Alarm Comment entered dur-
ing batch execution.

Table 11-1. AlarmComment

Field Allow Null Type Length

Batch_Log_ID No char 10
comment No varchar 256
DateTime No datetime 8
EnteredBy_User_ID No varchar 16

379
B0193YB – Rev C 11. History System

Table 11-1. AlarmComment (Continued)

Field Allow Null Type Length

messageId No uniqueidentifier NA
SeqNum No int NA

AnalogAlarm
The AnalogAlarm table contains one record for each I/A Series Analog Alarm generated during
batch execution.

Table 11-2. AnalogAlarm

Field Allow Null Type Length

ack_state No char 1
alarm_limit No float NA
alarmtype_msg No varchar 8
Batch_Log_ID No char 10
block_desc No varchar 33
block_name No varchar 15
compound_name No varchar 15
date_time No datetime 8
DateTime No datetime 8
in_out_txt No varchar 33
inhprt No char 1
letterbug No varchar 8
loopId No varchar 33
messageId No uniqueidentifier NA
messageTxtType No varchar 30
messg_text No varchar 81
messg_type No int NA
monotonictime No int NA
opr_err No int NA
parametername No varchar 8
pnt_no No int NA
point_name No varchar 15
priority No int NA
real_value No float NA
sbxno No char 1
sct_no No int NA
state_text No varchar 33
stepno No int NA
subrno No char 1

380
11. History System B0193YB – Rev C

Table 11-2. AnalogAlarm (Continued)

Field Allow Null Type Length

symbolicname No varchar 64
tenths No char 1
unit_txt No varchar 33
valid_time No int NA

Archive History

Table 11-3. ArchiveHistory

Field Allow Null Type Length

Archive_Desc No varchar 64
Archive_Device Yes varchar 30
Archive_Filename Yes varchar 254
Archive_IND Yes char 1
Description Yes varchar 512
HistoryDataEnd_DT Yes datetime 8
HistoryDataStart_DT Yes datetime 8
Job_Name No varchar 128
JobEnd_DT Yes datetime 8
JobStart_DT No datetime 8
Purge_IND Yes char 1
Restore_IND Yes char 1
Status_CD Yes char 1
Status_Description Yes varchar 256
Target_DB Yes varchar 30

AuditEvent
The AuditEvent table contains one record for system level event that is generated during batch
execution.

Table 11-4. AuditEvent

Field Allow Null Type Length

App_Name No varchar 16
Audit_Event_ID No uniqueidentifier NA
DateTime No datetime 8
Func_Lvl No varchar 8
Func_Name No varchar 16
Op_Station No varchar 16
Reason No varchar 100

381
B0193YB – Rev C 11. History System

Table 11-4. AuditEvent (Continued)

Field Allow Null Type Length

Recipe_ID No varchar 16
User_Name No varchar 30

BatchAdmin
The BatchAdmin table contains records for archive tasks defined in History Archive. History
Archive is responsible for the data in this table. The structure of this table is presented below.

Table 11-5. BatchAdmin

Field Allow Null Type Length

Archive_Desc No varchar 64
Archive_Device No varchar 30
Archive_Filename No varchar 254
Archive_IND No char 1
BatchAdmin_ID No char 10
Completion_CD No char 1
Completion_DT Yes datetime 8
Create_DT No datetime 8
End_DT No datetime 8
Purge_IND No char 1
Restore_IND No char 1
Schedule_DT No datetime 8
Scheduled_by_User No varchar 16
Start_DT No datetime 8
Status_CD No char 1
Status_Desc No varchar 255
Target_DB No varchar 30

BatchDetail
The BatchDetail table contains a record for every event in the execution of a batch. Events are
defined using an Action Code. The Action Codes are defined in the CodeTable table. Batch Man-
ager is responsible for the data in this table. The structure of this table is presented below.

382
11. History System B0193YB – Rev C

Table 11-6. BatchDetail

Field Allow Null Type Length

Action_CD No smallint NA
Batch_Log_ID No char 10
CheckBy No varchar 16
DateTime No datetime 8
DoneBy No varchar 16
Operation No varchar 16
Phase No varchar 16
PhaseLabel No varchar 9
UnitOrConnection No varchar 16
UnitProcedure No varchar 16

BatchIdLog
The BatchIdLog table contains a record for each batch produced. Batch Manager is responsible
for the data in this table. The structure of this table is presented below.

Table 11-7. BatchIdLog

Field Allow Null Type Length

Archive_CD No char 1
Batch_ID No varchar 16
Batch_Log_ID No char 10
Batch_Size No int NA
Campaign_ID No varchar 16
Log_Close_DT Yes datetime 8
Log_Open_DT No datetime 8
Lot_ID No varchar 16
Product_ID No varchar 16
Product_Name No varchar 16
Recipe_Approval_CD No smallint NA
Recipe_ID No varchar 16
Recipe_Name No varchar 16
Recipe_State No varchar 16
Recipe_Type No varchar 16
Recipe_Version No varchar 8
Train_ID No varchar 16

383
B0193YB – Rev C 11. History System

BatchQuestion
The BatchQuestion table contains a record for every question displayed and answered by the
operator during the execution of a batch. Batch Manager is responsible for the data in this table.
The structure of this table is presented below.

Table 11-8. BatchQuestion

Field Allow Null Type Length

Answer No smallint NA
Batch_Log_ID No char 10
CheckBy_User_ID No varchar 16
DateTime No datetime 8
DoneBy_User_ID No varchar 16
Question No varchar 40

BooleanAlarm
The BooleanAlarm table contains one record for each I/A Series Boolean Alarm generated during
batch execution.

Table 11-9. BooleanAlarm

Field Allow Null Type Length

ack_state No char 1
alarm_limit No float NA
alarmtype_msg No varchar 8
Batch_Log_ID No char 10
block_desc No varchar 33
block_Name No varchar 15
compound_Name No varchar 15
date_time No datetime 8
DateTime No datetime 8
in_out_txt No varchar 33
inhprt No char 1
letterbug No varchar 8
loopId No varchar 33
messageId No uniqueidentifier NA
messageTxtType No varchar 30
messg_text No varchar 81
Messg_type No int NA
monotonictime No int NA
opr_err No int NA
parametername No varchar 8

384
11. History System B0193YB – Rev C

Table 11-9. BooleanAlarm (Continued)

Field Allow Null Type Length

pnt_no No int NA
point_Name No varchar 15
priority No int NA
real_value No float NA
sbxno No char 1
sct_no No int NA
state_text No varchar 33
stepno No int NA
subrno No char 1
symbolicName No varchar 64
tenths No char 1
unit_txt No varchar 33
valid_time No int NA

CodeTable
CodeTable contains the codes and descriptions that are used in as part of other history tables.
This table is a permanent part of the History database and is not modified during batch execu-
tion. The structure of this table as well as the codes are presented below.

Field Allow Null Type Length

Code No smallint NA
Description No varchar 64

Table 11-10. CodeTable

Code Description
201 Batch Start
202 Batch Hold
203 Batch Restart
204 Batch Abort
205 Batch received Done
206 Batch received Close
207 Batch Warm Restart
208 Batch Redundancy Switchover
210 Allocate
211 Release
221 Phase wait for Allocate
222 Phase received Allocate

385
B0193YB – Rev C 11. History System

Table 11-10. CodeTable (Continued)

Code Description
223 Phase wait for Entry Ack
224 Phase received Entry Ack
225 Phase received Interlock
226 Phase received Ready
227 Phase set Start
228 Phase received Run
229 Phase set Hold
230 Phase received Held
231 Phase set Restart
232 Phase set Abort
233 Phase received Aborted
234 Phase received Done
235 Phase set Reset
236 Phase received Bad Ready
237 Phase received Bad Run
238 Phase received Bad Held
239 Phase received Bad Done Aborted
240 Phase received Bad Interlock
241 Phase wait for Req Edits
242 Phase received Req Edits
243 Phase wait for Req Cmmt
244 Phase received Req Cmmt
245 Phase wait for Exit Ack
246 Phase received Exit Ack
247 Phase wait for Start
248 Phase received Start
249 Phase resync
250 Phase wait for Entry Doc View
251 Phase received Entry Doc View
252 Phase wait for Entry Doc Ack
253 Phase received Entry Doc Ack
254 Phase wait for Exit Doc View
255 Phase received Exit Doc View
256 Phase wait for Exit Doc Ack
257 Phase received Exit Doc Ack
260 Batch mode changed to Automatic
261 Batch mode changed to Semi-Automatic
262 Batch mode changed to Manual

386
11. History System B0193YB – Rev C

Table 11-10. CodeTable (Continued)

Code Description
265 Phase set Control Button1
266 Phase set Control Button2
270 Unit Hold set
271 Unit Restart set
272 Unit Abort set
273 Force Transition True
274 Transition Start
275 Transition Stop
276 Transition True
277 Transition False
300 Yes
301 No
305 Approved for Production
306 Approved for Test
400 Batch set to Run
401 Batch set Held
402 Batch set Aborting
403 Batch received Lock
404 Batch received locking
405 Batch received Locked
406 Batch received Unlock
410 Unit Received Ready
411 Unit Received Run
412 Unit Received Held
413 Unit Received Alarm

Config

Field Allow Null Type Length

Tag No
Value No

DocViewEvent
The DocViewEvent table contains one record for each event that is generated when batch execu-
tion requires you to view and acknowledge an external document.

387
B0193YB – Rev C 11. History System

Table 11-11. DocViewEvent

Field Allow Null Type Length

Batch_Log_ID No char 10
CheckBy_User_ID No varchar 16
DateTime No datetime 8
Doc_Desc No varchar 120
Doc_Loc No varchar 254
DoneBy_User_ID No varchar 16
Operation_ID No varchar 16
Phase_ID No varchar 16
Phase_Instance_ID No char 10
Phase_Label No varchar 8
UnitORConnection_ID No varchar 16
UnitProcedure_ID No varchar 16

EquipStatus
The EquipStatus table contains a record for every unit or segment status transition. Batch Man-
ager is responsible for the data in this table. The structure of this table is presented below.

Table 11-12. EquipStatus

Field Allow Null Type Length

CheckBy_User_ID No varchar 16
DateTime No datetime 8
DoneBy_User_ID No varchar 16
ESField1 No varchar 16
ESField2 No varchar 16
ESField3 No varchar 16
ESField4 No varchar 16
ESField5 No varchar 16
ESField6 No varchar 16
ESField7 No varchar 16
ESField8 No varchar 16
Last_Recipe_ID No varchar 16
New_Status No varchar 16
Old_Status No varchar 16
Operator_Comment No varchar 40
Recipe_ID No varchar 16
UnitOrSegment No varchar 16

388
11. History System B0193YB – Rev C

ErrorQ

Table 11-13. ErrorQ

Field Allow Null Type Length

ErrorDescription No varchar 1024
ErrorId No int 4
LastAttempt No datetime 8
Message No varchar 1024
RetryCount No int 4

Event

Table 11-14. Event

Field Allow Null Type Length

Alarm_State No varchar 10
Alarm_Type No varchar 4
Batch_Log_ID No char 10
DateTime No datetime 8
Engineering_Units No varchar 16
Event_CD No varchar 3
Event_Comment No varchar 50
Group_Name No varchar 32
Operator_ID No varchar 16
Priority No int NA
Tag_Name No varchar 84
Tag_Value No varchar 16
Tag_Value_Limit No varchar 16
UnitOrConnection No varchar 16

MaterialChar
The MaterialChar table contains a record for every characteristic defined for a material used in a
batch. Batch Manager is responsible for the data in this table. The structure of this table is pre-
sented below.

Table 11-15. MaterialChar

Field Allow Null Type Length

Batch_Log_ID No char 10
Material_Char_Value No float NA
Material_Characteris No varchar 16
Material_ID No varchar 16

389
B0193YB – Rev C 11. History System

Table 11-15. MaterialChar (Continued)

Field Allow Null Type Length

Material_Instance_ID No varchar 10

MaterialInput
The MaterialInput table contains a record for every material consumed in a batch. Batch Manager
is responsible for the data in this table. The structure of this table is presented below.

Table 11-16. MaterialInput

Field Allow Null Type Length

ActualQty No float NA
Batch_Log_ID No char 10
DateTime No datetime 8
Material_ID No varchar 16
Material_Instance_ID No varchar 16
Material_Name No varchar 41
Material_Parameter No varchar 16
Mtrl_Batch_ID No varchar 16
Mtrl_Campaign_ID No varchar 16
Mtrl_Lot_ID No varchar 16
Operation_ID No varchar 16
Phase_Parameter_ID No varchar 16
Phase_ID No varchar 16
PhaseLabel No varchar 9
TargetQty No float NA
UnitOfMeasure No varchar 13
UnitOrConnection No varchar 16
UnitProcedure No varchar 16

MaterialInputChange
The MaterialInputChange table contains a record for every quantity change made by an operator
for a material consumed in a batch. Batch Manager is responsible for the data in this table. The
structure of this table is presented below.

390
11. History System B0193YB – Rev C

Table 11-17. MaterialInputChange

Field Allow Null Type Length

Batch_Log_ID No char 10
Check_By_User_ID No varchar 16
DateTime No datetime 8
DoneBy_User_ID No varchar 16
Material_ID No varchar 16
Material_Parameter No varchar 16
New_Target_Qty No float NA
Old_Target_Qty No float NA
Operation_ID No varchar 16
Phase_ID No varchar 16
Phase_Instance_ID varchar 16
Phase_Label No varchar 9
UnitOrConnection No varchar 16
UnitProcedure_ID No varchar 16

MaterialOutput
The MaterialOutput table contains a record for every material produced in a batch. Batch Man-
ager is responsible for the data in this table. The structure of this table is presented below.

Table 11-18. MaterialOutput

Field Allow Null Type Length

ActualQty No float NA
Batch_Log_ID No char 10
DateTime No datetime 8
Material_ID No varchar 16
Material_Name No varchar 40
Material_Parameter No varchar 40
Operation_ID No varchar 16
Phase_ID No varchar 16
Phase_Instance_ID No varchar 16
Phase_Label No varchar 9
Target_Qty No float NA
UnitOfMeasure No varchar 13
UnitOrConnection No varchar 16
UnitProcedure No varchar 16

391
B0193YB – Rev C 11. History System

NonBatchOperatorActions
The NonBatchOperatorActions table contains a group of one or more records for every operator
action that is not part of a batch. Event Manager is responsible for the data in this table. The
structure of this table is presented below.

Table 11-19. NonBatchOperatorActions

Field Allow Null Type Length

ActionType No int NA
block_name No varchar 15
compound_name No varchar 16
DateTime No datetime 8
Description No varchar 64
Messg_Type No int NA
Pad No int NA
parametername No varchar 8
Station No varchar 40

OperatorAction
The OperatorAction table contains a group of one or more records for every action of an operator
during a batch. Batch Manager is responsible for the data in this table. The structure of this table
is presented below.

Table 11-20. OperatorAction

Field Allow Null Type Length

ActionType No int NA
Batch_Log_ID No char 10
block_name No varchar 15
compound_name No varchar 16
DateTime No datetime 8
Description No varchar 64
Messg_Type No int NA
Pad No int NA
parametername No varchar 8
Station No varchar 40

OperatorComment
The OperatorComment table contains a group of one or more records for every comment entered
by an operator during a batch. Each record contains a portion (40 characters) of the comment.
The SeqNum field defines the comment sequence. Batch Manager is responsible for the data in
this table. The structure of this table is presented below.

392
11. History System B0193YB – Rev C

Table 11-21. OperatorComment

Field Allow Null Type Length

Batch_Log_ID No char 10
CheckBy_User_ID No varchar 16
DateTime No datetime NA
DoneBy_User_ID No varchar 16
Operation_ID No varchar 16
Operator_Comment No varchar 41
Phase_ID No varchar 16
Phase_Instance_ID No varchar 16
Phase_Label No varchar 9
SeqNum No int NA
UnitOrConnection No varchar 16
UnitProcedure_ID No varchar 16

PhaseInstruction
The PhaseInstruction table contains a group of one or more records for every phase instruction
presented to an operator during a batch. Each record contains a portion (40 characters) of the
instruction. The SeqNum field defines the instruction sequence. Batch Manager is responsible for
the data in this table. The structure of this table is presented below.

Table 11-22. PhaseInstruction

Field Allow Null Type Length

Batch_Log_ID No char 10
DateTime No datetime 8
Instruction No varchar 41
Operation_ID No varchar 16
Phase_ID No varchar 16
Phase_Label No varchar 9
UnitOrConnection No varchar 16
UnitProcedure_ID No varchar 16

ProcessLog
The ProcessLog table contains a record for every data sample logged. Process Log Manager is
responsible for the data in this table. The structure of this table is presented below.

393
B0193YB – Rev C 11. History System

Table 11-23. ProcessLog

Field Allow Null Type Length

Batch_Log_ID No char 10
Data_Class No varchar 12
DateTime No datetime NA
Tag_Name N varchar 84
Tag_Value No varchar 16
UnitOrConnection No varchar 16

ProcessVar
The ProcessVar table contains a record for the value of every phase process variable parameter
associated with a batch. Batch Manager is responsible for the data in this table. The structure of
this table is presented below.

Table 11-24. ProcessVar

Field Allow Null Type Length

Actual_Value No varchar 81
Batch_Log_ID No char 10
DateTime No datetime 8
Operation_ID No varchar 16
Parameter_ID No varchar 16
Phase_ID No varchar 16
Phase_Instance_ID No varchar 16
Phase_Label No varchar 9
Target_Value No varchar 81
UnitOrConnection No varchar 16
UnitProcedure_ID No varchar 16

ProcessVarChange
The ProcessVarChange table contains a record for every change made to a phase process variable
parameter by an operator during a batch. Batch Manager is responsible for the data in this table.

Table 11-25. ProcessVarChange

Field Allow Null Type Length

Batch_Log_ID No char 10
CheckBy_User_ID No varchar 16
DateTime No datetime 8
DoneBy_User_ID No varchar 16
New_Target_Value No varchar 81

394
11. History System B0193YB – Rev C

Table 11-25. ProcessVarChange (Continued)

Field Allow Null Type Length

Old_Target_Value No varchar 81
Operation_ID No varchar 16
Parameter_ID No varchar 16
Phase_ID No varchar 16
Phase_Instance_ID No varchar 16
Phase_Label No varchar 9
UnitOfMeasure No varchar 16
UnitOrConnection No varchar 16
UnitProcedure_ID No varchar 16

ReportDef

Table 11-26. ReportDef

Field Allow Null Type Length

ID No int 4
AutoBatchEnd No int 4
CrystalRpt No varchar 260
Description No varchar 120
Name No varchar 32
OutputPath Yes varchar 260
OutputToFile No int 4
OutputToPrinter No int 4
OutputType Yes int 4
Printer Yes varchar 260

ReportLog

Table 11-27. ReportLog

Field Allow Null Type Length

ID No int 4
Filename No varchar 260
ReportName No varchar 32
TimeStamp No datetime 8

395
B0193YB – Rev C 11. History System

ReportOutputTypes

Table 11-28. ReportOutputTypes

Field Allow Null Type Length

FilenameExtension No varchar 10
MimeType No varchar 50
Name No varchar 32
Value Yes int 4

ReportPrinters

Table 11-29. ReportPrinters

Field Allow Null Type Length

Driver No varchar 252
Name No varchar 252
Port No varchar 252

ReportQueue

Table 11-30. ReportQueue

Field Allow Null Type Length

ID No varchar 16
BeingProcessed No Boolean 1
FilenamePrefix No varchar 128
Name No varchar 32

ReportQueueParams

Table 11-31. ReportQueueParams

Field Allow Null Type Length

ReportQID No varchar 32
Name No varchar 32
Value Yes int 255

ReportViewers

Table 11-32. ReportViewers

Field Allow Null Type Length

Name No varchar 50

396
11. History System B0193YB – Rev C

SequenceBlock
The SequenceBlock table contains a record for each I/A Series Sequence Block associated with a
batch.

Table 11-33. SequenceBlock

Field Allow Null Type Length

ack_state No char 1
alarm_limit No float NA
alarmtype_msg No varchar 8
Batch_Log_ID No char 10
block_desc No varchar 33
block_name No varchar 15
compound_name No varchar 15
date_time No datetime NA
DateTime No datetime 8
in_out_txt No varchar 33
inhprt No char 1
letterbug No varchar 8
loopId No varchar 33
messageId No uniqueidentifier NA
messageTxtType No varchar 30
messg_text No varchar 81
messg_type No int NA
monotonictime No int NA
opr_err No int NA
parametername No varchar 8
pnt_no No int NA
point_name No varchar 15
priority No int NA
real_value No float NA
sbxno No char 1
sct_no No int NA
state_text No varchar 33
stepno No int NA
subrno No char 1
symbolicNAme No varchar 64
tenths No char 1
unit_txt No varchar 33
valid_time No int NA

397
B0193YB – Rev C 11. History System

Transition
The Transition table contains a record for every transition event. The events are: Start Transition,
Transition False, Transition True and Transition Forced. Batch Manager is responsible for the data
in this table.

Table 11-34. Transition

Field Allow Null Type Length

Batch_Log_ID No char 10
DateTime No datetime 8
Operation_ID No varchar 16
Transition_Desc No varchar 121
Transition_ID No varchar 16
Transition_Instance_ID No varchar 10
Transition_Label No varchar 8
UnitProcedure_ID No varchar 16

TransitionExpression
The TransitionExpression table contains a record for each Transition Expression that is encoun-
tered during batch execution.

Table 11-35. TransitionExpression

Field Allow Null Type Length

Batch_Log_ID No char 10
DateTime No datetime 8
Expression_Text No varchar 40
Operation_ID No varchar 16
SeqNum No int NA
Transition_ID No varchar 16
Transition_Instance No char 10
Transition_Label No varchar 8
UnitProcedure_ID No varchar 16

UserProfile
The UserProfile table contains a record that describes a user's identification. A record is generated
during batch execution whenever user identification is required.

398
11. History System B0193YB – Rev C

Table 11-36. UserProfile

Field Allow Null Type Length

Effective_TS No datetime 8
User_ID No varchar 16
User_Name No varchar 30

399
B0193YB – Rev C 11. History System

400
12. Reporting System
The reporting system provides I/A Series Batch users with the ability to schedule, view and
print reports relating to the batch history that is stored on the I/A Series Batch Information
Server (BIS). The user interface for the reporting system is a web browser which functions as a
reporting client by way of an HTTP connection. Accesses to all report configurations and batch
history on the Batch Information Server is established using a Microsoft Internet Information
Server (IIS).

Reporting System Components

The reporting system utilizes a variety of software components. Some are industry standard com-
ponents and others are unique to the I/A Series Batch system. This section describes the primary
components of the reporting system. It is recommended that you familiarize yourself with the
components as this will enable you to more clearly understand how to deploy the reporting sys-
tem for I/A Series Batch.

Information Server
The Information Server is an Intel™-based PC, running under Windows 2000 Server or
Windows NT 4.0 Server, and is dedicated to batch information management. The Batch Infor-
mation Server contains Microsoft SQL Server, a History Queue, History Queue Reader Service,
Report Queue, Report Queue Reader Service, and the Web Server (IIS) components.

History Queue
The History Queue is a first-in-first-out (FIFO) queue which is located on the Information Server
that is responsible for transferring all historical data from the Batch Manager on the Batch Server
to the Batch History Database on the Information Server. The History Queue is also responsible
for notifying the report queue of End-of-Batch and End-of-Phase events which trigger reports.

History Queue Reader

The History Queue Reader is a background executing task (service) which runs on the Batch
Information Server and is responsible for reading report requests from the history queue and
queuing report jobs to the SQL Server database.

Microsoft Internet Information Server (IIS)

IIS is a Microsoft application for publishing documents to an intranet or the internet.

Report Client
A Report Client is a Microsoft Internet Explorer (5.x or higher) that accesses the Information
Server by way of an HTTP connection (internet or intranet). The Microsoft IIS on the Informa-
tion Server contains the Active Server Page (ASP) content for all Report Configuration, Report
Scheduling and Report Viewing.

401
B0193YB – Rev C 12. Reporting System

Report Configuration
Report Configuration is accomplished using ASP content that is hosted on the Information
Server and accessed using a Report Client. Report Configuration allows users to create the map-
ping between the named report and the actual Crystal Reports report file (.rpt) on disk. This tool
also allows users to define the Information Server’s report output printer and/or report file output
path.

Report Queue
The Report Queue is a first-in-first-out (FIFO) queue located on the Information Server that
handles all requests for reporting activity. The queue also contains all parameter data necessary for
the execution of the report.

Report Queue Reader

This is a background executing task (service) which co-ordinates the generation of reports as
directed from the report queue.

Report Schedule
Report Scheduling is accomplished using ASP content that is hosted on the Information Server
and accessed using a web browser on a client PC. It allows users to define schedules for the
reports. Users can schedule reports on a one-shot basis or a repeating basis.

Report View
Report Viewing is accomplished using ASP content that is hosted on the Information Server and
accessed using a web browser on a client PC. Report Viewing allows users to run and view reports
on demand. It also provides the ability to save reports to disk and/or print them.

Reporting System Architecture

The following diagram is a high level overview of the reporting system.

402
12. Reporting System B0193YB – Rev C

Reporting Portal
Web Page

ReportSchedule

ReportConfig

ReportView

Report
Output

REPORTING CLIENT

HTTP
Web Browser

Batch Reporting
Web Server (IIS)
Server Components:
- Define
Crystal Server - Schedule
Component - Demand
- Security Intrface

SQL Server 7.0

Report Config
Crystal Reports Table
Directory

History
Tables

SQL Job
Table
BATCH INFORMATION
SERVER

Figure 12-1. Reporting System Overview

Reporting System Security

When the Information Server is installed, security is disabled. You can configure security for the
reporting system using the Security Editor to modify the parameters for the ReportWeb applica-
tion. When you enable security for the ReportWeb application, you are required to enter a User
ID and Password before the system can be accessed.
For more information on configuring security, see Chapter 14 “Security System”.

403
B0193YB – Rev C 12. Reporting System

Configuring Printers
All printers on which you intend to print must be installed on the Information Server and must
be associated with the same Windows account (User ID and Password). It is recommended that
you install your printers using the same account that you used when the Information Server soft-
ware was installed. If you do not use the same account, your printers are not available for selection
when you attempt to configure reports.
If you have installed the Information Server software using a different account than the one you
used when printers were installed, you can edit the InBatch_ReportQReader service in the
Windows operating system. Use the following procedure if you need to edit the
InBatch_ReportQReader service.
1. Stop the Wonderware Logger Service. You are advised that the InBatch_HistQReader
and InBatch_ReportQReader services will also be stopped.
2. Edit the InBatch_ReportQReader service Account and Password, and then save the
changes.
3. Start the Wonderware Logger Service, and then start the InBatch_HistQReader and
InBatch_ReportQReader services.
When the InBatch_ReportQReader service is started, the printers associated with the user
account that you specified are available for configuration.

Using The Batch Reporting System

The Batch Reporting web page provides access to the Report Configuration, Report Schedule and
Report View options.
If you have upgraded from an earlier version of I/A Series Batch, and have created or customized
Crystal Reports (*.rpt files), it is recommended that you review them before using them with the
latest software. In most cases, editing the reports based on the newer software results in faster per-
formance. Also, depending on your specific implementation, older Crystal Report files may not
work.

NOTE
When the Information Server is installed, the Report Path is C:\BatchInfoS-
erver\Crystal by default. The default Report Path is always associated with the C:
drive even if the Information Server is installed on a different drive. If the Informa-
tion Server is installed on a different drive, then Report Path must be edited using
the Config button on the Information Server's AdminWeb page. If you change the
Report Path, the ReportQReader service must be restarted. Users should consider
this when creating and editing recipes that include reports. For more information
on using the AdminWeb page, see Chapter 20 “System Administration”.

404
12. Reporting System B0193YB – Rev C

NOTE
I/A Series Batch v8.0 does not support expression triggered reports. If you were
using expression triggered reports in a previous version, they are converted when
you upgrade the databases and they will appear in the list of configured reports in
the ReportWeb web page. The report names will exist in the ReportDef table in
batch history. However, even though these reports will be listed, they will not be
generated.

Batch Reporting
To Open the Batch Reporting Web Page:
♦ In the Environment Display, click the BatchReport icon.
If you want to access the Batch Reporting web page from a different computer on
your network, you need to use the following URL address: http://<computer
name>/ReportWeb, where <computer name> is name of the computer on which the
Information Server is installed.

405
B0193YB – Rev C 12. Reporting System

Report Configuration
The Report Configuration web pages allow you to view, edit, delete, and add report configura-
tions to the reporting system.

To Open the Report Config Web Page:

1. Click the Report Config button on the Batch Reporting web page.
If security is enabled, enter a valid User ID and Password and click Login. For more
information on managing User IDs and Passwords, see “Reporting System Security”
on page 403.

2. All reports that have been previously configured appear in the Configured Reports
list.

To Add a Report Configuration:

1. On the Report Config page, click the Add Report button to display the Add Report
Config page.

406
12. Reporting System B0193YB – Rev C

2. Enter the Report Configuration parameters described in the following table.

407
B0193YB – Rev C 12. Reporting System

Table 12-1. Report Configuration Parameters

Parameter Description
Name The name of the report.
Description (optional) Optional text that describes the report.
Crystal Report The name of the Crystal Reports template that will be
used for the actual report layout and content.
Auto Batch End Enable this checkbox to have the report generated
automatically at the end of a batch.
Output To Printer Enable this checkbox if you want the report to be
printed on a printer.
Printer The printer to which the reports will be sent.
Note: See “Configuring Printers” on page 404.
Output To File Enable this checkbox if you want to retain a file copy
of the report.
Output Path The name of folder on the Information Server where
the configured report will be printed.
Output Type The available report options are Crystal Report, CSV,
Excel, Text and Word. To view these reports, you
must have the appropriate application installed on the
Report Client.

3. When you have finished entering the required configuration data, click the Add
Report button.

To View or Edit a Report Configuration:

1. On the Report Config page, in the Configured Reports list, click the Edit icon for the
Name of the report that you want to edit.

408
12. Reporting System B0193YB – Rev C

2. Edit the report configuration using Table 12-1.

3. When you have completed your editing, click the Update Report button.

To Delete a Report Configuration:

1. On the Edit Report Config page, select the Delete button that corresponds to the
Name of the report that you want to delete.
2. When you delete the report, it is removed from system and its name is removed from
the Information Server database.

409
B0193YB – Rev C 12. Reporting System

NOTE
Before you delete any reports, it is recommended that you perform a backup.

Report Scheduling
The Report Schedule web pages allow you to define schedules for the reports that you have con-
figured. Reports can be scheduled for one-shot execution or on a recurring basis. The schedules
are stored on the Information Server and can be edited as your specific application requires.

To Open the Report Schedule Web Page:

1. Click the Report Schedule button on the Batch Reporting web page.
If security is enabled, enter a valid User ID and Password and click Login. For more
information on managing User IDs and Passwords, see “Reporting System Security”
on page 403.

410
12. Reporting System B0193YB – Rev C

2. All report schedules that have been previously defined appear in the Report Schedule
list.

411
B0193YB – Rev C 12. Reporting System

To Add a Report Schedule:

1. On the Report Schedule page, click the Schedule New Report button to display the
Add Report page.

2. Enter the parameters described in items described in the following table.

412
12. Reporting System B0193YB – Rev C

Table 12-2. Report Schedule Properties

Parameter Description
Name The name assigned for the scheduled report.
Options Enable this checkbox if you want to enable the report. If the box is not
enabled, the report is not executed.
Report Selection Select the name of the Report Configuration from drop-down list. The list
contains the report configurations that you have defined using the Report
Configuration pages.
Report Duration Allows you to set the amount of batch data you want to include by specify-
ing a period of elapsed time).

Preset Duration - Fifteen Minutes, Thirty Minutes, One Hour, Two Hours,
Four Hours, Eight Hours, One Day (24 Hours), and One Week

Custom Duration - Enter the duration in minutes

Description Optional text that describes the Report Schedule.

3. When you have finished entering the required schedule data, click the Save Report
Data button.
The Edit Report Schedules page lists the Report Properties which shows all details of
the schedules that have just been defined. You can make additional changes to the
schedule directly from this page.

413
B0193YB – Rev C 12. Reporting System

4. On the Report Schedule - Report Detail page, select the report schedule interval at
which the report recurs. The options are as follows.
♦ One Time Schedule
♦ Add Daily Schedule
♦ Add Weekly Schedule
♦ Add Monthly Schedule.

Add One Time Schedule

Use the One Time Schedule option if you want the report to execute one time.

414
12. Reporting System B0193YB – Rev C

Table 12-3. One Time Schedule

Parameter Description
Name The name of the report.
Options Enable this checkbox if you want to enable the report. If the box is not
enabled, then the report will not be executed.
Run Date/Time Date (mm/dd/yyyy) and the Time (hh:mm am/pm) that you want the
report to execute.

Add Daily Schedule

Use the Add Daily Schedule option if you want to schedule the report for daily execution.

Table 12-4. Add Daily Schedule

Parameter Description
Name The name of the report.
Options Enable this checkbox if you want to enable the report. If the box is not
enabled, then the report is not executed.
Occurs The frequency of recurrence (in days).
Daily Frequency The time and recurrence of the report. The options are:

Occurs Once At - Enter the specified time (hh:mm am/pm) at which you
want the report to execute.

Occurs Every - Enter the interval (in Hours or Minutes), and start and end-
ing time (hh:mm am/pm) at which you want report execution to occur.
Duration The length of time during which you want the report to execute. The
options are:

Start Date (mm/dd/yyyy) - The date of first execution.

No End Date - Use this option if you want report execution to occur on a
recurring basis (no stop date).

End Date (mm/dd/yyyy) - Use this option in conjunction with the Start
Date to specify the duration of the reporting period.

Add Weekly Schedule

Use the Add Weekly Schedule option if you want to schedule the report for weekly execution.

415
B0193YB – Rev C 12. Reporting System

Table 12-5. Add Weekly Schedule

Parameter Description
Name The name of the report.
Options Enable this checkbox if you want to enable the report. If the box is not
enabled, then the report will not be executed.
Occurs The frequency of recurrence (in weeks). Checkboxes are provided so that
you can select the day(s) of the week on which you want the report to
occur.
Daily Frequency The time and recurrence of the report for selected day. The options are:

Occurs Once At - Enter the specified time (hh:mm am/pm) that you want
the report to execute at.

Occurs Every - Enter the interval (in Hours or Minutes), and start and end-
ing time (hh:mm am/pm) that you want report execution to occur.
Duration The length of time during which you want the report to execute. The
options are:

Start Date (mm/dd/yyyy) - The date of first execution.

No End Date - Use this option if you want report execution to occur on a
recurring basis (no stop date).

End Date (mm/dd/yyyy) - Use this option in conjunction with the Start
Date to specify the duration of the reporting period.

Add Monthly Schedule

Use the Add Monthly Schedule option if you want to schedule the report for monthly execution.

Table 12-6. Add Monthly Schedule

Parameter Description
Name The name of the report.
Options Enable this checkbox if you want to enable the report. If the box is not
enabled, then the report is not executed.
Occurs The frequency of recurrence (in months). The options are:

Specify the day of the month on which you want the report to occur.

Specify the day of the week and the monthly recurrence of the report.

Example 1: The 2nd Friday of every 6 months.

Example 2: The Last Day of every 1 month.
Example 3: The 1st Day of every 12 months.

416
12. Reporting System B0193YB – Rev C

Table 12-6. Add Monthly Schedule (Continued)

Parameter Description
Daily Frequency The time and recurrence of the report. The options are:

Occurs Once At - Enter the specified time (hh:mm am/pm) at which you
want the report to execute.

Occurs Every - Enter the interval (in Hours or Minutes), and start and end-
ing time (hh:mm am/pm) for report execution.
Duration The length of time during which you want the report to execute. The
options are:

Start Date (mm/dd/yyyy) - The date of first execution.

No End Date - Use this option if you want report execution to occur on a
recurring basis (no stop date).

End Date (mm/dd/yyyy) - Use this option in conjunction with the Start
Date to specify the duration of the reporting period.

After you have defined the required Report Schedule, click Add Schedule on the Edit Report
Schedules page.

To View or Edit Report Properties and Schedules:

1. On the Report Schedule page, click the Name of the schedule that you want to view
or edit. This displays the Report Detail for the selected report.

2. To edit the Report Properties, click the here link.

417
B0193YB – Rev C 12. Reporting System

3. Edit the Report Properties as required. Refer to Table 12-2, on page 413 for more
information. After you have completed your changes, click the Save Report Data but-
ton to apply the changes.
4. To edit a Report Schedule, click the Name of the schedule that you want to edit.

5. Refer to the Table 12-2 page 413 for more information.

418
12. Reporting System B0193YB – Rev C

6. After you have completed your changes, click the Edit Schedule button to apply the
changes. The content of the page varies depending on the type of schedule that you
have defined.

To Delete a Report Schedule:

♦ On the Edit Report Schedule page, in the Report Schedules list, locate the name of
the schedule that you want to delete and then click Delete.
The report schedule is deleted from the Report Schedules list.

Report Viewing
The Report View web pages allow you to run and view reports that have been defined in your
system.

To Open the Report View Web Page:

♦ Click the Report View button on the Batch Reporting page.
If security is enabled, enter a valid User ID and Password and click Login. For more
information on managing User IDs and Passwords, see “Reporting System Security”
on page 403.

419
B0193YB – Rev C 12. Reporting System

All reports that have been previously defined appear in the Reports list.

To Run a Report:
1. On the Report View page, click the Run button associated with the report that you
want to view. This displays the Report View - Run Report page.

420
12. Reporting System B0193YB – Rev C

2. The contents of the Run Report page will vary depending on the type of report that
you have defined.
3. After entering the required information, click the Run button.
The specific output for a report depends upon the configuration you defined. Run-
ning a report may result in an output to a browser window, a file on disk, a printer
device, and so on.

421
B0193YB – Rev C 12. Reporting System

To View a Report:
1. On the Report View page, click the View button associated with the report that you
want to view. This displays the View Report page.
All instances for the selected report that have been printed to a disk file are listed.
2. Identify the instance (as determined by Date/Time) and then click the corresponding
View button.
Report formats are defined when you configure a report and include: Crystal Report,
CSV, Excel, Text and Word.

NOTE
Viewing a report requires the installation of the appropriate application on the sys-
tem on which you are viewing.

Creating Reports
The reporting system provides a Batch Journal report template which consists of a comprehensive
journal of batch history for a specific batch. Other report templates are provided with the soft-
ware; however, they are not supported and should only be used as examples which you can use to
design your own custom templates.

Unsupported Report Templates

The following report templates are intended only to be used as examples for the development of
custom reports. These templates are stored on the Information Server
(C:/BatchInfoServer/Crystal folder) and are accessed using Seagate Crystal Reports.

Table 12-7. Unsupported Report Templates

Report Name Description

AnalogAlarms Provides a listing of I/A Series analog alarms issued for a batch.
Alarm comments that were entered for an analog alarm by way of
the Alarm Comment application are also included in the report.
BatchDetail Provides a summary of all batch execution activity for a batch.
BatchesByMaterial Provides a list of batches that used a specific material or material
from a specific vendor.
BatchListing Provides a summary report of all batches produced.
BatchQuestions Provides a summary of all questions for a batch.
BooleanAlarms Provides a listing of I/A Series Boolean alarms issued for a batch.
Alarm comments that were entered for a Boolean alarm by way of
the Alarm Comment application are also included in the report.
DocumentViewEvents Provides a listing of the Documentation Review events for a recipe.
EquipmentStatus Provides a listing of all Equipment Status changes that occurred
during batch execution.
MaterialChar Provides a summary of all material characteristics for a campaign,
lot and batch.

422
12. Reporting System B0193YB – Rev C

Table 12-7. Unsupported Report Templates (Continued)

Report Name Description

MaterialInputChanges Provides a summary of the changes made by operators to the origi-
nal formula inputs quantities for a batch.
MaterialInputs Provides a summary of all materials consumed in a batch.
MaterialOutputs Provides a summary of all materials produced by a batch.
MaterialOutputTotals Totalizes all materials produced for a batch.
NonBatchOperatorAction Provides a summary of all non-batch-related operator actions.
OperatorAction Provides a summary of all operator actions during a batch.
OperatorComments Provides a summary of all operator comments for a batch.
PhaseInstructions Provides a summary of all recipe phase instructions for a batch.
ProcessLog1 Provides a summary of all process log values for a batch.
ProcessLog2 Provides statistical information of all process log values recorded
for a specific tag.
ProcessLog3 Provides a graphical representation of all process log values
recorded for a specific tag.
ProccessVariables Provides a summary of all process variable target and actual values
for a batch.
ProccessVariablesChanges Provides a summary of changes made by operators to the original
formula process variables for a batch.
ProductByLot Provides a summary of all finished products produced.
ProductionReport Provides a summary report that includes number of finished prod-
ucts produced, number of lots, number of batches and total quan-
tity produced.
SecurityListing Provides a summary report of all security related activity for a
batch.
SequenceBlocks Provides a listing of I/A Series sequence block messages issued for a
batch. Comments that were entered for each sequence block by
way of the Alarm Comment application are also included in the
report

423
B0193YB – Rev C 12. Reporting System

424
13. Process Logging
The Process Logging system captures data at periodic time intervals or based on the occurrence
of events, and then logs the data to a printer or to the history database for storage.
Use Process Log Editor to create Process Log Configurations and store them in the Process Log
Database. A Process Log Configuration consists of one or more groups of tags with each group
having its own logging criteria. The criteria specify how the groups of tags and their respective val-
ues are sampled and logged at run time by the Process Log Manager.

Figure 13-1. Process Logging

Process Log Criteria

Each Process Log Configuration consists of one or more groups of tags. Each group specifies its
own general logging criteria, consisting of a Log Trigger, Log Event and Data Destination. All tags
that are a part of the process model are available for selection.

General Logging Criteria

Log Trigger
The Log Trigger defines the condition(s) that initiate logging for the group. The Log Trigger
options are Always and On Event. If Always is selected, logging begins as soon as the run-time
Process Log Manager is started. If On Event is selected, a true/false Boolean expression is evalu-
ated. If the result of the expression is true, logging occurs.
Expressions are defined using the Expression Editor. The Expression Editor is used to create a
true/false Boolean expression using any of the tags in the process model. A Boolean expression, for
example, could simply be a discrete tag. When the tag is true (value of 1), logging for the group
begins. When the tag is false (value of 0), logging stops. An example is provided later in this
section.
For more information on building expressions, see Chapter 15 “Expression Editor”.

425
B0193YB – Rev C 13. Process Logging

Log Interval
The Log Interval defines the frequency of sampling for each tag in the group. The interval options
are On Event, 2 seconds, 5 seconds, 10 seconds, 30 seconds, 1 minute, 5 minutes, 15 minutes, 30
minutes, 1 hour, 2 hours, 4 hours, and 24 hours. If On Event is selected, a true/false Boolean
expression must be defined. The Expression Editor is used to create a true/false Boolean expres-
sion using any tag in the process model. Each time the expression is true, the data values for each
of the tags in the group are logged.

NOTE
Logging only takes place when the trigger and interval settings are satisfied. Also,
data is not logged when Process Log Manager is first started.

Figure 13-2. Expression Editor Window

This example shows a simple Boolean expression that initiates logging whenever ReactorA is
allocated.
For more information on building expressions, see Chapter 15 “Expression Editor”.

Data Destination
The data destination defines where the logged data is directed during run-time execution. Data
can be logged to the Historian, a printer, or both.

426
13. Process Logging B0193YB – Rev C

Tags
Tags that are logged as part of the group are assigned from the Tag Selection window which is
accessed from the Process Logger Group Editor. All analog and discrete tags in the process model
database are available for selection. You can select as many tags as you want.

Using Process Log Editor

Use Process Log Editor to create and edit configurations for logging. A configuration consists of
one or more groups of tags. The criteria for each group can be uniquely configured. You can cre-
ate an unlimited number of groups, each of which may contain an unlimited number of tags.

To Start the Process Log Editor:

1. Double-click the LogEdit icon in the Environment Display.
2. The Process Log Editor window appears.

3. Enter a Configuration Name (16-char max) and optionally, a Description (120-char

max).

NOTE
If you modify a Process Log Configuration that is in use by the run-time system,
you should stop and then restart the Process Log Manager so that your changes take
effect.

File Menu
Use the File menu to access system functions for your process log configurations.

File/New
Use the File/New command to create a new process log configuration.

To Create a Process Log Configuration:

1. Click File and then select New.
2. The Process Log Editor window appears.

427
B0193YB – Rev C 13. Process Logging

NOTE
If you edit a configuration and do not save it, you are prompted to save or discard it
prior to the creation of a new configuration.

3. Enter a Configuration Name (16-char max) and optionally, a Description (120-char

max).

File/Open
Use the File/Open command to open an existing process log configuration.

To Open a Configuration:
1. On the menu bar, click File and select Open.
2. The Configurations window appears.

NOTE
If you edit a configuration and do not save it, you are prompted to save or discard it
prior to opening a different one.

3. From the Configurations window, select the configuration that you want to open.
4. Click Open.

File/Save
Use the File/Save command to save a process log configuration.

To Save a Configuration:
1. On the menu bar, click File and select Save.
2. The Configurations window appears.

428
13. Process Logging B0193YB – Rev C

NOTE
The save option is unavailable if you have opened a configuration but have not
made any changes.

File/Validate
Use the File/Validate command to validate a process log configuration. The validation process ver-
ifies that all tagnames assigned in the configuration are available in the process model.

To Validate a Configuration:
1. On the menu bar, click File and select Validate.
2. The Validate window appears. If the validation is successful, the window displays the
message “Process Log configuration is valid.” If the configuration contains errors, all
invalid tagnames are listed.

File/Delete
Use the File/Delete command to delete a process log configuration from the database.

To Delete a Configuration:
1. On the menu bar, click File and select Delete.
2. The Delete window appears, requiring you to confirm the deletion.

NOTE
When you delete a process log configuration, it is removed from the database. How-
ever, Process Log Editor still displays the Configuration Name and Description of
the deleted configuration. To clear these fields, you must use the File/New
command.

File/Print
Use the File/Print command to select from one or more pre-formatted reports, and then print the
process log configuration. The print window also provides standard Windows printer options.

To Print a Configuration:
1. On the menu bar, click File and select Print.
2. The Print window appears.

429
B0193YB – Rev C 13. Process Logging

3. In the Select Reports list, select item(s) that you want.

4. Select other printer options as required.
5. Click OK to print the report and close the window.

NOTE
If you want to print several reports, press and hold the control or shift key, while
selecting from the list with the left mouse button.

File/Print Preview
Use the File/Print Preview command to select one or more formatted reports, and then view the
report(s) on the screen.

To Preview a Configuration Report:

1. On the menu bar, click File and select Print Preview.
2. The Select Reports window appears.

430
13. Process Logging B0193YB – Rev C

3. Select the report(s) from the list.

4. Click OK.

NOTE
If you want to preview several reports, press and hold the Control or Shift key, while
selecting from the list with the left mouse button.

File/Print Setup
Use the File/Print Setup command to select and configure a printer. Refer to your printer manu-
facturer’s documentation for more information.

To Set Up your Printer:

1. On the menu bar, click File and select Print Setup.
2. The Print Setup window appears.

File/Exit
Use the File/Exit command to close the Process Log Editor.

To Close the Process Log Editor:

On the menu bar, click File and select Exit.

NOTE
If you edit a configuration and do not save it, you are prompted to save or discard
the changes prior to closing the Process Log Editor.

Edit Menu
Use the Edit menu to access system functions to define the criteria for your process log
configuration.

431
B0193YB – Rev C 13. Process Logging

Edit/Groups
Use the Edit/Groups menu to define the criteria for your process log configurations. For each
group that you define, you must configure the general logging criteria and tags. General logging
criteria consists of configuring a Log Trigger, Log Interval, and a destination for the logged data.
The tags that are available for selection are those that exist in the process model.
For more information on configuring logging criteria, see “General Logging Criteria” on
page 425.
For more information on creating Process Log Groups, see “Creating a Process Log Group” below.

Creating a Process Log Group

The steps involved in the creation of a Process Log Group are summarized below.
♦ Create a Process Log Configuration
♦ Create a Process Log Group
♦ Define Trigger and Event
♦ Select Data Destination
♦ Select Tags.

To Create a Process Log Configuration:

1. On the menu bar, click File and then select New.

2. Enter a Configuration Name (16-char max) and an optional Description (120-char

max).
3. Click Edit and then select Groups.
The Process Logger Group Editor window appears.

432
13. Process Logging B0193YB – Rev C

4. Enter a Group Name, Name (16-char max) and an optional Description (120-char
max).
5. Click Add.
6. The Group Name that you entered appears in the Process Logger Group Editor
Group Names list.

NOTE
All Group Names are verified for uniqueness when you click Add or Change.

To Select a Log Trigger and a Log Interval:

1. Click Log Trigger and then select On Event.

433
B0193YB – Rev C 13. Process Logging

When you select the On Event option, you must also provide an expression, using the
Expression Editor, for the event.
2. Click the Expression button to open the Expression Editor.
3. Enter an expression. In this example, the Boolean expression,
{ReactorA---BATSZ.Value}>1000, initiates logging when the batch size in ReactorA is
greater than 1000.

4. Click OK to close the Expression Editor.

5. The expression that you entered appears in the expression field of the Process Logger
Group Editor.

6. Select a Log Interval by repeating repeat Steps 1 through 4.

For more information on building expressions, see Chapter 15 “Expression Editor”.
For more information on configuring logging criteria, see “General Logging Criteria” on
page 425.

To Select a Data Destination (Printer and/or Historian):

1. If you want to log process data to the history database, enable the Historian checkbox
in the Process Logger Group Editor window.

434
13. Process Logging B0193YB – Rev C

2. If you want to log process data to a printer, enable the Printer checkbox in the Pro-
cess Logger Group Editor window and then click the Printer button.
The Printer Selection dialog box appears.

3. Select the printer that you want from the list and then click OK.

To Select Tags:
1. On the Process Logger Group Editor, click Select Tags.
2. The Tag Selection window appears.

435
B0193YB – Rev C 13. Process Logging

3. From the list, select the tags that you want to include in the process log.

NOTE
You can sort the list by clicking a column heading. For example, to sort the list by
parameter, click the Parameter heading. If you want to select multiple tags, press
and hold the Control or Shift key, while selecting from the list.

4. Click OK.
5. The Tag Selection window closes and the tags that you selected appear in the Process
Logger Group Editor.

436
13. Process Logging B0193YB – Rev C

6. On the Process Logger Group Editor, click Close.

To Validate and Save the Configuration:

1. On the Process Log Editor, click File and then select Validate.
2. The Validate window appears.
3. Ensure that the window does not indicate an error, and then click Close.
4. Click File and then select Save.

NOTE
If you have not entered a Configuration name, you are prompted to do so. If you
have made changes to an existing configuration, you are prompted to overwrite the
configuration. If you have not made any changes to the configuration, the Save
option is unavailable.

Using Process Log Manager

Process Log Manager (LogMngr) is a run-time program that is responsible for retrieving and pass-
ing the data to the historian or the printer. Data is sampled and stored only when the conditions
specified for the log triggers and log intervals are met.
Process Log Manager continuously monitors all log triggers and log intervals in order to provide
the required logging for each group.

Starting Process Log Manager

Process Log Manager is a run-time application that is configured using the Environment Editor. It
is started from the Runtime Application Display window in Environment Display. A Configura-
tion application parameter corresponding to the configuration name defined in the Process Log
Editor is required.

437
B0193YB – Rev C 13. Process Logging

! WARNING
If you stop the Process Log Manager while it is in the process of logging data at a
fast interval, or if there is batch activity that results in data logging, data loss can
result. It is strongly recommended that you only stop Process Log Manager when
logging activity is minimal.

Runtime Logging Criteria

Process Log Manager logs tag values to the history database. Logging occurs only when a batch is
active for the associated unit or connection. The name of the unit or connection can be found in
the first field of the tagname. Batch information is obtained from the Information Manager
(InfoMngr) application at run time and recorded with the tag value in history.
For example, the ReactorA-Heat-Temp-ACT tag is only logged if there is a batch active in the
ReactorA unit.

NOTE
If a batch is not active within the unit or connection, the value is not logged.

438
14. Security System
The Security System provides a high level of protection for all recipe and batch management
applications, functions, operator stations, and products. System design is open and completely
configurable allowing external applications to be easily interfaced
Configuration of the system consists of defining system security parameters, security levels, opera-
tor stations, user accounts, application access security levels, and application function security
levels.
The security system consists of the Security Editor, Security Manager, and a Security Application
Program Interface (API).
The Security Editor is used to edit the system security configuration. All of the batch manage-
ment system applications and functions are provided with the system.
All applications utilize the Security API when security clearance is required. When needed, the
application prompts the operator for an ID and password. The information is compiled into a
security request message and sent to the Security Manager along with the application and/or func-
tion name, the operator station from where the request was made, and if applicable, the recipe
identification code. The Security Manager compares the security request with the information
defined in the security database and returns an OK or NOT OK result to the application making
the request. The application acts on the result accordingly.

439
B0193YB – Rev C 14. Security System

Figure 14-1. Security System

Using Security Editor

Use Security Editor to manage security configuration for the batch management system. This
includes adding, deleting, or changing security levels, operator stations, user accounts, applica-
tions, functions, and security level assignments.

To Start Security Editor:

1. In the Environment Display, double-click the SecEdit icon.

2. The Security Editor window appears.

440
14. Security System B0193YB – Rev C

NOTE
If security has been enabled for accessing Security Editor, the Security Clearance
Request window is displayed and you are prompted to enter a valid User ID and
Password.

Using Security Editor for the First Time

If you are using Security Editor for the first time, you are required to enter the default User ID
(system) and Password (system) in the Security Clearance Request window. You are then required
to enter and verify a new password in the New Password and Verify Password window.
Passwords must be at least six characters in length.

Figure 14-2. Entering User ID and Password

441
B0193YB – Rev C 14. Security System

File Menu
Use the Security Editor File menu to access system functions for Security Editor.

File/Validate
Use this command to validate security configuration. Validation consists of verifying that all the
recipes assigned to users exist in the recipe database and that the Password Timeout and Password
Reuse values are non-negative.
If the validation is successful, the validation window indicates that the configuration is valid. If
validation errors exist, the associated tags are displayed along with a validation error message.

File/Print
Use this command to display the Print window.

Figure 14-3. Print Window

Use the Select Reports list box to select one or more formatted reports.

File/Print Preview
Use this command to display the Select Reports window. You can select the report(s) that you
want and then preview them on the screen.

442
14. Security System B0193YB – Rev C

Figure 14-4. Select Reports Window

File/Print Setup
Use this command to set up your printer devices. Refer to your Windows documentation for
more information.

File/Exit
Use this command to close Security Editor.

NOTE
All your work is saved in the security database as you edit and make changes to the
security configuration.

Edit Menu
Use the Security Editor Edit menu to access security configuration windows.

Edit/Security Levels
Use this command to access the Security Levels Editor.

Edit/Operator Stations
Use this command to access the Operator Stations Editor.

Edit/User Accounts
Use this command to access the User Accounts Editor.

Edit/Applications-Functions
Use this command to access the Applications-Functions Editor.

Help Menu
Use the Security Editor Help menu to display online Help and view version information for
Security Editor.

443
B0193YB – Rev C 14. Security System

Help/Help Topics
Use this command to display online Help for Security Editor.

Help/About Security Editor

Use this command to view version information.

Security System Configuration

Use the Security Editor window to configure the overall operation of the security system. Proper
security system operation is dependent upon the options described below.

Security Enabled
Use the Security Enabled checkbox to enable or disable the entire security system. Disabling the
system may be desirable during startup or when maintenance on the process is required.

Retries
The Retries entry is associated with the number of requests a user is permitted to attempt in order
to obtain a security clearance. If the number of retries is exceeded, an error message is displayed
and access is denied. For example, if the retries value is set to 2, the error message is displayed
following the third invalid entry. If desired, the operator may immediately re-attempt to obtain
security clearance.

Password Time-out
The Password Time-out specifies the time period, in days, that a password is valid. Any passwords
older than the set period automatically expires. After a time-out, you are required to enter your
old User ID and Password before security clearance is granted. You are then required to change
your password when security clearance is requested

Password Reuse
The Password Reuse specifies the time period, in days, which must pass before a password can be
re-used. This feature prevents operators from repeatedly using the same password.

Comment
This optional field can be used to document or comment on the security system configuration.

Security Levels
Use the Security Levels Editor window to add, delete, and change security levels in the system.
Security level names are verified to ensure uniqueness. New security levels can be added to the
security system at any time. There is no restriction placed on the number of security levels that
you can assign.

444
14. Security System B0193YB – Rev C

Figure 14-5. Security Levels Editor

To Edit a Security Level:

1. In the Name field, enter a security level (16-chars max). You can also optionally enter
a Description (120-chars max) in the Description field.
2. Click Add if you are entering a new Name, or click Change if you are editing an exist-
ing Security Level.

To Delete a Security Level:

1. Select the Security Level that you want to delete from the list.
2. Click Delete.

NOTE
When a security level is deleted, all users that are assigned that level have their secu-
rity level assignment deleted. If a user does not have a security level, the user is not
able to obtain security clearance.

Operator Stations
The Operator Stations Editor dialog box is used to add, delete, and change operator stations in
the system.

445
B0193YB – Rev C 14. Security System

Figure 14-6. Operator Stations Editor

New operator stations can be added to the security system at any time, and there is no limit to the
number of stations that can be defined.
An operator station can be any computer that is a part of your system. The name defined for the
Batch Server or a Batch Configuration Client corresponds to the network host name assigned to
the node. The name defined for the Batch Runtime Client corresponds to the Client Type
Instance.

NOTE
Both the network host name and the client type instance name must be defined for
nodes that function as both a batch server and a run-time client.

To Edit an Operator Station:

1. In the Name field, enter an operator station (16-chars max). You can also optionally
enter a Description (120-chars max) in the Description field.
2. Click Add if you are entering a new Name, or click Change if you are editing an exist-
ing Operator Station.

To Delete a Security Level:

1. Select the Operator Station that you want to delete from the list.
2. Click Delete.

User Accounts
Use the User Accounts window to add, delete, and change users in the system.

446
14. Security System B0193YB – Rev C

Figure 14-7. User Accounts Editor

User account names are verified to ensure uniqueness. New users can be added to the security sys-
tem at any time, and there is no limit to the number of user accounts that can be defined.
You can assign passwords to a user and select specific recipes and operator stations on which the
operator is authorized. These account configuration options are described in the following
section.

To Edit a User Account:

1. Enter a User Name (30-chars max).
2. Enter a User ID field (12-chars max).
3. Use the Security Level, Password, Recipes and Op Stations buttons to assign addi-
tional security parameters to the account. Additional information on these buttons is
provided immediately following this section.
4. Click Add if you are entering a new User Account, or click Change if you are editing
an existing User Account.

To Delete a User Account:

1. Select the User Name that you want to delete from the list.
2. Click Delete.

447
B0193YB – Rev C 14. Security System

Security Level
Security Levels typically define a user’s job function, such as Operator, Supervisor, Lab Techni-
cian, Mixer Operator, Boiler Operator, Control Engineer.
Assign security levels by clicking the Security Level button.

Figure 14-8. Assign Security Levels Window

You can only assign one security level to a user.

Password
A password can be assigned to a user be selecting the Password button. A password must contain
between 6 and 12 characters.
Because the combination of user ID and password is always unique in the system, duplicate pass-
words are permitted. Passwords expire when the Password Timeout period defined for the system
is reached. User passwords are independently maintained.
If an invalid password is entered or the new and verified passwords are not the same, an error mes-
sage is displayed.
All passwords in the system are stored and transmitted in an encrypted format.

Figure 14-9. Change Password Window

448
14. Security System B0193YB – Rev C

Recipes
Use the Recipe Access window to assign recipes to a user. You can assign as many recipes to a user
as required. If you do not want an operator to have recipe access, you do not have to grant it.
Recipe assignments provide protection against operators working on products for which they have
not been trained.
Recipes can be assigned to a user by selecting the Recipes button.

Figure 14-10. Recipe Access Window

All recipes that have been approved for production or approved for test in the Recipe Editor are
available for assignment. In addition, all recipes can be assigned by enabling the All Recipe Access
checkbox.

NOTE
Security for the Delete Recipe Function does not restrict you to a specific number
of recipes to access when the recipe access list is intended to be restricted. This
allows you to delete any recipe in the list, not just the ones to which you are
restricted. RecipeEdit does not use Security Editor's list of recipes assigned to a user.
Recipes that are available for configuration in the Security Editor restrict run-time
access only. That is, the configuration that you are changing is applicable when the
listed recipes are executed as part of a batch. There is no real correlation between
recipe definition in the Security Editor and the Recipe Editor. To more appropri-
ately manage these types of requirements, you may want to configure each user's
security model, that is, the definition and configuration of users, levels, operator
stations, and so forth. When you are setting up the accounts, you can configure
each for unauthorized recipe deletion, saving, and so forth.

Operator Stations
Use the Operator Stations window to assign specific operator stations to users. You can assign as
many operator stations to a user as required. If you do not want an operator to have access to an
operator station, you do not have to grant it. Operator station assignments provide protection

449
B0193YB – Rev C 14. Security System

against operators working at operator stations for which they have not been trained or should not
have access.
Operator stations can be assigned to a user by selecting the Op Stations button.

Figure 14-11. Operator Stations

All operator stations that have been defined using the Operator Stations Editor are available. You
can assign all stations by enabling the All Station Access checkbox.

Applications-Functions
Use the Applications-Functions Editor to add, delete, and change applications or functions
defined for an application, assign security levels to restrict access to applications, and assign secu-
rity levels required for the Done-By and Check-By functions. A description of the applications
and their associated functions is described later in this section.

450
14. Security System B0193YB – Rev C

Figure 14-12. Applications Functions Editor

Adding a New Application

New applications can be added at any time. An application consists of a numeric identification
(ID) between 1 and 999, a name (16-chars max), an optional 120-character description. Use the
Security Enabled checkbox to enable or disable the need for application startup security.

NOTE
When designing a new application, make sure that you use the same application ID
when making security clearance requests through the Security API.

451
B0193YB – Rev C 14. Security System

The Security system is provided with the standard batch management system applications. Each
application has a pre-defined ID and name. The ID is used whenever a security clearance request
is sent to the Security Manager. The default application ID and name cannot be changed. If the
ID and/or name information is altered, an error message is displayed.

Enabling Application Security

Application security should be defined if access to starting an application needs to be restricted.
Each application can be assigned one or more security access levels if security is enabled and more
than one level of user is permitted to access the application.
Access security levels can be assigned to an application by selecting the Access command button.
This displays the Assign Security Levels dialog box.

Figure 14-13. Assign Security levels Window

All security levels that have been defined in the Security Levels Editor are available.

NOTE
To properly enable security, you must enable the checkbox in the Applications-
Functions Editor and define at least one level of security access.

! WARNING
There is one exception to defining application security. You cannot enable security
for a Batch Client application. This application is the basis for all Batch Display and
Batch Scheduler security. Security may be configured for any or all of the functions
defined for a Batch Client, but not for the application itself. If security is defined
for the Batch Client application, none of its functions pass a security request.

452
14. Security System B0193YB – Rev C

Adding a New Function

New functions can be added at any time. A function consists of a numeric identification (ID)
between 1 and 999, a name (16-chars max), an optional 120-character description, a Security
Enabled checkbox that is used to enable or disable security to perform and verify the function,
and security levels permitted to perform and verify the function.

NOTE
When designing a new function, make sure to use the same application ID when
making security clearance requests through the Security API.

The Security system is provided with a standard set of appropriate functions for each Batch
management system application. Each function has a pre-defined ID and name. The ID is used
whenever a security clearance request is sent to the Security Manager. The default function ID
and name cannot be changed. If the ID and/or name information is altered, an error message is
displayed.

Enabling Function Security

Function security should be defined if access to executing any function needs to be restricted.
Each function can be assigned one or more Done By and Checked By security levels if function
security is enabled and more than one level of user is permitted to perform or verify the function.
Function Done By and Checked By security levels are assigned by selecting the Done By and
Checked By buttons respectively. Each displays the Access Security Levels dialog box All security
levels that have been defined in the Security Levels Editor are available.

NOTE
Security is not enabled unless the appropriate checkbox has been set and one or
more Done By security levels have been defined. Also, Checked By security is not
enabled unless there is also Done By security defined. If the Done By security levels
are removed and there are Checked By security levels assigned, an error message is
displayed notifying the user that Done By levels cannot be removed. Finally, secu-
rity can be enabled for functions even if security is not enabled for the parent appli-
cation.

Application-Function Descriptions
The following table describes the available Applications (default) and the associated (default)
Function descriptions for each. The Function Names and Descriptions shown in the table can be
edited as required for your application.

453
B0193YB – Rev C 14. Security System

Table 14-1. Application-Function Descriptions

Application Function Description

Batch Client Abort Batch Enables a batch client to abort an active batch.
Abort Phase Enables a batch client to abort an active phase.
Ack to Enter Enables a batch client to require an Acknowledgment
after the entry of batch information.
Ack to Exit Enables a batch client to require an Acknowledgment in
order to
Allocate Equip
Answer Question
Chg Batch Mode
Control Buttons
Edit Phase Param
Enter Comment
Hold Batch
Hold Phase
Jump Batch
Launch FoxSCF
Manual Operation
Release Equip
Restart Batch
Restart Phase
Selecet Equip
Unit Abort
Unit Hold
Unit Restart
Access Schedule
Save Recipe
Save Recipe
Edit Phase
Force Transition
View Doc
View Doc Ack

454
14. Security System B0193YB – Rev C

Table 14-1. Application-Function Descriptions (Continued)

Application Function Description

Environmenmt Start/Stop Apps Enables the startup and stopping of the Environment
Display Display batch run-time applications.
Update Envnmt Enables the Update Environment feature on Environ-
ment Display.
Update Model Enables the Update Configuration feature on Environ-
ment Display.
Exit & Shutdown Enables Exit and Shutdown of the batch system from
Environment Display.
Force Master For Redundant Systems Only - Enables the Force Master
feature.
Envnmnt Editor Edit System Apps
Add New Apps
Edit New Apps
Materials Editor Location Editor
Material Editor
Recipe Editor Author
Approval#2
Approval#3
Approval#4
Approval#5
Approval Test
Delete Recipe
Assign States
Edit States
Assign States
Edit Types

Run-time Security
The run-time Security system interfaces with the Security database and the Security API to permit
or deny requests for security clearance that are received from the batch control applications.

Starting the Security Manager

If the installation instructions are performed correctly, the Security Manager runs as long as the
Batch Server node is turned on and operating correctly. This can be verified by selecting the
View/Status… menu option from the Environment Display. The System Application Status
dialog box indicates the current status of the Security system.

Changing Passwords
Use the Change Password (ChgPwd) window to change user passwords whenever required.

455
B0193YB – Rev C 14. Security System

Figure 14-14. Change Password

The window prompts you for User ID, Current Password, New Password, and to Verify Password.
If all of the information has been entered correctly, the you have successfully changed your
password.
If an invalid user identification or current password is entered or the new and verified passwords
are not the same, an error message displays.

Application Security Requests

When the overall security system has been enabled and an application is started that has security
enabled and one or more security levels configured, the Security Manager displays the Security
Clearance Request window.

Figure 14-15. Security Clearance Request

You must enter your User ID and Password. If you are permitted to access the application, the
application starts when OK is clicked.
If you are not permitted to access the application, an error message is displayed notifying you that
permission has been denied. The error message also provides the reason that access was denied.
If your password has not yet been defined or the password has expired, the New Password window
is displayed. This requires you to enter your current User ID and Password, and then enter and
verify a new password.

Function Security Requests

When a function within an application is encountered that has security enabled, and one or more
security levels configured for either the Done By and/or Checked By options, the Security

456
14. Security System B0193YB – Rev C

Manager displays the Done By (or Check By) Security Clearance Request window.

Figure 14-16. Security Clearance Windows

You must enter your User ID and Password. If you are permitted to perform or verify the func-
tion, the function executes when OK is clicked.
If you are not permitted to access the function, an error message is displayed notifying you that
permission has been denied. The error message also provides the reason that access was denied.
If your password has not yet been defined or the password has expired, the you are required to
enter a User ID and Password as explained earlier in this section.

NOTE
When a user-defined application or function is executed, the code for the applica-
tion and/or function must transmit the required security request to the Security
Manager through the Security API. As with the default applications and function,
you must enter your ID number and password. If you are permitted to use the
application or function, it is performed. If you are not permitted to access the
application or function, one of the above error messages displays notifying you that
permission has been denied.

457
B0193YB – Rev C 14. Security System

458
15. Expression Editor
This chapter describes how to use the Expression Editor to construct logical expressions that are
used in the Recipe Editor, Report Editor, and Process Log Editor.
Expressions consist of mathematical operators (+,-...) and/or operands (tags, constants...). For
each application, the expression normally returns a logical true or false result. It is possible to
assign values to tags under certain circumstances in the Expression Editor, but caution must be
used.
Expressions are entered when recipes or other configurations are defined. Expressions are stored as
part of the configuration. Each application uses the Expression Editor for different reasons. The
Recipe Editor uses the Expression Editor to construct true/false Boolean expressions for transition
logic and loop-back logic. The Process Log Editor uses the Expression Editor for defining a Log
Trigger and a Log Interval. In all cases, the Expression Editor functionality is the same.

Using Expression Editor

The Expression Editor functions similarly to a calculator, except that results are not calculated
immediately. Instead, expressions are evaluated and results returned whenever the application
needs them.
Expressions are constructed in an Edit Area using the formatting commands, numeric keypad,
operators, delimiters, tags, and functions. Expressions can be entered by using the mouse or the
computer keyboard.
Typically, an expression consists of one or more operands, such as tags and constants, and one or
more operators. It is not mandatory for an expression to have an operator. Only when two or
more operands are used is an operator required.

Starting the Expression Editor

The Expression Editor is displayed whenever an application requires you to define an expression.
When the Expression Editor is invoked, the Expression Editor window is displayed. From this
window, an appropriate expression can be defined.

Editing an Expression
Expressions are defined in the Edit Area. The Edit Area functions similarly to a word processor.
All entries are automatically inserted to the right of the cursor. Therefore, each time a numeric
key, operand, or delimiter key is selected, the character is inserted. Your computer keyboard can
also be used to enter an expression.
After the expression is completed, click OK or Apply to save the expression to the target object. If
the expression is not valid, an error message is displayed indicating the nature of the error and that
the cursor is positioned near or immediately after the error.

459
B0193YB – Rev C 15. Expression Editor

Formatting Numeric
Commands Edit Area Keypad Operators Delimiters

Tags Functions Formatting

Commands
Figure 15-1. Expression Editor

Edit Buttons
The formatting commands (Space, Back Space, New Line, Tab, Store, Recall, Clear, and Reset)
are available to assist you in constructing expressions. The Store and Recall are two buttons that
are especially helpful for reusing expressions.
Whenever the Store button is selected, the expression displayed in the Edit Area is stored. The
Recall button is used to retrieve and redisplay the stored expression. This feature is extremely
helpful when there are several expressions that are similar. The Store and Recall buttons are used
as follows.
1. After completing the first expression, save the expression to the target object (for
example, a recipe transition object or a report expression trigger) by clicking Apply,
and then clicking Store to store the expression.
2. Next, select the new target object. The Edit Area is now clear.
3. Click Recall to retrieve the expression.
4. Modify the expression as needed, then Apply the expression to the new object.

460
15. Expression Editor B0193YB – Rev C

Tag operands and functions can be entered by typing them in or they can be automatically
inserted into the expression using the selection dialog box. The details of each operand and func-
tion are described in the following pages.

To Insert a Tag Operand:

1. Click inside Edit Area at the desired position.
2. Click Tags. The appropriate Tag Selection window appears.
3. Select the desired tag. This inserts the tag, with the appropriate delimiters, into the
Edit Area.

To Insert a Function:
1. Click inside the Edit Area at the desired position.
2. Click Functions. The Functions window appears.

3. Select the desired function. This inserts the function, with the appropriate delimiters,
into the Edit Area.

Expression Elements
The following sections describe, in detail, the elements available for constructing expressions.

Operators
An operator is a symbol used to manipulate the value of one or more operands. Below is a list of
valid operators from highest precedence to lowest.

Table 15-1. Operators

Operator Symbol Description

Negate - Negates value of next operand.
Multiply * Multiplies values of previous and next operands.
Divide / Divides value of previous operand by next operand.
Modulus % Remainder of division between previous operand and next operand.

461
B0193YB – Rev C 15. Expression Editor

Table 15-1. Operators (Continued)

Operator Symbol Description

Add + Adds values of previous and next operands.
Subtract - Subtracts value of previous operand by next operand.
Less Than < TRUE if previous operand is less than next operand; else FALSE.
Less Than or <= TRUE if previous operand is less than or equal to next operand; else
Equal To FALSE.
Greater Than > TRUE if previous operand is greater than next operand; else FALSE.
Greater Than >= TRUE if previous operand is greater than or equal to next operand;
or Equal To else FALSE.
Equal To = TRUE if previous operand is equal to next operand; else FALSE.
Not Equal To <> TRUE if previous operand is not equal to next operand; else FALSE.
And & TRUE if previous operand and next operand are TRUE; else FALSE.
Or | TRUE if previous operand or next operand is TRUE; else FALSE.
Assignment := No usable return value. Writes next operand to previous operand.

Operands
Operands can be of type Boolean (True or False; also referred to as Discrete), Numeric (any posi-
tive or negative number) and String (alpha-numeric string of any length). Below is a list of valid
operands.

Table 15-2. Operands

Operand Type Description

Tag Boolean, Batch control system tag- defined in the Process Model
Numeric, String database. (for example, {ReactorA-Heat-CS-RUN})
Numeric Constant Numeric Numeric Values. (for example, 123.456)
String Constant String String of characters within double quotes. (for example,
“Allocated”)

Functions
There are seven functions currently available. All functions are available in the Recipe Editor.
However, only the Not function is available in the Process Log Editor applications.

462
15. Expression Editor B0193YB – Rev C

Table 15-3. Functions

Function Example Description

Ask Ask (“Continue?”) Used only in the Recipe Editor to ask yes/no type questions of
operators.
AskDoneBy AskDoneBy Used only in the Recipe Editor to ask yes/no type questions
(“Continue?”) that require confirmation that the question has been answered.
AskCheckBy AskCheckBy Used only in the Recipe Editor to ask yes/no type questions
(“Continue?”) that require confirmation and verification that the question has
been answered.
Not Not({TagName1}) Negates the result of the Boolean expression within the paren-
thesis. Converts a numeric result of value greater than 1 to 0.
Converts a numeric result of value 0 to 1.
WaitSec WaitSec(10) Used only in the Recipe Editor. When encountered, execution
is delayed the specified number of seconds.
WaitMin WaitMin(30) Used only in the Recipe Editor. When encountered, execution
is delayed the specified number of minutes.
WaitHour WaitHour(1) Used only in the Recipe Editor. When encountered, execution
is delayed the specified number of hours.

Delimiters
There are five delimiters that are used to identify operands and to build expressions within expres-
sions (recursive expressions).
Table 15-4. Delimiters

Delimiter Example(s) Description

Braces - {...} {TagName1} Braces are used to identify tags.
Parentheses - (...) ((10 + 1) * 20) Used for setting precedence.
Not ({TagName1}) Used to define a function argument.
({Tag1}+(Tag2*3)) Used to nest expressions.
Index - [...] Not currently used Used to access an offset value, in an operand greater
than size zero.
Quotes - “...” ‘Text String” Quotes are used to identify a string.
Comma - , N/A Used to separate function parameters which can be
operands or expressions.

Expression Building Rules

The following rules must be followed when defining expressions.
1. The operand to the left of the Assign operator (:=) must be a Tag operand.
2. Dividing by zero returns a result of zero.
3. Negate is only valid on numeric operands.

463
B0193YB – Rev C 15. Expression Editor

4. Add, Subtract, Multiply, and Divide are valid only when used with numeric
operands.
5. Modulus can only be used with numeric integer values.
6. Less Than, Greater Than, Less Than or Equal To, Greater Than or Equal To, Equal
To, and Not Equal To are valid only when evaluating non-Boolean operands and/or
expressions that have a non-Boolean result.
7. AND and OR operators are only valid when evaluating Boolean operands and/or
expressions that have a Boolean result.
8. Tag assignments can be made but require a special format so that the overall expres-
sion results in a Boolean value. Assignment expressions must be defined with the fol-
lowing format. Examples of tag assignment expressions are provided later in this
chapter.
({Tag}:=Value)=1
9. Equipment must be allocated for tags to work properly in an expression.

! WARNING
Tag assignments can be constructed in the Expression Editor. However, caution
must be used in defining these expressions. Only tags with an Access of Read/Write
can be used in an assignment expression. Attempting to create assignment expres-
sions using read-only tags results in run-time errors.

Expression Examples
The following tags are used in the examples listed below.

Table 15-5. Tags

Tag Type Value

Tag1 Numeric 100
Tag2 Numeric 50
Tag3 Numeric 5.5
Tag4 Boolean 0
Tag5 Boolean 1
Tag6 String “String1”

The following examples are included to illustrate the types of expressions that can be created as
well as expressions that are invalid.

464
15. Expression Editor B0193YB – Rev C

Table 15-6. Expression Examples

Expression Result Description

{Tag1}+{Tag2} Invalid Tags cannot be directly modified. The result must be Boolean.
{Tag2}/{Tag1} Invalid Tags cannot be directly modified. The result must be Boolean.
{Tag1}=>{Tag2} Invalid Invalid operator; should be >=.
(Tag5} Invalid Invalid delimiter { instead of (.
{Tag1} | {Tag5} Invalid Tag1 has invalid data type. Both tags must be Boolean.
{Tag6} | {Tag4} Invalid Tag6 has invalid data type. Both tags must be Boolean.
{Tag6}:=“String2” Invalid Tags cannot be directly modified. The result must be Boolean.
{Tag4} Valid FALSE
{Tag5} Valid TRUE
{Tag1}<{Tag3} Valid FALSE
{Tag1}>{Tag3} Valid TRUE
{Tag6}=“String1” Valid TRUE
{Tag6}<>“String1” Valid FALSE
{Tag4} & {Tag5} Valid FALSE
{Tag4} | {Tag5} Valid TRUE
({Tag6}:=“String2”)=1 Valid Putting parentheses around the assignment and evaluating it
equal to one makes this valid.

465
B0193YB – Rev C 15. Expression Editor

466
16. Phase Logic Development and
Testing
This section is intended to provide the control engineer with information on how to design and
test phase logic blocks. A phase block testing tool is provided and is described later in this
section.

NOTE
This information is written in a very generic manner in order to address the overall
use of phase logic, and is intended to be used strictly as a guide. The concepts can
be applied regardless of the control system in which the phases are being written.

The batch management system controls and monitors the execution of batches through equip-
ment phases. A phase is an independent processing action that can reside in the server or client
platform, a PLC, an I/A Series Control Processor, an I/A Series AW or other control system used
to evaluate logic and/or interface with manufacturing equipment. Even though phases can reside
in many different locations, the interface between the batch management system and the phase is
the same and must follow certain guidelines.
For more information on implementing unit and phase logic in I/A Series Control Suite refer to
Chapter 6 “Tag Management” of this User's Guide.

Phase Block Design Guidelines

Definition of a Phase Block
The basic building block used for co-ordinating the control system communication with the
batch system is the phase block. Also called a phase, the phase block is a small portion of control
system logic that conducts an independent action within a process or transfer class associated with
a batch. Some examples of phase blocks are ramp heat, ramp cool, soak, and bulk add. Phase
blocks are associated with each unit or connection in a particular modeling class. Therefore, there
could be an agitator phase block corresponding to a reactor, as well as an agitator phase block cor-
responding to a receiving tank.
It is recommended that phase blocks be designed as self-contained as possible. This allows the
phase blocks to be moved from one control system to another with minimum alterations. Thus, a
large library of phase blocks can exist that could be altered and used on an individual basis as new
equipment or new systems are installed.
The following list provides some of the ultimate goals of phase block logic. While it is likely that
processes exist that prevent satisfying all these goals simultaneously, achieving the goals should
always be the primary objective.
♦ Phase logic should be modular for easy duplication and transferability.
♦ Phase logic must utilize the standard interface between the control system and the
supervisory computer.

467
B0193YB – Rev C 16. Phase Logic Development and Testing

♦ Phase blocks can be written independently of one another.

♦ Phase blocks should be control system independent.
♦ The control system memory map should not be confining.
♦ The addition of process equipment should be done easily with little code revision.
♦ Phase logic structure should be standardized for ease of troubleshooting.
♦ Phase logic should be available for multiple use within the operational program.
♦ Phase logic should consist of a minimum amount of code without compromising
functionality or safety.
♦ Phase logic complexity should be geared to the level of the technical support staff.

Phase Block Rules of Operation

This section summarizes the general rules to be followed when planning and constructing the
operation of a phase block and/or complete process program. These rules are discussed in greater
detail throughout the remainder of this document.
♦ All items, except outputs, specific to a particular phase block should reside within that
phase block.
♦ An interlock is a pre-run condition of a phase block that prevents the phase block
from being operated.
♦ An alarm is generated by either a run-time conditional error or a device failure.
♦ Critical alarms put the corresponding phase block(s) on hold if they are currently
executing.
♦ On an initial control system power on sequence, the status of all phase blocks should
be ready or interlocked, and all outputs must be in a de-energized state.
♦ In the event of a batch system to control system communications error, any phase in
the run mode should continue until done, and the control system should wait for
communications to be restored for the next command.
♦ The manual operation of output devices must be addressed with regard to the status
of the phase logic blocks that utilize the outputs.
♦ It is the responsibility of the control system logic to recognize and react to unit control
bits. These control bits include Unit Hold, Unit Restart, and Unit Abort.

Function Block Diagram

There are eight main components to a phase block: the phase control bits, phase status bits, con-
trol inputs, control outputs, formula parameters, control buttons, interlocks, and alarms. These
items are transmitted between the control system and the batch control system via tags. The phase
block acts on this information to control the process equipment. Each of the components is dis-
cussed in greater detail later in this section.

468
16. Phase Logic Development and Testing B0193YB – Rev C

Figure 16-1. Phase Logic

Operational Flow Chart

There is a logical progression that the phase block logic should follow. As can be seen in the flow
chart, the phase block uses the phase control bits to proceed through the code as long as the par-
ticular phase status bits are satisfied. Code must also be written to provide the phase block with
interlock and alarm conditions.
The following is a brief explanation of the sequence of events for a typical phase block. When a
phase block is inactive, the phase status is ready. The only time this is not true is when the phase
block is interlocked. When the block is required to operate, the batch control system sends any
required formula parameters followed by a start command. When the start is received, the phase
block enters the Run status mode and executes the block logic. During the remainder of this oper-
ation, the block can be put into the held status mode via the batch control system phase control
hold command, or by the occurrence of a critical alarm condition. From the held status mode, the
phase block can either be restarted or aborted. The restart command resumes the phase block
operation. The abort puts the phase block in the aborted status mode and ends the block opera-
tion. The batch control system monitors this aborted status, and sends a phase reset command to
return the block to the ready status mode. If the phase block continues to completion, the status
becomes Done. The batch control system monitors this Done status, and similar to the Aborted,
sends a phase Reset command to return the block to the Ready mode. This sequence of events is
followed each time the phase block is included in the current batch control system recipe
configuration.

469
B0193YB – Rev C 16. Phase Logic Development and Testing

Note: * Denotes Phase Control Bit

# Denotes Phase Status Bit

Figure 16-2. Operational Flow Chart

Control System Memory Configuration

One of the most difficult decisions to make during the process of planning for a new system is the
manner in which the memory of a control system is configured. All control systems contain a spe-
cific amount of memory. In many of these control systems, the memory can be configured. In this
section, some general guidelines are presented to help allocate the available memory into specific
portions that minimize memory problems associated with system installation and expansion.
As an overview, there are some memory concepts that are similar for all control systems.

470
16. Phase Logic Development and Testing B0193YB – Rev C

♦ Most control systems have different types of memory that correspond to different
aspects of the overall program.
♦ The most sophisticated control systems allow the memory to be configured by the
user.
♦ There exists a finite number of analog and discrete memory available within each con-
trol system.
♦ There is a limit to the number of inputs and outputs a certain control system is capa-
ble of supporting.

Phase Block Memory Guidelines

In the phase block concept, some memory rules and constraints have been established to make
phase blocks consistent and portable. These guidelines are described below.
♦ Determine the number of phase blocks needed for the entire system and increase this
number by 20% to allow for expansion.
♦ Determine the number of global interlocks needed for the entire system and increase
this number by 20% to allow for expansion. This is the number of discrete data points
to allocate for global interlocks.
♦ Determine the number of global alarms needed for the entire system and increase this
number by 20% to allow for expansion. This is the number of discrete data points to
allocate for global alarms.
♦ Determine the number of outputs needed for the entire system and increase this num-
ber by 20% to allow for expansion. This is the number of discrete data points to
allocate for manual operation of global outputs.
♦ Should future expansion beyond the 20% cushion become necessary, the memory
guidelines should be followed within each expansion section and added to the end of
the previous section.
♦ If the control system memory can be configured by the user, determine all phase block
logic requirements (timers, counters, and so forth), then allocate memory accordingly
while also allowing for expansion.
♦ Whenever possible, phase control and status bits should be packed within words to
make more efficient use of control system memory.

Control System Code Structure

In order to achieve goals of modular, self-sufficient, independent phase blocks, the structure of the
control system code for each phase block and for entire processes must be consistent. This is nec-
essary so that phase blocks can easily be placed in other processes with little reprogramming. The
following sections provide a guidelines that has been established for structuring individual phase
blocks and complete process programs. It is recognized that alterations of a plant's processing
capabilities may occur after the initial program structuring that disrupts the program sequence.
However, if all additions are structured in a similar manner and added to the end of the code,
then the complete program consists of smaller programs, all having the same consistent structure.

Phase Block
A template has been created to assist in the structuring of a phase block. As can be seen from the
diagram on the following page, the phase block code consists of six sections. This diagram shows

471
B0193YB – Rev C 16. Phase Logic Development and Testing

the components in a distinct order. This order is recommended for sequential processing control
systems. For control systems that are capable of parallel processing, the flow of information is
different.
♦ Phase Control
This section of the phase block handles the manipulation of the phase control bits
needed to operate the phase logic. The batch management system enables the appro-
priate control word within the control system associated with a particular phase block.
The phase logic must be written to interpret this word and resolve the individual con-
trol bits of the word to the start, restart, hold, abort, and reset commands. It is recom-
mended that the phase logic reset the control word so that the next requested function
can be recognized. Thus, the control bits are essentially one-shot commands. This sec-
tion must be included for every automatic and semi-automatic phase block.
♦ Control Buttons
The section of the phase block corresponding to the control buttons is constructed
similarly to the phase control section. The batch management system enables any
defined control buttons in the control system, and the control system interprets the
control button request and performs the appropriate function. This section can be
used in automatic, semi-automatic, and manual phases, but is optional and depends
on the function of the phase.
♦ Interlocks
The interlock section of the phase block defines only the specific interlock conditions
associated with that phase block. Each interlock condition is assigned to a discrete
memory point and to a tag if the batch control system is to display the interlocks to
the user. This section appears only if there are specific interlocks associated with the
phase block.
♦ Alarms
The alarm section handles all error conditions specifically associated with the phase
block. All alarms appropriate to the phase are placed in parallel with each other to
engage a single discrete point that is used through the remainder of the phase logic to
affect the operation of the block. This section appears only if there are alarms
associated with the phase block.
♦ Phase Status
The phase status section includes the logic necessary to place the phase block into any
one of the possible status modes. The possible phase status values are ready, run, held,
done, interlocked, and aborted. Only one of these modes may be enabled at any time.
When all status control logic has been evaluated, the results are transferred to the
phase block status word that is monitored by the batch management system. This sec-
tion must be included for every automatic and semi-automatic phase block.
♦ Functional Logic
The remainder of the phase block is used to write the logic that is necessary to per-
form the required process or transfer action. This section varies in size and complexity
depending on the phase block operation, and contains the computational,
comparison, and timing functions required by the phase block. This section also
includes code that is associated with any formula parameters that may be assigned to
the phase block, as well as logic necessary to energize process outputs.

472
16. Phase Logic Development and Testing B0193YB – Rev C

Figure 16-3. General Phase Block Structure

Complete Program
A template has been created to assist in the structuring of the complete control system program
structure. As can be seen from Figure 16-4, the complete program consists of multiple sections
depending on the complexity of the system. Also, the control system code is structured in a man-
ner similar to the batch control system process model. The diagram shows the components in a
distinct order. This order is recommended for sequential processing control systems. For control
systems that are capable of parallel processing, the flow of information is different.
♦ Processes
Each defined process in the process model has a corresponding process section in the
control system program. The code for this section is located between any transfer
classes defined in the model that use this process class. Within each process section is
the control logic for the units associated with the process in the model.
♦ Units
Within each process section of the control system program is the logic corresponding
to the units defined for the process class in the process model. Within each of these
units, there exists the control system code for all phases defined for the unit.
♦ Transfers
Each defined transfer in the process model has a corresponding transfer section in the
control system program. This section is located just prior to the transfer’s destination
process class section of the control system program. Within each transfer section are
the connections associated with the transfer in the model.
♦ Connections
Within each transfer section of the control system program is the logic corresponding
to the connections defined for the transfer class in the process model. Within each of

473
B0193YB – Rev C 16. Phase Logic Development and Testing

these connections, there exists the control system code for all phases defined for the
connection.
♦ Phases
The control system code for the phase blocks assigned to each of the defined units and
connections appears after the appropriate unit or connection section of the program.
The number of phase blocks varies with the sophistication of the system.
♦ Unit Control and Status Words
The code for the unit control and status words is typically kept together in one section
of the program. This code receives all relevant batch hold, restart, and abort com-
mands from the batch control system and performs the requested action on each of
the phases associated with this unit.
♦ System alarms
All logic generating control system alarms appear in one section of the program. The
specific alarms can then be referenced in the various phase logic to affect the operation
of a phase as desired.
♦ System Outputs
All logic required to exercise the control system outputs are contained in one section
of the program. This logic contains references from the phase logic necessary to
manipulate the outputs. Also, any manual device operation logic is present in this
section.

474
16. Phase Logic Development and Testing B0193YB – Rev C

Figure 16-4. Complete Control System Program Structure

Unit Control
The batch control system transmits its batch requests to the control system through a series of tags
that are mapped to the memory of the control system. One group of these requests is for handling
the unit control commands. The control bits used for each unit are hold, restart, and abort. When
the batch control system desires to alter the status of a recipe, it writes to a tag in the control sys-
tem that corresponds to the particular unit control bit. Similar to the phase control bits, these
commands are typically packed into a word in order to maximize control system memory. In the
control system program, the unit control word can be monitored continuously or upon a change
of status. Each of the commands is read as a one-shot action, and only one request is transmitted

475
B0193YB – Rev C 16. Phase Logic Development and Testing

at a time. The particular control bits are utilized within each phase block associated with the par-
ticular unit and the phase operation responds accordingly. Transfer phases that utilize a unit that is
being placed on hold act according to customer specifications. Usually, when the unit is the source
of the transfer, the phase holds, and when the unit is the destination of the transfer, the phase con-
tinues to completion. It is recommended that the control system also contain unit status bits.
These status bits are not monitored by the batch management system, but are very useful within
the operation of the control system program. The defined unit control bits and recommended
unit status bits are described in this section.
The batch control system provides an enhanced Unit Control option which consists of two Hold
Propagation modes that can be used to propagate a phase Hold during batch execution. These
Hold Propagation modes are described later in this section.
♦ Hold
The unit hold command is enabled by the batch management system for all units that
are booked when a batch hold command is executed. The phase blocks associated
with the unit respond according to the user specification. When the unit hold bit is
enabled, none of the remaining unit control bits is set.
♦ Restart
The unit restart command is enabled by the batch management system for all units
that are booked when a batch restart command is executed. The phase blocks associ-
ated with the unit respond according to the user specification. When the unit restart
bit is enabled, none of the remaining unit control bits is set.
♦ Abort
The unit abort command is enabled by the batch management system for all units
that are booked when a batch abort command is executed. The phase blocks associ-
ated with the unit respond according to the user specification. When the unit abort
bit is enabled, none of the remaining unit control bits is set.
♦ Ready
The ready bit is an optional status value that can be generated and used within the
control system to keep track of the status of a particular unit. Generally, the ready sta-
tus bit is set when there is no execution of any of the phase blocks associated with the
unit and all phases have been reset and are ready for execution. When the ready status
control relay is enabled, none of the remaining unit status bits should be set. This sta-
tus bit is only used within the control system program, and is not monitored by batch
control system.
♦ Run
The run bit is an optional status value that can be generated and used within the con-
trol system to keep track of the status of a particular unit. Generally, the run status bit
is set when any of the phase blocks associated with the unit have been started and
everything in the phase blocks is executing normally. When the run status control
relay is enabled, none of the remaining unit status bits should be set. This status bit is
only used within the control system program, and is not monitored by batch control
system.
♦ Held
The held bit is an optional status value that can be generated and used within the con-
trol system to keep track of the status of a particular unit. Generally, the held status bit

476
16. Phase Logic Development and Testing B0193YB – Rev C

is enabled only after the unit hold bit has been received from the batch management
system. When the held status control relay is enabled, none of the remaining unit sta-
tus bits should be set. This status bit is only used within the control system program,
and is not monitored by batch control system.
♦ Aborted
The aborted bit is an optional status value that can be generated and used within the
control system to keep track of the status of a particular unit. Generally, the aborted
status bit is set only after the unit abort bit has been received from batch management
system. When the aborted status control relay is enabled, none of the remaining unit
status bits should be set. This status bit is only used within the control system pro-
gram, and is not monitored by batch control system.

Hold Propagation
I/A Series Batch provides two Hold Propagation modes which can be used to propagate a phase
Hold during batch execution. Hold mode functionality is enhanced when you use the Unit Con-
trol option since the Unit State is included in the unit control logic. A brief description of the
Hold modes is described below. For more information on Hold Propagation and enabling the
Unit Control option, see Chapter 10 “Batch Management System”.

Mode 1
The Batch Manager sets the Unit Hold tags whenever an operator puts a batch in Hold and con-
trol system logic is responsible for putting all its phases in Hold. Using this mode, if a unit or
phase goes to Held state, no action is taken by the Batch Manager.

Mode 2
The Batch Manager monitors all phases and if any phase goes to Held state or if the operator puts
the batch in Held state then all other phases associated with the batch are issued a Hold
command.

Phase Control
The batch control system transmits its phase requests to the control system through a series of tags
that are mapped to the memory of the control system. One group of these requests is for handling
the phase control commands. The control bits available for each phase are start, hold, restart,
abort, and reset. Only the start and reset bits are required. When the batch control system desires
to alter the status of a phase block, it writes to a tag in the control system that corresponds to the
particular phase control bit. These commands are typically packed into a word in order to maxi-
mize control system memory. In the phase logic, the phase control word can be monitored contin-
uously or upon a change of status. Each of the commands is read as a one-shot action, and only
one request is transmitted at a time. The particular control bits are utilized within the phase
block, and the phase operation responds accordingly.
The phase control bits are described below.
♦ Start
The phase start command is enabled by the batch management system for a phase as it
is encountered in a batch. Generally, the start command begins the execution of the
requested phase and puts the phase status in the run mode. When the phase start bit is
enabled, none of the remaining phase control bits is set. Finally, the batch manage-

477
B0193YB – Rev C 16. Phase Logic Development and Testing

ment system cannot send a request to start a phase block unless the phase block status
is in the ready mode.
♦ Hold
The phase hold command is enabled by the batch management system for a phase
whenever the hold command button is selected. Generally, the hold command sus-
pends the execution of the particular phase. When the phase hold bit is enabled, none
of the remaining phase control bits is set. Finally, the batch management system can-
not send a request to hold a phase block unless the phase block status is in the run
mode.
♦ Restart
The phase restart command is enabled by the batch management system for a phase
whenever the restart command button is selected. Generally, the restart command
resumes the execution of the requested phase, and returns the status of the phase block
to the run mode. When the phase restart bit is enabled, none of the remaining phase
control bits is set. Finally, the batch management system cannot send a request to
restart a phase block unless the phase block status is in the held mode.
♦ Abort
The phase abort command is enabled by the batch management system for a phase
whenever the abort command button is selected. Generally, the abort command ends
the execution of the requested phase and puts the phase status in the aborted mode.
When the phase abort bit is enabled, none of the remaining phase control bits is set.
Finally, the batch management system cannot send a request to abort a phase block
unless the phase block status is in the held mode.
♦ Reset
The phase reset command is enabled by the batch management system for a phase
whenever the phase has completed normally or been aborted. Generally, the reset
command returns all phase logic to its original state and puts the phase status in the
Ready mode. When the phase reset bit is enabled, none of the remaining phase con-
trol bits is set. Finally, the batch management system cannot send a request to reset a
phase block unless the phase block status is in either the done or aborted mode.

Phase Status
The batch control system recognizes the current status of a phase block through a series of tags
that are mapped to the memory of the control system. One group of these requests is for monitor-
ing the status of each phase. The status bits available for each phase are ready, run, held, done,
interlocked, and aborted. Only the ready and done bits are required. When the phase block status
changes, either via the phase logic or from a request from the batch management system, the
phase status word is set accordingly. In the phase block, the phase status word can be continuously
written or written only when the status changes. When a phase status changes in the control sys-
tem, the bit associated with that status in the phase status word is altered. All phase status changes
must be transmitted to the batch management system through the phase status word. It is
required that the phase block be in only one status mode at a time. The phase status bits are
described below.
♦ Ready

478
16. Phase Logic Development and Testing B0193YB – Rev C

The ready status bit is enabled by the control system for all phases ready to run. Gen-
erally, the ready status bit is set when there is no execution of the phase block and
everything in the block has been reset and is ready for execution. When the ready sta-
tus bit is enabled, none of the remaining phase status bits can be set. Finally, the batch
management system cannot send a request to start a phase block unless the phase
block status is in the ready mode.
♦ Run
The run status bit is enabled by the control system for all executing phases. Generally,
the run status bit is set when the phase block has been started or restarted and every-
thing in the block is executing normally. When the run status bit is enabled, none of
the remaining phase status bits can be set. Finally, the batch management system can-
not send a request to hold a phase block unless the phase block status is in the run
mode.
♦ Held
The held status bit is enabled by the control system for all phases that have been put
on hold either by the batch management system or from the occurrence of a critical
alarm. Generally, the phase logic freezes the current operation in progress, and places
the block in the held mode. However, the actual operation of the phase logic while in
the held mode is application specific. When the held status bit is enabled, none of the
remaining phase status bits can be set. Finally, the batch management system cannot
send a request to restart or abort a phase block unless the phase block status is in the
held mode.
♦ Done
The done status bit is enabled by the control system for all phases that have finished
their execution. When the done status bit is enabled, none of the remaining phase sta-
tus bits may be set. Finally, the batch management system cannot send a request to
reset a phase block unless the phase block status is in the done or, as seen below, the
aborted mode.
♦ Interlocked
The interlocked status bit is enabled by the control system for all phases in which a
condition prevents their safe execution. Generally, the interlocked status bit is set
before the start of execution of the phase block. The interlocked status represents a
condition of the process which prevents proper operation of the phase block. When
the interlocked status bit is enabled, none of the remaining phase status bits can be
set. Finally, the batch management system cannot send a request to start a phase block
if the phase block status is in the interlocked mode.
♦ Aborted
The aborted status bit is enabled by the control system for all phases that have been
aborted. The only way this bit can be turned on is by placing the phase block on hold
and then selecting the abort option. Therefore, it is impossible to abort a phase with-
out first placing the phase in hold. When the aborted status bit is enabled, none of the
remaining phase status bits can be set. Finally, the batch management system cannot
send a request to reset a phase block unless the phase block status is in the Aborted or
Done mode.

479
B0193YB – Rev C 16. Phase Logic Development and Testing

Figure 16-5. Phase Status

Formula Parameters
The phase block parameters correspond to the temperatures, times, speeds, rates, quantities, and
alarm settings configured in a particular formula for a recipe in the batch control system. The for-
mula parameters are downloaded to the control system just prior to the phase start command.
The control system receives the desired values and returns any corresponding actual values. Phase
blocks can have no parameters, or they can have many parameters.

Parameter Types
There are three types of parameters: Input, Output, and Process Variable.
Input parameters are used to define and monitor the addition (input) of a material to a batch. A
common Input parameter is Quantity.
Output parameters are used to define and monitor the production (output) of a material from a
batch. A common Output parameter is Quantity.
Process Variable parameters are used to define how a phase should function when the phase is exe-
cuting. Common Process Variable parameters are Temperature, Speed, Flow Rate, Mix Time,
Cook Time, React Time, Hi-Hi Temp Alarm, Hi Temp Alarm, and Rate of Change Alarm.

Parameter Type Extensions

Each type of parameter has a set of extensions that may or may not be used, depending on the use
of the parameter. Further discussion on how extensions should be used is presented below.
♦ Input Parameter Extensions
Target
Actual
High Deviation

480
16. Phase Logic Development and Testing B0193YB – Rev C

Low Deviation
Preact
Lot Code
Material ID
♦ Output Parameter Extensions
Target
Actual
Material ID
♦ Process Variable Extensions
Target
Actual
High Deviation
Low Deviation
High Limit
Low Limit.

Definition of Parameter Extensions

♦ Target Value
The target value extension is used by the batch control system to transfer a specific
numerical value to the particular phase block that is in operation. This value is one
that has been configured within the batch control system and is specific to the current
recipe as well as the phase block. Generally, the target value parameters consist of pro-
cess temperatures, timer values, and transfer quantities.
♦ Actual Value
The actual value extension consists of a specific numerical value that originates within
the phase block logic and is transferred to batch control system. This value corre-
sponds with a target value that has been passed to the phase block from the batch con-
trol system, and is usually monitored and displayed in the batch control system. The
values also generally consist of process temperatures, timer values, and transfer quanti-
ties. The comparisons between the target values and corresponding actual values are
used to determine the completion of the respective phase block. An example of an
actual value would be the time remaining as the soak phase block is operating.
♦ High Deviation
The high deviation extension is a batch control system configured value that corre-
sponds to a high tolerance limit for the actual value. Generally, when the actual value
becomes greater than the high deviation value while the phase block is in the run sta-
tus mode, an alarm is generated.
♦ Low Deviation
The low deviation extension is a batch control system configured value that corre-
sponds to a low tolerance limit for the actual values. Generally, when the actual value
becomes less than the low deviation value while the phase block is in the run status
mode, an alarm is generated.

481
B0193YB – Rev C 16. Phase Logic Development and Testing

♦ High Limit
The high limit extension is a batch control system configured value that corresponds
to the maximum value that can be entered in the recipe for a parameter target.
♦ Low Limit
The low limit extension is a batch control system configured value that corresponds to
the minimum value that can be entered in the recipe for a parameter target.
♦ Preact
The preact extension value corresponds to the addition of bulk ingredients, and it is
defined as the amount of an ingredient that is discharged from a source after the com-
mand has been given to stop the flow. An example of a preact would be the extra
quantity of an ingredient that is being fed to a scale from a conveyor. When the
desired weight is reached and the conveyor is turned off, there remains some extra
quantity of the ingredient that falls from the conveyor to the scale. The quantity of
this extra amount of an ingredient is called the preact. Automatic adjustments of the
preact must be done in the control system.
♦ Lot Code
The lot code extension is a batch control system configured value that corresponds to
the lot code entered by the operator for an input material.
♦ Material ID
The material ID extension is a batch control system configured value that corresponds
to the identification code of the input or output material being moved by the opera-
tor. The material ID is assigned in the recipe, but may be changed by the operator.

Control Buttons
Each phase block may contain two control buttons that are available for whatever functions the
phase block desires. These control buttons are operated from the batch control system display
screen and are transferred to the control system via tags that are associated with control system
memory locations. Examples of control buttons are the scale reset and tare buttons used during a
weighing operation.

Interlocks
Interlocks are conditional statements that are used to prevent the start of a particular phase block.
Phase blocks can have any number of interlocks, as well as share interlock conditions with multi-
ple phase blocks. The interlocks are found in the interlock section of the program corresponding
to the unit or connection with which they are associated. Usually, the interlocks correspond to an
output device. If a particular interlock condition exists, the respective interlock bit is set, the phase
status interlock bit is set, and the phase block is unable to be started. Interlock conditions must be
changed for the interlock to clear and the block to become ready. Also, interlock conditions are
disabled if the phase block is in operation. Some examples of phase block interlocks are listed
below.
♦ Reactor discharge valve open prevents the operation of any phase block that adds bulk
ingredients to the reactor.
♦ The level in a reactor must be a certain height before the agitator phase block can be
started.

482
16. Phase Logic Development and Testing B0193YB – Rev C

Alarms
Alarms are conditional statements that can be enabled at any time and can alter the status of a par-
ticular phase block. Phase blocks can have any number of alarms. The alarms are found in the
alarm section of the program corresponding to the unit or connection with which they are associ-
ated. Usually, the alarms correspond to an output device. There are usually two levels of severity
associated with alarms for a given set of conditions. One is an advisory alarm. This alarm may
require an acknowledgment by the operator. However, the advisory alarm does not require an
operator reset, and usually, the phase block does not require a restart command. The block opera-
tion continues as normal. The other alarm is a critical alarm. This alarm condition usually
requires the operator to acknowledge the alarm, reset the alarm, and restart the phase block. If a
particular alarm condition exists, the respective discrete memory location is enabled, the phase
block alarm is set, and if it is a critical alarm, the phase block status may be altered.

NOTE
It is recommended that, for the safety of process personnel, alarms are configured as
critical alarms whenever possible so that the phase block must be manually
restarted.

Some examples of phase block alarms are listed below.

♦ Reactor discharge valve fails to open or close and disrupts the operation of a transfer
phase block, setting an alarm bit that is read by batch control system, and putting the
transfer phase block in held.
♦ The agitator does not turn on within a predetermined length of time after the signal
to turn on is sent to the starter. This also sets an alarm bit that must be addressed by
the operator.
♦ The actual temperature within a reactor exceeds a predetermined value.

Input and Output Control

In the complete process control system program there exist inputs and outputs corresponding to
the process equipment. These I/O points should be treated differently within the control system
code. The inputs should appear wherever they are needed throughout the code. The outputs,
however, are located in the appropriate unit or connection section of the program, and demand a
more formal structure.
Because a particular output may be referenced in more than one phase block within a unit or con-
nection, conflict could arise if the direct output address is used in multiple places of the program.
Therefore, it is strongly suggested that all outputs, no matter how many times they are used, be
placed in the global output section. Any phase block requiring the output energizes an intermedi-
ate discrete memory location that is then placed in the appropriate location of the output section.
Thus, an output used by more than one phase block contains multiple discrete locations con-
nected in parallel, each of which independently turns on the particular output. Also, all manual
device operation logic exists in this section. The reasons behind placing all outputs in the global
output section are consistency and ease of troubleshooting. Finally, for safety reasons, alarms that
disable one or many outputs should exist in the global output code and not be scattered through-
out the phase logic. This ensures that the outputs are disengaged.

483
B0193YB – Rev C 16. Phase Logic Development and Testing

Using the Phase Logic Testing Tool

The Phase Logic testing tool can be used to take the place of the batch management system and
exercise the handshaking interface that is expected between a phase logic block and the Batch
Manager. Each and every phase in a control system can be tested using the Phase Logic testing
tool.

Starting the Phase Logic Testing Tool

To Start the Phase Logic Testing Tool:
1. In the Environment Display, double-click the PhaseLogic icon.

NOTE
The Phase Logic testing tool is not included in the Environment Display by default.
You must add the application using Environment Editor.

2. The Phase Logic window appears.

From this window, phases for any unit or connection can be selected and executed
using the Start, Hold, Restart, Abort, and Reset buttons. You can also exercise Con-
trol buttons and review interlock operation.
For more information on editing the environment system, see Chapter 4 “Environment Manage-
ment System”.

484
16. Phase Logic Development and Testing B0193YB – Rev C

Figure 16-6. Phase Logic Window

File Menu
Use the Phase Logic testing tool File to access system functions for the Phase Logic testing tool.

File/Exit
Use this command to close the Phase Logic testing tool.

! WARNING
It is the responsibility of the user to end and reset all phases before exiting the Phase
Logic testing tool. If a phase is not properly reset, the batch management system is
unable to use that phase in a batch successfully.

Help Menu
Use the Phase Logic testing tool Help menu to access online help and information about product
version.

485
B0193YB – Rev C 16. Phase Logic Development and Testing

Help/Help Topics
Use this command to display Help for the Phase Logic testing tool.

Help/About Phase Logic

Use this command to view version information.

Exercising Phases
A phase can be executed very easily from the Phase Logic testing tool. The following steps are nec-
essary to generate, export, refresh, and print a report.
1. Select the unit or connection that contains the phase that you want to execute from
the Units/Connections list.
The Phases list updates to show the process or transfer phases available for the
selected unit or connection.
2. Select the phase to be executed from the Phases list.
The Parameter list updates to show any formula parameters defined for the selected
phase.

NOTE
Phases are not required to have formula parameters.

3. To modify any formula parameter value, select the parameter extension in the
Parameter list, enter the new value in the text entry field, and select the Change
button.
The new formula parameter value is displayed in the Parameter list.
4. Use the buttons at the bottom of the window to send control signals to the phase.
The Status signals change to show the current state of the phase.
For more information on the handshaking between the phase control and status com-
mands, see “Operational Flow Chart” on page 469.

NOTE
It is very important to Reset each phase when the state of the phase is either Done
or Aborted.

5. Click the Interlocks button to view any interlock tags assigned to the phase.
The Interlocks window displays all interlock tags and their current values.

486
17. Tag Interface Management
(TIM) System
The Tag Interface Management (TIM) system is a tag based interface between the I/A Series
Batch and I/A Series Control system.
I/A Series Batch provides several ways a user can interact with the scheduling and execution of
batches. Another, more flexible, option is available that utilizes the Tag Interface Management
(TIM) system included with I/A Series Batch. The TIM system is designed to provide a tag based
interface to the functions available in the batch management system and security system.

Figure 17-1. Tag Interface Management System

The TIM system should be used if custom logic is required in the I/A Series Control system rela-
tive to interfacing with the I/A Series Batch Manager to:
♦ Manipulate the Batch Schedule

487
B0193YB – Rev C 17. Tag Interface Management (TIM) System

♦ Monitor and Control Active Batches

♦ View and Adjust Allocation Queue
♦ Manipulate Recipe Focus
♦ Monitor and Respond to Batch Questions
♦ Enter Batch Comments
♦ Monitor and Control Active Phases
♦ Select Equipment for Allocation
♦ Monitor Batch Messages
♦ Edit Phases and Parameters
♦ Monitor and Control Equipment
♦ View/Force Transition Logic
♦ Save Control Recipe
♦ Monitor and Respond to Errors
♦ Interact with the Security System
♦ Phase Prepare/Complete
♦ Evaluate Equipment for Allocation
♦ Log Equipment Status
♦ Equipment Allocation Changes.

TIM System Configuration

For more information on configuring the TIM system, see Chapter 6 “Tag Management”.

Tag Interface Management (TIM) Editor (TIMEdit)

The TIM Editor is used to define the I/A Series workstation nodes and the Interface functionality
needed at that node.

TIMMap File
The TIMMap file defines how TIM tags defined for each TIM node are mapped to the I/A Series
Control system. The TIMMap file is edited from the I/A Series Tag Link Editor and used by the
Link Editor and by the TIM Tag Shared Variable Utility.

I/A Link Editor (IALink)

The I/A Series Linker is used to define the links between both Process Model Tags (Model Tags)
and TIM Tags to I/A Series Compound:Block.Parameters or Shared Variables (I/A Series Tags).
The Linker has access to the Process Model and TIM databases to retrieve and synchronize the
databases when you add, delete, or change tags.

I/A Series TIM Shared Variable Utility (IATIM)

The I/A Series TIM Shared Variable utility is used to create a system startup file that creates
shared variable names and registers them with the I/A Series system.

488
17. Tag Interface Management (TIM) System B0193YB – Rev C

TIM System Runtime

TIM Batch Process (TIMBatch)
The TIM system Batch Process manages the run-time tag interface between the batch manage-
ment system and the computers and/or controllers defined in the system.

TIM Function Library Process (TIMFunc)

The TIM system Function Library Process manages the run-time tag interface between the batch
functions and the computers and/or controllers defined in the system. TIMFunc should not be
executed unless one or more of the Batch Function Interfaces are enabled.

TIM Security Process (TIMSec)

The TIM system Security Process manages the run-time tag interface between the security system
and the computers and/or controllers defined in the system.

Batch Focus Versus Unit Focus

Many of the interface groups allow for two ways to view and manipulate information. The two
methods are referred to as batch-centric and unit-centric. The batch-centric approach is used to
view the information associated with a specific batch. To enable this view, you write the appropri-
ate batch value to the .FOCUS.CLB tags and write a null string to the .FOCUS.UNIT tags. The
unit-centric approach is used to view the information associated with a specific unit. To enable
this view, you write the appropriate unit value to the .FOCUS.UNIT tags and write a null string
to the .FOCUS.CLB tags.

NOTE
It is possible, but not recommended, to combine both batch-centric and unit-
centric focusing within the same client. This requires extensive scripting using the
tags presented in this manual.

Working with List Tags

TIM tags provide run-time Batch Manager information. Most of this information is provided in
lists. For example, the batches contained in the Batch Scheduler are presented in a list. Also, the
active phase display, active parameter display, instruction display, and active question display all
contain lists of data. A large portion of the TIM tags has been defined to represent these lists of
data. The other TIM tags permit interaction with the data in the lists and allow selection and
alterations of this list data.
There are several list tags that are used to view a list, select an item in the list, and to determine the
attributes of the list. The example shown below illustrates the tags used to manipulate a list of
data in the Batch Scheduler. For all lists, there are tags that denote the number of items contained
in the list, the first item displayed in the list, the item that has been selected in the list, all individ-
ual entries in the list, the fields contained in the selected item, and a handshake tag that is used to
communicate with the appropriate runtime TIM application.

489
 B0193YB – Rev C 17. Tag Interface Management (TIM) System

BT.SCHEDULE.SCHED_LIST.FIRST_ITEM

BT.SCHEDULE.SCHED_LIST.ITEM3

BT.SCHEDULE.SELECT.SCHED_ITEM

BT.SCHEDULE.SELECT.SCHED_BATCH BT.SCHEDULE.SELECT.SCHED_MODE

BT.SCHEDULE.SELECT.SCHED_LOT BT.SCHEDULE.SELECT.SCHED_RECIPEID

BT.SCHEDULE.SELECT.SCHED_CAMPAIGN BT.SCHEDULE.SELECT.SCHED_SIZE

BT.SCHEDULE.SCHED_LIST.NUM_ITEMS
BT.SCHEDULE.SELECT.SCHED_TRAIN

BT.SCHEDULE.COMM.HANDSHAKE

Figure 17-2. Tags in Batch Scheduler

The .NUM_ITEMS tag value defines the number of items that are in the list. The value may
exceed the number of items that can be displayed using the .ITEM# tags. If the value is zero, there
are no entries in the list.
The .FIRST_ITEM tag value defines the item number to be displayed first in the list. Manipula-
tion of this value allows for paging up and down or scrolling up and down through the list.
The .ITEM# tags contain the data for the display lists. There are 16 item tags created for each list,
except for the Batch Function Interface, which has 99 tags.
The .SELECT. tag is used to select an item in the list. Whenever an item is selected and it is not in
the display list, the .FIRST_ITEM tag value is changed so that the selected item is brought into
view.
The .HANDSHAKE tag is used to communicate with the runtime TIM application. Values are
written to the .HANDSHAKE tag to perform the functions permitted with the list of data.

Actions Requiring Security Clearance

Many actions within I/A Series Batch can have security defined for them. When using these
actions, the security clearance requests are automatically displayed by another application installed

490
17. Tag Interface Management (TIM) System B0193YB – Rev C

on the client. Writing to TIM security tags is not required in this case. However, if an application
or function that is accessible by an operator requires security that has been added to the Security
system, there are TIM security tags that are used to verify that an operator is allowed to perform
the action. It is the responsibility of the client application to obtain the operator’s user identifica-
tion and password and apply them to the appropriate TIM security tags. If security is not required
for an action, the tags must be left blank. Two levels of security are available. The DoneBy level by
itself records who performed the action and requires the .DONEBY and .DONEBY_PWD tags
to be written. The DoneBy and CheckBy levels used together record who performed the action
and who verified the action was performed properly. This requires the .DONEBY,
.DONEBY_PWD, .CHECKBY, and .CHECKBY_PWD tags to be written. Refer to Chapter 14
“Security System” for more information on defining security.

Batch Function Interfaces

There are several critical points during batch execution where the user can interact. These points
are referred to as Batch Function Interfaces and can be accessed via TIM Batch Function tags.
Because of the direct interaction that these tags allow with the Batch Manager, the interfaces are
enabled only upon demand from within the I/A Series Linker application. The batch functions
are called at the beginning of each phase, the end of each phase, when equipment is evaluated for
allocation, when equipment allocation changes occur, and when equipment status changes are
written to history. Each function has its own set of TIM tags. After a function is called the batch
management system waits for a response signal before continuing.

NOTE
Caution must be exercised if any of the Batch Function Interface options is enabled.
Batch execution activity for all batches is suspended until client responses are
provided.

Tag Generation
The following table provides a summary of the tags generated for each Node instance if the TIM
interface option is enabled in the TIM Editor.

Table 17-1. Summary of Tags

Number Tags per

TIM Action Group Tag Prefix of Lists Node
Manipulate the Batch Schedule BT.SCHEDULE. 5 116
Monitor and Control Active Batches BT.BATCH. 1 36
View and Adjust Allocation Queue BT.ALLOCQUEUE 1 36
Manipulate Recipe Focus BT.RECIPE. 0 3
Monitor and Respond to Batch Questions BT.RECIPE_QUES. 1 27
Enter Batch Comments BT.RECIPE_COMMENT. 0 6
Monitor and Control Active Phases BT.RECIPE_PHASE. 4 108
Select Equipment for Allocation BT.RECIPE_SELECT. 2 46
Monitor Batch Messages BT.MESSAGE. 1 23

491
B0193YB – Rev C 17. Tag Interface Management (TIM) System

Table 17-1. Summary of Tags

Number Tags per

TIM Action Group Tag Prefix of Lists Node
Edit Phases and Parameters BT.PHASE_ED. 3 82
Monitor and Control Equipment BT.EQUIPMENT. 2 51
View/Force Transition Logic BT.VIEW_TRANS. 3 69
Save Control Recipe BT.SAVE_RECIPE. 0 10
Monitor and Respond to Errors BT.ERROR. 1 22
Interact with Security System SE.SECURITY. 0 10
Phase Prepare/Complete FU.PHASE. 1 32
Evaluate Equipment for Allocation FU.EVAL_EQUIP. 1 28
Log Equipment Status FU.LOG_EQUIP. 0 17
Equipment Allocation Changes FU.ALLOC_CHANGE. 1 27
TOTAL 27 749

Batch Management System Interface

Manipulate the Batch Schedule
This action group allows the user to perform all functions available from the Batch Scheduler
through tags. The tags can be used to add, delete, and change batches in the schedule. Also,
batches can be initialized and moved in the list.

Table 17-2. Manipulate the Batch Schedule Tags

Tag Name Type Size Access

BT.SCHEDULE.SCHED_LIST.NUM_ITEMS INTEGER 1 RO
BT.SCHEDULE.SCHED_LIST.FIRST_ITEM INTEGER 1 R/W
BT.SCHEDULE.SCHED_LIST.ITEM1 TO STRING 91 RO
BT.SCHEDULE.SCHED_LIST.ITEM16
Each list tag consists of six fields separated by two spaces.
CAMPAIGN ID 16
LOT ID 16
BATCH ID 16
RECIPE ID 16
MODE 9
STATUS 8
BT.SCHEDULE.RECIPE_LIST.NUM_ITEMS INTEGER 1 RO
BT.SCHEDULE.RECIPE_LIST.FIRST_ITEM INTEGER 1 R/W
BT.SCHEDULE.RECIPE_LIST.ITEM1 TO STRING 70 RO
BT.SCHEDULE.RECIPE_LIST.ITEM16
Each list tag consists of four fields separated by two spaces.

492
17. Tag Interface Management (TIM) System B0193YB – Rev C

Table 17-2. Manipulate the Batch Schedule Tags (Continued)

Tag Name Type Size Access

RECIPE ID 16
RECIPE NAME 16
RECIPE STATE 16
RECIPE TYPE 16
BT.SCHEDULE.TRAIN_LIST.NUM_ITEMS INTEGER 1 RO
BT.SCHEDULE.TRAIN_LIST.FIRST_ITEM INTEGER 1 R/W
BT.SCHEDULE.TRAIN_LIST.ITEM1 TO STRING 16 RO
BT.SCHEDULE.TRAIN_LIST.ITEM16
BT.SCHEDULE.TYPE_LIST.NUM_ITEMS INTEGER 1 RO
BT.SCHEDULE.TYPE_LIST.FIRST_ITEM INTEGER 1 R/W
BT.SCHEDULE.TYPE_LIST.ITEM1 TO STRING 16 RO
BT.SCHEDULE.TYPE_LIST.ITEM16
BT.SCHEDULE.STATE_LIST.NUM_ITEMS INTEGER 1 RO
BT.SCHEDULE.STATE_LIST.FIRST_ITEM INTEGER 1 R/W
BT.SCHEDULE.STATE_LIST.ITEM1 TO STRING 16 RO
BT.SCHEDULE.STATE_LIST.ITEM16
BT.SCHEDULE.SCHED_MODE.EXECINORDER INTEGER 1 RO
BT.SCHEDULE.SELECT.SCHED_ITEM INTEGER 1 R/W
BT.SCHEDULE.SELECT.SCHED_CAMPAIGN STRING 16 R/W
BT.SCHEDULE.SELECT.SCHED_LOT STRING 16 R/W
BT.SCHEDULE.SELECT.SCHED_BATCH STRING 16 R/W
BT.SCHEDULE.SELECT.SCHED_RECIPEID STRING 16 R/W
BT.SCHEDULE.SELECT.SCHED_SIZE INTEGER 1 R/W
BT.SCHEDULE.SELECT.SCHED_TRAIN STRING 16 R/W
BT.SCHEDULE.SELECT.SCHED_MODE INTEGER 1 R/W
BT.SCHEDULE.SELECT.RECIPE_ITEM INTEGER 1 R/W
BT.SCHEDULE.SELECT.RECIPE_ID STRING 16 R/W
BT.SCHEDULE.SELECT.RECIPE_NAME STRING 16 R/W
BT.SCHEDULE.SELECT.RECIPE_TYPE STRING 16 R/W
BT.SCHEDULE.SELECT.RECIPE_STATE STRING 16 R/W
BT.SCHEDULE.SELECT.TRAIN_ITEM INTEGER 16 R/W
BT.SCHEDULE.SELECT.TRAIN_NAME STRING 16 R/W
BT.SCHEDULE.SELECT.TYPE_ITEM INTEGER 1 R/W
BT.SCHEDULE.SELECT.TYPE STRING 16 R/W
BT.SCHEDULE.SELECT.STATE_ITEM INTEGER 1 R/W
BT.SCHEDULE.SELECT.STATE STRING 16 R/W
BT.SCHEDULE.SECURITY.DONEBY STRING 12 R/W
BT.SCHEDULE.SECURITY.DONEBY_PWD STRING 12 R/W

493
B0193YB – Rev C 17. Tag Interface Management (TIM) System

Table 17-2. Manipulate the Batch Schedule Tags (Continued)

Tag Name Type Size Access

BT.SCHEDULE.SECURITY.CHECKBY STRING 12 R/W
BT.SCHEDULE.SECURITY.CHECKBY_PWD STRING 12 R/W
BT.SCHEDULE.COMM.INFO INTEGER 1 RO
BT.SCHEDULE.COMM.HANDSHAKE INTEGER 1 R/W

1. The BT.SCHEDULE.SCHED_LIST.NUM_ITEMS tag is an integer tag containing

the number of batches in the schedule.
2. The BT.SCHEDULE.SCHED_LIST.ITEM1 to
BT.SCHEDULE.SCHED_LIST.ITEM16 tags are string tags used to display the list
of batches in the schedule. The first item in the list is defined by the value in tag
BT.SCHEDULE.SCHED_LIST.FIRST_ITEM.
3. The BT.SCHEDULE.RECIPE_LIST.NUM_ITEMS tag is an integer tag containing
the number of approved recipes available to be scheduled.
4. The BT.SCHEDULE.RECIPE_LIST.ITEM1 to
BT.SCHEDULE.RECIPE_LIST.ITEM16 tags are string tags used to display the list
of recipes available. The first item in the list is defined by the value in tag
BT.SCHEDULE.RECIPE_LIST.FIRST_ITEM.
5. The BT.SCHEDULE.TRAIN_LIST.NUM_ITEMS tag is an integer tag containing
the number of trains available on which batches can be scheduled.
6. The BT.SCHEDULE.TRAIN_LIST.ITEM1 to
BT.SCHEDULE.TRAIN_LIST.ITEM16 tags are string tags used to display the list of
trains available. The first item in the list is defined by the value in tag BT.SCHED-
ULE.TRAIN_LIST.FIRST_ITEM.
7. The BT.SCHEDULE.TYPE_LIST.NUM_ITEMS tag is an integer tag containing
the number of recipe types defined in the recipe database.
8. The BT.SCHEDULE.TYPE_LIST.ITEM1 to
BT.SCHEDULE.TYPE_LIST.ITEM16 tags are string tags used to display the list of
recipe types available. The first item in the list is defined by the value in tag
BT.SCHEDULE.TYPE_LIST.FIRST_ITEM.
9. The BT.SCHEDULE.STATE_LIST.NUM_ITEMS tag is an integer tag containing
the number of recipe states defined in the recipe database.
10. The BT.SCHEDULE.STATE_LIST.ITEM1 to
BT.SCHEDULE.STATE_LIST.ITEM16 tags are string tags used to display the list of
recipe states available. The first item in the list is defined by the value in tag
BT.SCHEDULE.STATE_LIST.FIRST_ITEM.
11. The BT.SCHEDULE.SCHED_MODE.EXECINORDER tag is an integer tag used
to monitor or display the Execute In Order Mode.

Value Execute In Order

0 Off
1 On

494
17. Tag Interface Management (TIM) System B0193YB – Rev C

12. The BT.SCHEDULE.SELECT.SCHED_ITEM tag is an integer tag used to select

the item in the list that is the focus of the action being performed. This is equivalent
to the selection of the batch from the list with the mouse.
13. The following tags contain the specific schedule information corresponding to the
selected item from the list. Also, these tags would be written to in order to add a new
batch.
BT.SCHEDULE.SELECT.SCHED_CAMPAIGN - String tag containing the Cam-
paign ID of the current batch.
BT.SCHEDULE.SELECT.SCHED_LOT - String tag containing the Lot ID of the
current batch.
BT.SCHEDULE.SELECT.SCHED_BATCH - String tag containing the Batch ID of
the current batch.
BT.SCHEDULE.SELECT.SCHED_RECIPEID - String tag containing the Recipe
ID of the current batch.
BT.SCHEDULE.SELECT.SCHED_SIZE - Integer tag containing the Size of the
current batch.
BT.SCHEDULE.SELECT.SCHED_TRAIN - String tag containing the Train of the
current batch.
BT.SCHEDULE.SELECT.SCHED_MODE - Integer tag containing the Mode of
the current batch.

Value Mode
0 Automatic
1 Semi-Automatic
2 Manual

14. The BT.SCHEDULE.SELECT.RECIPE_ITEM tag is an integer tag used to select

the item in the list that is the focus of the action being performed. This is equivalent
to the selection of the recipe from the list with the mouse.
15. The following tags contain the specific recipe information corresponding to the
selected item from the list.
BT.SCHEDULE.SELECT.RECIPE_ID - String tag containing the selected
Recipe ID.
BT.SCHEDULE.SELECT.RECIPE_NAME - String tag containing the selected
Recipe Name.
BT.SCHEDULE.SELECT.RECIPE_TYPE - String tag containing the selected
Recipe Type.
BT.SCHEDULE.SELECT.RECIPE_STATE - String tag containing the selected
Recipe State.
16. The BT.SCHEDULE.SELECT.TRAIN_ITEM tag is an integer tag used to select the
item in the list that is the focus of the action being performed. This is equivalent to
the selection of the train from the list with the mouse.

495
B0193YB – Rev C 17. Tag Interface Management (TIM) System

17. The following tags contain the specific train information corresponding to the
selected item from the list.
BT.SCHEDULE.SELECT.TRAIN_NAME - String tag containing the selected Train
Name.
18. The BT.SCHEDULE.SELECT.TYPE_ITEM tag is an integer tag used to select the
item in the list that is the focus of the action being performed. This is equivalent to
the selection of the recipe type from the list with the mouse.
19. The following tags contain the specific recipe type information corresponding to the
selected item from the list.
BT.SCHEDULE.SELECT.TYPE - String tag containing the selected Recipe Type.
20. The BT.SCHEDULE.SELECT.STATE_ITEM tag is an integer tag used to select the
item in the list that is the focus of the action being performed. This is equivalent to
the selection of the recipe state from the list with the mouse.
21. The following tags contain the specific recipe state information corresponding to the
selected item from the list.
BT.SCHEDULE.SELECT.STATE - String tag containing the selected Recipe State.
22. The BT.SCHEDULE.SECURITY.DONEBY tag specifies the ID and the
BT.SCHEDULE.SECURITY.DONEBY_PWD tag specifies the password for the
user executing the action. The user ID and password should be obtained from the
operator once or whenever an action is to be executed. Values are required for these
tags if security has been configured for the Batch Client functions in the Security Edi-
tor.
23. The BT.SCHEDULE.SECURITY.CHECKBY tag specifies the ID and the
BT.SCHEDULE.SECURITY.CHECKBY_PWD tag specifies the password for the
user executing the action. The user ID and password should be obtained from the
operator once or whenever an action is to be executed. Values are required for these
tags if security has been configured for the Batch Client functions in the Security Edi-
tor.
24. The BT.SCHEDULE.COMM.INFO tag is an integer tag used to monitor the work-
ing state of the batch management system. This tag is equal to one when the batch
system is busy. New TIM commands are immediately processed while this tag is
enabled. Operation can resume when the value of this tag is zero. The
BT.SCHEDULE.COMM.HANDSHAKE tag has a value of -118 when the
BT.SCHEDULE.COMM.INFO tag is enabled.
25. The BT.SCHEDULE.COMM.HANDSHAKE tag is an integer tag that is written to
initiate a specified action and read to monitor the results of the action. The handshake
values are provided in the following table.

Handshake
Value Description
1 Add the batch defined by the specific selection tags to the schedule after the batch
selected by the BT.SCHEDULE.SELECT.SCHED_ITEM tag. If no batch is
selected, the new batch is added to the bottom of the list. Same as the Add button on
the Batch Scheduler display.

496
17. Tag Interface Management (TIM) System B0193YB – Rev C

Handshake
Value Description
2 Generate batches starting with batch number defined in the specific selection tags.
This action requires the BT.SCHEDULE.SELECT.SCHED_SIZE tag to be greater
than the maximum batch size defined by the recipe. The default recipe batch size is
used as the size for all generated batches. Same as the Multi-Add button on the Batch
Scheduler display.
3 Change the batch selected by the BT.SCHEDULE.SELECT.SCHED_ITEM tag to
the batch data defined in specific selection tags. Same as the Change button on the
Batch Scheduler display.
4 Delete the batch selected by the BT.SCHEDULE.SELECT.SCHED_ITEM tag.
Same as the Delete button on the Batch Scheduler display.
5 Remove all Done and Aborted batches from the schedule list. Same as the Clean-up
button on the Batch Scheduler display.
6 Initialize the batch selected by the BT.SCHEDULE.SELECT.SCHED_ITEM tag.
Same as Init Batch button on the Batch Scheduler display.
7 Initialize all batches in the schedule. Same as the Init All button on the Batch Sched-
uler display.
8 Move the batch selected by the BT.SCHEDULE.SELECT.SCHED_ITEM tag up
one position in the list. Same as the Move Up button on the Batch Scheduler display.
9 Move the batch selected by the BT.SCHEDULE.SELECT.SCHED_ITEM tag
down one position in the list. Same as the Move Down button on the Batch Sched-
uler display.
10 Sets the Execute in Order Mode on. Same as the EIO On button on the Batch
Scheduler display.
11 Sets the Execute in Order Mode off. Same as the EIO Off button on the Batch
Scheduler display.
12 Refresh the list of recipes that are approved for production and available for
scheduling.
13 Refresh the list of trains that are available for scheduling.
14 Refresh the list of recipe types for the recipes that are approved for production and
available for scheduling.
15 Refresh the list of recipe states for the recipes that are approved for production and
available for scheduling.
16 Move the batch selected by the BT.SCHEDULE.SELECT.SCHED_ITEM before
the previous position in the list. Similar to the move up option, but used when filter-
ing is being used.
17 Move the batch selected by the BT.SCHEDULE.SELECT.SCHED_ITEM after the
next position in the list. Similar to the move down option, but used when filtering is
being used.

497
B0193YB – Rev C 17. Tag Interface Management (TIM) System

View and Adjust Allocation Queue

This action group allows the user to perform the functions associated with the Equipment Alloca-
tion Queue in Batch Display and Batch View through tags. The tags can be used to move a batch
up or down in the allocation queue list.

Table 17-3. View and Adjust Allocation Queue Tags

Tag Name Type Size Access

BT.ALLOCQUEUE.ALLOC_LIST.NUM_ITEMS INTEGER 1 RO
BT.ALLOCQUEUE.ALLOC_LIST.FIRST_ITEM INTEGER 1 R/W
BT.ALLOCQUEUE.ALLOC_LIST.ITEM1 TO STRING 119 RO
BT.ALLOCQUEUE.ALLOC_LIST.ITEM16
Each list tag consists of eight fields separated by two spaces.
CAMPAIGN ID 16
LOT ID 16
BATCH ID 16
INSTANCE NAME 16
RECIPE ID 16
MODE 9
STATUS 8
ORDER 8
BT.ALLOCQUEUE.SCHED_MODE.EXECINORDER INTEGER 1 RO
BT.ALLOCQUEUE.SELECT.SCHED_ITEM INTEGER 1 R/W
BT.ALLOCQUEUE.SELECT.SCHED_CAMPAIGN STRING 16 RO
BT.ALLOCQUEUE.SELECT.SCHED_LOT STRING 16 RO
BT.ALLOCQUEUE.SELECT.SCHED_BATCH STRING 16 RO
BT.ALLOCQUEUE.SELECT.SCHED_INSTANCE STRING 16 RO
BT.ALLOCQUEUE.SELECT.SCHED_RECIPEID STRING 16 RO
BT.ALLOCQUEUE.SELECT.SCHED_SIZE INTEGER 1 RO
BT.ALLOCQUEUE.SELECT.SCHED_TRAIN STRING 16 RO
BT.ALLOCQUEUE.SELECT.SCHED_MODE INTEGER 1 RO
BT.ALLOCQUEUE.SELECT.SCHED_SEQ INTEGER 1 RO
BT.ALLOCQUEUE.SECURITY.DONEBY STRING 12 R/W
BT.ALLOCQUEUE.SECURITY.DONEBY_PWD STRING 12 R/W
BT.ALLOCQUEUE.SECURITY.CHECKBY STRING 12 R/W
BT.ALLOCQUEUE.SECURITY.CHECKBY_PWD STRING 12 R/W
BT.ALLOCQUEUE.FOCUS.EQUIP STRING 16 R/W
BT.ALLOCQUEUE.COMM.INFO INTEGER 1 RO
BT.ALLOCQUEUE.COMM.HANDSHAKE INTEGER 1 R/W

1. EUE.ALLOC_LIST.NUM_ITEMS tag is an integer tag containing the number of

batches in the queue list.

498
17. Tag Interface Management (TIM) System B0193YB – Rev C

2. The BT.ALLOCQUEUE.ALLOC_LIST.ITEM1 to BT.ALLOC-

QUEUE.ALLOC_LIST.ITEM16 tags are string tags used to display the list of batches
in the queue list. The first item in the list is defined by the value in tag BT.ALLOC-
QUEUE.ALLOC_LIST.FIRST_ITEM.
3. The BT.ALLOCQUEUE.SCHED_MODE.EXECINORDER tag is an integer tag
used to monitor or display the Execute In Order mode.

Value Execute In Order

0 Off
1 On

4. The BT.ALLOCQUEUE.SELECT.SCHED_ITEM tag is an integer tag used to select

the item in the list that is the focus of the action being performed. This is equivalent
to the selection of the batch from the list with the mouse.
5. The following tags contain the specific schedule information corresponding to the
selected item from the list.
BT.ALLOCQUEUE.SELECT.SCHED_CAMPAIGN - String tag containing the
Campaign ID of the current batch.
BT.ALLOCQUEUE.SELECT.SCHED_LOT - String tag containing the Lot ID of
the current batch.
BT.ALLOCQUEUE.SELECT.SCHED_BATCH - String tag containing the Batch
ID of the current batch.
BT.ALLOCQUEUE.SELECT.SCHED_INSTANCE - String tag containing the
name of the equipment instance for which the queue has formed.
BT.ALLOCQUEUE.SELECT.SCHED_RECIPEID - String tag containing the Rec-
ipe ID of the current batch.
BT.ALLOCQUEUE.SELECT.SCHED_SIZE - Integer tag containing the Size of the
current batch.
BT.ALLOCQUEUE.SELECT.SCHED_TRAIN - String tag containing the Train of
the current batch.
BT.ALLOCQUEUE.SELECT.SCHED_MODE - Integer tag containing the Mode
of the current batch.

Value Mode
0 Automatic
1 Semi-Automatic
2 Manual

6. The BT.ALLOCQUEUE.SELECT.SCHED_SEQ is an integer tag that contains the

order (sequence) of the batch in the allocation queue.
7. The BT.ALLOCQUEUE.SECURITY.DONEBY tag specifies the ID and the
BT.ALLOCQUEUE.SECURITY.DONEBY_PWD tag specifies the password for the

499
B0193YB – Rev C 17. Tag Interface Management (TIM) System

user executing the action. The user ID and password should be obtained from the
operator once or whenever an action is to be executed. Values are required for these
tags if security has been configured for the Batch Client functions in the Security
Editor.
8. The BT.ALLOCQUEUE.SECURITY.CHECKBY tag specifies the ID and the
BT.ALLOCQUEUE.SECURITY.CHECKBY_PWD tag specifies the password for
the user executing the action. The user ID and password should be obtained from the
operator once or whenever an action is to be executed. Values are required for these
tags if security has been configured for the Batch Client functions in the Security
Editor.
9. The BT.ALLOCQUEUE.FOCUS.EQUIP tag is an string tag which contains the
name of the equipment from which the queue is being reviewed (that is, has the
focus).
10. The BT.ALLOCQUEUE.COMM.INFO tag is an integer tag used to monitor the
working state of the batch management system. This tag is equal to one when the
batch system is busy. New TIM commands are not immediately processed while this
tag is enabled. Operation can resume when the value of this tag is zero. The
BT.ALLOCQUEUE.COMM.HANDSHAKE tag has a value of -118 when the
BT.ALLOCQUEUE.COMM.INFO tag is enabled.
11. The BT.ALLOCQUEUE.COMM.HANDSHAKE tag is an integer tag that is written
to initiate a specified action and read to monitor the results of the action. The hand-
shake values are provided in the table below.

Handshake
Value Description
5 Move the batch selected by the
BT.ALLOCQUEUE.SELECT.SCHED_ITEM tag up one
row in the list. Same as the Move Up button on the allocation
queue dialog in Batch Display and Batch View display.
6 Move the batch selected by the
BT.ALLOCQUEUE.SELECT.SCHED_ITEM tag down one
row in the list. Same as the Move Down button on the alloca-
tion queue dialog in Batch Display and Batch View display.
7 Refresh the allocation queue list.

Monitor and Control Active Batches

This action group allows the user to perform all of the batch control functions available from the
Batch Display through tags. There are tags that can be used to select and control active batches in
the schedule.

500
17. Tag Interface Management (TIM) System B0193YB – Rev C

Table 17-4. Monitor and Control Active Batches Tags

Tag Name Type Size Access

BT.BATCH.FOCUS.SCHED_LIST STRING 128 R/W
This tag consists of unit names separated by a “/”.
UNIT1 TO UNITn 16
BT.BATCH.SCHED_LIST.NUM_ITEMS INTEGER 1 RO
BT.BATCH.SCHED_LIST.FIRST_ITEM INTEGER 1 R/W
BT.BATCH.SCHED_LIST.ITEM1 TO STRING 84 RO
BT.BATCH.SCHED_LIST.ITEM16
Each list tag consists of six fields separated by two spaces.
CAMPAIGN ID 16
LOT ID 16
BATCH ID 16
RECIPE ID 16
STATUS 8
ACTION 2
BT.BATCH.SELECT.SCHED_ITEM INTEGER 1 R/W
BT.BATCH.SELECT.SCHED_CLB STRING 50 RO
This tag consists of three fields separated by a “/”.
CAMPAIGN ID 16
LOT ID 16
BATCH ID 16
BT.BATCH.SELECT.SCHED_RECIPEID STRING 16 RO
BT.BATCH.SELECT.SCHED_SIZE INTEGER 1 RO
BT.BATCH.SELECT.SCHED_TRAIN STRING 16 RO
BT.BATCH.SELECT.SCHED_MODE INTEGER 1 RO
BT.BATCH.SELECT.SCHED_MODE_STR STRING 16 RO
BT.BATCH.SELECT.SCHED_STATUS INTEGER 1 RO
BT.BATCH.SELECT.SCHED_STATUS_STR STRING 8 RO
BT.BATCH.SELECT.SCHED_EDIT_MASK INTEGER 1 RO
BT.BATCH.SELECT.SCHED_CLBFOCUSOK INTEGER 1 RO
BT.BATCH.SECURITY.DONEBY STRING 12 R/W
BT.BATCH.SECURITY.DONEBY_PWD STRING 12 R/W
BT.BATCH.SECURITY.CHECKBY STRING 12 R/W
BT.BATCH.SECURITY.CHECKBY_PWD STRING 12 R/W
BT.BATCH.COMM.INFO INTEGER 1 RO
BT.BATCH.COMM.HANDSHAKE INTEGER 1 R/W

501
B0193YB – Rev C 17. Tag Interface Management (TIM) System

1. The BT.BATCH.FOCUS.SCHED_LIST tag is a string tag that defines the units that
are used to filter the list of batches and provide the focus for the action. Use of this tag
is optional. The system defaults to all batches in the schedule if no entry is provided.
2. The BT.BATCH.COMM.HANDSHAKE tag is an integer tag that is written to ini-
tiate an update of the batches according to the values assigned to the focus tag. The
handshake values are provided in the table at the end of this procedure.
3. The BT.BATCH.SCHED_LIST.NUM_ITEMS tag is an integer tag containing the
number of batches in the schedule.
4. The BT.BATCH.SCHED_LIST.ITEM1 to BT.BATCH.SCHED_LIST.ITEM16
tags are string tags used to display the list of batches in the schedule. The first item in
the list is defined by the value in tag BT.BATCH.SCHED_LIST.FIRST_ITEM.
5. The BT.BATCH.SELECT.SCHED_ITEM tag is an integer tag used to select the
item in the list that is the focus of the action being performed. This is equivalent to
the selection of the batch from the list with the mouse.
6. The following tags contain the specific schedule information corresponding to the
selected item from the list.
BT.BATCH.SELECT.SCHED_CLB - String tag containing the identification of the
selected batch.
BT.BATCH.SELECT.SCHED_RECIPEID - String tag containing the Recipe ID of
the selected batch.
BT.BATCH.SELECT.SCHED_SIZE - Integer tag containing the size of the selected
batch.
BT.BATCH.SELECT.SCHED_TRAIN - String tag containing the Train of the
selected batch.
BT.BATCH.SELECT.SCHED_MODE - Integer tag containing the mode value of
the selected batch.

Value Mode
0 Automatic
1 Semi-Automatic
2 Manual

BT.BATCH.SELECT.SCHED_MODE_STR - String tag containing the mode of the

selected batch.
BT.BATCH.SELECT.SCHED_STATUS - Integer tag containing the status value of
the selected batch.

Value Status
0 Open
1 Ready
2 Wait
3 Run

502
17. Tag Interface Management (TIM) System B0193YB – Rev C

Value Status
4 Done
5 Interlock
6 Aborted
7 Held
8 Aborting
9 Continue
10 Locking
11 Locked

BT.BATCH.SELECT.SCHED_STATUS_STR - String tag containing the status of

the selected batch.
BT.BATCH.SELECT.SCHED_EDIT_MASK - Integer tag containing the configura-
tion of the selected batch.

Bit Offset Value Action Permitted

0 1 Batch Start
1 2 Batch Hold
2 4 Batch Restart
3 8 Batch Abort
4 16 Edit Mode
5 32 Operator Action
6 64 Lock Batch
7 128 Unlock Batch

The BT.BATCH.SELECT.SCHED_EDIT_MASK tag contains the composite value

of all of the bit offsets that pertain to the configuration settings of the selected batch.
The value of this tag is the sum of all of the values in the table above for each configu-
ration item selected. For example, if the batch is in Held and can be restarted or
aborted, the tag value is 12.
BT.BATCH.SELECT.SCHED_CLBFOCUSOK - Integer tag containing the focus
status of the selected batch.

503
B0193YB – Rev C 17. Tag Interface Management (TIM) System

Value Description
0 There is no batch selected.
1 or 2 The selected batch has not yet been started or has been com-
pleted, and should not be used to manipulate the recipe focus. If
two batches that match this criteria are selected sequentially, this
tag toggles between one and two. This allows the user to define
data change logic on this value.
3 or 4 The selected batch is running, held, or aborting, and it is permis-
sible to manipulate the recipe focus. If two batches that match
this criteria are selected sequentially, this tag toggles between
three and four. This allows the user to define data change logic on
this value.

7. The BT.BATCH.SECURITY.DONEBY tag specifies the ID and the

BT.BATCH.SECURITY.DONEBY_PWD tag specifies the password for the user
executing the action. The user ID and password should be obtained from the operator
once or whenever an action is to be executed. Values are required for these tags if secu-
rity has been configured for the Batch Client functions in the Security Editor.
8. The BT.BATCH.SECURITY.CHECKBY tag specifies the ID and the
BT.BATCH.SECURITY.CHECKBY_PWD tag specifies the password for the user
executing the action. The user ID and password should be obtained from the operator
once or whenever an action is to be executed. Values are required for these tags if secu-
rity has been configured for the Batch Client functions in the Security Editor.
9. The BT.BATCH.COMM.INFO tag is an integer tag used to monitor the working
state of the batch management system. This tag is equal to one when the batch system
is busy. New TIM commands are not immediately processed while this tag is enabled.
Operation can resume when the value of this tag is zero. The
BT.BATCH.COMM.HANDSHAKE tag has a value of -118 when the
BT.BATCH.COMM.INFO tag is enabled.
10. The BT.BATCH.COMM.HANDSHAKE tag is an integer tag that is written to ini-
tiate a specified action and read to monitor the results of the action. The handshake
values are provided in the table below.

Handshake Value Description

1 Abort the batch defined by the
BT.BATCH.SELECT.SCHED_ITEM tag.
2 Hold the batch defined by the
BT.BATCH.SELECT.SCHED_ITEM tag.
3 Restart the batch defined by the
BT.BATCH.SELECT.SCHED_ITEM tag.
4 Start the batch defined by the
BT.BATCH.SELECT.SCHED_ITEM tag.

504
17. Tag Interface Management (TIM) System B0193YB – Rev C

Handshake Value Description

5 Changes the mode of the batch defined by the
T.BATCH.SELECT.SCHED_ITEM tag to Auto-
matic. Same as the Batch Mode: Set
6 Changes the mode of the batch defined by the
BT.BATCH.SELECT.SCHED_ITEM tag to Semi-
Automatic. Same as the Batch Mode:
7 Changes the mode of the batch defined by the
BT.BATCH.SELECT.SCHED_ITEM tag to Manual.
8 Re-evaluate the units defined in the
BT.BATCH.FOCUS.SCHED_LIST tag and update
the list according to the focus change.
9 Starts Manual Operation.
10 Lock the batch for Jump Mode as defined by the
BT.BATCH.SELECT.SCHED_ITEM tag.
11 Unlock the batch for Jump Mode as defined by the
BT.BATCH.SELECT.SCHED_ITEM tag.

Manipulate Recipe Focus

This is a very important action group that allows the user to define different criteria used for
selecting the batch that is monitored or changed through tags.

Table 17-5. Manipulate Recipe Focus Tags

Tag Name Type Size Access

BT.RECIPE.FOCUS.CLB STRING 50 R/W
This tag consists of three fields separated by a “/”.
CAMPAIGN ID 16
LOT ID 16
BATCH ID 16
BT.RECIPE.FOCUS.UNIT STRING 16 R/W
BT.RECIPE.COMM.HANDSHAKE INTEGER 1 R/W

1. The BT.RECIPE.FOCUS.CLB tag is a string tag that defines the Campaign, Lot, and
Batch combination that is the batch focus for the action.
2. The BT.RECIPE.FOCUS.UNIT tag is a string tag that defines the unit that is the
unit focus for the action. If an asterisk “*” is written to this tag, then the focus is on all
equipment associated with the batch defined by the BT.RECIPE.FOCUS.CLB tag. If
a null string “” is written to this tag, then the focus is on the batch defined by the
BT.RECIPE.FOCUS.CLB tag.
3. The BT.RECIPE.COMM.HANDSHAKE tag is an integer tag that is written to ini-
tiate an update of the batch and phase related interface groups according to the values
assigned to the focus tags. The handshake values and affected interface groups are pro-
vided in the tables below.

505
B0193YB – Rev C 17. Tag Interface Management (TIM) System

Handshake Value Description

1 Change focus according to the values defined
for the batch and unit focus tags.

Interface Groups Affected by this Focus Setting

Monitor and Respond to Batch Questions
Enter Batch Comments
Monitor and Control Active Phases
Select Equipment for Allocation

Monitor and Respond to Batch Questions

This action group allows the user to perform all of the functions available from the question por-
tion of the Batch Display through tags. There are tags that can be used to view and answer ques-
tions for any active batch.

Table 17-6. Batch Question Tags

Tag Name Type Size Access

BT.RECIPE_QUES.QUESTION_LIST.NUM_ITEMS INTEGER 1 RO
BT.RECIPE_QUES.QUESTION_LIST.FIRST_ITEM INTEGER 1 R/W
BT.RECIPE_QUES.QUESTION_LIST.ITEM1 TO STRING 40 RO
BT.RECIPE_QUES.QUESTION_LIST.ITEM16
BT.RECIPE_QUES.SELECT.QUESTION_ITEM INTEGER 1 R/W
BT.RECIPE_QUES.SELECT.QUESTION STRING 40 RO
BT.RECIPE_QUES.SELECT.QUESTION_TYPE INTEGER 1 RO
BT.RECIPE_QUES.SELECT.SECURITY INTEGER 1 RO
BT.RECIPE_QUES.SECURITY.DONEBY STRING 12 R/W
BT.RECIPE_QUES.SECURITY.DONEBY_PWD STRING 12 R/W
BT.RECIPE_QUES.SECURITY.CHECKBY STRING 12 R/W
BT.RECIPE_QUES.SECURITY.CHECKBY_PWD STRING 12 R/W
BT.RECIPE_QUES.COMM.HANDSHAKE INTEGER 1 R/W

1. The BT.RECIPE_QUES.QUESTION_LIST.NUM_ITEMS tag is an integer tag

containing the number of question items currently in the list. The list is determined
by the focus that is established using the Manipulate Recipe Focus action group
described earlier.
2. The BT.RECIPE_QUES.QUESTION_LIST.ITEM1 to
BT.RECIPE_QUES.QUESTION_LIST.ITEM16 tags are string tags used to display
the list of questions. The first item in the list is defined by the value in tag
BT.RECIPE_QUES.QUESTION_LIST.FIRST_ITEM.

506
17. Tag Interface Management (TIM) System B0193YB – Rev C

3. The BT.RECIPE_QUES.SELECT.QUESTION_ITEM tag is an integer tag used to

select the item in the list that is the focus of the action being performed. This is equiv-
alent to the selection of the question from the list with the mouse.
4. The following tags contain the specific question information corresponding to the
selected item from the list.
BT.RECIPE_QUES.SELECT.QUESTION - String tag containing the current
selected question.
BT.RECIPE_QUES.SELECT.QUESTION_TYPE - Integer tag containing the type
of the current question.

Value Question Type

0 Loop Back
1 Transition Logic

BT.RECIPE_QUES.SELECT.SECURITY - Integer tag containing the type of the

question security required.

Value Security Required

0 None
1 DoneBy Only
2 DoneBy and CheckBy

5. The BT.RECIPE_QUES.SECURITY.DONEBY tag specifies the ID and the

BT.RECIPE_QUES.SECURITY.DONEBY_PWD tag specifies the password for the
user executing the action. The user ID and password should be obtained from the
operator once or whenever an action is to be executed. Values are required for these
tags if security has been configured for the Batch Client functions in the Security
Editor.
6. The BT.RECIPE_QUES.SECURITY.CHECKBY tag specifies the ID and the
BT.RECIPE_QUES.SECURITY.CHECKBY_PWD tag specifies the password for
the user executing the action. The user ID and password should be obtained from the
operator once or whenever an action is to be executed. Values are required for these
tags if security has been configured for the Batch Client functions in the Security
Editor.
7. The BT.RECIPE_QUES.COMM.HANDSHAKE tag is an integer tag that is written
to initiate a specified action and read to monitor the results of the action. The hand-
shake values are provided in the table below.

Handshake Value Description

1 Answer Yes to the question selected by the
BT.RECIPE_QUES.SELECT.QUESTION_ITEM tag.
2 Answer No to the question selected by the
BT.RECIPE_QUES.SELECT.QUESTION_ITEM tag.

507
B0193YB – Rev C 17. Tag Interface Management (TIM) System

Enter Batch Comments

This action group allows the user to enter comments that pertain to the execution of batches
through tags. There are tags that can be used to enter and submit comments for any active batch.

Table 17-7. Batch Comments Tags

Tag Name Type Size Access

BT.RECIPE_COMMENT.INPUT.COMMENT STRING 80 R/W
BT.RECIPE_COMMENT.SECURITY.DONEBY STRING 12 R/W
BT.RECIPE_COMMENT.SECURITY.DONEBY_PWD STRING 12 R/W
BT.RECIPE_COMMENT.SECURITY.CHECKBY STRING 12 R/W
BT.RECIPE_COMMENT.SECURITY.CHECKBY_PWD STRING 12 R/W
BT.RECIPE_COMMENT.COMM.HANDSHAKE INTEGER 1 R/W

1. The BT.RECIPE_COMMENT.INPUT.COMMENT tag is a string tag used to enter

the desired comment. The comment is assigned to the batch determined by the focus
that is established using the Manipulate Recipe Focus action group described earlier.
2. The BT.RECIPE_COMMENT.SECURITY.DONEBY tag specifies the ID and the
BT.RECIPE_COMMENT.SECURITY.DONEBY_PWD tag specifies the password
for the user executing the action. The user ID and password should be obtained from
the operator once or whenever an action is to be executed. Values are required for
these tags if security has been configured for the Batch Client functions in the Security
Editor.
3. The BT.RECIPE_COMMENT.SECURITY.CHECKBY tag specifies the ID and the
BT.RECIPE_COMMENT.SECURITY.CHECKBY_PWD tag specifies the pass-
word for the user executing the action. The user ID and password should be obtained
from the operator once or whenever an action is to be executed. Values are required
for these tags if security has been configured for the Batch Client functions in the
Security Editor.
4. The BT.RECIPE_COMMENT.COMM.HANDSHAKE tag is an integer tag that is
written to initiate a specified action and read to monitor the results of the action. The
handshake values are provided in the table below.

Handshake Value Description

1 Enters the defined comment for the batch selected.

Monitor and Control Active Phases

This action group allows the user to perform all phase monitor and control functions available
from the Batch Display through tags. There are tags that can be used to select, view, and control
active phases and associated information for the selected batch.

508
17. Tag Interface Management (TIM) System B0193YB – Rev C

Table 17-8. Batch Phase Tags

Tag Name Type Size Access

BT.RECIPE_PHASE.PHASE_LIST.NUM_ITEMS INTEGER 1 RO
BT.RECIPE_PHASE.PHASE_LIST.FIRST_ITEM INTEGER 1 R/W
BT.RECIPE_PHASE.PHASE_LIST.ITEM1 TO STRING 84 RO
BT.RECIPE_PHASE.PHASE_LIST.ITEM16
Each list tag consists of six fields separated by two spaces.
EQUIPMENT 16
UNIT PROCEDURE 16
OPERATION 16
PHASE 16
STATUS 8
ACTION 2
BT.RECIPE_PHASE.INSTRUCT_LIST.NUM_ITEMS INTEGER 1 RO
BT.RECIPE_PHASE.INSTRUCT_LIST.FIRST_ITEM INTEGER 1 R/W
BT.RECIPE_PHASE.INSTRUCT_LIST.ITEM1 TO STRING 40 RO
BT.RECIPE_PHASE.INSTRUCT_LIST.ITEM16
BT.RECIPE_PHASE.INTERLOCK_LIST.NUM_ITEMS INTEGER 1 RO
BT.RECIPE_PHASE.INTERLOCK_LIST.FIRST_ITEM INTEGER 1 R/W
BT.RECIPE_PHASE.INTERLOCK_LIST.ITEM1 TO STRING 94 RO
BT.RECIPE_PHASE.INTERLOCK_LIST.ITEM16
Each list tag consists of two fields separated by two spaces.
TAG NAME 84
VALUE 8
BT.RECIPE_PHASE.PARAM_EXT_LIST.NUM_ITEMS INTEGER 1 RO
BT.RECIPE_PHASE.PARAM_EXT_LIST.FIRST_ITEM INTEGER 1 R/W
BT.RECIPE_PHASE.PARAM_EXT_LIST.ITEM1 TO STRING 112 RO
BT.RECIPE_PHASE.PARAM_EXT_LIST.ITEM16
Each list tag consists of six fields separated by two spaces.
PARAMETER NAME 16
PARAMETER TYPE 12
EXTENSION 12
VALUE 16
EDIT STATUS 8
UNIT OF MEASURE 16
DATA CLASS 2
ENUMERATION SET 16
BT.RECIPE_PHASE.SELECT.PHASE_ITEM INTEGER 1 R/W
BT.RECIPE_PHASE.SELECT.PHASE_EQUIPMENT STRING 16 RO
BT.RECIPE_PHASE.SELECT.PHASE_UNITPROC STRING 16 RO

509
B0193YB – Rev C 17. Tag Interface Management (TIM) System

Table 17-8. Batch Phase Tags (Continued)

Tag Name Type Size Access

BT.RECIPE_PHASE.SELECT.PHASE_OPERATION STRING 16 RO
BT.RECIPE_PHASE.SELECT.PHASE_NAME STRING 16 RO
BT.RECIPE_PHASE.SELECT.PHASE_LABEL STRING 8 RO
BT.RECIPE_PHASE.SELECT.PHASE_STATUS INTEGER 1 RO
BT.RECIPE_PHASE.SELECT.PHASE_EDIT_MASK INTEGER 1 RO
BT.RECIPE_PHASE.SELECT.PHASE_LABEL1 STRING 8 RO
BT.RECIPE_PHASE.SELECT.PHASE_LABEL2 STRING 8 RO
BT.RECIPE_PHASE.SELECT.PHASE_OPERMSGINT INTEGER 1 RO
BT.RECIPE_PHASE.SELECT.PHASE_OPERMSG STRING 50 RO
BT.RECIPE_PHASE.SELECT.PHASE_DOCUMENT STRING 128 RO
BT.RECIPE_PHASE.SELECT.PHASE_DESC STRING 120 RO
BT.RECIPE_PHASE.SELECT.PARAM_EXT_ITEM INTEGER 1 R/W
BT.RECIPE_PHASE.SELECT.PARAM_NAME STRING 16 RO
BT.RECIPE_PHASE.SELECT.PARAM_TYPE INTEGER 1 RO
BT.RECIPE_PHASE.SELECT.PARAM_EXT INTEGER 1 RO
BT.RECIPE_PHASE.SELECT.PARAM_UOM STRING 16 RO
BT.RECIPE_PHASE.SELECT.PARAM_EDIT_TYPE INTEGER 1 RO
BT.RECIPE_PHASE.SELECT.PARAM_DATACLASS INTEGER 1 RO
BT.RECIPE_PHASE.SELECT.PARAM_SET STRING 16 RO
BT.RECIPE_PHASE.SELECT.PARAM_EXT_VALUE STRING 80 RO
BT.RECIPE_PHASE.SELECT.PARAM_DESC STRING 120 RO
BT.RECIPE_PHASE.SELECT.INSTRUCT_ITEM INTEGER 1 R/W
BT.RECIPE_PHASE.SELECT.INSTRUCT STRING 40 RO
BT.RECIPE_PHASE.SELECT.INTERLOCK_ITEM INTEGER 1 R/W
BT.RECIPE_PHASE.SELECT.INTERLOCK_TAG STRING 84 RO
BT.RECIPE_PHASE.SELECT.INTERLOCK_STATUS STRING 8 RO
BT.RECIPE_PHASE.INPUT.PHASE_COMMENT STRING 80 R/W
BT.RECIPE_PHASE.INPUT.PARAM_EXT_VALUE STRING 80 R/W
BT.RECIPE_PHASE.SECURITY.DONEBY STRING 12 R/W
BT.RECIPE_PHASE.SECURITY.DONEBY_PWD STRING 12 R/W
BT.RECIPE_PHASE.SECURITY.CHECKBY STRING 12 R/W
BT.RECIPE_PHASE.SECURITY.CHECKBY_PWD STRING 12 R/W
BT.RECIPE_PHASE.COMM.HANDSHAKE INTEGER 1 R/W

1. The BT.RECIPE_PHASE.PHASE_LIST.NUM_ITEMS tag is an integer tag con-

taining the number of phase items currently in the list. The list is determined by the
focus that is established using the Manipulate Recipe Focus action group described
earlier.

510
17. Tag Interface Management (TIM) System B0193YB – Rev C

2. The BT.RECIPE_PHASE.PHASE_LIST.ITEM1 to
BT.RECIPE_PHASE.PHASE_LIST.ITEM16 tags are string tags used to display the
list of active phases in the selected batch. The first item in the list is defined by the
value in tag BT.RECIPE_PHASE.PHASE_LIST.FIRST_ITEM.

NOTE
The “Use 3 Levels” application parameter must be enabled in the Environment Edi-
tor for the TIMBatch application for the operation name field to be included in the
list tags.

3. The BT.RECIPE_PHASE.SELECT.PHASE_ITEM tag is an integer tag used to select

the item in the list that is the focus of the action being performed. This is equivalent
to the selection of the phase from the list with the mouse.
4. The following tags contain the specific schedule information corresponding to the
selected item from the list.
BT.RECIPE_PHASE.SELECT.PHASE_EQUIPMENT - String tag containing the
unit or connection associated with the selected phase.
BT.RECIPE_PHASE.SELECT.PHASE_UNITPROC - String tag containing the
unit procedure running the selected phase.
BT.RECIPE_PHASE.SELECT.PHASE_OPERATION - String tag containing the
operation running the selected phase.
BT.RECIPE_PHASE.SELECT.PHASE_NAME - String tag containing the name of
the selected phase.
BT.RECIPE_PHASE.SELECT.PHASE_DESC - String tag containing the descrip-
tion of the selected phase.
BT.RECIPE_PHASE.SELECT.PHASE_LABEL - String tag containing the label of
the selected phase.
BT.RECIPE_PHASE.SELECT.PHASE_STATUS - Integer tag containing the status
of the selected phase.

Value Phase Status

1 Ready
2 Wait
3 Run
4 Done
5 Interlocked
6 Aborted
7 Held
9 Continue

BT.RECIPE_PHASE.SELECT.PHASE_EDIT_MASK - Integer tag containing the

configuration of the selected phase.

511
B0193YB – Rev C 17. Tag Interface Management (TIM) System

Bit Offset Value Description

0 1 Ack On Entry Required
1 2 DoneBy Ack On Entry Required
2 4 CheckBy Ack On Entry Required
3 8 Ack On Exit Required
4 16 DoneBy Ack On Exit Required
5 32 CheckBy Ack On Exit Required
6 64 Comment Required
7 128 Hold Permitted
8 256 Restart Permitted
9 512 Abort Permitted
10 1024 Start Permitted
11 2048 Operator Action Required
12 4096 Control Button 1 Available
13 8192 Control Button 2 Available
14 16384 Partial Add Ack On Exit Required
15 32768 Continue Mode Enabled
16 65536 View Document On Entry Required
17 131072 View Document On Exit Required
18 262144 Ack Document On Entry Required
19 524288 Ack Document On Exit Required
20 1048576 Continue Mode Can Be Enabled
21 2097152 Manual Phase - Ack On Exit Always Enabled
7 General Ack Entry Mask
56 General Ack Exit Mask
16447 General Ack Mask

The BT.RECIPE_PHASE.SELECT.PHASE_EDIT_MASK tag contains the compos-

ite value of all bit offsets that pertain to the configuration settings of the selected
phase. The value of this tag is the sum of all the values in the table above for each con-
figuration item set. For example, if the phase is in Held and can be restarted or
aborted and control button one is available, the tag value is 4864.
BT.RECIPE_PHASE.SELECT.PHASE_LABEL1 - String tag containing the label of
control button 1 label for the selected phase.
BT.RECIPE_PHASE.SELECT.PHASE_LABEL2 - String tag containing the label of
control button 2 label for the selected phase.
BT.RECIPE_PHASE.SELECT.PHASE_OPERMSGINT - Integer tag containing the
value of the message being displayed for the selected phase.

512
17. Tag Interface Management (TIM) System B0193YB – Rev C

Value Message
0 None
1 Waiting for Phase Start.
2 Waiting for entry acknowledge.
3 Waiting for exit acknowledge.
4 Waiting for Required Edits.
5 Waiting for Required Comment.
6 Waiting for Phase Status.
7 Waiting for Phase Start
8 Partial Add. Waiting for Exit Acknowledge.
9 Waiting for document viewing.
10 Waiting for document acknowledge.
11 Writing phase parameters.
12 Reading phase parameters.

BT.RECIPE_PHASE.SELECT.PHASE_OPERMSG - String tag containing the mes-

sage being displayed for the selected phase.
BT.RECIPE_PHASE.SELECT.PHASE_DOCUMENT - String tag containing the
path of the document assigned to the selected phase.
5. The BT.RECIPE_PHASE.INPUT.PHASE_COMMENT tag is a string tag used to
enter in a comment for the selected phase.
6. The BT.RECIPE_PHASE.PARAM_EXT_LIST.NUM_ITEMS tag is an integer tag
containing the number of parameter items currently in the list.
7. The BT.RECIPE_PHASE.PARAM_EXT_LIST.ITEM1 to
BT.RECIPE_PHASE.PARAM_EXT_LIST.ITEM16 tags are string tags used to dis-
play the list of active parameters in the selected phase. The first item in the list is
defined by the value in tag
BT.RECIPE_PHASE.PARAM_EXT_LIST.FIRST_ITEM.
8. The BT.RECIPE_PHASE.SELECT.PARAM_EXT_ITEM tag is an integer tag used
to select the item in the list that is the focus of the action being performed. This is
equivalent to the selection of the parameter from the list with the mouse.
9. The following tags contain the specific schedule information corresponding to the
selected item from the list.
BT.RECIPE_PHASE.SELECT.PARAM_NAME - String tag containing the name of
the selected phase.
BT.RECIPE_PHASE.SELECT.PARAM_TYPE - Integer tag containing the type of
the selected phase.

513
B0193YB – Rev C 17. Tag Interface Management (TIM) System

Value Description
0 Input
9 Process Variable
12 Output

BT.RECIPE_PHASE.SELECT.PARAM_EXT - Integer tag containing the type of

extension of the selected phase.

Value Description
1 Material ID
2 Material Name
3 Target
4 Actual
5 High Deviation
6 Low Deviation
7 Lot Code
8 Preact
9 High Limit
10 Low Limit

BT.RECIPE_PHASE.SELECT.PARAM_UOM - String tag containing the unit of

measure of the selected parameter.
BT.RECIPE_PHASE.SELECT.PARAM_EDIT_TYPE - Integer tag containing the
editing that is allowed for the selected phase.

Value Editing Permitted

0 None
1 Numeric Entry Allowed
2 Alphanumeric Entry Allowed
3 Numeric Entry Required
4 Alphanumeric Entry Required

BT.RECIPE_PHASE.SELECT.PARAM_DATACLASS - String tag containing the

data class of the selected parameter.

514
17. Tag Interface Management (TIM) System B0193YB – Rev C

Value Description
0 Analog
1 Discrete
2 String
3 Enumeration

BT.RECIPE_PHASE.SELECT.PARAM_SET - String tag containing the enumera-

tion set name of the selected parameter.
BT.RECIPE_PHASE.SELECT.PARAM_EXT_VALUE - String tag containing the
value of the selected parameter.
BT.RECIPE_PHASE.SELECT.PARAM_DESC - String tag containing the descrip-
tion of the selected parameter.
10. The BT.RECIPE_PHASE.INPUT.PARAM_EXT_VALUE tag is a string tag used to
enter in a new value for the selected parameter.
11. The BT.RECIPE_PHASE.INSTRUCT_LIST.NUM_ITEMS tag is an integer tag
containing the number of instruction items currently in the list.
12. The BT.RECIPE_PHASE.INSTRUCT_LIST.ITEM1 to
BT.RECIPE_PHASE.INSTRUCT_LIST.ITEM16 tags are string tags used to display
the list of active instruction for the selected phase. The first item in the list is defined
by the value in tag BT.RECIPE_PHASE.INSTRUCT_LIST.FIRST_ITEM.
13. The BT.RECIPE_PHASE.SELECT.INSTRUCT_ITEM tag is an integer tag used to
select the item in the list that is the focus of the action being performed. This is equiv-
alent to the selection of the instruction from the list with the mouse.
14. The following tag contains the specific schedule information corresponding to the
selected item from the list.
BT.RECIPE_PHASE.SELECT.INSTRUCT - String tag containing the selected line
of the instruction.
15. The BT.RECIPE_PHASE.INTERLOCK_LIST.NUM_ITEMS tag is an integer tag
containing the number of interlock items currently in the list.
16. The BT.RECIPE_PHASE.INTERLOCK_LIST.ITEM1 to
BT.RECIPE_PHASE.INTERLOCK_LIST.ITEM16 tags are string tags used to dis-
play the list of active interlock tags for the selected phase. The first item in the list is
defined by the value in tag
BT.RECIPE_PHASE.INTERLOCK_LIST.FIRST_ITEM.
17. The BT.RECIPE_PHASE.SELECT.INTERLOCK_ITEM tag is an integer tag used
to select the item in the list that is the focus of the action being performed. This is
equivalent to the selection of the interlock from the list with the mouse.
18. The following tag contains the specific schedule information corresponding to the
selected item from the list.
BT.RECIPE_PHASE.SELECT.INTERLOCK_TAG - String tag containing the tag
associated with the selected interlock.

515
B0193YB – Rev C 17. Tag Interface Management (TIM) System

BT.RECIPE_PHASE.SELECT.INTERLOCK_STATUS - String tag containing the

value of the selected interlock.
19. The BT.RECIPE_PHASE.SECURITY.DONEBY tag specifies the ID and the
BT.RECIPE_PHASE.SECURITY.DONEBY_PWD tag specifies the password for
the user executing the action. The user ID and password should be obtained from the
operator once or whenever an action is to be executed. Values are required for these
tags if security has been configured for the Batch Client functions in the Security
Editor.
20. The BT.RECIPE_PHASE.SECURITY.CHECKBY tag specifies the ID and the
BT.RECIPE_PHASE.SECURITY.CHECKBY_PWD tag specifies the password for
the user executing the action. The user ID and password should be obtained from the
operator once or whenever an action is to be executed. Values are required for these
tags if security has been configured for the Batch Client functions in the Security
Editor.
21. The BT.RECIPE_PHASE.COMM.HANDSHAKE tag is an integer tag that is writ-
ten to initiate a specified action and read to monitor the results of the action. The
handshake values are provided in the table below.

Handshake Value Description

1 Abort the phase defined by the
BT.RECIPE_PHASE.SELECT.PHASE_ITEM tag.
2 Hold the phase defined by the
BT.RECIPE_PHASE.SELECT.PHASE_ITEM tag.
3 Restart the phase defined by the
BT.RECIPE_PHASE.SELECT.PHASE_ITEM tag.
4 Start the phase defined by the
BT.RECIPE_PHASE.SELECT.PHASE_ITEM tag.
5 Acknowledge the phase defined by the
BT.RECIPE_PHASE.SELECT.PHASE_ITEM tag. Executes both the Ack
On Entry and Ack On Exit commands.
6 Enter the comment to the phase defined by the
BT.RECIPE_PHASE.SELECT.PHASE_ITEM tag.
7 Performs the selection of control button 1.
8 Performs the selection of control button 2.
9 Change the value of the parameter defined by the
BT.RECIPE_PHASE.SELECT.PARAM_EXT_ITEM tag.
10 View the document assigned to the phase defined by the
BT.RECIPE_PHASE.SELECT.PHASE_ITEM tag.
11 Acknowledge the document assigned to the phase defined by the
BT.RECIPE_PHASE.SELECT.PHASE_ITEM tag.
12 Display the Foxboro SFC for the phase defined by the
BT.RECIPE_PHASE.SELECT.PHASE_ITEM tag.

516
17. Tag Interface Management (TIM) System B0193YB – Rev C

Select Equipment for Allocation

This action group allows the user to perform all functions available from the Equipment Selection
dialog box of the Batch Display through tags. There are tags that can be used to select equipment
for any active batch.

Table 17-9. Batch Selection Tags

Tag Name Type Size Access

BT.RECIPE_SELECT.INSTANCE_LIST.NUM_ITEMS INTEGER 1 RO
BT.RECIPE_SELECT.INSTANCE_LIST.FIRST_ITEM INTEGER 1 R/W
BT.RECIPE_SELECT.INSTANCE_LIST.ITEM1 TO STRING 16 RO
BT.RECIPE_SELECT.INSTANCE_LIST.ITEM16
BT.RECIPE_SELECT.UNIT_LIST.NUM_ITEMS INTEGER 1 RO
BT.RECIPE_SELECT.UNIT_LIST.FIRST_ITEM INTEGER 1 R/W
BT.RECIPE_SELECT.UNIT_LIST.ITEM1 TO STRING 34 RO
BT.RECIPE_SELECT.UNIT_LIST.ITEM16
Each list tag consists of two fields separated by two spaces.
UNIT NAME 16
STATUS 16
BT.RECIPE_SELECT.SELECT.INSTANCE_ITEM INTEGER 1 R/W
BT.RECIPE_SELECT.SELECT.INSTANCE_NAME STRING 16 RO
BT.RECIPE_SELECT.SELECT.UNIT_ITEM INTEGER 1 R/W
BT.RECIPE_SELECT.SELECT.UNIT_NAME STRING 16 RO
BT.RECIPE_SELECT.SELECT.UNIT_STATUS STRING 16 RO
BT.RECIPE_SELECT.SECURITY.DONEBY STRING 12 R/W
BT.RECIPE_SELECT.SECURITY.DONEBY_PWD STRING 12 R/W
BT.RECIPE_SELECT.SECURITY.CHECKBY STRING 12 R/W
BT.RECIPE_SELECT.SECURITY.CHECKBY_PWD STRING 12 R/W
BT.RECIPE_SELECT.COMM.HANDSHAKE INTEGER 1 R/W

1. The BT.RECIPE_SELECT.INSTANCE_LIST.NUM_ITEMS tag is an integer tag

containing the number of instance items currently in the list. The list is determined
by the focus that is established using the Manipulate Recipe Focus action group
described earlier.
2. The BT.RECIPE_SELECT.INSTANCE_LIST.ITEM1 to
BT.RECIPE_SELECT.INSTANCE_LIST.ITEM16 tags are string tags used to dis-
play the list of instances. The first item in the list is defined by the value in tag
BT.RECIPE_SELECT.INSTANCE_LIST.FIRST_ITEM.
3. The BT.RECIPE_SELECT.SELECT.INSTANCE_ITEM tag is an integer tag used to
select the item in the list that is the focus of the action being performed. This is equiv-
alent to the selection of the instance from the list with the mouse.
4. The following tag contains the specific question information corresponding to the
selected item from the list.

517
B0193YB – Rev C 17. Tag Interface Management (TIM) System

BT.RECIPE_SELECT.SELECT.INSTANCE_NAME - String tag containing the

name of the selected instance.
5. The BT.RECIPE_SELECT.UNIT_LIST.NUM_ITEMS tag is an integer tag contain-
ing the number of units available for selection and assignment to the selected instance.
6. The BT.RECIPE_SELECT.UNIT_LIST.ITEM1 to
BT.RECIPE_SELECT.UNIT_LIST.ITEM16 tags are string tags used to display the
list of units and associated information. The first item in the list is defined by the
value in tag BT.RECIPE_SELECT.UNIT_LIST.FIRST_ITEM.
7. The BT.RECIPE_SELECT.SELECT.UNIT_ITEM tag is an integer tag used to select
the item in the list that is the focus of the action being performed. This is equivalent
to the selection of the unit from the list with the mouse.
8. The following tags contain the specific question information corresponding to the
selected item from the list.
BT.RECIPE_SELECT.SELECT.UNIT_NAME - String tag containing the name of
the selected unit.
BT.RECIPE_SELECT.SELECT.UNIT_STATUS - String tag containing the status of
the selected unit. The status values correspond to those defined in the Process Model.
9. The BT.RECIPE_SELECT.SECURITY.DONEBY tag specifies the ID and the
BT.RECIPE_SELECT.SECURITY.DONEBY_PWD tag specifies the password for
the user executing the action. The user ID and password should be obtained from the
operator once or whenever an action is to be executed. Values are required for these
tags if security has been configured for the Batch Client functions in the Security
Editor.
10. The BT.RECIPE_SELECT.SECURITY.CHECKBY tag specifies the ID and the
BT.RECIPE_SELECT.SECURITY.CHECKBY_PWD tag specifies the password for
the user executing the action. The user ID and password should be obtained from the
operator once or whenever an action is to be executed. Values are required for these
tags if security has been configured for the Batch Client functions in the Security
Editor.
11. The BT.RECIPE_SELECT.COMM.HANDSHAKE tag is an integer tag that is writ-
ten to initiate a specified action and read to monitor the results of the action. The
handshake values are provided in the table below.

Handshake Value Description

1 Assign the unit selected by the
BT.RECIPE_SELECT.SELECT.UNIT_ITEM tag to
the instance selected by the
BT.RECIPE_SELECT.SELECT.INSTANCE_ITEM
tag.

Monitor Batch Messages

This action group allows the user to perform all of the functions available from the Batch Mes-
sages dialog box through tags. There are tags that can be used to view and display all messages for
active batches within a client environment.

518
17. Tag Interface Management (TIM) System B0193YB – Rev C

Table 17-10. Batch Message Tags

Tag Name Type Size Access

BT.MESSAGE.FOCUS.CLB STRING 50 R/W
This tag consists of three fields separated by a “/”.
CAMPAIGN ID 16
LOT ID 16
BATCH ID 16
BT.MESSAGE.FOCUS.UNIT STRING 16 R/W
BT.MESSAGE.MESSAGE_LIST.NUM_ITEMS INTEGER 1 RO
BT.MESSAGE.MESSAGE_LIST.FIRST_ITEM INTEGER 1 R/W
BT.MESSAGE.MESSAGE_LIST.ITEM1 TO STRING 80 RO
BT.MESSAGE.MESSAGE_LIST.ITEM16
BT.MESSAGE.SELECT.MESSAGE_ITEM INTEGER 1 R/W
BT.MESSAGE.SELECT.MESSAGE STRING 80 RO
BT.MESSAGE.COMM.HANDSHAKE INTEGER 1 R/W

Description
1. The BT.MESSAGE.FOCUS.CLB tag is a string tag that defines the Campaign, Lot,
and Batch combination that is the batch focus for the action.
2. The BT.MESSAGE.FOCUS.UNIT tag is a string tag that defines the unit that is the
unit focus for the action. If an asterisk “*” is written to this tag, then the focus is on all
equipment associated with the batch defined by BT.MESSAGE.FOCUS.CLB tag. If a
null string “” is written to this tag, then the focus is on the batch defined by the
BT.MESSAGE.FOCUS.CLB tag.
3. The BT.MESSAGE.COMM.HANDSHAKE tag is an integer tag that is written to
initiate an update of the message list according to the values assigned to the focus tags.
The handshake values are provided in the table below.

Handshake Value Description

1 Change the batch or unit focus for any batch messages.

4. The BT.MESSAGE.MESSAGE_LIST.NUM_ITEMS tag specifies the number of

pending Batch Messages. The number of possible messages does not exceed the num-
ber of messages that can be displayed. If the message list is full and a new message is
received, the oldest message is removed from the list and the new messages are added.
Messages are maintained in chronological order with BT.MES-
SAGE.MESSAGE_LIST.ITEM1 being the oldest message.
5. The BT.MESSAGE.MESSAGE_LIST.ITEM1 to
BT.MESSAGE.MESSAGE_LIST.ITEM16 tags are string tags used to display the list
of batch messages. The first item in the list is defined by the value in tag BT.MES-
SAGE.MESSAGE_LIST.FIRST_ITEM.

519
B0193YB – Rev C 17. Tag Interface Management (TIM) System

6. The BT.MESSAGE.SELECT.MESSAGE_ITEM tag is an integer tag used to select

the item in the list that is the focus of the action being performed. This is equivalent
to the selection of the message from the list with the mouse.
7. The following tag contains the specific message information corresponding to the
selected item from the list.
BT.MESSAGE.SELECT.MESSAGE - String tag containing the current selected
message.

Edit Phases and Parameters

This action group allows the user to perform all the functions available from the Phase/Parameter
Editor portion of the Batch Display through tags. There are tags that can be used to view and
change the parameters defined for any inactive phase.

Table 17-11. Phase Editing Tags

Tag Name Type Size Access

BT.PHASE_ED.FOCUS.CLB STRING 50 R/W
This tag consists of three fields separated by a “/”.
CAMPAIGN ID 16
LOT ID 16
BATCH ID 16
BT.PHASE_ED.PHASE_LIST.NUM_ITEMS INTEGER 1 RO
BT.PHASE_ED.PHASE_LIST.FIRST_ITEM INTEGER 1 R/W
BT.PHASE_ED.PHASE_LIST.ITEM1 TO STRING 80 RO
BT.PHASE_ED.PHASE_LIST.ITEM16
Each list tag consists of five fields separated by two spaces.
INSTANCE NAME 16
UNIT PROCEDURE 16
OPERATION 16
LABEL 8
PHASE NAME 16
BT.PHASE_ED.INSTRUCT_LIST.NUM_ITEMS INTEGER 1 RO
BT.PHASE_ED.INSTRUCT_LIST.FIRST_ITEM INTEGER 1 R/W
BT.PHASE_ED.INSTRUCT_LIST.ITEM1 TO STRING 40 RO
BT.PHASE_ED.INSTRUCT_LIST.ITEM16
BT.PHASE_ED.PARAM_LIST.NUM_ITEMS INTEGER 1 RO
BT.PHASE_ED.PARAM_LIST.FIRST_ITEM INTEGER 1 R/W
BT.PHASE_ED.PARAM_LIST.ITEM1 TO STRING 102 RO
BT.PHASE_ED.PARAM_LIST.ITEM16
Each list tag consists of five fields separated by two spaces.
PARAMETER NAME 16
PARAMETER TYPE 8
MATERIAL ID 16

520
17. Tag Interface Management (TIM) System B0193YB – Rev C

Table 17-11. Phase Editing Tags (Continued)

Tag Name Type Size Access

VALUE 16
UNIT OF MEASURE 16
DATA CLASS 2
ENUMERATION SET 16
BT.PHASE_ED.SELECT.PHASE_ITEM INTEGER 1 R/W
BT.PHASE_ED.SELECT.PHASE_INSTANCE STRING 16 RO
BT.PHASE_ED.SELECT.PHASE_UNITPROC STRING 16 RO
BT.PHASE_ED.SELECT.PHASE_OPERATION STRING 16 RO
BT.PHASE_ED.SELECT.PHASE_LABEL STRING 8 RO
BT.PHASE_ED.SELECT.PHASE_NAME STRING 16 RO
BT.PHASE_ED.SELECT.PHASE_OPER_MASK INTEGER 1 R/W
BT.PHASE_ED.SELECT.PHASE_DESC STRING 120 RO
BT.PHASE_ED.SELECT.INSTRUCT_ITEM INTEGER 1 R/W
BT.PHASE_ED.SELECT.INSTRUCT STRING 40 RO
BT.PHASE_ED.SELECT.PARAM_ITEM INTEGER 1 R/W
BT.PHASE_ED.SELECT.PARAM_PARAM STRING 16 RO
BT.PHASE_ED.SELECT.PARAM_TYPE INTEGER 1 RO
BT.PHASE_ED.SELECT.PARAM_MTRLID STRING 16 RO
BT.PHASE_ED.SELECT.PARAM_MTRLNAME STRING 40 RO
BT.PHASE_ED.SELECT.PARAM_VALUE STRING 80 RO
BT.PHASE_ED.SELECT.PARAM_UOM STRING 16 RO
BT.PHASE_ED.SELECT.PARAM_DATACLASS INTEGER 1 RO
BT.PHASE_ED.SELECT.PARAM_SET STRING 16 RO
BT.PHASE_ED.SELECT.PARAM_DESC STRING 120 RO
BT.PHASE_ED.INPUT.INSTRUCT STRING 80 R/W
BT.PHASE_ED.INPUT.PARAM_VALUE STRING 16 R/W
BT.PHASE_ED.SECURITY.DONEBY STRING 12 R/W
BT.PHASE_ED.SECURITY.DONEBY_PWD STRING 12 R/W
BT.PHASE_ED.SECURITY.CHECKBY STRING 12 R/W
BT.PHASE_ED.SECURITY.CHECKBY_PWD STRING 12 R/W
BT.PHASE_ED.COMM.HANDSHAKE INTEGER 1 R/W

1. The BT.PHASE_ED.FOCUS.CLB tag is a string tag that defines the Campaign, Lot,
and Batch combination that is the batch focus for the action.
2. The BT.PHASE_ED.PHASE_LIST.NUM_ITEMS tag is an integer tag containing
the number of active phases in the selected batch.
3. The BT.PHASE_ED.PHASE_LIST.ITEM1 to
BT.PHASE_ED.PHASE_LIST.ITEM16 tags are string tags used to display the list of
active phases and associated information for the selected batch. The first item in the

521
B0193YB – Rev C 17. Tag Interface Management (TIM) System

list is defined by the value in tag BT.PHASE_ED.PHASE_LIST.FIRST_ITEM.

NOTE
The “Use 3 Levels” application parameter must be enabled in the Environment Edi-
tor for the TIMBatch application for the operation name field to be included in the
list tags.

4. The BT.PHASE_ED.SELECT.PHASE_ITEM tag is an integer tag used to select the

phase item in the list that is the focus of the action being performed. This is equiva-
lent to the selection of the phase from the list with the mouse.
5. The following tags contain the specific phase information corresponding to the
selected item from the list.
BT.PHASE_ED.SELECT.PHASE_INSTANCE - String tag containing the instance
name of the selected phase.
BT.PHASE_ED.SELECT.PHASE_UNITPROC - String tag containing the unit pro-
cedure name of the selected phase.
BT.PHASE_ED.SELECT.PHASE_OPERATION - String tag containing the opera-
tion name of the selected phase.
BT.PHASE_ED.SELECT.PHASE_LABEL - String tag containing the label of the
selected phase.
BT.PHASE_ED.SELECT.PHASE_NAME - String tag containing the name of the
selected phase.
BT.PHASE_ED.SELECT.PHASE_DESC - String tag containing the description of
the selected phase.
BT.PHASE_ED.SELECT.PHASE_OPER_MASK - Integer tag containing the con-
figuration of the selected phase.

Bit Offset Value Description

0 1 Ack On Entry Required
1 2 DoneBy Ack On Entry Required
2 4 CheckBy Ack On Entry Required
3 8 Ack On Exit Required
4 16 DoneBy Ack On Exit Required
5 32 CheckBy Ack On Exit Required
6 64 Comment Required
15 32768 Continue Mode Enabled
20 1048576 Continue Mode Can Be Enabled
21 2097152 Manual Phase - Ack On Exit Always Enabled
7 General Ack Entry Mask
56 General Ack Exit Mask
16447 General Ack Mask

522
17. Tag Interface Management (TIM) System B0193YB – Rev C

The BT.PHASE_ED.SELECT.PHASE_OPER_MASK tag contains the composite

value of all bit offsets that pertain to the configuration settings of the current phase.
The value of this tag is the sum of all of the values in the table above for each configu-
ration item selected. For example, if Ack On Entry and Comment Required are
selected, the tag value is 65. This tag can be written to as well to allow the current
phase configuration settings to be changed.
6. The BT.PHASE_ED.INSTRUCT_LIST.NUM_ITEMS tag is an integer tag contain-
ing the number of lines of instructions for the selected phase.
7. The BT.PHASE_ED.INSTRUCT_LIST.ITEM1 to
BT.PHASE_ED.INSTRUCT_LIST.ITEM16 tags are string tags used to display the
list of instructions for the selected phase. The first item in the list is defined by the
value in tag BT.PHASE_ED.INSTRUCT_LIST.FIRST_ITEM.
8. The BT.PHASE_ED.SELECT.INSTRUCT_ITEM tag is an integer tag used to select
the instruction item in the list that is the focus of the action being performed. This is
equivalent to the selection of the instruction from the list with the mouse.
9. The following tag contains the specific instruction information corresponding to the
selected item from the list.
BT.PHASE_ED.SELECT.INSTRUCT - String tag containing the selected instruc-
tion line of the selected phase.
10. The BT.PHASE_ED.INPUT.INSTRUCT tag is a string tag used to enter in a new
instruction line that is to be appended to the current instruction for the selected
phase.
11. The BT.PHASE_ED.PARAM_LIST.NUM_ITEMS tag is an integer tag containing
the number of parameters in the selected phase.
12. The BT.PHASE_ED.PARAM_LIST.ITEM1 to
BT.PHASE_ED.PARAM_LIST.ITEM16 tags are string tags used to display the list of
active parameters and associated information for the selected phase. The first item in
the list is defined by the value in tag BT.PHASE_ED.PARAM_LIST.FIRST_ITEM.
13. The BT.PHASE_ED.SELECT.PARAM_ITEM tag is an integer tag used to select the
parameter item in the list that is the focus of the action being performed. This is
equivalent to the selection of the parameter from the list with the mouse.
14. The following tags contain the specific phase information corresponding to the
selected item from the list.
BT.PHASE_ED.SELECT.PARAM_PARAM - String tag containing the name of the
selected parameter.
BT.PHASE_ED.SELECT.PARAM_TYPE - Integer tag containing the type of the
selected parameter.

Value Description
0 Input
9 Process Variable
12 Output

523
B0193YB – Rev C 17. Tag Interface Management (TIM) System

BT.PHASE_ED.SELECT.PARAM_MTRLID - String tag containing the material ID

assigned to the selected parameter.
BT.PHASE_ED.SELECT.PARAM_MTRLNAME - String tag containing the mate-
rial name assigned to the selected parameter.
BT.PHASE_ED.SELECT.PARAM_VALUE - String tag containing the value of the
selected parameter.
BT.PHASE_ED.SELECT.PARAM_UOM - String tag containing the unit of measure
of the selected parameter.
BT.PHASE_ED.SELECT.PARAM_DATACLASS - String tag containing the data
class of the selected parameter.

Value Description
0 Analog
1 Discrete
2 String
3 Enumeration

BT.PHASE_ED.SELECT.PARAM_SET - String tag containing the enumeration set

name of the selected parameter.
BT.PHASE_ED.SELECT.PARAM_DESC - String tag containing the description of
the selected parameter.
15. The BT.PHASE_ED.INPUT.PARAM_VALUE tag is a string tag used to enter in a
new value for the selected parameter.
16. The BT.PHASE_ED.SECURITY.DONEBY tag specifies the ID and the
BT.PHASE_ED.SECURITY.DONEBY_PWD tag specifies the password for the user
executing the action. The user ID and password should be obtained from the operator
once or whenever an action is to be executed. Values are required for these tags if secu-
rity has been configured for the Batch Client functions in the Security Editor.
17. The BT.PHASE_ED.SECURITY.CHECKBY tag specifies the ID and the
BT.PHASE_ED.SECURITY.CHECKBY_PWD tag specifies the password for the
user executing the action. The user ID and password should be obtained from the
operator once or whenever an action is to be executed. Values are required for these
tags if security has been configured for the Batch Client functions in the Security
Editor.
18. The BT.PHASE_ED.COMM.HANDSHAKE tag is an integer tag that is written to
initiate a specified action and read to monitor the results of the action. The handshake
values are provided in the table below.

524
17. Tag Interface Management (TIM) System B0193YB – Rev C

Handshake Value Description

1 Change batch focus.
2 Change the phase configuration according to the phase mask
setting for the selected phase and append new instructions.
3 Change the phase parameter value for the selected parameter.

Monitor and Control Equipment

This action group allows the user to perform all functions available from the Equipment Alloca-
tion dialog box of the Batch Display through tags. There are tags that can be used to view and
change the allocation and statuses of equipment for any active batch or unit.

Table 17-12. Equipment Tags

Tag Name Type Size Access

BT.EQUIPMENT.FOCUS.CLB STRING 50 R/W
This tag consists of three fields separated by a “/”.
CAMPAIGN ID 16
LOT ID 16
BATCH ID 16
BT.EQUIPMENT.FOCUS.UNIT STRING 16 R/W
BT.EQUIPMENT.EQUIPMENT_LIST.NUM_ITEMS INTEGER 1 RO
BT.EQUIPMENT.EQUIPMENT_LIST.FIRST_ITEM INTEGER 1 R/W
BT.EQUIPMENT.EQUIPMENT_LIST.ITEM1 TO STRING 82 RO
BT.EQUIPMENT.EQUIPMENT_LIST.ITEM16
Each list tag consists of five fields separated by two spaces.
EQUIPMENT NAME 16
EQUIPMENT TYPE 10
ALLOCATION 16
STATUS 16
STATE 16
BT.EQUIPMENT.INSTANCE_LIST.NUM_ITEMS INTEGER 1 RO
BT.EQUIPMENT.INSTANCE_LIST.FIRST_ITEM INTEGER 1 R/W
BT.EQUIPMENT.INSTANCE_LIST.ITEM1 TO STRING 16 RO
BT.EQUIPMENT.INSTANCE_LIST.ITEM16
BT.EQUIPMENT.SELECT.EQUIPMENT_ITEM INTEGER 1 R/W
BT.EQUIPMENT.SELECT.EQUIPMENT_NAME STRING 16 RO
BT.EQUIPMENT.SELECT.EQUIPMENT_TYPE INTEGER 1 RO
BT.EQUIPMENT.SELECT.EQUIPMENT_ALLOC STRING 16 RO
BT.EQUIPMENT.SELECT.EQUIPMENT_STATUS STRING 16 RO
BT.EQUIPMENT.SELECT.EQUIPMENT_UCTRL INTEGER 1 RO
BT.EQUIPMENT.SELECT.INSTANCE_ITEM INTEGER 1 R/W

525
B0193YB – Rev C 17. Tag Interface Management (TIM) System

Table 17-12. Equipment Tags (Continued)

Tag Name Type Size Access

BT.EQUIPMENT.SELECT.INSTANCE_NAME STRING 16 RO
BT.EQUIPMENT.SECURITY.DONEBY STRING 12 R/W
BT.EQUIPMENT.SECURITY.DONEBY_PWD STRING 12 R/W
BT.EQUIPMENT.SECURITY.CHECKBY STRING 12 R/W
BT.EQUIPMENT.SECURITY.CHECKBY_PWD STRING 12 R/W
BT.EQUIPMENT.COMM.HANDSHAKE INTEGER 1 R/W

1. The BT.EQUIPMENT.FOCUS.CLB tag is a string tag that defines the Campaign,

Lot, and Batch combination that is the batch focus for the action.
2. The BT.EQUIPMENT.FOCUS.UNIT tag defines the unit that is the unit focus for
the action. If an asterisk “*” is written to this tag, then the focus is on all equipment
associated with the batch defined by BT.EQUIPMENT.FOCUS.CLB tag. If a null
string “” is written to this tag, then the focus is on the batch defined by the
BT.EQUIPMENT.FOCUS.CLB tag.
3. The BT.EQUIPMENT.EQUIPMENT_LIST.NUM_ITEMS tag is an integer tag
containing the number of pieces of equipment in the batch in focus.
4. The BT.EQUIPMENT.EQUIPMENT_LIST.ITEM1 to
BT.EQUIPMENT.EQUIPMENT_LIST.ITEM16 tags are string tags used to display
the list of equipment in the batch defined by the focus. The first item in the list is
defined by the value in tag BT.EQUIPMENT.EQUIPMENT_LIST.FIRST_ITEM.
5. The BT.EQUIPMENT.SELECT.EQUIPMENT_ITEM tag is an integer tag used to
select the item in the list that is the focus of the action being performed. This is equiv-
alent to the selection of the equipment from the list with the mouse.
6. The following tags contain the specific equipment information corresponding to the
selected item from the list.
BT.EQUIPMENT.SELECT.EQUIPMENT_NAME - String tag containing the
name of the selected equipment.
BT.EQUIPMENT.SELECT.EQUIPMENT_TYPE - Integer tag containing the type
of the selected equipment.

Value Mode
0 Unit
1 Connection

BT.EQUIPMENT.SELECT.EQUIPMENT_ALLOC - String tag containing the allo-

cation status of the selected equipment.
Possible Values – Ready, Allocated, Busy
BT.EQUIPMENT.SELECT.EQUIPMENT_STATUS - String tag containing the sta-
tus of the selected equipment. The status values correspond to those defined in the
Process Model.

526
17. Tag Interface Management (TIM) System B0193YB – Rev C

BT.EQUIPMENT.SELECT.EQUIPMENT_UCTRL - Integer tag indicating if unit

control tags exist.

Value Unit Control Tags Exist

0 Unit Control Tags exist
1 Unit Control Tags do not exist

7. The BT.EQUIPMENT.INSTANCE_LIST.NUM_ITEMS tag is an integer tag con-

taining the number of instances of equipment for the selected batch.
8. The BT.EQUIPMENT.INSTANCE_LIST.ITEM1 to
BT.EQUIPMENT.INSTANCE_LIST.ITEM16 tags are string tags used to display
the list of equipment instances in the batch defined by the focus. The first item in the
list is defined by the value in tag
BT.EQUIPMENT.INSTANCE_LIST.FIRST_ITEM.
9. The BT.EQUIPMENT.SELECT.INSTANCE_ITEM tag is an integer tag used to
select the item in the list that is the focus of the action being performed. This is equiv-
alent to the selection of the instance from the list with the mouse.
10. The following tag contains the specific equipment information corresponding to the
selected item from the list.
BT.EQUIPMENT.SELECT.INSTANCE_NAME - String tag containing the name
of the selected instance.
11. The BT.EQUIPMENT.SECURITY.DONEBY tag specifies the ID and the
BT.EQUIPMENT.SECURITY.DONEBY_PWD tag specifies the password for the
user executing the action. The user ID and password should be obtained from the
operator once or whenever an action is to be executed. Values are required for these
tags if security has been configured for the Batch Client functions in the Security
Editor.
12. The BT.EQUIPMENT.SECURITY.CHECKBY tag specifies the ID and the
BT.EQUIPMENT.SECURITY.CHECKBY_PWD tag specifies the password for the
user executing the action. The user ID and password should be obtained from the
operator once or whenever an action is to be executed. Values are required for these
tags if security has been configured for the Batch Client functions in the Security
Editor.
13. The BT.EQUIPMENT.COMM.HANDSHAKE tag is an integer tag that is written
to initiate a specified action and read to monitor the results of the action. The hand-
shake values are provided in the table below.

Handshake Value Description

1 Allocates the piece of equipment selected by the BT.EQUIP-
MENT.SELECT.EQUIPMENT_ITEM tag to the instance
selected by the
BT.EQUIPMENT.SELECT.INSTANCE_ITEM tag.
2 Releases the piece of equipment selected by the
BT.EQUIPMENT.SELECT.EQUIPMENT_ITEM tag.

527
B0193YB – Rev C 17. Tag Interface Management (TIM) System

Handshake Value Description

3 Writes a value of one to the unit abort tag for the unit
selected by the
BT.EQUIPMENT.SELECT.EQUIPMENT_ITEM tag.
4 Writes a value of one to the unit hold tag for the unit
selected by the BT.EQUIP-
MENT.SELECT.EQUIPMENT_ITEM tag.
5 Writes a value of one to the unit restart tag for the unit
selected by the BT.EQUIP-
MENT.SELECT.EQUIPMENT_ITEM tag.
6 Changes the focus of equipment being monitored according
to the values for the batch and focus tags.

View/Force Transition Logic

This action group allows the user to perform all functions available from the Transition Logic dia-
log box of the Batch Display through tags. There are tags that can be used to view and force tran-
sition logic expressions for any active batch.

Table 17-13. View/Force Transition Logic Tags

Tag Name Type Size Access

BT.VIEW_TRANS.FOCUS.CLB STRING 50 R/W
This tag consists of three fields separated by a “/”.
CAMPAIGN ID 16
LOT ID 16
BATCH ID 16
BT.VIEW_TRANS.TRANS_LIST.NUM_ITEMS INTEGER 1 RO
BT.VIEW_TRANS.TRANS_LIST.FIRST_ITEM INTEGER 1 R/W
BT.VIEW_TRANS.TRANS_LIST.ITEM1 TO STRING 37 RO
BT.VIEW_TRANS.TRANS_LIST.ITEM16
Each list tag consists of three fields separated by two spaces.
TRANSITION NAME 16
LABEL 8
TIME REMAINING 9
BT.VIEW_TRANS.EXP_LIST.NUM_ITEMS INTEGER 1 RO
BT.VIEW_TRANS.EXP_LIST.FIRST_ITEM INTEGER 1 R/W
BT.VIEW_TRANS.EXP_LIST.ITEM1 TO STRING 40 RO
BT.VIEW_TRANS.EXP_LIST.ITEM16
BT.VIEW_TRANS.TAG_LIST.NUM_ITEMS INTEGER 1 RO
BT.VIEW_TRANS.TAG_LIST.FIRST_ITEM INTEGER 1 R/W
BT.VIEW_TRANS.TAG_LIST.ITEM1 TO STRING 102 RO
BT.VIEW_TRANS.TAG_LIST.ITEM16
Each list tag consists of two fields separated by two spaces.

528
17. Tag Interface Management (TIM) System B0193YB – Rev C

Table 17-13. View/Force Transition Logic Tags (Continued)

Tag Name Type Size Access

TAG NAME 84
VALUE 16
BT.VIEW_TRANS.SELECT.TRANS_ITEM INTEGER 1 R/W
BT.VIEW_TRANS.SELECT.TRANS_NAME STRING 16 RO
BT.VIEW_TRANS.SELECT.TRANS_LABEL STRING 8 RO
BT.VIEW_TRANS.SELECT.TRANS_DESC STRING 120 RO
BT.VIEW_TRANS.SELECT.EXP_ITEM INTEGER 1 R/W
BT.VIEW_TRANS.SELECT.EXP STRING 40 RO
BT.VIEW_TRANS.SELECT.TAG_ITEM INTEGER 1 R/W
BT.VIEW_TRANS.SELECT.TAG_NAME STRING 84 RO
BT.VIEW_TRANS.SELECT.TAG_VALUE STRING 80 RO
BT.VIEW_TRANS.SECURITY.DONEBY STRING 12 R/W
BT.VIEW_TRANS.SECURITY.DONEBY_PWD STRING 12 R/W
BT.VIEW_TRANS.SECURITY.CHECKBY STRING 12 R/W
BT.VIEW_TRANS.SECURITY.CHECKBY_PWD STRING 12 R/W
BT.VIEW_TRANS.COMM.HANDSHAKE INTEGER 1 R/W

1. The BT.VIEW_TRANS.FOCUS.CLB tag is a string tag that defines the Campaign,

Lot, and Batch combination that is the batch focus for the action.
2. The BT.VIEW_TRANS.COMM.HANDSHAKE tag is an integer tag that is written
to initiate an update of the transition logic list according to the values assigned to the
focus tag. The handshake values are provided in the table at the end of this procedure.
3. The BT.VIEW_TRANS.TRANS_LIST.NUM_ITEMS tag is an integer tag contain-
ing the number of active transition logic objects in the selected batch.
4. The BT.VIEW_TRANS.TRANS_LIST.ITEM1 to
BT.VIEW_TRANS.TRANS_LIST.ITEM16
tags are string tags used to display the list of transition logic objects in the batch
defined by the focus. The first item in the list is defined by the value in tag
BT.VIEW_TRANS.TRANS_LIST.FIRST_ITEM.
5. The BT.VIEW_TRANS.SELECT.TRANS_ITEM tag is an integer tag used to select
the item in the list that is the focus of the action being performed. This is equivalent
to the selection of the transition from the list with the mouse.
6. The following tags contain the specific transition object information corresponding to
the selected item from the list.
BT.VIEW_TRANS.SELECT.TRANS_NAME - String tag containing the name of
the selected transition.
BT.VIEW_TRANS.SELECT.TRANS_LABEL - String tag containing the label for
the selected transition.
BT.VIEW_TRANS.SELECT.TRANS_DESC - String tag containing the description
for the selected transition.

529
B0193YB – Rev C 17. Tag Interface Management (TIM) System

7. The BT.VIEW_TRANS.EXP_LIST.NUM_ITEMS tag is an integer tag containing

the number of expressions comprising the active transition logic object.
8. The BT.VIEW_TRANS.EXP_LIST.ITEM1 to
BT.VIEW_TRANS.EXP_LIST.ITEM16 tags are string tags used to display the list of
expressions in the selected transition logic object. The first item in the list is defined
by the value in tag BT.VIEW_TRANS.EXP_LIST.FIRST_ITEM.
9. The BT.VIEW_TRANS.SELECT.EXP_ITEM tag is an integer tag used to select the
item in the list that is the focus of the action being performed. This is equivalent to
the selection of the expression from the list with the mouse.
10. The following tags contain the specific transition object information corresponding to
the selected item from the list.
BT.VIEW_TRANS.SELECT.EXP - String tag containing a line of the selected
expression.
11. The BT.VIEW_TRANS.TAG_LIST.NUM_ITEMS tag is an integer tag containing
the number of tags contained in the selected expression for the selected transition
logic object.
12. The BT.VIEW_TRANS.TAG_LIST.ITEM1 to
BT.VIEW_TRANS.TAG_LIST.ITEM16 tags are string tags used to display the list of
tags in the expression selected. The first item in the list is defined by the value in tag
BT.VIEW_TRANS.TAG_LIST.FIRST_ITEM.
13. The BT.VIEW_TRANS.SELECT.TAG_ITEM tag is an integer tag used to select the
item in the list that is the focus of the action being performed. This is equivalent to
the selection of the tag from the list with the mouse.
14. The following tags contain the specific equipment information corresponding to the
selected item from the list.
BT.VIEW_TRANS.SELECT.TAG_NAME - String tag containing the name of the
selected tag.
BT.VIEW_TRANS.SELECT.TAG_VALUE - String tag containing the value of the
selected tag.
15. The BT.VIEW_TRANS.SECURITY.DONEBY tag specifies the ID and the
BT.VIEW_TRANS.SECURITY.DONEBY_PWD tag specifies the password for the
user executing the action. The user ID and password should be obtained from the
operator once or whenever an action is to be executed. Values are required for these
tags if security has been configured for the Batch Client functions in the Security
Editor.
16. The BT.VIEW_TRANS.SECURITY.CHECKBY tag specifies the ID and the
BT.VIEW_TRANS.SECURITY.CHECKBY_PWD tag specifies the password for the
user executing the action. The user ID and password should be obtained from the
operator once or whenever an action is to be executed. Values are required for these
tags if security has been configured for the Batch Client functions in the Security
Editor.
17. The BT.VIEW_TRANS.COMM.HANDSHAKE tag is an integer tag that is written
to initiate a specified action and read to monitor the results of the action. The hand-
shake values are provided in the table below.

530
17. Tag Interface Management (TIM) System B0193YB – Rev C

Handshake Value Description

1 Changes the focus of transition logic being moni-
tored according to the value for the batch focus tag.
2 Forces the selected transition logic expression to be
true and allows the batch engine to continue beyond
the transition logic object.

Save Control Recipe

This action group allows the user to perform all of the functions available from the Save Control
Recipe dialog box of the Batch Display through tags. There are tags that can be used to save the
results of any completed batch.

Table 17-14. Save Control Recipe Tags

Tag Name Type Size Access

BT.SAVE_RECIPE.INPUT.CLB STRING 50 R/W
This tag consists of three fields separated by a “/”.
CAMPAIGN ID 16
LOT ID 16
BATCH ID 16
BT.SAVE_RECIPE.INPUT.RECIPEID STRING 16 R/W
BT.SAVE_RECIPE.INPUT.AUTHOR STRING 30 R/W
BT.SAVE_RECIPE.INPUT.OPTION_MASK INTEGER 1 R/W
BT.SAVE_RECIPE.INPUT.VERSION_COMMENT STRING 80 R/W
BT.SAVE_RECIPE.SECURITY.DONEBY STRING 12 R/W
BT.SAVE_RECIPE.SECURITY.DONEBY_PWD STRING 12 R/W
BT.SAVE_RECIPE.SECURITY.CHECKBY STRING 12 R/W
BT.SAVE_RECIPE.SECURITY.CHECKBY_PWD STRING 12 R/W
BT.SAVE_RECIPE.COMM.HANDSHAKE INTEGER 1 R/W

1. The BT.SAVE_RECIPE.INPUT.CLB tag defines the Campaign, Lot, and Batch

combination that is the batch focus for the action.
2. The BT.SAVE_RECIPE.INPUT.RECIPEID tag is a string tag containing the recipe
ID that is used as the name under which the batch is saved.
3. The BT.SAVE_RECIPE.INPUT.AUTHOR tag is a string tag containing the author
that is used as the individual under which the recipe for the batch is saved.
4. The BT.SAVE_RECIPE.INPUT.OPTION_MASK tag is an integer tag containing
the configuration under which the recipe of the selected batch is saved.

531
B0193YB – Rev C 17. Tag Interface Management (TIM) System

Bit Offset Value Description

0 1 Save Runtime Equipment
1 2 Retain Recipe Approvals

The BT.SAVE_RECIPE.INPUT.OPTION_MASK tag contains the composite value

of all bit offsets that pertain to the configuration settings of the current recipe. The
value of this tag is the sum of all of the values in the table above for each configuration
item selected. For example, if Save Runtime Equipment and Retain Recipe Approvals
are selected, the tag value is 3. This tag can be written to as well to allow the current
phase configuration settings to be changed.
5. The BT.SAVE_RECIPE.INPUT.VERSION_COMMENT tag is a string tag con-
taining any comment that is saved along with the recipe of the batch.
6. The BT.SAVE_RECIPE.SECURITY.DONEBY tag specifies the ID and the
BT.SAVE_RECIPE.SECURITY.DONEBY_PWD tag specifies the password for the
user executing the action. The user ID and password should be obtained from the
operator once or whenever an action is to be executed. Values are required for these
tags if security has been configured for the Batch Client functions in the Security
Editor.
7. The BT.SAVE_RECIPE.SECURITY.CHECKBY tag specifies the ID and the
BT.SAVE_RECIPE.SECURITY.CHECKBY_PWD tag specifies the password for the
user executing the action. The user ID and password should be obtained from the
operator once or whenever an action is to be executed. Values are required for these
tags if security has been configured for the Batch Client functions in the Security
Editor.
8. The BT.SAVE_RECIPE.COMM.HANDSHAKE tag is an integer tag that is written
to initiate a specified action and read to monitor the results of the action. The hand-
shake values are provided in the table below.

Handshake Value Description

1 Save the recipe associated with the selected batch.
This handshake verifies that the recipe does not
already exist. If the recipe exists, a handshake value
of -117 is returned.
2 Save the recipe associated with the selected batch.
This handshake overwrites any existing recipe.

Monitor and Respond to Errors

This action group allows the user to respond to all action and runtime errors that may occur
between the client and the TIM system through tags. There are tags that can be used to view and
acknowledge errors for any active batch.

532
17. Tag Interface Management (TIM) System B0193YB – Rev C

Table 17-15. Monitor and Respond to Error Tags

Tag Name Type Size Access

BT.ERROR.MESSAGE_LIST.MAX_ITEMS INTEGER 1 R/W
BT.ERROR.MESSAGE_LIST.NUM_ITEMS INTEGER 1 RO
BT.ERROR.MESSAGE_LIST.FIRST_ITEM INTEGER 1 R/W
BT.ERROR.MESSAGE_LIST.ITEM1 TO STRING 60 RO
BT.ERROR.MESSAGE_LIST.ITEM16
BT.ERROR.SELECT.MESSAGE_ITEM INTEGER 1 R/W
BT.ERROR.SELECT.MESSAGE STRING 60 RO
BT.ERROR.COMM.HANDSHAKE INTEGER 1 R/W

1. The BT.ERROR.MESSAGE_LIST.MAX_ITEMS tag is an integer tag that is written

to specify the maximum number of error messages to retain in the list. The default
value for this tag is 16.
2. The BT.ERROR.MESSAGE_LIST.NUM_ITEMS tag is an integer tag containing
the number of error items currently in the list.
3. The BT.ERROR.MESSAGE_LIST.ITEM1 to
BT.ERROR.MESSAGE_LIST.ITEM16 tags are string tags used to display the list of
errors. The first item in the list is defined by the value in tag
BT.ERROR.MESSAGE_LIST.FIRST_ITEM.
4. The BT.ERROR.SELECT.MESSAGE_ITEM tag is an integer tag used to select the
item in the list that is the focus of the action being performed. This is equivalent to
the selection of the error from the list with the mouse.
5. The following tag contains the specific error information corresponding to the
selected item from the list.
BT.ERROR.SELECT.MESSAGE - String tag containing the current selected error
message.
6. The BT.ERROR.COMM.HANDSHAKE tag is an integer tag that is written to ini-
tiate a specified action and read to monitor the results of the action. The handshake
value is negative if any error occurs in the system. Client applications should be
designed to monitor this tag for a negative value and take the appropriate action. The
handshake values are provided in the table below.

Handshake Value Description

Value < 0 An error has occurred in the system.
1 Clear all errors.

Batch Management System Interface Handshake Errors

The handshake values that were provided for each interface are used to initiate an action within
the TIM batch interface. The handshake tags are also used to monitor responses from the TIM
applications. For the batch interfaces, the return handshake values are presented in the table
below. When a function is performed properly by either a handshake or a batch action, the hand-

533
B0193YB – Rev C 17. Tag Interface Management (TIM) System

shake value is zero. When a function fails from either a handshake or a batch action, the hand-
shake value is negative according to the table. The handshake tag should be monitored if error
messages are to be displayed to the operator.

NOTE
If security is enabled, and the number of retries is exceeded along with the return of
a negative handshake for a failed request, the handshake value is as described in the
table plus a value of -256. For example, if Done By security is enabled, and an
invalid password is entered more times than permitted by the number of retries con-
figured in the Security Editor, the handshake value is (-1016 + (-256)) = -1272.

Table 17-16. Handshake Errors

Handshake Value Description

0 Action successful
-100 Invalid or unselected entry (CLB)!
-101 Wrong batch status to perform action!
-102 Unable to access security tags!
-104 Failed to communicate with BatchMngr!
-105 Invalid or unselected equipment!
-106 Invalid or unselected equipment instance!
-107 Selected equipment type is invalid for action!
-108 No phase is selected!
-109 Wrong phase status to perform action!
-110 No acknowledge currently required!
-111 No parameter is selected!
-112 No question is selected!
-113 Invalid answer to selected question!
-114 Invalid schedule!
-115 Invalid handshake action!
-116 Unit Control is not available for this equipment!
-117 Recipe already exists!
-118 BatchMngr is busy!
-119 Quantity greater than recipe’s maximum batch size!
-1002 DoneBy Security - Unknown User
-1003 DoneBy Security - Denied because of Operator Station
-1004 DoneBy Security - Unknown Operator Station
-1005 DoneBy Security - Denied because of Recipe
-1012 DoneBy Security - Additional Level Needed
-1014 DoneBy Security - Unknown Recipe
-1016 DoneBy Security - Invalid User Password

534
17. Tag Interface Management (TIM) System B0193YB – Rev C

Table 17-16. Handshake Errors (Continued)

Handshake Value Description

-1017 DoneBy Security - Denied because of improper DoneBy Clearance
-1018 DoneBy Security - Enter Password
-1020 DoneBy Security - Non-Reusable Password
-1022 DoneBy Security - Password Mismatch
-1024 DoneBy Security - Invalid Password Length
-1033 DoneBy Security - Denied because of improper CheckBy Clearance
-2002 CheckBy Security - Unknown User
-2003 CheckBy Security - Denied because of Operator Station
-2004 CheckBy Security - Unknown Operator Station
-2005 CheckBy Security - Denied because of Recipe
-2012 CheckBy Security - Additional Level Needed
-2014 CheckBy Security - Unknown Recipe
-2016 CheckBy Security - Invalid User Password
-2017 CheckBy Security - Denied because of improper DoneBy Clearance
-2018 CheckBy Security - Enter Password
-2020 CheckBy Security - Non-Reusable Password
-2022 CheckBy Security - Password Mismatch
-2024 CheckBy Security - Invalid Password Length
-2032 CheckBy Security - DoneBy and CheckBy User ID must be different
-2033 CheckBy Security - Denied because of improper CheckBy Clearance

Security System Interface

Interact with Security System
This action group allows the user to perform functions associated with the security system
through tags. There are tags that can be used to obtain security clearance and change security sys-
tem settings.

Table 17-17. Security System Tags

Tag Name Type Size Access

SE.SECURITY.INPUT.USERID STRING 12 R/W
SE.SECURITY.INPUT.PASSWORD STRING 12 R/W
SE.SECURITY.INPUT.NEWPASSWORD STRING 12 R/W
SE.SECURITY.INPUT.VERIFYPASSWORD STRING 12 R/W
SE.SECURITY.INPUT.OPSTATION STRING 16 R/W
SE.SECURITY.INPUT.APPLICATION INTEGER 1 R/W
SE.SECURITY.INPUT.FUNCTION INTEGER 1 R/W

535
B0193YB – Rev C 17. Tag Interface Management (TIM) System

Table 17-17. Security System Tags (Continued)

Tag Name Type Size Access

SE.SECURITY.INPUT.RECIPEID STRING 16 R/W
SE.SECURITY.INPUT.SECURITYLEVEL INTEGER 1 R/W
SE.SECURITY.COMM.HANDSHAKE INTEGER 1 R/W

1. The SE.SECURITY.INPUT.USERID tag is a string tag written to provide the secu-

rity system with the ID of the user attempting to initiate an application or function.
2. The SE.SECURITY.INPUT.PASSWORD tag is a string tag written to provide the
security system with the password of the user attempting to initiate an application or
function.
3. The SE.SECURITY.INPUT.NEWPASSWORD tag is a string tag written to provide
the security system with the new password for the user attempting to initiate an appli-
cation or function.
4. The SE.SECURITY.INPUT.VERIFYPASSWORD tag is a string tag written to pro-
vide the security system with the verified password for the user attempting to initiate
an application or function.
5. The SE.SECURITY.INPUT.OPSTATION tag is a string tag written to provide the
security system with the name of the operator station from which the user is attempt-
ing to initiate an application or function. Operator station values can be found in the
Security System User Accounts Editor.
6. The SE.SECURITY.INPUT.APPLICATION tag is an integer tag written to provide
the security system with the ID of the application that the user is attempting to ini-
tiate. Application ID values can be found in the Security System Application-Func-
tion Security Editor.
7. The SE.SECURITY.INPUT.FUNCTION tag is an integer tag written to provide the
security system with the ID of the function that the user is attempting to initiate.
Function ID values can be found in the Security System Application-Function
Security Editor.
8. The SE.SECURITY.INPUT.RECIPEID tag is a string tag written to provide the
security system with the name of the recipe in which the user is attempting to initiate
an application or function. Recipe ID values can be found in the Security System User
Accounts Editor.
9. The SE.SECURITY.INPUT.SECURITYLEVEL tag is an integer tag written to pro-
vide the security system with the type of clearance that the user is attempting to
satisfy.
Value Security Level
1 Done By
2 Check By

10. The SE.SECURITY.COMM.HANDSHAKE tag is an integer tag that is written to

initiate a specified action and read to monitor the results of the action. The handshake
values are provided in the table below. The input tags list those required in order to
perform the appropriate action.

536
17. Tag Interface Management (TIM) System B0193YB – Rev C

Possible
Handshake Return
Value Description Input Tags Required Codes
-1 Change the password SE.SECURITY.INPUT.USERID 0, 2, 16,
for the selected user. SE.SECURITY.INPUT.PASSWORD 20, 22,
SE.SECURITY.INPUT.NEWPASSWORD 24
SE.SECURITY.INPUT.VERIFYPASSWORD
-2 Request the security SE.SECURITY.INPUT.USERID 0, 2, 3,
level for the selected SE.SECURITY.INPUT.PASSWORD 4, 6, 9,
application. SE.SECURITY.INPUT.OPSTATION 16, 18,
SE.SECURITY.INPUT.APPLICATION 256
-3 Request whether secu- SE.SECURITY.INPUT.APPLICATION 0, 1, 4
rity is enabled for the
selected application.
-4 Request security clear- SE.SECURITY.INPUT.USERID 0, 2, 3,
ance for the selected SE.SECURITY.INPUT.PASSWORD 4, 5, 6,
function. SE.SECURITY.INPUT.OPSTATION 8, 12,
SE.SECURITY.INPUT.APPLICATION 14, 16,
SE.SECURITY.INPUT.FUNCTION 18, 65,
SE.SECURITY.INPUT.RECIPEID 129, 256
SE.SECURITY.INPUT.SECURITYLEVEL
-5 Request the security SE.SECURITY.INPUT.APPLICATION 0, 1, 3, 4
level for the selected SE.SECURITY.INPUT.FUNCTION
function.
-6 Assign a new password SE.SECURITY.INPUT.USERID 0, 2, 20,
to the selected user. SE.SECURITY.INPUT.NEWPASSWORD 22, 24
SE.SECURITY.INPUT.VERIFYPASSWORD
-7 Reset the number of None 0
retries that the user
can make for obtain-
ing security clearance.
Used when a function
is cancelled or a new
function is attempted.
-8 Verify that the security None 0, 1
system is installed and
active.

Security System Interface Handshake Errors

The handshake values that were provided for each interface are used to initiate an action within
the TIM security interface. The handshake tags are also used to monitor responses from the TIM
applications. For the security interfaces, the return handshake values are presented in the table
below. When a function is performed properly by either a handshake or a batch action, the hand-
shake value is zero. When a function fails from a handshake, the handshake value is positive

537
B0193YB – Rev C 17. Tag Interface Management (TIM) System

according to the table. The handshake tag should be monitored if error messages are to be dis-
played to the operator.

NOTE
If the number of retries is exceeded along with the return of a positive handshake for
a failed request of handshake values -2 or -4, the handshake value is as presented in
the table plus a value of 256. For example, if an invalid function is entered more
times than permitted by the number of retries configured in the Security Editor, the
handshake value is (8 + 256) = 264.

Table 17-18. Handshake Error Tags

Handshake Value Handshake Value

Returned Written Description
0 -1, -6 Password Changed
-2, -4 Security Granted
-3 Application Security is Off
-5 Function Security is Off
-7 Number of Retries has been Reset
-8 Security System is Installed and Running
1 -3 Application Security On
-5 Function has DoneBy Security
-8 Security System is Not Installed and Running
2 -1, -2, -4, -6 Unknown User
3 -2, -4 Denied because of Operator Station
-5 Function has CheckBy Security
4 -2, -4 Unknown Operator Station
-3, -5 Invalid Query
5 -4 Denied because of Recipe
6 -2, -4 Invalid Application
8 -4 Invalid Function
9 -2 Denied because of Application
12 -4 Additional Level Needed
14 -4 Unknown Recipe
16 -1, -2, -4 Invalid User Password
17 -4 Denied because of improper DoneBy Clearance
18 -2, -4 Enter Password
20 -1, -6 Non-Reusable Password
22 -1, -6 Password Mismatch
24 -1, -6 Invalid Password Length
32 -4 DoneBy and CheckBy User ID must be different

538
17. Tag Interface Management (TIM) System B0193YB – Rev C

Table 17-18. Handshake Error Tags (Continued)

Handshake Value Handshake Value

Returned Written Description
33 -4 Denied because of improper CheckBy Clearance
65 -4 Denied because did not receive Application Clearance
129 -4 Denied because did not receive DoneBy Clearance

Batch Function Interface

Phase Prepare/Complete
This action group allows the user to perform functions prior to or immediately following the exe-
cution of a phase through tags. The tags in this action group can be used within a client to create
an interface with the batch management system.

Table 17-19. Phase Prepare/Complete Tags

Tag Name Type Size Access

FU.PHASE.INFO.CLB STRING 50 RO
This tag consists of three fields separated by a “/”.
CAMPAIGN ID 16
LOT ID 16
BATCH ID 16
FU.PHASE.INFO.RECIPE STRING 16 RO
FU.PHASE.INFO.SIZE INTEGER 1 RO
FU.PHASE.INFO.TRAIN STRING 16 RO
FU.PHASE.INFO.MODE INTEGER 1 RO
FU.PHASE.INFO.STATUS INTEGER 1 RO
FU.PHASE.INFO.EQUIPMENT STRING 16 RO
FU.PHASE.INFO.PHASE STRING 16 RO
FU.PHASE.PARAM_EXT_LIST.NUM_ITEMS INTEGER 1 RO
FU.PHASE.PARAM_EXT_LIST.ITEM1 TO STRING 72 RO
FU.PHASE.PARAM_EXT_LIST.ITEM16
Each list tag consists of five fields separated by two spaces.
NAME 16
TYPE 12
EXTENSION 12
DATA CLASS 8
VALUE 16
FU.PHASE.SELECT.PARAM_EXT_ITEM INTEGER 1 R/W
FU.PHASE.SELECT.PARAM_NAME STRING 16 RO
FU.PHASE.SELECT.PARAM_TYPE INTEGER 1 RO

539
B0193YB – Rev C 17. Tag Interface Management (TIM) System

Table 17-19. Phase Prepare/Complete Tags (Continued)

Tag Name Type Size Access

FU.PHASE.SELECT.PARAM_EXT INTEGER 1 RO
FU.PHASE.SELECT.PARAM_DATA_CLASS INTEGER 1 RO
FU.PHASE.SELECT.PARAM_EXT_VALUE STRING 16 R/W
FU.PHASE.COMM.HANDSHAKE INTEGER 1 R/W

1. The FU.PHASE.INFO.CLB tag is a string tag that defines the Campaign, Lot, and
Batch combination that is the batch focus for the action.
2. The FU.PHASE.INFO.RECIPE tag is a string tag containing the recipe ID of the
batch selected.
3. The FU.PHASE.INFO.SIZE tag is an integer tag containing the size of the batch
selected.
4. The FU.PHASE.INFO.TRAIN tag is a string tag containing the train of the batch
selected.
5. The FU.PHASE.INFO.MODE tag is an integer tag containing the mode of the batch
selected.

Value Mode
0 Automatic
1 Semi-Automatic
2 Manual

6. The FU.PHASE.INFO.STATUS tag is an integer tag containing the status of the

batch selected.

Value Status
1 Ready
2 Wait
3 Run
4 Done
5 Interlock
6 Aborted
7 Held
8 Aborting

7. The FU.PHASE.INFO.EQUIPMENT tag is a string tag containing the unit or con-

nection being analyzed in the selected batch.
8. The FU.PHASE.INFO.PHASE tag is a string tag containing the current active phase
in the selected batch.

540
17. Tag Interface Management (TIM) System B0193YB – Rev C

9. The FU.PHASE.PARAM_EXT_LIST.NUM_ITEMS tag is an integer tag containing

the number of active parameters for the active phase in the selected batch.
10. The FU.PHASE.PARAM_EXT_LIST.ITEM1 to
FU.PHASE.PARAM_EXT_LIST.ITEM16 tags are string tags used to display the list
of parameters for the active phase in the selected batch.
11. The FU.PHASE.SELECT.PARAM_EXT_ITEM tag is an integer tag used to select
the item in the list that is the focus of the action being performed. This is equivalent
to the selection of the parameter from the list with the mouse.
12. The following tags contain the specific transition object information corresponding to
the selected item from the list.
FU.PHASE.SELECT.PARAM_NAME - String tag containing the name of the
selected parameter.
FU.PHASE.SELECT.PARAM_TYPE - Integer tag containing the type of the selected
parameter.

Value Description
0 Input
9 Process Variable
12 Output

FU.PHASE.SELECT.PARAM_EXT - Integer tag containing the extension of the

selected parameter.

Value Description
1 Material ID
2 Material Name
3 Target
4 Actual
5 High Deviation
6 Low Deviation
7 Lot Code
8 Preact
9 High Limit
10 Low Limit

FU.PHASE.SELECT.PARAM_DATA_CLASS - Integer tag containing the class of

the selected parameter.

541
B0193YB – Rev C 17. Tag Interface Management (TIM) System

Value Description
0 Analog
1 Discrete
2 String
3 Enumeration

FU.PHASE.SELECT.PARAM_EXT_VALUE - String tag containing the value of the

selected parameter.
13. The FU.PHASE.COMM.HANDSHAKE tag is an integer tag that is written to ini-
tiate a specified action and read to monitor the results of the action. The handshake
values are provided in the table below.

Handshake Value Description

0 Value written to the batch management system
to have it continue with the normal execution.
-1 Value used by the batch management system to
notify the user that execution is at the beginning
of the selected phase and waiting for a response.
-2 Value used by the batch management system to
notify the user that execution is at the end of the
selected phase and waiting for a response.

NOTE
The batch manager waits for the handshake to continue processing. All batch pro-
cessing activity is essentially suspended until the signal to continue is received.
Therefore, it is vital to return the continue handshake quickly.

Evaluate Equipment for Allocation

This action group allows the user to perform functions that affect the allocation of equipment by
the batch management system through tags. The tags in this action group can be used within a
client to create an interface with the batch management system.

Table 17-20. Evaluate Equipment for Allocation Tags

Tag Name Type Size Access

FU.EVAL_EQUIP.INFO.CLB STRING 50 RO
This tag consists of three fields separated by a “/”.
CAMPAIGN ID 16
LOT ID 16
BATCH ID 16
FU.EVAL_EQUIP.INFO.RECIPE STRING 16 RO

542
17. Tag Interface Management (TIM) System B0193YB – Rev C

Table 17-20. Evaluate Equipment for Allocation Tags (Continued)

Tag Name Type Size Access

FU.EVAL_EQUIP.INFO.SIZE INTEGER 1 RO
FU.EVAL_EQUIP.INFO.TRAIN STRING 16 RO
FU.EVAL_EQUIP.INFO.MODE INTEGER 1 RO
FU.EVAL_EQUIP.INFO.STATUS INTEGER 1 RO
FU.EVAL_EQUIP.INFO.INSTANCE STRING 16 RO
FU.EVAL_EQUIP.INFO.EQUIPMENT STRING 16 RO
FU.EVAL_EQUIP.SEGMENT_LIST.NUM_ITEMS INTEGER 1 RO
FU.EVAL_EQUIP.SEGMENT_LIST.ITEM1 TO STRING 16 RO
FU.EVAL_EQUIP.SEGMENT_LIST.ITEM16
FU.EVAL_EQUIP.SELECT.SEGMENT_ITEM INTEGER 1 R/W
FU.EVAL_EQUIP.SELECT.SEGMENT STRING 16 RO
FU.EVAL_EQUIP.COMM.HANDSHAKE INTEGER 1 R/W

1. The FU.EVAL_EQUIP.INFO.CLB tag is a string tag that defines the Campaign, Lot,
and Batch combination that is the batch focus for the action.
2. The FU.EVAL_EQUIP.INFO.RECIPE tag is a string tag containing the recipe ID of
the batch selected.
3. The FU.EVAL_EQUIP.INFO.SIZE tag is an integer tag containing the size of the
batch selected.
4. The FU.EVAL_EQUIP.INFO.TRAIN tag is a string tag containing the train of the
batch selected.
5. The FU.EVAL_EQUIP.INFO.MODE tag is an integer tag containing the mode of
the batch selected.

Value Mode
0 Automatic
1 Semi-Automatic
2 Manual

6. The FU.EVAL_EQUIP.INFO.STATUS tag is an integer tag containing the status of

the batch selected.

Value Status
1 Ready
2 Wait
3 Run
4 Done
5 Interlock
6 Aborted

543
B0193YB – Rev C 17. Tag Interface Management (TIM) System

Value Status
7 Held
8 Aborting

7. The FU.EVAL_EQUIP.INFO.INSTANCE tag is a string tag containing the instance

name being analyzed in the selected batch.
8. The FU.EVAL_EQUIP.INFO.EQUIPMENT tag is a string tag containing the unit
or connection being analyzed in the selected batch.
9. The FU.EVAL_EQUIP.SEGMENT_LIST.NUM_ITEMS tag is an integer tag con-
taining the number of segments defined for the active equipment in the selected
batch.
10. The FU.EVAL_EQUIP.SEGMENT_LIST.ITEM1 to
FU.EVAL_EQUIP.SEGMENT_LIST.ITEM99 tags are string tags used to display the
list of segments for the active equipment in the selected batch.
11. The FU.EVAL_EQUIP.SELECT.SEGMENT_ITEM tag is an integer tag used to
select the item in the list that is the focus of the action being performed. This is equiv-
alent to the selection of the segment from the list with the mouse.
12. The following tags contain the specific transition object information corresponding to
the selected item from the list.
FU.EVAL_EQUIP.SELECT.SEGMENT - String tag containing the name of the
selected segment.
13. The FU.EVAL_EQUIP.COMM.HANDSHAKE tag is an integer tag that is written
to initiate a specified action and read to monitor the results of the action. The hand-
shake values are provided in the table below.

Handshake Value Description

0 Reject the selected unit or connection for allocation to
the particular instance.
1 Accept the selected unit or connection for allocation to
the particular instance.
-1 Value used by the batch management system to notify
the user that the system is evaluating the selected unit
for allocation and waiting for a response.
-2 Value used by the batch management system to notify
the user that the system is evaluating the selected con-
nection for allocation and waiting for a response.

NOTE
The batch manager waits for the handshake to continue processing. All batch pro-
cessing activity is essentially suspended until the signal to continue is received.
Therefore, it is vital to return the continue handshake quickly.

544
17. Tag Interface Management (TIM) System B0193YB – Rev C

Log Equipment Status

This action group allows the user to perform functions as equipment status changes are being
written to the Batch Historian through tags. The tags in this action group can be used within a
client to obtain notification of a change of status as well as write other data to the history data-
base.

Table 17-21. Log Equipment Status Tags

Tag Name Type Size Access

FU.LOG_EQUIP.INFO.UNIT_SEGMENT STRING 16 RO
FU.LOG_EQUIP.INFO.NEW_STATUS STRING 16 RO
FU.LOG_EQUIP.INFO.OLD_STATUS STRING 16 RO
FU.LOG_EQUIP.INFO.RECIPEID STRING 16 RO
FU.LOG_EQUIP.INFO.LASTRECIPEID STRING 16 RO
FU.LOG_EQUIP.INFO.DONEBY STRING 12 R/W
FU.LOG_EQUIP.INFO.CHECKBY STRING 12 R/W
FU.LOG_EQUIP.INFO.COMMENT INTEGER 32 R/W
FU.LOG_EQUIP.INFO.FIELD1 STRING 8 R/W
FU.LOG_EQUIP.INFO.FIELD2 STRING 8 R/W
FU.LOG_EQUIP.INFO.FIELD3 STRING 8 R/W
FU.LOG_EQUIP.INFO.FIELD4 STRING 8 R/W
FU.LOG_EQUIP.INFO.FIELD5 STRING 16 R/W
FU.LOG_EQUIP.INFO.FIELD6 STRING 16 R/W
FU.LOG_EQUIP.INFO.FIELD7 STRING 16 R/W
FU.LOG_EQUIP.INFO.FIELD8 STRING 16 R/W
FU.LOG_EQUIP.COMM.HANDSHAKE INTEGER 1 R/W

1. The FU.LOG_EQUIP.INFO.UNIT_SEGMENT tag is a string tag that contains the

unit or segment name for which the status has changed.
2. The FU.LOG_EQUIP.INFO.NEW_STATUS tag is a string tag containing the new
status of the unit or segment.
3. The FU.LOG_EQUIP.INFO.OLD_STATUS tag is a string tag containing the old
status of the unit or segment.
4. The FU.LOG_EQUIP.INFO.RECIPEID tag is a string tag containing the recipe ID
currently active in the unit or segment.
5. The FU.LOG_EQUIP.INFO.LASTRECIPEID tag is a string tag containing the pre-
vious recipe ID active in the unit or segment.
6. The FU.LOG_EQUIP.INFO.DONEBY tag is an integer tag containing the ID of the
user that changed the unit or segment status.
7. The FU.LOG_EQUIP.INFO.CHECKBY tag is a string tag containing the ID of the
user that verified the change of the unit or segment status.

545
B0193YB – Rev C 17. Tag Interface Management (TIM) System

8. The FU.LOG_EQUIP.INFO.COMMENT tag is a string tag that can be written to

enter a comment that is written to history along with the record of the change of sta-
tus for the unit or segment.
9. The FU.LOG_EQUIP.INFO.FIELD1 tag is a string tag that can be written to with
an extraneous piece of data that the user would like to store in the history database
along with the record of the change of status for the unit or segment.
10. The FU.LOG_EQUIP.INFO.FIELD2 tag is a string tag that can be written to with
an extraneous piece of data that the user would like to store in the history database
along with the record of the change of status for the unit or segment.
11. The FU.LOG_EQUIP.INFO.FIELD3 tag is a string tag that can be written to with
an extraneous piece of data that the user would like to store in the history database
along with the record of the change of status for the unit or segment.
12. The FU.LOG_EQUIP.INFO.FIELD4 tag is a string tag that can be written to with
an extraneous piece of data that the user would like to store in the history database
along with the record of the change of status for the unit or segment.
13. The FU.LOG_EQUIP.INFO.FIELD5 tag is a string tag that can be written to with
an extraneous piece of data that the user would like to store in the history database
along with the record of the change of status for the unit or segment.
14. The FU.LOG_EQUIP.INFO.FIELD6 tag is a string tag that can be written to with
an extraneous piece of data that the user would like to store in the history database
along with the record of the change of status for the unit or segment.
15. The FU.LOG_EQUIP.INFO.FIELD7 tag is a string tag that can be written to with
an extraneous piece of data that the user would like to store in the history database
along with the record of the change of status for the unit or segment.
16. The FU.LOG_EQUIP.INFO.FIELD8 tag is a string tag that can be written to with
an extraneous piece of data that the user would like to store in the history database
along with the record of the change of status for the unit or segment.
17. The FU.LOG_EQUIP.COMM.HANDSHAKE tag is an integer tag that is written to
initiate a specified action and read to monitor the results of the action. The handshake
values are provided in the table below.

Handshake Value Description

0 Value written to the handshake tag to notify the
batch management system to continue.
-1 Value used by the batch management system to
notify the user that the system is logging a unit or
segment status change to history and waiting for a
response.

NOTE
The batch manager waits for the handshake to continue processing. All batch pro-
cessing activity is essentially put on hold until the signal to continue is received.
Therefore, it is vital to return the continue handshake quickly.

546
17. Tag Interface Management (TIM) System B0193YB – Rev C

Equipment Allocation Changes

This action group allows the user to perform functions as equipment allocation changes are made
by the batch management system through tags. The tags in this action group can be used within a
client to obtain notification of a change of allocation.

Table 17-22. Equipment Allocation Change Tags

Tag Name Type Size Access

FU.ALLOC_CHANGE.INFO.CLB STRING 50 RO
This tag consists of three fields separated by a “/”.
CAMPAIGN ID 16
LOT ID 16
BATCH ID 16
FU.ALLOC_CHANGE.INFO.RECIPE STRING 16 RO
FU.ALLOC_CHANGE.INFO.SIZE INTEGER 1 RO
FU.ALLOC_CHANGE.INFO.TRAIN STRING 16 RO
FU.ALLOC_CHANGE.INFO.MODE INTEGER 1 RO
FU.ALLOC_CHANGE.INFO.STATUS INTEGER 1 RO
FU.ALLOC_CHANGE.INFO.EQUIPMENT STRING 16 RO
FU.ALLOC_CHANGE.SEGMENT_LIST.NUM_ITEMS INTEGER 1 RO
FU.ALLOC_CHANGE.SEGMENT_LIST.ITEM1 TO STRING 16 RO
FU.ALLOC_CHANGE.SEGMENT_LIST.ITEM16
FU.ALLOC_CHANGE.SELECT.SEGMENT_ITEM INTEGER 1 R/W
FU.ALLOC_CHANGE.SELECT.SEGMENT STRING 16 RO
FU.ALLOC_CHANGE.COMM.HANDSHAKE INTEGER 1 R/W

1. The FU.ALLOC_CHANGE.INFO.CLB tag is a string tag that contains the Cam-

paign, Lot, and Batch combination that is the batch focus for the action.
2. The FU.ALLOC_CHANGE.INFO.RECIPE tag is a string tag containing the recipe
ID of the batch selected.
3. The FU.ALLOC_CHANGE.INFO.SIZE tag is an integer tag containing the size of
the batch selected.
4. The FU.ALLOC_CHANGE.INFO.TRAIN tag is a string tag containing the train of
the batch selected.
5. The FU.ALLOC_CHANGE.INFO.MODE tag is an integer tag containing the
mode of the batch selected.

Value Mode
0 Automatic
1 Semi-Automatic
2 Manual

547
B0193YB – Rev C 17. Tag Interface Management (TIM) System

6. The FU.ALLOC_CHANGE.INFO.STATUS tag is an integer tag containing the sta-

tus of the batch selected.

Value Status
1 Ready
2 Wait
3 Run
4 Done
5 Interlock
6 Aborted
7 Held
8 Aborting

7. The FU.ALLOC_CHANGE.INFO.EQUIPMENT tag is a string tag containing the

unit or connection whose allocation is changing in the selected batch.
8. The FU.ALLOC_CHANGE.SEGMENT_LIST.NUM_ITEMS tag is an integer tag
containing the number of segments defined for the active equipment in the selected
batch.
9. The FU.ALLOC_CHANGE.SEGMENT_LIST.ITEM1 to
FU.ALLOC_CHANGE.SEGMENT_LIST.ITEM16 tags are string tags used to dis-
play the list of segments for the active equipment in the selected batch.
10. The FU.ALLOC_CHANGE.SELECT.SEGMENT_ITEM tag is an integer tag used
to select the item in the list that is the focus of the action being performed. This is
equivalent to the selection of the segment from the list with the mouse.
11. The following tags contain the specific transition object information corresponding to
the selected item from the list.
FU.ALLOC_CHANGE.SELECT.SEGMENT - String tag containing the name of
the selected segment.
12. The FU.ALLOC_CHANGE.COMM.HANDSHAKE tag is an integer tag that is
written to initiate a specified action and read to monitor the results of the action. The
handshake values are provided in the table below.

Handshake Value Description

0 Value written to the handshake tag to notify the batch
management system to continue.
-1 Value used by the batch management system to notify
the user that the system is allocating a unit and waiting
for a response.
-2 Value used by the batch management system to notify
the user that the system is allocating a connection and
waiting for a response.

548
17. Tag Interface Management (TIM) System B0193YB – Rev C

Handshake Value Description

-3 Value used by the batch management system to notify
the user that the system is releasing a unit and waiting
for a response.
-4 Value used by the batch management system to notify
the user that the system is releasing a connection and
waiting for a response.

NOTE
The batch manager waits for the handshake to continue processing. All batch pro-
cessing activity is essentially put on hold until the signal to continue is received.
Therefore, it is vital to return the continue handshake quickly.

TIM Runtime Operation

The TIM runtime system contains the applications necessary to interact with the TIM interface
groups. There is also an application (ProcStatus) that allows the user to monitor and write to the
TIM tags from within the Batch Server application.
Each TIM interface group requires a unique runtime TIM application to be started before the
tags from that group can be monitored or written. The table below illustrates the runtime applica-
tion that is associated with each interface group. The Environment Editor is used to include the
appropriate runtime TIM application in the system startup.

Table 17-23. TIM Runtime Applications

Interface Group Runtime TIM Application Required

Batch Management System TIMBatch
Security System TIMSec
Batch Functions TIMFunc

NOTE
TIMFunc should only be started if any of the Batch Function Interfaces is enabled
in the TIM Editor.

549
B0193YB – Rev C 17. Tag Interface Management (TIM) System

550
18. Batch Alarm
The I/A Series Batch Alarm subsystem captures all equipment and process alarm events
associated with a batch and stores them in the Batch Historian. The Batch Alarm Subsystem
consists of the Event Manager, Alarm Comment Application, Sequence Unsuspend Application,
and a set of Batch Alarm report queries. This subsystem interfaces with the Batch Historian via
ODBC to store and retrieve batch-related alarms. I/A Series FoxAlert provides a means to view
batch related alarms, enter comments and unsuspend equipment phases. Through the
interaction of equipment system tags, Batch Manager and I/A Series Control Processor, Event
Manager is able to capture batch-related alarms.
Batch alarms, in I/A Series Batch Suite, are captured, associated with a batch and stored in the
Batch Historian. The user can view alarms for a specific batch using the FoxAlert alarm display
and can attach a comment to any batch specific alarm event displayed in FoxAlert. A set of three
alarm report queries is provided to retrieve batch analog alarms and comments, Boolean alarms
and comments, and sequence blocks and comments from batch history and include them in batch
reports.
The diagram shown below provides an overview of the major elements of the Batch Alarm sub-
system.

551
B0193YB – Rev C 18. Batch Alarm

Reports

Batch Reporting
System

SQL Server I/A Series

Batch Historian Batch Display(s)

Launch
Alarm Comment w/Batch ID

Batch
Alarms
Alarm I/A Series
Comment FoxAlert
Event
Manager

Process Alarm
Messages

Acknowledge Sequence
I/A Series Block Message
CP

Figure 18-1. Major Elements of the Batch Alarm Subsystem

BATCH_ID System Tag

Units, connections and segments (generally referred to as equipment) have batch identification
system tags that are created when equipment is defined in the Model Editor. They are:
<equipment name>.CAMPAIGN_ID
<equipment name>.LOT_ID
<equipment name>.BATCH_ID
When the Batch Manager allocates equipment to batches, it also updates these tags to reflect the
batch to which the equipment is allocated. One element of this 3-part batch identifier, the
BATCH_ID, is assumed to be a unique identifier for a batch. Therefore, for alarms to be associ-
ated with a batch, each unit, connection and segment must have a corresponding I/A Series Com-
pound or Block in the I/A Series control system, and the equipment’s BATCH_ID system tag
must be linked to the equipment’s corresponding Compound:LOOPID parameter.
The I/A Series Tag Linker, by default, links the BATCH_ID system tag to the equipment’s
Compound:UNIT.SN0010 parameter. Sequence Block code in the equipment’s

552
 Compound:PHASE_EXEC Block assigns the value of Batch_ID system tag, stored in SN0010,
to the equipment’s Compound:LOOPID parameter.
Units must have a corresponding Compound in the I/A Series control system of the same name.
Connections and segments should have a corresponding Compound of the same name; but some-
times this is not practical and a Data Block may be used. In this situation, the connection or seg-
ment BATCH_ID system tag must be linked to the Data Block’s LOOPID parameter. When an
alarm occurs in the Data Block, the alarm contains the Data Block’s LOOPID parameter value.
The alarm is sent to alarm destinations configured in the Data Block’s Compound.

Event Manager
Event Manager is a Windows NT service application, which communicates with the I/A Series
subsystems. Event Manager’s main responsibility is to receive all I/A Series alarms and store them
in the Batch Historian.
Event Manager uses either the LOOPID value or Equipment Allocation to determine the Batch
Identification for alarms. During batch execution, Event Manager compares the LOOPID field of
the alarm message with the current list of batches in the schedule. If there is a match, the alarm is
considered a batch alarm. An Alarm ID is then assigned to the alarm, and it is logged to the Batch
Historian along with its Batch Identification (Campaign, Lot and Batch ID). If the LOOPID
value does not match a Batch ID in the schedule, Event Manager searches the Link database for
the Compound:Block name. If there is a match, the alarm is considered a batch alarm. Event
Manager determines the equipment name (Unit, Connection or Segment) from the Link database
and then, using Equipment Allocation information, determines the Batch ID. An Alarm ID is
then assigned to the alarm and it is logged to the Batch Historian along with its Batch Identifica-
tion (Campaign, Lot and Batch ID). If the Compound:Block name is not found in the Link
database, the alarm is not considered to be a batch alarm and is discarded.

I/A Series Control Strategy - Alarm Considerations

The manner in which the batch management system implements alarming provides several alter-
natives as to how you can implement an I/A Series Control Strategy. The following descriptions
provides an overview of these designs.
1. One Equipment entity (unit, connection or segment) is represented by one
Compound.
In this case, each Equipment entity (unit, connection or segment) has a corresponding
Compound in the I/A Series Control Processor.
Solution: Use either the LOOPID parameter or the Equipment Allocation approach.
2. One Equipment entity is represented by Multiple Compounds.
a. Exclusive Use
In this case, there is more than one Compound used to control the Equipment
entity. There is typically one Lead Compound with the same name as the Equip-
ment entity and other Exclusive Use Compounds whose logic is used by the Lead
Compound as required. In this situation, the Exclusive Use Compounds can only
be used by one and only one Lead Compound. Alarms generated in the Exclusive
Use Compound should be associated with the batch that has allocated the Equip-
ment entity that is associated with the Lead Compound.

553
B0193YB – Rev C 18. Batch Alarm

Example: A Filter can be used by either REACTOR_A or REACTOR_B, but

only one Reactor at a time can use the Filter. When the Filter is being used with
REACTOR_A, Filter alarms must be logged to the batch that has allocated
REACTOR_A. If the filter is being used with REACTOR_B, then the alarms
must be logged to the batch that has allocated REACTOR_B.
Solution: The LOOPID approach must be used. When REACTOR_A is allo-
cated the Batch ID is written to the LOOPID of the REACTOR_A Lead Com-
pound by I/A Series Batch. When the Filter is used, the Batch ID should be
written to its Compound’s LOOPID, so if alarm occur in the Filter the correct
Batch ID is used.
b. Shared Use
In this case, there is more than one Compound used to control the Equipment
entity. There is typically a Lead Compound with the same name as the Equipment
entity and other Compounds whose logic is used by the Lead Compound as
required. In this situation, the Shared Compound can be used by more than one
Lead Compound simultaneously. Alarms generated in any of the blocks within
this Shared Compound should be associated to both batches if both Lead Com-
pounds are using the Shared Compound.
Example: An example of this is a Heat Exchanger that can be used by more than
one reactor simultaneously. When the Heat Exchanger is being used by
REACTOR_A and REACTOR_B, Heat Exchanger alarms should be logged to
the batch that allocated REACTOR_A and to the batch that allocated
REACTOR_B.
Solution: I/A Series Batch does not support this situation. Batch Alarms can only
be associated to one Equipment entity not multiple Equipment entities.
c. One to One Usage
In this case, there is more than one Compound used to control an Equipment
entity. There is typically a Lead Compound with the same name as the Equipment
entity and other Dedicated Compounds whose logic is used by the Lead Com-
pound as required. In this situation, the Dedicated Compounds are always used
by the same Lead Compound and are never shared. Alarms generated in any of the
Dedicated Compounds should be associated to the Batch that has allocated the
Lead Compound.
Example: A Filter is used by only by REACTOR_A. When the Filter is being used
with REACTOR_A, Filter alarms should be logged to the batch that has allocated
REACTOR_A.
Solution: Either the LOOPID or the Equipment Allocation approach can be
used. If the Equipment Allocation approach is used, then at least one Equipment
Entity Tag (REACTOR_A) must be linked to an I/A Series Filter Tag
(Compound:Block.Parameter).
3. Multiple Equipment Entities Represented by One Compound
This approach is desirable if there are many connections or segments in a system and
Compound are limited. In this situation, one Compound has many Blocks each rep-
resenting a Connection or a Segment. Alarms generated in any of the Blocks should
be associated with the Batch that has allocated the Connection or the Segment.

554
18. Batch Alarm B0193YB – Rev C

Example: A Manifold has many connections and many segments. A Compound is

dedicated to the Manifold and each connection and segment has an associated Block.
Any block alarms should be associated with the batch that has allocated its associated
connection or segment.
Solution: Either the LOOPID or the Equipment Allocation approach can be used.

Viewing Batch Alarms with FoxAlert

The I/A Series FoxAlert application is used to view I/A Series alarms. When launched from
I/A Series Batch Display(s) with a batch selected, FoxAlert displays only the alarms associated
with a batch. When a batch is not selected, all alarms are displayed.

Entering Alarm Comments with FoxAlert

The Alarm Comment application is launched from the FoxAlert Alarm display and is used to
enter a comment for an alarm. The user must first select an alarm from the FoxAlert alarm dis-
play, and then launch the Alarm Comment application using the Alm Comment button. The
comment string, once entered, is stored as an Alarm Comment historian record in batch history.
An unlimited number of comments can be entered for any alarm displayed in FoxAlert.
For more information on configuring an Alm Comment button, refer to Chapter 20 “System
Administration”.

Unsuspending Equipment Phases with FoxAlert

The Sequence Unsuspend Application is launched from the FoxAlert Alarm display and is used to
unsuspend an equipment phase. When a sequence block issues a SENDCONF message, the
equipment phase processing is suspended until one of the following occurs: the timer associated
with the SENDCONF message expires or the operator unsuspends the block. To unsuspend the
block, the operator selects the button labeled Seq Unsusp from the FoxAlert Alarm display thus
allowing the block to resume processing.
For more information on configuring a Seq Unsuspend button, refer to Chapter 20 “System
Administration” of this User’s Guide.

555
B0193YB – Rev C 18. Batch Alarm

556
19. Redundancy
This chapter describes the configuration design and operation of a redundant I/A Series Batch
Server.

NOTE
If you are installing a redundant system, you must configure your system/network
as described in this section before you install I/A Series Batch.

The batch management system is designed with a redundancy option. Redundancy refers to the
capability of the batch management system to automatically continue normal execution on a
backup server in the event of a master server shutdown due to a single hardware failure or power
loss. Multiple failures are beyond the capabilities of redundancy. It is particularly useful in critical
manufacturing facilities where the loss of the batch system and/or associated batch data is intoler-
able.
Two computers running the I/A Series Batch software are required for the proper execution of
redundancy. During normal operation of redundant I/A Series Batch servers, one server is a mas-
ter and one server is a backup. Two independent networks are required to insure a high level of
fault tolerance. A communication token is passed between the batch servers checking for a
response based on a configurable time interval. The batch system is configured to pass two tokens
simultaneously, one along a primary and one along a secondary network. If a response is not
received within the configured time interval, the master is assumed to no longer exist and the
backup server assumes operation as the master.

NOTE
Configuration of a redundant batch control system requires computer network
experience. It is strongly recommended that only qualified personnel configure the
redundant system.

The network must be properly configured before installing redundant I/A Series Batch servers.
Each server must be equipped with at least two network interface cards (NICs). One NIC is des-
ignated as the primary and the other NIC the secondary. By establishing two independent net-
work paths between the batch servers the I/A Series Batch redundancy managers can send the
required communication tokens over both paths simultaneously. The nodebus must be designated
as the batch secondary network to minimize traffic over that network.

NOTE
Reliable network communications between the servers in the above described man-
ner is absolutely critical to the proper functioning of I/A Series Batch redundancy.
Redundancy, by design, is intolerant of unreliable network communications, and
this constraint must be taken into account when designing and deploying a redun-
dant I/A Series Batch system.

557
B0193YB – Rev C 19. Redundancy

Setting Up a Redundant I/A Series Batch Server

Redundancy is an option when installing I/A Series Batch servers and clients. However, the order
in which the components of the system are deployed is important. The system must be deployed
in the following order.
1. Establish a valid network configuration.
2. Install redundant I/A Series Batch servers.
3. Install and configure I/A Series Batch clients.

Network Overview
Before installing redundant I/A Series Batch servers, the network must be properly configured.
Each server is equipped with two network interface cards (NICs); each NIC is assigned a uniquely
addressable host name and a corresponding IP address. One NIC in each server can be designated
the primary, and the other NIC the secondary. Use the following checklist to verify proper net-
work configuration (an example configuration is provided).

NOTE
Redundant Network Configuration must be performed by qualified personnel.

♦ Dual Network Interface Cards – Two NICs must be present in each server.
♦ Protocol – Each server must be configured for the TCP network protocol.
♦ Network Addresses – Each NIC, on each server, must be assigned a proper IP address.
It is critical that the two addresses assigned to the NICs on a single server are from
different networks. This ensures that the network connection is used when communi-
cating the heartbeats. If these addresses differ only at the host level, redundancy does
not work properly.
♦ Lmhosts – Lmhosts lookup must be enabled as a TCP/IP property. The set of four
network addresses must be loaded into the lmhosts file. This loading ensures the
fastest possible name resolution. Sample entries for the lmhosts file are given in the
example that follows.
♦ Hosts – To ensure communications through the non-Nodebus NIC, the Hosts file
must not contain any entries.
♦ WINS – The WINS protocol must be unbound from the Nodebus NIC.
♦ RedCfg – A redundancy configuration file (RedCfg) is created on each server as part
of the redundancy installation. The RedCfg file contains specific information about
system names associated with the computers in your redundant setup.
♦ Verification – Communication between both servers and both paths must be tested
and verified.

Example of a Redundant Server Configuration

The following example provides a typical configuration for redundancy. The computer names and
IP addresses shown are used in the descriptions later in this section.

558
19. Redundancy B0193YB – Rev C

Batch
Primary
Network
10.40.20.181 10.40.20.182

Master Server Backup Server

(AW7003) (AW7004)

151.128.8.66
151.128.8.65

Batch
Secondary
Nodebus Network

Batch Batch
Information
Runtime Development
Server
Client Client
(InfoSvr)
(WP7003) (WP7004)

10.40.20.183 10.40.20.184 10.40.20.185

d i g i t a l d i g i t a l

Control Processors

Figure 19-1. Redundant Server Configuration

RedCfg and Lmhosts File Examples

In the example shown earlier, two computers, AW7003 and AW7004 represent a master server
and a backup server respectively. The terms master and backup are expressed for the purpose of
this example. Remember that during the operation of a redundant system, the relationship
between the master and the backup changes when a switch-over occurs. That is, the backup server
becomes the master, and then when the failed master is restored to proper operation, it assumes
the role as the backup system.
The computer names, and network IP addresses shown in this example, are used as the entries in
the RedCfg and Lmhosts files. You must substitute the appropriate IP addresses and hostnames as
defined by your system administrator.

559
B0193YB – Rev C 19. Redundancy

RedCfg File Example

The computer named AW7003 would have a RedCfg file as follows:
AW7004
<blank line>
\\AW7004\config_A\
<blank line>
AW7003PN
AW7003SN
AW7004PN
AW7004SN
<blank line>
The computer named AW7004 would have a RedCfg file as follows:
AW7003
<blank line>
\\ AW7003\config_A\
<blank line>
AW7004PN
AW7004SN
AW7003PN
AW7003SN
<blank line>
In this example, the names AW7003PN, AW7003SN, AW7004PN, and AW7004SN are defined
in the Lmhosts file on each computer.

RedCfg File Structure

The RedCfg file contains the structure described below.

Line 1: The remote computer name.

Line 2: Blank, not used.
Line 3: The path to the remote computer config_A directory.
Line 4: Blank, not used.
Line 5: The local hostname for primary network (cannot be a computer name).
Line 6: The local hostname for secondary network (blank if not used).
Line 7: The remote hostname for primary network (cannot be a computer name).
Line 8: The remote hostname for secondary network (blank if not used).
Line 9: Blank, not used.

560
19. Redundancy B0193YB – Rev C

NOTE
The last line of the RedCfg file must be blank (that is, carriage return.) The line
numbers shown are for reference only. They are not actually entered in the file.

Lmhosts File
The lmhosts file contains the structure described below. The lmhosts file is located in the
C:\winnt\system32\drivers\etc folder on your computer. The file is the same for all stations. Note
that the names entered correspond to the entries in the RedCfg file. The #PRE entries cause the
entries to be preloaded when your system is started. This is recommended for improved perfor-
mance.
10.40.20.181 AW7003 #PRE
10.40.20.181 AW7003PN #PRE
151.128.8.65 AW7003SN #PRE
10.40.20.182 AW7004 #PRE
10.40.20.182 AW7004PN #PRE
151.128.8.66 AW7004SN #PRE
10.40.20.183 WP7003 #PRE
10.40.20.184 WP7004 #PRE
10.40.20.185 InfoSvr #PRE

Hosts File
The Hosts file should contain no entries. The Hosts file is located in the C:\winnt\system32\driv-
ers\etc folder on your computer.

Installing a Redundant Batch System

Redundancy is an optional feature of I/A Series Batch. It is installed on both servers using the
I/A Series Batch installation program. You are presented with a series of dialog boxes that prompt
you for specific information about your network.

NOTE
I/A Series Batch must always be installed to the D: drive of your system.

To Install I/A Series Batch With Redundancy:

1. Follow the installation procedure for Batch Servers as described in Chapter 2 “System
Installation”.
2. Proceed through the installation until the Select Components window appears.
3. Enable the Redundant System checkbox. Click Next.
4. Enter the Information Server hostname (Machine Name). Click Next.
5. Enter the other Server's hostname (Letterbug). Click Next.
6. Select the number of interface cards installed. Click Next.

561
B0193YB – Rev C 19. Redundancy

7. Enter the logical hostnames for the Primary network. Click Next.
8. Enter the logical hostnames for the Secondary network. Click Next.
9. Follow the remaining installation instructions.
10. Setup automatically creates a program group with icons for the I/A Series Batch
Server.
11. Repeat these steps on the other server, substituting the appropriate hostname and log-
ical hostname for the redundant system.

Batch Client - Redundancy Configuration

A Batch Client is configured for redundancy using the I/A Series Batch installation program. You
are presented with a series of dialog boxes that prompt you for specific information about your
network.

NOTE
I/A Series applications need to be running on the client in order to map the net-
work drives during the installation of Configuration and/or Runtime Client
Options if the client’s only connection to the server is through the Nodebus.

NOTE
IMPORTANT: Before you begin configuring a Client for redundancy, you must
first have valid network connections between your servers and each Client.

Server Configuration (Post-Server Installation)

1. On each Batch Development Client, map two network drives. Each drive must corre-
spond (that is, point to) to the appropriate Batch Server.
2. When properly configured, each Development Client has two additional network
drive letters available: one that provides a connection to the master server, and one
that provides a connection to the backup server.

Batch Client Configuration

1. Follow the installation procedure for Batch Client as described in Chapter 2 “System
Installation”.
2. Proceed through the installation until the Select Components window appears.
3. Disable the Batch Server option and enable the Redundant System option.
4. Select Batch Clients and click Change to view the Sub-component installation
window. By default, both clients are selected for installation. Select the required sub-
components and then close the window.
5. Click Next to continue
6. Enter the hostname of the Information Server.
7. Enter the hostname of the Batch server and the drive letter which is mapped to the
batch server.

562
19. Redundancy B0193YB – Rev C

8. Enter the hostname of the other batch server and the drive letter which is mapped to
the batch server.
9. The Installation program creates two program groups. Each set of icons within each
program group is specifically associated with the batch server identified in the title bar.

Post-Installation Requirement
The status of a redundant system is made available to your I/A Series network by way of a shared
variable. The shared variable can be used to monitor the redundancy status of the server.
In operation, IADriver continuously attempts to write an integer value to the shared variable. If
the write attempt fails, a message is displayed and the feature is disabled.
The format of the shared variable is: <hostname>_RS
where: <hostname> is a machine name and “_RS” is appended to the <hostname> (for example,
AW7004_RS)

Create the Shared Variable

Start an MS-DOS Command line prompt. In the d:\opt\fox\bin\tools directory, execute the
following command:
omcrt -v -i <hostname>_RS
For example:
omcrt -v -i AW7004_RS
The shared variable that you created above is discarded each time you reboot your system. If you
want to create this shared variable automatically each time you restart your system, create a batch
file as described below and then register it using the TIM shared variable utility as described in
Chapter 6 “Tag Management”.
The batch file should contain entries similar to those shown.
d:
cd d:\opt\fox\bin\tools
omcrt -v -i AW7004_RS

Redundancy Verification
NOTE
IMPORTANT: A thorough understanding of this section is critical for the proper
deployment of a Redundant Batch System.

After installing and configuring the batch servers as described previously, you should verify that
the Servers are capable of properly switching over batch control. In the following discussion, it is
assumed that either server could be acting in the role of a master or backup. When the batch
servers are started for the first time, the server that actually boots first assumes the responsibility of
the Master. Thereafter, the role of each server is determined by the information contained in the
local RedState file on each system.
Redundant batch server operation is controlled by a Redundancy Manager process that runs on
each server. The heartbeat is exchanged over the network between these two processes. Each

563
B0193YB – Rev C 19. Redundancy

Redundancy Manager controls the other local I/A Series Batch processes. When a switch-over
event occurs, the associated process activity is controlled by the Redundancy Manager.
A system parameter in the Environment called Redundancy TimeOut is used to set the switch-
over delay. The value is user-configurable and is specified in seconds.
For more information on Environment Manager, see Chapter 4 “Environment Management
System”.
In the event a Redundant Batch server has failed to detect the other servers heartbeat, it waits for
the configured time before initiating a switch-over.
The normal state of an I/A Series Batch Redundant system has one server acting as a “Master with
Valid Backup” and the other server acting as a “Valid Backup.” The role of an active I/A Series
Batch server can be determined by opening the status window on the Environment Display.
In the event of complete communications failure between the two Redundancy Managers, a
switch-over event may be initiated by both servers, in which case there are two Masters. If this
occurs, proper Batch control is not guaranteed and operator intervention is mandatory. See the
section “Typical Redundant Sequence of Operation” on page 566 for a discussion on recovering
from the dual master condition. Avoiding this situation is, in fact, a primary requirement when
deploying a redundant I/A Series Batch system. This type of communication failure between the
two servers can occur for a variety of reasons. For example, the simultaneous loss of both networks
for a period of time at least equal to the switch-over setting, or, the execution of any process on a
batch server which completely consumes system resources (CPU, network, and so forth).
For this reason, it is strongly recommended that the expected batch server load is given careful
consideration and hardware resources are gauged accordingly. Resource intensive applications
such as screen savers should be disabled on the Batch servers, as they could cause the problem of
“two master systems.” Prior to deploying a redundant batch system into the production process,
the load and resource utilization on both batch servers must be assessed, and a reasonable assur-
ance of adequate resources for I/A Series Batch must be achieved.

Redundancy Operation
The batch control system has the capability to operate concurrent configuration and run-time
systems. The presence of two identical systems permits the backup system to continue run-time
execution if the master system fails. This functionality is known as redundancy. As the batch con-
trol system databases are altered, all revisions are written to databases located on both the master
system and the backup system. In the event of a master system failure, the backup system contin-
ues all batch operations.

564
19. Redundancy B0193YB – Rev C

Backup Server
Master Server
Batch System
Backup System
(Dormant)

Master Backup
Batch System Batch System
Databases Databases

Figure 19-2. Redundant Functionality

Directory Configuration
In a redundant batch control system configuration, the directories containing the batch applica-
tions on each server are shared. During installation of redundancy, the only user-supplied infor-
mation required to establish redundancy is the network name (hostname) of the other redundant
system. The same installation procedure is performed on both servers. Each identifies the other as
the redundant host. If the directory names, network references and network sharing, are config-
ured incorrectly, redundancy does not function properly.

Initial System Startup

Once the system configuration is complete, the master batch control system can be started nor-
mally. The server which is started first (by way of Environment Manager) becomes the master.

NOTE
All configuration changes other than recipes and materials should be made prior to
starting the run-time system.

After Environment Manager on the master is started, the Redundancy Manager (RedMngr) is
started. RedMngr creates a state file indicating that the system is the master. The state file also logs
the time at which it became the master. If, for some reason, RedMngr fails to start, EnvMngr
continues normal operation. RedMngr, however, sends a message to the Batch Logger indicating
an error. In this case you need to correct the error, shut down, and exit from the Environment
Display, and then restart the Environment Display.

RedMngr Startup Procedure

When RedMngr successfully starts on either the master or the backup system, it executes the fol-
lowing procedure:
1. If the state file indicates that the system was a backup, then the system operates as a
backup. If no master exists, then RedMngr does not start. A message is displayed indi-
cating the condition.
2. If the state file indicates that the system was a master, then it makes an attempt to
interrogate the state file on the remote system. If a remote system state file is not
found, then the system does not start and a message is displayed indicating the
condition.

565
B0193YB – Rev C 19. Redundancy

3. If the state file on the remote system is found, then the file is read and its last state is
determined. If the state of the remote system is backup, then the interrogating system
starts as a master.
4. If the state file on the remote system indicates that its last state was a master, then the
time that is logged to both of the state files is evaluated. If the state file on the interro-
gating system is more recent, then it starts as the master.
5. If the time in state file on the remote system is more recent, then the interrogating sys-
tem changes its state to backup and starts.
Environment Display provides a method to force either system to operate as the master, regardless
of the state of the state files on each system. In a redundant system, the Environment Display
application file pull-down menu appears as shown.

NOTE
Extreme caution is recommended when using the Force System to Master option.
When the system starts as a backup, it synchronizes all of the configuration data-
bases with those located on the master system. Therefore, if the system was previ-
ously operating as the master, then the data generated during the previous execution
is overwritten by the synchronization process.

Typical Redundant Sequence of Operation

The following paragraphs detail the normal sequence of operation for a redundant batch control
system. The results of system failures, as well as recommended recovery procedures are presented.

NOTE
Once the Environment Display is started on both servers in the batch control sys-
tem, a period of several minutes or longer elapses while configuration databases and
other batch control system processes are synchronized. During this period, both sys-
tems display messages that use the terms invalid and valid, in reference to the state
of the master or backup system. During the synchronization period, the messages
can be misleading. The term valid indicates that (1) all of the databases on both sys-
tems are synchronized and (2) the run-time system on the backup is enabled. The
term invalid indicates that (1) the databases on both systems are not (or are not yet)
synchronized and/or (2) the run-time system on the backup is not enabled and/or
(3) a backup system cannot be detected.

Initial Startup
The master batch control system is started as described earlier. The backup batch control system
databases are synchronized and started. Once the master and backup batch control systems have
been properly configured and all modules on each system have been started properly, the redun-
dant system executes normally until a failure of either system is experienced.

566
19. Redundancy B0193YB – Rev C

Normal Runtime Operation

The master system is responsible for updating both the master and backup system databases. The
master and backup system clocks must be manually synchronized on a regular basis to insure that
the data and time stamps associated with the historical data are consistent. The backup system
continuously monitors the status of the master system.

Backup System Failure

If the backup system fails prior to a master system failure, the master batch control system contin-
ues to operate normally but stops updating the backup system databases. The backup batch con-
trol system problem must be corrected and then restarted. The databases on the backup system
are then automatically re-synchronized.

Master System Failure

In the event of a master system failure, the backup system automatically assumes the role of the
master only if the backup system is valid. The transition is transparent to the control system. All
batches that were executing in the failed master system continue to execute on the backup system
that assumes the role of the master. Master system clients that are executing on other client sys-
tems terminate upon the failure of the master system. However, the operator may easily restart
these clients with connections to the new master system.

Master System Failure while Backup’s Operating System is Failed

It is possible for the Master system to fail while the backup system is not operational. Upon
restarting the Environment Display on the Master system, the Redundancy Manager does not
start because the starting system cannot communicate with the alternate system. If the alternate
system cannot be started, then the procedure to recover is to manually force the viable system to
become the Master using the Force System to Master option on the File dropdown menu on the
Environment Display. Perform an Exit and Shutdown of the Environment Display and restart the
Environment Display. This system assumes the role of Master and operates as a stand-alone server
until the backup system is restored to an operational state.

NOTE
The failed master should not be started as the backup until the problem that caused
the failure is repaired.

If the system does not have a redundancy state of Master with Valid Backup, or if redundancy is
not being used and IADriver loses communications with the CP, IADriver continues trying to
read valid tag values. The read error is not reported more than once per tag. Read errors on tags
that have never had a successful read only report the error once and redundancy is not initiated.
This ensures that improperly linked tags do not initiate a redundancy switchover.

567
B0193YB – Rev C 19. Redundancy

NOTE
If communication between the CP and IADriver fails, an automatic switch-over to
the Backup System does not occur. IADriver issues “read failed errors” for the linked
tags that are attempting to be read. If this should occur, the operator must deter-
mine the cause of the failure and then determine if a manual switch-over to the
Backup System can resolve the communication fault.

Failed System Recovery

When the original master system problem is rectified, the system can be restarted as the backup.

Dual-Master Recovery
In the event that a dual master situation occurs, operators must take action to restore the batch
system to a proper state. Operators should put all batches on hold while an assessment of the state
of the process is made. The network must then be restored to allow for proper Redundant
operation.
To restore the system, one of the Batch Servers must be selected to be the Master based on the
assessment of the process.
Use the RedState Utility, described in “Redundancy Status Utility (RedState)” on page 569, to
determine the time each system became Master.
If the machine with the newest time is chosen, perform an Exit and Shutdown on the other
station. Then restart the batch runtime applications on that station. It will restart as a Valid
Backup.
If the machine with the oldest time is chosen, perform an Exit and Shutdown on the other
station first. Then perform a “Force to Master” on the first (oldest) station, followed by an Exit
and Shutdown on that station. Lastly, restart the runtime applications on both machines.

Manual Switch-Over to Backup System

The operator may manually switch the operation to the backup system at any time during normal
operation. This is accomplished by shutting down the master batch control system. The backup
system assumes the role of the master as if there were a hardware failure.

NOTE
If you are going to execute a manual switchover, it is recommended to do so (if pos-
sible) when batch activity is minimal. This ensures the highest degree of integrity of
the master-to-backup database synchronization.

Shutting Down a Redundant System

If changes are made to the tag database on the master system and the runtime is then updated
(while the backup is valid), the backup system may not have current tag data. If I/O Clients (that
is, SysTagMngr) are running on the backup system when the master is updated, the I/O client
data in memory on the backup system is not updated. To avoid this problem, it is strongly
recommended that you follow the guideline below.

568
19. Redundancy B0193YB – Rev C

Whenever you shut down a redundant system, ensure that you first shut down the backup system,
followed by the shutdown of the master. When you start a redundant system, ensure that you start
the master system first, followed by the start of the backup. This ensures that the runtime data is
current and synchronized.

Redundant System Points of Interest

During normal redundant system operation, there are several important topics of which the user
must be aware. Each of these details should be followed to ensure successful redundant operation.
♦ Editing of the batch control system databases can only be performed on the active
master.
♦ Following the guidelines in this document for setting up a redundant system ensures
successful system operation. However, if a situation occurs where the backup system
or network loses communication, hence its synchronization with the master system,
an error message is sent and displayed in the Batch Logger. In this case, the hardware
and/or system configuration requirements presented earlier should be reviewed.
♦ In the event that a hardware failure occurs during the transition of the status of one or
more phases, the batch management system assumes that the control system phase
logic is correct. Thus, for all phases that were executing prior to the failure, the status
is read from the control system upon the start of the backup system.
♦ When starting a backup system, it is recommended that batch control system activity
be at minimal level. This ensures the highest degree of accuracy for database
synchronization.
♦ The backup server station is not intended to be used as a Runtime Client, therefore, it
is not possible to create/schedule/start batches from the backup server.

Redundancy Status Utility (RedState)

The RedState utility executes from the command line. The utility returns an exit value represent-
ing the redundancy status (master or backup) of the node. The possible return values are
described below. These values are stored in a shared variable for use in your applications.

Table 19-1. Redundancy Status Values

Value Description
-1 Error
0 Master with no backup or an
invalid backup
1 Master with valid backup
2 Invalid backup
3 Valid backup
5 Failed master
6 Not a redundant system

569
B0193YB – Rev C 19. Redundancy

570
20. System Administration
This section describes the utilities and procedures that you should use for administration of your
I/A Series Batch components.

Information Server Administration

Information Server administration software is provided via a web page that is hosted on the Infor-
mation Server. The administration web page provides the following functionality:
♦ History Administration
♦ Error Queue Administration
♦ Information Server Configuration
♦ History Archiving
♦ Report Log Administration.

To Access the Batch Information Server Administration Web Page:

1. On the Start menu of your Information Server, point to Programs>IA Series Batch,
BatchInfoServer and then select BatchAdmin.
If you want to access the Batch Information Server web page from a different com-
puter on your network, you need to use the following URL address: http://<computer
name>/AdminWeb, where <computer name> is name of the computer on which the
Information Server is installed
2. If you have enabled Batch security, you are prompted to enter a valid Username and
Password to access the administration web pages. By default, security is not enabled,
and the Batch Info Server Administration main page is displayed.

571
B0193YB – Rev C 20. System Administration

Figure 20-1. Batch Info Server Administration Window

History Administration
Use the History Admin button to access the Batch Information Server Administration - History
Admin page and configure the Information Server (SQL Server) accounts that are associated with
access to the administration functions. The accounts that you are specifying are ultimately used to
establish access to the History Database in the SQL Server.

572
20. System Administration B0193YB – Rev C

Figure 20-2. History Admin Window

1. Enter the required User ID and Password.

NOTE
The Password is case sensitive.

When the Information Server software is installed, the default User ID is

BatchAdminUser and the Password is WildcatFalls.
The accounts that you enter must already have been defined using Microsoft SQL
Server Enterprise Manager. For more information on accounts, see “User Accounts”
on page 574.
2. After you enter the required information, click the Set Admin Data button. This
returns you to the Batch Information Server Administration main page.

573
B0193YB – Rev C 20. System Administration

User Accounts
When you create user accounts for the History Administration pages, it is important that you fol-
low the guidelines described in this section. The following requirements must be observed when-
ever you are creating or editing System Administration user accounts associated with the users
who can access History Administration web pages. If you do not properly configure user access
and assign the appropriate privileges, you are not able to use History Administration.
For all user accounts associated with History Administration, use Microsoft SQL Server Enter-
prise Manager to define the following SQL Server Login Properties.
♦ BatchHistory database must be assigned as the default database.
♦ Server roles must include: Disk Administrators and Database Creators.
♦ Database Access for the BatchHistory and BatchArchive databases must each
include the following Database Roles: public, db_owner, and BatchAdminRole
options must be assigned.

Error Queue Administration

During normal batch execution, all historical data is written to the History Database on the Infor-
mation Server. While it is very unlikely, it is nevertheless possible, for a failure to occur that would
prevent data from being written into the History Database. These abnormal conditions may result
in an accumulation of data in the Error Queue. If you are observing what appears to be erroneous
historical data or some other abnormal indications, it is recommended that you make use of the
Error Queue Admin page.
Use the Error Queue button to access the Error Queue Admin page. From this page you can view
and edit the data that is stored in the Error Queue. By reviewing the information in the Error
Queue, it may be possible to edit the data in such a way that the Information Server is able to
properly store it. If necessary, you can delete the affected data.

574
20. System Administration B0193YB – Rev C

Figure 20-3. Error Queue Admin Window

Information Server Configuration

Use the Info Server Config button to access the Information Server Configuration page. From
this page you can specify the Report Path that is associated with reports that are printed to a file.
1. In the Report Path text box, enter the path in which you want your reports to be
written.

NOTE
When the Information Server is installed, the Report Path is C:\BatchInfoS-
erver\Crystal by default. The default Report Path is always associated with the C:
drive even if the Information Server is installed on a different drive. If the Informa-
tion Server is installed on a different drive, then Report Path must be edited using
the Config button on the Information Server's AdminWeb page. If you change the
Report Path, the ReportQReader service must be restarted. Users should consider
this when creating and editing recipes that include reports.

2. Click the Update button to store the path.

575
B0193YB – Rev C 20. System Administration

Figure 20-4. Info Server Config Window

History Archiving
Use the History Archive button to access the History Archive page. From this page, you can cre-
ate, edit and execute archiving tasks that are registered by SQL Server.

576
20. System Administration B0193YB – Rev C

Figure 20-5. History Archive Window

Adding an Archive Job

This section describes how to add an archive job.

To Add an Archive Job:

1. Click the Add Archive Job button.
The History Archive - Add Archive page appears.

577
B0193YB – Rev C 20. System Administration

Figure 20-6. Add Archive Page

2. Enter the information as described in the following table.

578
20. System Administration B0193YB – Rev C

Table 20-1. Archive Job

Item Description
Job Name The user-defined name for the archive job.
Job Description Text that describes the archive.
Scheduled Date & Time The scheduled date (mm/dd/yyyy) and time (hh:mm am/pm)
identify when the Information Server performs the archive task.
Dump Device Name The dump device can be any descriptive text you want to use. The
History Archive application creates a Backup Device in Microsoft
SQL Server with the same name. An error message is displayed if
the entry is blank.
Dump File Name The complete path and name are created when the archive task is
executed. An error message is displayed if the entry is blank.
Archive Database Name This is the name of the Archive Database that you defined when
you installed the Information Server (default is BatchArchive).
History Data Start Date The start date (mm/dd/yyyy) identifies the starting point for
archiving history data.

This date is inclusive. All batches completed on or after this date

are archived.

A batch is considered completed when it has obtained a status of

Done or Aborted, and is closed (removed from the batch schedule).
History Data End Date The end date (mm/dd/yyyy) identifies the ending point for
archiving history data.

This date is inclusive. All batches completed on or before this date

are archived.

A batch is considered completed when it has obtained a status of

Done or Aborted, and is closed (removed from the batch schedule).
Options - Purge Data After Enable this checkbox if you want the archive task to delete the data
Archive (defined by the start and end dates) from the history database
when it executes archive task.

3. After you have completed making your entries, click the Add button.

Adding a Purge Job

This section describes how to add a purge job.

! CAUTION
Extreme caution should be used when purging historical information. Always make
sure the data to be purged has been successfully archived. It is recommended that
you archive and verify your data first, and then, if required, purge it.

579
B0193YB – Rev C 20. System Administration

To Add a Purge Job:

1. Click the Add Purge Job button to display the History Archive - Add Purge page.

Figure 20-7. Add Purge Page

2. Enter the information as described in the following table.

580
20. System Administration B0193YB – Rev C

Table 20-2. Purge Job

Item Description
Job Name The user-defined name for the purge job.
Job Description Text that describes the job.
Scheduled Date & Time The scheduled date (mm/dd/yyyy) and time (hh:mm am/pm)
identify when the Information Server performs the archive task.
History Data Start Date The start date (mm/dd/yyyy) identifies the starting point for
archiving history data.

This date is inclusive. All batches completed on or after this date

are archived.

A batch is considered completed when it has obtained a status of

Done or Aborted, and is closed (removed from the batch schedule).
History Data End Date The end date (mm/dd/yyyy) identifies the ending point for
archiving history data.

This date is inclusive. All batches completed on or before this date

are archived.

A batch is considered completed when it has obtained a status of

Done or Aborted, and is closed (removed from the batch schedule).

3. After you have completed making your entries, click the Add button.

Adding a Restore Job

This section describes how to restore a previously archived database.

To Add a Restore Job:

1. Click the Add Restore Job button to display the History Archive - Add Restore page.

581
B0193YB – Rev C 20. System Administration

Figure 20-8. Add Restore Page

2. Enter the information as described in the following table.

582
20. System Administration B0193YB – Rev C

Table 20-3. Restore Job

Item Description
Job Name The user-defined name for the job.
Job Description Text that describes the job.
Scheduled Date & Time The scheduled date (mm/dd/yyyy) and time (hh:mm am/pm)
identify when the Information Server performs the archive task.
Dump Device Name The dump device can be any descriptive text you want to use. The
History Archive application creates a Backup Device in Microsoft
SQL Server with the same name. An error message is displayed if
the entry is blank.
Archive Database Name The name of the Archive Database that you defined when you
installed the Information Server.

3. After you have completed making your entries, click the Add button.

Completed Archives
After an archive has been created, it can be deleted, restored or purged.
1. On the History Archive page, identify the archive that you want from the Completed
Archives list.

583
B0193YB – Rev C 20. System Administration

Figure 20-9. Completed Archives List

2. To delete the archive, click the Delete button associated with the archive Name. The
archive is immediately deleted.
3. To Restore an archive, click the Restore button associated with the archive Name.
The archive is immediately restored.
If you want to view the Completed Archive before you restore it, click the archive
Name. This displays the Completed Archive Details page.

584
20. System Administration B0193YB – Rev C

Figure 20-10. Completed Archives Details Page

After viewing the information, click the Restore Archive button. The History Archive
- Add Restore page appears. Review and edit the Add Restore job, and then click the
Add button. The selected archive is restored.

Report Log Administration

The Report Log Admin button provides access to the Report Log Administration page. The
Reporting system allows you to configure and generate reports, and save them in a folder on your
Information Server. All reports that are stored on the Information Server are stored in the database
and are displayed whenever you use the Report View feature of the Reporting System. Depending
on your specific requirements, you may want to remove reports that are no longer needed.
1. Locate and delete the report(s) using Windows Explorer.

585
B0193YB – Rev C 20. System Administration

NOTE
The location of saved reports is specified by the user during configuration.

2. Click the Report Log Admin button to display the Report Log Administration page.

Figure 20-11. Report Log Administration Page

3. On the Report Log Admin page, click the Update button.

This causes the Information Server to update the database so that the reports that you
deleted no longer appear when you use the Report View feature on the Batch Report-
ing web page.

Changing an Information Server Assignment on a Batch Server

When you install an I/A Series Batch Server you are prompted to enter the name of the computer
on which your Information Server is located. If you need to change the Information Server Host
name, follow the steps shown.
The I/A Series Batch Server uses the environment variable BHQ_HOST and its assigned value to
determine the network location of the Information Server.

586
20. System Administration B0193YB – Rev C

1. On the Start menu of the Batch Server, point to Settings and then select Control
Panel.
2. In the Control Panel window, double-click the System icon.
3. On the System Properties window, select the Environment tab.
4. Define the System Variable BHQ_HOST.
5. Enter the hostname of your Information Server as the Value for the BHQ_HOST
environment variable.
6. Click Set when you have entered the required variable name and value, and then click
OK.
7. On the Start menu of the Batch Server, point to Run.

! WARNING
The following steps require you to modify the Windows system registry. It is essen-
tial that you follow the instructions carefully and modify only the key that is identi-
fied. Unintentional changes to the registry can leave your system in an unusable
state.

8. In the Open field, enter Regedit.

9. Under My Computer, expand the HKEY_LOCAL_MACHINE branch.
10. Expand the SOFTWARE branch, select Wonderware and then expand the InBatch
branch.
11. Double-click the IIS_Server name.
12. In the Edit String window Value Data field, enter the computer name of the Informa-
tion Server (in lower case) that you want to use.
13. Click OK.
14. Restart the computer to register the new Information Server environment variable and
registry settings.

Changing a Batch Server Assignment on an Information Server

When you install an I/A Series Information Server you are prompted to enter the Host name of
the computer on which your Batch Server is located. If you need to change the Batch Server Host
name on the Information Server, follow the steps below.

! WARNING
The following steps require you to modify the Windows system registry. It is essen-
tial that you follow the instructions carefully and modify only the key that is identi-
fied. Unintentional changes to the registry can leave your system in an unusable
state.

1. On the Start menu of the Information Server, point to Run.

2. In the Open field, enter Regedit.
3. Under My Computer, expand the HKEY_LOCAL_MACHINE branch

587
B0193YB – Rev C 20. System Administration

4. Expand the SOFTWARE branch, select Wonderware and then expand the InBatch
branch.
5. Point to InfoServer and then double-click Host1 name. In the Edit String window
Value Data field, enter the computer name of the Batch Server (in lower case) that you
want to use. If you are changing a Batch Server name that is associated with Host2 (a
redundant system), simply repeat this step for Host2.
6. Click OK.
7. There is no need to restart the computer, but it is necessary to restart any browsers
that were connected to the Information Server.

Backing Up I/A Series Batch Databases

You can create backup copies of your configuration databases at any time by using the DBCOPY
utility. The batch management system does not need to be shut down to perform the backup. The
utility, which is executed from the command line, locks the specified database, and then safely
copies it to a location that you enter.
DBCOPY is located in d:\IASeriesBatch\bin folder.

NOTE
The DBCOPY utility is designed for use on an active batch server that contains the
databases that you want to backup. If you want to backup databases that are not
active, you can use a standard Windows file copy.

Using the DBCOPY Utility

To back up I/A Series databases, use the DBCOPY utility:
Syntax: dbcopy [-L] <path1><db_ name> <path2><backup_db_name>
Where:
-L enables database locking. (This is required.)
<path1> is the source location of the database that you want to back up (for example,
D:\IASeriesBatch\cfg\config_A)
<db_name> is the source database that you want to backup (for example, ModelDB)
<path2> is the destination location (for example, D:\)
<backup_db_name> is the backup database name (for example, ModelDB)
Example:
D:\IASeriesBatch\bin\dbcopy -L ..\cfg\config_A\modeldb D:\modeldb

! WARNING
Will not work with NuTCRACKER™. Must be at DOS prompt.

588
20. System Administration B0193YB – Rev C

! WARNING
Do not use DBCOPY to back up configuration databases while an “Update Runt-
ime” or “Update Configuration” is in progress. Attempting this may result in cor-
rupt data.

Managing I/A Series Batch Configurations

The IA Series Batch install program creates a complete set of batch databases that are necessary to
store and manage all batch-related data. The default path and folder for these databases is
D:\IASeriesBatch\cfg\config_A. The default databases are available in the dflt_cfg folder, with the
exception of the RedCfg file which is necessary for redundancy. The databases are complete, but
are intentionally blank, so that you can use them for development of new configurations.
A file named RedCfg is generated when the Redundancy option is selected during the installation.
This file is created in the config_A folder and should be copied to the dflt_cfg folder if you are
using redundancy. The RedCfg file is unique to each server installation.
When you create new configurations, you can copy the contents of the dflt_cfg folder into the
config_A folder. After you develop a new configuration, you can save it to a folder other than
config_A and later copy it into the config_A folder as needed. It is recommended that you copy
all the files contained in the configuration rather than attempt to copy selected databases from
different configurations.
When you copy files into the config_A folder, all previous databases are overwritten. If you are
making this change in a production system, it is highly recommended that you perform a thor-
ough control system validation once you have copied the databases into the config_A folder.

NOTE
If you are making this change on a production system, ensure that all batches are
complete and removed from the Batch Schedule list.

It is recommended that you use the following guidelines whenever you need to overwrite the
config_A folder.
1. Perform an Exit and Shutdown from the Environment Display.
2. Copy the current config_A files to another folder as a backup precaution.
3. Copy all the files in the dflt_cfg folder to the config_A folder.
4. If the system is set up for redundancy, ensure the original RedCfg file is in the
config_A folder.
You can then use the editors to create a new system configuration or you can copy a
previously saved configuration into the config_A folder.
The following table shows the files in the configuration directory and provides a description of
how the batch system uses each.

589
B0193YB – Rev C 20. System Administration

Table 20-4. I/A Series Batch Configuration Directory Files

Configuration File Location Description Usage

.batchwr …\IASeries- Directory that contains Created by install and
Batch\cfg\config_A all batch warm restart no modifications are
data files. made to directory.
.batchwr\alloc_req.wr …\IASeries- Current equipment allo- Changes made by
Batch\cfg\config_A cation table across all Batch Manager during
batches. batch execution.
.batchwr\system.wr …\IASeries- Current value of system Changes made by
Batch\cfg\config_A tags across all equip- Batch Manager during
ment. batch execution.
.batchwr\[clb].wr …\IASeries- File for each batch in the Files added and
Batch\cfg\config_A schedule database. Struc- removed by Batch
ture of file name is Cam- Manager during batch
paignID.LotID.BatchID execution.
.wr.
.F2.lock …\IASeries- Batch warm restart lock Created by RedMngr
Batch\cfg\config_A file created on master when the backup batch
server by backup server server is started.
during redundancy star- Redundancy only.
tup. Redundancy only.
.F2.sync …\IASeries- Batch warm restart syn- Created by RedMngr
Batch\cfg\config_A chronization file created when the backup batch
on master server by server is started.
backup server during Redundancy only.
redundancy startup.
Redundancy only.
.RedState …\IASeries- Contains the current Created and modified
Batch\cfg\config_A state of the server in a by RedMngr during
redundant configura- redundancy operation.
tion. Redundancy only. Redundancy only.
BatchDB.dat …\IASeries- Batch schedule database Changes as batches are
Batch\cfg\config_A data file. added and removed
from the Batch
Scheduler.
BatchDB.dbd …\IASeries- Batch schedule database Does not change.
Batch\cfg\config_A schema file.
BatchDB.key …\IASeries- Batch schedule database Changes as batches are
Batch\cfg\config_A index file. added and removed
from the Batch
Scheduler.

590
20. System Administration B0193YB – Rev C

Table 20-4. I/A Series Batch Configuration Directory Files (Continued)

Configuration File Location Description Usage

BatchDB.lock …\IASeries- Batch schedule database Created by RedMngr
Batch\cfg\config_A lock file created on mas- when the backup batch
ter server by backup server is started.
server during redun- Redundancy only.
dancy startup.
Redundancy only.
BatchDB.sync …\IASeries- Batch schedule database Created by RedMngr
Batch\cfg\config_A synchronization file cre- when the backup batch
ated on master server by server is started.
backup server during Redundancy only.
redundancy startup.
Redundancy only.
[hostname][pid].log …\IASeries- Raima Data Manager Each IASeriesBatch
Batch\cfg\config_A transaction log file(s). application creates one
Transaction Log File
(LOG) file where host-
name is the name of the
machine and PID is the
process ID. This file is
used within a transac-
tion to store the pend-
ing database changes.
An application creates
its own LOG file at the
beginning of execution
and deletes it at the end
of execution.
CfgIALinkDB.dat …\IASeries- Configuration IALink Changes as modifica-
Batch\cfg\config_A database data file. tions are made to the
configuration Process
Model database and
also though changes
made with IALink or
by selecting the Update
Configuration menu
option within Environ-
ment Display.
CfgIALinkDB.dbd …\IASeries- Configuration IALink Does not change.
Batch\cfg\config_A database schema file.

591
B0193YB – Rev C 20. System Administration

Table 20-4. I/A Series Batch Configuration Directory Files (Continued)

Configuration File Location Description Usage

CfgIALinkDB.key …\IASeries- Configuration IALink Changes as modifica-
Batch\cfg\config_A database index file. tions are made to the
configuration Process
Model database and
also though changes
made with IALink or
by selecting the Update
Configuration menu
option within Environ-
ment Display.
CfgIALinkDB.lock …\IASeries- Configuration IALink Created by RedMngr
Batch\cfg\config_A database lock file cre- when the backup batch
ated on master server by server is started.
backup server during Redundancy only.
redundancy startup.
Redundancy only.
CfgIALinkDB.sync …\IASeries- Configuration IALink Created by RedMngr
Batch\cfg\config_A database synchroniza- when the backup batch
tion file created on mas- server is started.
ter server by backup Redundancy only.
server during redun-
dancy startup.
Redundancy only.
CfgModelDB.dat …\IASeries- Configuration Process Changes as modifica-
Batch\cfg\config_A Model database data file. tions are made with the
Process Model Editor
or by selecting the
Update Configuration
menu option within
Environment Display.
CfgModelDB.dbd …\IASeries- Configuration Process Does not change.
Batch\cfg\config_A Model database schema
file.
CfgModelDB.key …\IASeries- Configuration Process Changes as modifica-
Batch\cfg\config_A Model database index tions are made with the
file. Process Model Editor
or by selecting the
Update Configuration
menu option within
Environment Display.

592
20. System Administration B0193YB – Rev C

Table 20-4. I/A Series Batch Configuration Directory Files (Continued)

Configuration File Location Description Usage

CfgModelDB.lock …\IASeries- Configuration Process Created by RedMngr
Batch\cfg\config_A Model database lock file when the backup batch
created on master server server is started.
by backup server during Redundancy only.
redundancy startup.
Redundancy only.
CfgModelDB.sync …\IASeries- Configuration Process Created by RedMngr
Batch\cfg\config_A Model database synchro- when the backup batch
nization file created on server is started.
master server by backup Redundancy only.
server during redun-
dancy startup.
Redundancy only.
CfgTIMDB.dat …\IASeries- Configuration TIM Changes as modifica-
Batch\cfg\config_A database data file. tions are made with
IALink or by selecting
the Update Configura-
tion menu option
within Environment
Display.
CfgTIMDB.dbd …\IASeries- Configuration TIM Does not change.
Batch\cfg\config_A database schema file.
CfgTIMDB.key …\IASeries- Configuration TIM Changes as modifica-
Batch\cfg\config_A database index file. tions are made with
IALink or by selecting
the Update Configura-
tion menu option
within Environment
Display.
CfgTIMDB.lock …\IASeries- Configuration TIM Created by RedMngr
Batch\cfg\config_A database lock file cre- when the backup batch
ated on master server by server is started.
backup server during Redundancy only.
redundancy startup.
Redundancy only.
CfgTIMDB.sync …\IASeries- Configuration TIM Created by RedMngr
Batch\cfg\config_A database synchroniza- when the backup batch
tion file created on mas- server is started.
ter server by backup Redundancy only.
server during redun-
dancy startup.
Redundancy only.

593
B0193YB – Rev C 20. System Administration

Table 20-4. I/A Series Batch Configuration Directory Files (Continued)

Configuration File Location Description Usage

EnvDB.dat …\IASeries- Environment Editor Changes as modifica-
Batch\cfg\config_A database data file. tions are made with the
Environment Editor.
EnvDB.dbd …\IASeries- Environment Editor Does not change.
Batch\cfg\config_A database schema file.
EnvDB.key …\IASeries- Environment Editor Changes as modifica-
Batch\cfg\config_A database index file. tions are made with the
Environment Editor.
EnvDB.lock …\IASeries- Environment Editor Created by RedMngr
Batch\cfg\config_A database lock file cre- when the backup batch
ated on master server by server is started.
backup server during Redundancy only.
redundancy startup.
Redundancy only.
EnvDB.sync …\IASeries- Environment Editor Created by RedMngr
Batch\cfg\config_A database synchroniza- when the backup batch
tion file created on mas- server is started.
ter server by backup Redundancy only.
server during redun-
dancy startup.
Redundancy only.
hinfo.dat …\IASeries- Storage location for His- Changes as modifica-
Batch\cfg\config_A tory Admin details. tions are made with the
History Admin tool.
host.dat …\IASeries- Permits tag browsing Modified by Environ-
Batch\cfg\config_A from client applications. ment Manager when
started.
IALinkDB.dat …\IASeries- Runtime IALink data- Changed only by
Batch\cfg\config_A base data file. selecting the Update
Runtime menu option
within Environment
Display.
IALinkDB.dbd …\IASeries- Runtime IALink data- Does not change.
Batch\cfg\config_A base schema file.
IALinkDB.key …\IASeries- Runtime IALink data- Changed only by
Batch\cfg\config_A base index file. selecting the Update
Runtime menu option
within Environment
Display.

594
20. System Administration B0193YB – Rev C

Table 20-4. I/A Series Batch Configuration Directory Files (Continued)

Configuration File Location Description Usage

IALinkDB.lock …\IASeries- Runtime IALink data- Created by RedMngr
Batch\cfg\config_A base lock file created on when the backup batch
master server by backup server is started.
server during redun- Redundancy only.
dancy startup.
Redundancy only.
IALinkDB.sync …\IASeries- Runtime IALink data- Created by RedMngr
Batch\cfg\config_A base synchronization file when the backup batch
created on master server server is started.
by backup server during Redundancy only.
redundancy startup.
Redundancy only.
LoggerDB.dat …\IASeries- Process Logger Editor Changes as modifica-
Batch\cfg\config_A database data file. tions are made with the
Process Logger Editor.
LoggerDB.dbd …\IASeries- Process Logger Editor Does not change.
Batch\cfg\config_A database schema file.
LoggerDB.key …\IASeries- Process Logger Editor Changes as modifica-
Batch\cfg\config_A database index file. tions are made with the
Process Logger Editor.
LoggerDB.lock …\IASeries- Process Logger Editor Created by RedMngr
Batch\cfg\config_A database lock file cre- when the backup batch
ated on master server by server is started.
backup server during Redundancy only.
redundancy startup.
Redundancy only.
LoggerDB.sync …\IASeries- Process Logger Editor Created by RedMngr
Batch\cfg\config_A database synchroniza- when the backup batch
tion file created on mas- server is started.
ter server by backup Redundancy only.
server during redun-
dancy startup.
Redundancy only.
MaterialDB.dat …\IASeries- Materials Editor data- Changes as modifica-
Batch\cfg\config_A base data file. tions are made with the
Materials Editor.
MaterialDB.dbd …\IASeries- Materials Editor data- Does not change.
Batch\cfg\config_A base schema file.
MaterialDB.key …\IASeries- Materials Editor data- Changes as modifica-
Batch\cfg\config_A base index file. tions are made with the
Materials Editor.

595
B0193YB – Rev C 20. System Administration

Table 20-4. I/A Series Batch Configuration Directory Files (Continued)

Configuration File Location Description Usage

MaterialDB.lock …\IASeries- Materials Editor data- Created by RedMngr
Batch\cfg\config_A base lock file created on when the backup batch
master server by backup server is started.
server during redun- Redundancy only.
dancy startup.
Redundancy only.
MaterialDB.sync …\IASeries- Materials Editor data- Created by RedMngr
Batch\cfg\config_A base synchronization file when the backup batch
created on master server server is started.
by backup server during Redundancy only.
redundancy startup.
Redundancy only.
ModelDB.dat …\IASeries- Process Model database Changed only by
Batch\cfg\config_A data file. selecting the Update
Runtime menu option
within Environment
Display.
ModelDB.dbd …\IASeries- Process Model database Does not change.
Batch\cfg\config_A schema file.
ModelDB.key …\IASeries- Process Model database Changed only by
Batch\cfg\config_A index file. selecting the Update
Runtime menu option
within Environment
Display.
ModelDB.lock …\IASeries- Process Model database Created by RedMngr
Batch\cfg\config_A lock file created on mas- when the backup batch
ter server by backup server is started.
server during redun- Redundancy only.
dancy startup.
Redundancy only.
ModelDB.sync …\IASeries- Process Model database Created by RedMngr
Batch\cfg\config_A synchronization file cre- when the backup batch
ated on master server by server is started.
backup server during Redundancy only.
redundancy startup.
Redundancy only.
RecipeDB.dat …\IASeries- Recipe Editor database Changes as modifica-
Batch\cfg\config_A data file. tions are made with the
Recipe Editor or
changed by Batch
Manager during batch
execution.
RecipeDB.dbd …\IASeries- Recipe Editor database Does not change.
Batch\cfg\config_A schema file.

596
20. System Administration B0193YB – Rev C

Table 20-4. I/A Series Batch Configuration Directory Files (Continued)

Configuration File Location Description Usage

RecipeDB.key …\IASeries- Recipe Editor database Changes as modifica-
Batch\cfg\config_A index file. tions are made with the
Recipe Editor or
changed by Batch
Manager during batch
execution.
RecipeDB.lock …\IASeries- Recipe Editor database Created by RedMngr
Batch\cfg\config_A lock file created on mas- when the backup batch
ter server by backup server is started.
server during redun- Redundancy only.
dancy startup.
Redundancy only.
RecipeDB.sync …\IASeries- Recipe Editor database Created by RedMngr
Batch\cfg\config_A synchronization file cre- when the backup batch
ated on master server by server is started.
backup server during Redundancy only.
redundancy startup.
Redundancy only.
RedCfg …\IASeries- Redundancy configura- Created by install. May
Batch\cfg\config_A tion file. Redundancy be changed manually.
only. Configuration changes
not required during
normal operation.
Redundancy only.
RedStats.date.txt …\IASeries- Redundancy statistics Created by RedMngr
Batch\cfg\config_A files that provide infor- during redundancy
mation of the status of operation.
batch redundancy. Redundancy only.
Structure of file name is
Red-
Stats.current_date.txt.
Redundancy only.
SecurityDB.dat …\IASeries- Security Editor database Changes as modifica-
Batch\cfg\config_A data file. tions are made with the
Security Editor.
SecurityDB.dbd …\IASeries- Security Editor database Does not change.
Batch\cfg\config_A schema file.
SecurityDB.key …\IASeries- Security Editor database Changes as modifica-
Batch\cfg\config_A index file. tions are made with the
Security Editor.

597
B0193YB – Rev C 20. System Administration

Table 20-4. I/A Series Batch Configuration Directory Files (Continued)

Configuration File Location Description Usage

SecurityDB.lock …\IASeries- Security Editor database Created by RedMngr
Batch\cfg\config_A lock file created on mas- when the backup batch
ter server by backup server is started.
server during redun- Redundancy only.
dancy startup.
Redundancy only.
SecurityDB.sync …\IASeries- Security Editor database Created by RedMngr
Batch\cfg\config_A synchronization file cre- when the backup batch
ated on master server by server is started.
backup server during Redundancy only.
redundancy startup.
Redundancy only.
TIMDB.dat …\IASeries- TIM database data file. Changed only by
Batch\cfg\config_A selecting the Update
Runtime menu option
within Environment
Display.
TIMDB.dbd …\IASeries- TIM database schema Does not change.
Batch\cfg\config_A file.
TIMDB.key …\IASeries- TIM database index file. Changed only by
Batch\cfg\config_A selecting the Update
Runtime menu option
within Environment
Display.
TIMDB.lock …\IASeries- TIM database lock file Created by RedMngr
Batch\cfg\config_A created on master server when the backup batch
by backup server during server is started.
redundancy startup. Redundancy only.
Redundancy only.
TIMDB.sync …\IASeries- TIM database synchro- Created by RedMngr
Batch\cfg\config_A nization file created on when the backup batch
master server by backup server is started.
server during redun- Redundancy only.
dancy startup.
Redundancy only.

598
20. System Administration B0193YB – Rev C

Table 20-4. I/A Series Batch Configuration Directory Files (Continued)

Configuration File Location Description Usage

vista.taf …\IASeries- Raima Data Manager If it does not exist,
Batch\cfg\config_A Transaction Activity File. Raima Data Manager
automatically creates
it.The name of a pro-
cess’s LOG file is writ-
ten to the Transaction
Activity File (TAF) just
before a commit and
removed following the
commit in order to
provide for external
recovery in the event
that the lock manager
fails.
HistQDB.dat …\IASeries- History queue database Changed by the His-
Batch\HistQ data file. tory Queue Manager.
HistQDB.dbd …\IASeries- History queue database Does not change.
Batch\HistQ schema file.
histq.taf …\IASeries- History Queue Transac- If it does not exist,
Batch\HistQ tion Activity File. Raima Data Manager
automatically creates it.
dflt_HistQ …\IASeries- Folder containing Does not change.
Batch\HistQ Default HistQDB data-
base

Configuring I/A Series Subsystems for Windows NT

Support
This section describes some of the configuration details that you need to properly implement your
I/A Series subsystems.

I/A Series Control System

Configuring CP to generate a “return-to-normal” message for a
SENDCONF message
The Control Processor’s (CP) Station Block parameter “CFGOPT” must be set to 2, using the
Integrated Control Configurator (ICC). This configuration allows the CP to generate a “return-
to-normal” message when a SENDCONF message has been acknowledged (when the sequence
block is unsuspended).

599
B0193YB – Rev C 20. System Administration

CFGOPT =0 no configuration
=1 auto checkpoint
=2 RTN to normal

To Configure the CP:

1. From FoxView’s process_eng or software_eng environment display, select the top
menu item config/control_cfg->CIO_Config to invoke ICC.
2. From Compound Selection display, select the CP station compound. (for example,
CP4001_STA) and click OK. This displays the ICC main window.
3. From the Compounds: list, select the CP station compound.
4. From Compound functions list, select View Blocks/ECBs in this compound.
5. A new window displays block name list for the selected compound. Select block name
STATION.
6. From Block/ECB Functions, select Edit all Block/ECB Parameters.
7. Scroll through the parameter list and find CFGOPT. Select the parameter and type 2
for the value.
8. Press ENTER.
9. Click done and then click the top menu item EXIT to close ICC.

Enhanced Control Processor Software to Support LOOPID

NOTE
I/A Series Version 6.2 or higher is required.

The compound and block parameter LOOPID is used by the Batch System to store the batch ID
string name (32-char max). If the Compound’s LOOPID is not blank and the block’s LOOPID is
blank, alarms generated by the block contain the LOOPID information stored in the Com-
pound’s LOOPID parameter. If the block’s LOOPID parameter is not blank, the alarm generated
from the block contains LOOPID data as stored in the block.
When a string name is stored in the LOOPID parameter by way of the ICC, the string name is
stored as-is. LOOPID data, when set by way of the I/A Series Object Manager function, is pad-
ded with trailing blanks (32-char max).

Configuring Alarm and Message Destination Group

Device Parameter for Each Compound
A compound which is used by the Batch System should send its messages to the Batch Message
Interface (BMI) subsystem by configuring the GRxDVn parameter (where: x is a value between 1
and 3, and n is a value between 1 and 8). One of the compound’s GRxDVn parameters should be
configured with the value FBFMI. The Event Manager application processes all batch-related
I/A Series messages by storing them in the batch historian's relational database.

600
20. System Administration B0193YB – Rev C

As a minimum, you should configure the following alarm destinations:

GR1DV1 : FBFMI → sends alarm to BMI
GR1DV2 : FBWP01 → sends to alarm destination2
GR1DV3 : WPNT01 → sends to alarm destination2

To Configure Alarm and Message Destination Group Device Parameters:

1. From FoxView’s process_eng or software_eng environment display, select the top
menu item config/control_cfg->CIO_Config to invoke ICC.
2. From Compound Selection display, select the compound (for example, R210) and
then click OK. This displays the ICC main window.
3. From the Compounds: list, select the same compound, and from Compound func-
tions, and then select Edit Compound Parameters.
4. A new window displays a list of Compound Definitions.
5. From Compound Definitions, select the Group Device parameter to be configured.
(for example, GR1DV1) and then enter FBFMI in the input field.
6. Press ENTER.
7. From the top menu, select SHOW > Available WP’s. This allows a user to select the
WP to be configured.
8. Select the next required Group Device parameter and double-click a WP name from
available WP list.
9. Press ENTER.
10. Repeat the above step for each additional WP that you want to configure for the
compound.
11. This configuration process is required for each compound that sends messages to the
BMI.
12. Click done and then click the top menu item EXIT to close ICC.

Control Processor Custom Templates Files

Batch System custom files are provided as examples only.

To Use These Files:

♦ Copy from “<install dir>\templates\PHASE_EXEC.s”
to “D:\opt\fox\ciocfg\sequenlibrary\PHASE_EXEC.s”
♦ Copy from “<install dir>\templates\HLBL_PHASE.s”
to “D:\opt\fox\ciocfg\sequenlibrary\HLBL_PHASE.s”
♦ Copy from “<install dir>\templates\SFC_PHASE.g”
to “D:\opt\fox\ciocfg\sequenlibrary\SFC_PHASE.g”
♦ Copy from “<install dir>\templates\SFC_PHASE.k”
to “D:\opt\fox\ciocfg\sequenlibrary\SFC_PHASE.k”
♦ Copy from “<install dir>\templates\FB_CONST.inc”
to “D:\opt\fox\ciocfg\sequeninclude\FB_CONST.inc”

601
B0193YB – Rev C 20. System Administration

I/A Series FoxAlert Alarm Subsystem

NOTE
The following steps must be performed on each station in the batch system.

FoxAlert provides a display feature to display process alarms using configurable filters.
FoxAlert can display process alarms associated with a batch by matching Batch ID data in the
alarm’s LOOPID parameter. For FoxAlert (in a WP) to receive batch alarms, you must configure
the WP station name in the Compound’s GRxDVn parameter.

To Configure FoxAlert to Receive Alarm Messages:

For detailed information on how to configure FoxAlert to receive alarm messages, see “Configur-
ing Alarm and Message Destination Group Device Parameter for Each Compound” on page 600.

NOTE
If FoxAlert’s display alarm match feature is started manually, you should be aware of
the trailing blanks in the LOOPID. In order to find exact match for a Batch ID
string, a wildcard “*” is required after the Batch ID name or must enter trailing
blanks in the LOOPID field (32 char max).

To Configure “Alm Comment” Command Button:

Users can configure command button(s) on FoxAlert's CAD user interface to start the
CommentApp program. CommentApp allows users to enter a comment associated with a batch-
related alarm. The comment is stored as batch data in the batch history SQL database. It can then
be retrieved and reported by the batch system's Report Manager.

To Configure in FoxAlert:
1. A configuration file <install dir>\IA_Config\BatchAlarmCfg.txt is provided for you to
copy and paste from while configuring the FoxAlert command button. You must first
open this file using a text editor such as Wordpad and edit the <install dir> to point to
the correct product installation path.
2. From FoxView display, select the Config/DispalarmCfg menu item. This displays
FoxAlert’s main window that you can use to configure a command button for CAD
display.
3. Select File/Open, and then select the am database foxboro.
4. Select Save As and enter the required database filename. For example: “BatchNT”.
This procedure retains the original databases included with the product.
5. On the right side of the configuration’s main window, enable the Alarm Manager
radio button, and then select the New button.
The Alarm Manager window appears.
6. Enter the following parameter values:
Alarm manager name: AM0000
Station letterbug: XXXXXX
Screen: Undedicated

602
20. System Administration B0193YB – Rev C

Alarm Manager Property Scheme: foxDefault

7. Click OK.
8. On the Display and Alarm Managers window, select the radio button (fifth in the list)
User Interfaces under Select group.
9. From the list of Scheme Names, select foxCAD under User Interface group, and then
select the Edit button under Command group.
10. The User Interface Scheme window appears for foxCAD, along with the EDIT
window.
11. In the EDIT window, select the unused button that you want to configure.
12. The Pushbutton Editor window appears.

NOTE
If there are no unused buttons on the alarm manager window, first increase the
number of rows and then select the button labeled Preview.

13. In the Label field, enter Alm Comment.

14. In the Button Actions field, copy and paste the button command line found in the
BatchAlarmCfg.txt file which you modified in the first step:
run <install dir>\bin\CommentApp.exe &<AlarmType>&<Block>&<Block-
Desc>&<Compound>&<LoopId>&<Date[%Y-%m-
%d]>&<Time[%H:%M:%S]>&<Tenths>&<OptionText>
for example, <install dir> = D:\IASeriesBatch
The Access Code and Mnemonic fields can be left empty.
15. Click ADD and then OK to close the EDIT window.

To Configure “Seq Unsusp” Button:

You can configure a second command button on FoxAlert's CAD user interface display to
acknowledge a SENDCONF type sequence block message. A SENDCONF type message can be
selected and acknowledged by clicking this command button. The button action unsuspends the
sequence block and the CP generates a return-to-normal message (see page 599). Upon receiving
the return-to-normal message, FoxAlert removes the SENDCONF message from its user interface
display.

To Configure the Alm Comment Button:

Use same configuration procedure described earlier for the Alm Comment button. A separate line
is provided for copy and paste in BatchAlarmCfg.txt file for this function.
1. From the User Interface Scheme window, click Preview. The EDIT window appears.
2. Click the unused button that you want to configure. The Pushbutton Editor window
appears.
3. In the Label field, enter Seq Unsusp.
4. In the Button Actions field, copy and paste the button command line from the Batch-
AlarmCfg.txt file which you modified in the first step:
run <install dir>\bin\seq_unsuspend.bat <Compound> <Block>

603
B0193YB – Rev C 20. System Administration

for example, <install dir> = D:\IASeriesBatch

The Access Code and Mnemonic fields can be left empty.
5. Click ADD and then OK to close the EDIT window.

To Save and Validate the Button Configuration:

1. Save the new button configuration into a file.
2. On the DispalarmCfg window, from the Display and Alarm managers file menu,
select Save.
3. Click Validate Record. Validation ensures that all the schemes are linked properly. A
message is displayed for a successful validation.
4. Click Create Install File to create a configuration file for Alarm Manager.
5. Click DONE.
6. Click Exit to exit FoxAlert’s Configurator DispalarmCfg.

To Install a Configuration File into Run Time Directory:

1. The configuration file AM0000.cfg you just created resides in the configuration direc-
tory: D:\usr\fox\customer\config\BatchNT.dir\XXXXXX\.
2. From the runtime directory D:\usr\fox\customer\alarms\cfg\, backup the original
configuration file am_def.cfg by renaming to am_def.cfg.bak.
3. Copy the new config file from configuration directory to runtime directory:
Copy from “D:\usr\fox\customer\config\BatchNT.dir\XXXXXX\AM0000.cfg”
To “D:\usr\fox\customer\alarms\cfg\ am_def.cfg “
4. When you start FoxAlert (double-click Process menu bar from FoxView), you see
that the new configuration is enabled. However, if FoxAlert has already been launched
at time of configuration, it must be stopped and restarted in order to use the new con-
figuration data.
5. To stop FoxAlert, from a command prompt, execute the following command:
D:\> pref –<GCLBG> amcmd “quitam on; exit”
Where: <GCLBG> = station host name

NOTE
For more information, see Workstation Alarm Management (B0193RV).

To Configure FoxAlert for Removal of SENDCONF Message Upon Acknowledgement of the

Message (unsuspend):
1. In D:\usr\fox\wp\data, make a copy of init.user.rel. Rename the copy as init.user.
2. Open init.user using Wordpad.
3. Search for line the line that contains “#CONF_RTN=N.”
4. Remove the number symbol (#) from the line at the first character position and
change =N to =Y.
5. Save the changes and then close Wordpad.

604
20. System Administration B0193YB – Rev C

6. Reboot AW70 to enable the changes.

Configuring I/A Series Operator Action Journal

You can enable the Operator Action Journal feature to cause all of the operator actions from Dis-
play Manager, FoxView, and Alarm Manager that are associated with changing the parameters in
the process database, to be logged to a printer and/or to the specified historical database. These
operator actions include toggling points, ramping or direct data entry of new point values, chang-
ing block statuses, acknowledging block alarms, and other actions such as horn muting.

To Configure Operator Actions for I/A Series Batch:

1. Set the FoxView Environment to IA Batch.
2. Select the FoxView menu Config/OperActJournal.
3. The Operator Action Journal Configuration window appears.
4. In the Historian Log pane, enable the Enabled radio button.
5. In the Historian text box, enter FBFMI and click Enter.
6. On the lower right-hand portion of the window, click Done.
If you want the Operator Action Journal to start when your system restarts, you must follow these
steps:

To configure the Operator Action Journal to Start When System Restarts:

1. In D:\usr\fox\wp\data, open init.user using Wordpad.
2. Add the following lines:
OJLOG=DLP01,EFBFMI
gctsize=14
dmtlist=OJLOG
3. Save the changes and then close Wordpad.

NOTE
For more information see Operator Action Journal (B0193CW).

605
B0193YB – Rev C 20. System Administration

606
Index

**, in Phase List 353

**, in schedule list 340
.rcp extension 222, 223

A
Abort a Batch 361
Aborted 321
Aborting 321
Access Mode 84
Acknowledge Addition of Material 365, 368
Acknowledge button 289
Acknowledge on Entry 154
Activate Jump Mode 339
Active Phases
TIM tags 508
Active Transitions
Objects 356
viewing 344
ActiveX 6
Actual Element
Process Phase 112
Transfer Phase 137
Actual Value 204
Assigning for Unit Assignment 206
Add Archive Job 577
Add Attributes to a Train 305
Add Batch to list 321
Add Daily Schedule 414, 415
Add Materials From List
check box 247, 251
Add Monthly Schedule 414, 416
Add Operation 262, 270
Add Operation Branch 261, 263
Add Operation Loop 261, 263
Add Operation Transition 261, 263
Add Phase 264
Add Phase Branch 264
Add Phase Loop 264
Add Phase Transition 264
Add Purge Job 579
Add Restore Job 581
Add Units to a Train 305
Add Weekly Schedule 414, 415
Adding Process Classes 97

607
B0193YB – Rev C Index

Adding Units 94
Advanced Planning Systems 6
Alarm Comment EditorApplication 551
Alarm limits 137
Alarm Manager, starting from Batch Display 344
Alarm Subsystem 551
Alarms 468
Allocate Phase
in recipes 211
Allocation Queue 343
Analog input parameters 137
Analog process variable 137, 138
using with Hi and Low Limit 113
Analog tag 83
API
Security 439
Application ID
in security 451
Application Parameters
Table of 60
Application Security Requests 456
Application Status
Viewing 50
Applications-Functions Editor 450
Approvals 219
Approved for Production 219
recipe security 449
Approved for Test 219
recipe security 449
Archive Job 577
Ask 463
AskCheckBy 463
AskDoneBy 463
Assign a Material to a Unit 205
Assign Application Parameter Values 59
Assign Application Parameters 59
Assign Destination Instances 240
Assign Lot Tracking Information 206
Assign Process Classes 232
Assign Source Instances 240
Assign Tags
additional information 149
Assign Tags to Process and Transfer Classes
additional information 151
Assign Units
Process Class Instances 234
Assigning a Material to a Unit 204
Assigning Attributes to Trains 305
Assigning Connections to Transfers 125
Assigning Segments 120
Assigning Units to a Process Class 98

608
Index B0193YB – Rev C

Assigning Units to Trains 304

attribute range 236
Attributes
Process Class 100
Process Class Instances 236
Trains 305
Automatic Allocation
unit 357
Automatic Batch Execution 320
Automatic Batch Mode 359
Automatic phase 72, 103, 110, 127
description of 110
examples of 111
Automatic Process Phases 364, 366
with Material Input Parameters 364
Automatic Tag Creation and Assignment 155
additional information 149
Automatic Tagnames, Naming Convention 150
Automatic to Manual 363
Automatic to Semi-automatic mode change 362
after phase abort 363
Automatic Transfer Phases 134, 204, 366
examples of 135
Automatic Unit Selection 363
Automatically Generated Tagnames 82

B
Backing Up Configuration Databases 588
Backup a Database with DBCOPY 588
Batch 204
Defining 318
Batch Alarm 551
Batch and Unit Management
Description of 307
Batch Configuration Client
Installed Components 7
Batch Configuration Client, security 446
Batch Control 351
Batch Control Buttons 349
Batch Display 336, 356
Actions Menu 338
control buttons 148
Description of 336
File Menu 338
functionality 351
Help Menu 347
layout 347
Menus
Actions/Activate Jump Mode 339
Actions/Manual Operation 338

609
B0193YB – Rev C Index

Actions/Save Control Recipe 338

File/Exit 338
View/Errors 345
Windows/Batch Messages 340
Windows/Equipment Allocation 341
Windows/FoxAlert 344
Windows/Phase Parameter Editor 344
Windows/Phase Sequence 344
Windows/Schedule 340
Windows/Transition Logic 344
Phantom Batch Considerations 376
toolbar 348
Using 336, 356
View Menu 345
Windows Menu 340
Batch Errors
Runtime 371
Schedule 373
Batch Execution 357
warm restart 374
Batch Execution Mode 320, 352
changes 362
Batch Focus Versus Unit Focus 489
Batch Function Interface
TIM tags 539
Batch Function Tags 491
Batch History
Description of 5
Batch ID 86, 318
Batch Identification 318, 349
Batch Information Server web page 571
Batch Logger
Train Names 89
Batch Management
Description of 3
Materials Usage 203
Batch management
material tracking 204
Batch Management System 307
Batch Management System Interface 492
Batch Management System Interface Handshake Errors
TIM tags 533
Batch Manager
Process Tag to Unit Tag Resolution 86
Starting 357
Unit Control Tag usage 98
Unit State Tag usage 98
Warm Restart 373
Batch Messages 341
TIM tags 518

610
Index B0193YB – Rev C

Batch Questions
TIM tags 506
Batch Reporting System
Starting 404
Batch Reporting web page 405
Batch Reports 422
Description of 5
Batch Restart Mode 374
Batch Runtime Client
Installed Components 8
Batch Runtime Errors 371
Batch Schedule
CLB filtering 313
Mode/Status 314
Recipe Status 314
Train 314
Batch Schedule Errors 373
Batch Schedule List, modifying 321
Batch Scheduler 309, 326
Edit Menu 312
File Menu 310
Help Menu 318
Initialize Menu 316
Menus
Edit/Cleanup 312, 313
File/Exit 311
File/Print 310
File/Print Preview 311
File/Print Setup 311
Initialize/All 316
Initialize/Batch 316
Options/Execute in Order 317
View/Errors 315
View/Filters 313
View/Status Bar 315
View/Undo Sorting 313
Options Menu 317
View Menu 313
Batch Server
Changing Assignment on an Information Server 587
security 446
Batch Status
Descriptions 351
BatchAdmin 571
Batch-centric focus 489
BatchDspl 11, 61
BatchMngr 10, 60
BATCHOBJSRV.DLL 12
BatchReport 9
BatchSched 11

611
B0193YB – Rev C Index

BATCHVBSERVER.DLL 12
BHQ_HOST 586
Braces 463
Branch 261, 263, 264
Branch Execute Types 275
Branch Leg
Deleting 281
Branch Object 274
description of 209
insert 274
Branch Types 274
all 274
one 274
Branch, Deleting 283
BT.BATCH.COMM.HANDSHAKE 502, 504
BT.BATCH.COMM.INFO 504
BT.BATCH.FOCUS.SCHED_LIST 502
BT.BATCH.SCHED_LIST.FIRST_ITEM 502
BT.BATCH.SCHED_LIST.ITEM1 502
BT.BATCH.SCHED_LIST.NUM_ITEMS 502
BT.BATCH.SECURITY.CHECKBY 504
BT.BATCH.SECURITY.CHECKBY_PWD 504
BT.BATCH.SECURITY.DONEBY 504
BT.BATCH.SECURITY.DONEBY_PWD 504
BT.BATCH.SELECT.SCHED_CLB 502
BT.BATCH.SELECT.SCHED_CLBFOCUSOK 503
BT.BATCH.SELECT.SCHED_EDIT_MASK 503
BT.BATCH.SELECT.SCHED_ITEM 502
BT.BATCH.SELECT.SCHED_MODE 502
BT.BATCH.SELECT.SCHED_MODE_STR 502
BT.BATCH.SELECT.SCHED_RECIPEID 502
BT.BATCH.SELECT.SCHED_SIZE 502
BT.BATCH.SELECT.SCHED_STATUS 502
BT.BATCH.SELECT.SCHED_STATUS_STR 503
BT.BATCH.SELECT.SCHED_TRAIN 502
BT.EQUIPMENT.COMM.HANDSHAKE 527
BT.EQUIPMENT.EQUIPMENT_LIST.FIRST_ITEM 526
BT.EQUIPMENT.EQUIPMENT_LIST.ITEM 526
BT.EQUIPMENT.EQUIPMENT_LIST.NUM_ITEMS 525, 526
BT.EQUIPMENT.FOCUS.CLB 525, 526
BT.EQUIPMENT.FOCUS.UNIT 525, 526
BT.EQUIPMENT.INSTANCE_LIST.ITEM 527
BT.EQUIPMENT.INSTANCE_LIST.NUM_ITEMS 527
BT.EQUIPMENT.SECURITY.CHECKBY 527
BT.EQUIPMENT.SECURITY.CHECKBY_PWD 527
BT.EQUIPMENT.SECURITY.DONEBY 527
BT.EQUIPMENT.SECURITY.DONEBY_PWD 527
BT.EQUIPMENT.SELECT.EQUIPMENT_ALLOC 526
BT.EQUIPMENT.SELECT.EQUIPMENT_ITEM 526
BT.EQUIPMENT.SELECT.EQUIPMENT_NAME 526
BT.EQUIPMENT.SELECT.EQUIPMENT_STATUS 526
BT.EQUIPMENT.SELECT.EQUIPMENT_TYPE 526

612
Index B0193YB – Rev C

BT.EQUIPMENT.SELECT.EQUIPMENT_UCTRL 527
BT.EQUIPMENT.SELECT.INSTANCE_ITEM 527
BT.EQUIPMENT.SELECT.INSTANCE_NAME 527
BT.ERROR.COMM.HANDSHAKE 533
BT.ERROR.MESSAGE_LIST.ITEM 533
BT.ERROR.MESSAGE_LIST.MAX_ITEMS 533
BT.ERROR.MESSAGE_LIST.NUM_ITEMS 533
BT.ERROR.SELECT.MESSAGE 533
BT.ERROR.SELECT.MESSAGE_ITEM 533
BT.MESSAGE.COMM.HANDSHAKE 519
BT.MESSAGE.FOCUS.CLB 519
BT.MESSAGE.FOCUS.UNIT 519
BT.MESSAGE.MESSAGE_LIST.FIRST_ITEM 519
BT.MESSAGE.MESSAGE_LIST.ITEM 519
BT.MESSAGE.MESSAGE_LIST.NUM_ITEMS 519
BT.MESSAGE.SELECT.MESSAGE 520
BT.MESSAGE.SELECT.MESSAGE_ITEM 519, 520
BT.PHASE_ED.COMM.HANDSHAKE 521, 524
BT.PHASE_ED.FOCUS.CLB 521
BT.PHASE_ED.INPUT.INSTRUCT 523
BT.PHASE_ED.INSTRUCT_LIST.FIRST_ITEM 523
BT.PHASE_ED.INSTRUCT_LIST.ITEM 523
BT.PHASE_ED.INSTRUCT_LIST.NUM_ITEMS 520, 523
BT.PHASE_ED.PARAM_LIST.FIRST_ITEM 523
BT.PHASE_ED.PARAM_LIST.ITEM 523
BT.PHASE_ED.PARAM_LIST.NUM_ITEMS 523
BT.PHASE_ED.PHASE_LIST.FIRST_ITEM 520, 522
BT.PHASE_ED.PHASE_LIST.ITEM 521
BT.PHASE_ED.PHASE_LIST.NUM_ITEMS 520, 521
BT.PHASE_ED.SECURITY.CHECKBY 521, 524
BT.PHASE_ED.SECURITY.CHECKBY_PWD 521, 524
BT.PHASE_ED.SECURITY.DONEBY 524
BT.PHASE_ED.SECURITY.DONEBY_PWD 521, 524
BT.PHASE_ED.SELECT.INSTRUCT 523
BT.PHASE_ED.SELECT.INSTRUCT_ITEM 523
BT.PHASE_ED.SELECT.PARAM_DATACLASS 524
BT.PHASE_ED.SELECT.PARAM_DESC 524
BT.PHASE_ED.SELECT.PARAM_ITEM 523
BT.PHASE_ED.SELECT.PARAM_MTRLID 524
BT.PHASE_ED.SELECT.PARAM_MTRLNAME 524
BT.PHASE_ED.SELECT.PARAM_PARAM 523
BT.PHASE_ED.SELECT.PARAM_SET 524
BT.PHASE_ED.SELECT.PARAM_TYPE 523
BT.PHASE_ED.SELECT.PARAM_UOM 524
BT.PHASE_ED.SELECT.PARAM_VALUE 524
BT.PHASE_ED.SELECT.PHASE_INSTANCE 521, 522
BT.PHASE_ED.SELECT.PHASE_LABEL 521, 522
BT.PHASE_ED.SELECT.PHASE_NAME 521, 522
BT.PHASE_ED.SELECT.PHASE_OPER_MASK 521, 522
BT.PHASE_ED.SELECT.PHASE_OPERATION 521, 522
BT.RECIPE.COMM.HANDSHAKE 505
interfaces affected by 506

613
B0193YB – Rev C Index

BT.RECIPE.FOCUS.CLB 505
BT.RECIPE.FOCUS.UNIT 505
BT.RECIPE_COMMENT.COMM.HANDSHAKE 508
BT.RECIPE_COMMENT.INPUT.COMMENT 508
BT.RECIPE_COMMENT.SECURITY.CHECKBY 508
BT.RECIPE_COMMENT.SECURITY.CHECKBY_PWD 508
BT.RECIPE_COMMENT.SECURITY.DONEBY 508
BT.RECIPE_COMMENT.SECURITY.DONEBY_PWD 508
BT.RECIPE_PHASE.COMM.HANDSHAKE 516
BT.RECIPE_PHASE.INPUT.PARAM_EXT_VALUE 515
BT.RECIPE_PHASE.INPUT.PHASE_COMMENT 513
BT.RECIPE_PHASE.INSTRUCT_LIST.FIRST_ITEM 515
BT.RECIPE_PHASE.INSTRUCT_LIST.ITEM 515
BT.RECIPE_PHASE.INSTRUCT_LIST.NUM_ITEMS 515
BT.RECIPE_PHASE.INTERLOCK_LIST.ITEM 515
BT.RECIPE_PHASE.INTERLOCK_LIST.NUM_ITEMS 515
BT.RECIPE_PHASE.PARAM_EXT_LIST.FIRST_ITEM 513
BT.RECIPE_PHASE.PARAM_EXT_LIST.ITEM 513
BT.RECIPE_PHASE.PARAM_EXT_LIST.NUM_ITEMS 513
BT.RECIPE_PHASE.PHASE_LIST.FIRST_ITEM 511
BT.RECIPE_PHASE.PHASE_LIST.ITEM 511
BT.RECIPE_PHASE.PHASE_LIST.NUM_ITEMS 510
BT.RECIPE_PHASE.SECURITY.CHECKBY 516
BT.RECIPE_PHASE.SECURITY.CHECKBY_PWD 516
BT.RECIPE_PHASE.SECURITY.DONEBY 516
BT.RECIPE_PHASE.SECURITY.DONEBY_PWD 516
BT.RECIPE_PHASE.SELECT.INSTRUCT 515
BT.RECIPE_PHASE.SELECT.INSTRUCT_ITEM 515
BT.RECIPE_PHASE.SELECT.INTERLOCK_ITEM 515
BT.RECIPE_PHASE.SELECT.INTERLOCK_STATUS 516
BT.RECIPE_PHASE.SELECT.INTERLOCK_TAG 515
BT.RECIPE_PHASE.SELECT.PARAM_DATACLASS 514
BT.RECIPE_PHASE.SELECT.PARAM_DESC 515
BT.RECIPE_PHASE.SELECT.PARAM_EDIT_TYPE 514
BT.RECIPE_PHASE.SELECT.PARAM_EXT 514
BT.RECIPE_PHASE.SELECT.PARAM_EXT_ITEM 513
BT.RECIPE_PHASE.SELECT.PARAM_EXT_VALUE 515
BT.RECIPE_PHASE.SELECT.PARAM_NAME 513
BT.RECIPE_PHASE.SELECT.PARAM_SET 515
BT.RECIPE_PHASE.SELECT.PARAM_TYPE 513
BT.RECIPE_PHASE.SELECT.PARAM_UOM 514
BT.RECIPE_PHASE.SELECT.PHASE_DESC 511, 522
BT.RECIPE_PHASE.SELECT.PHASE_DOCUMENT 513
BT.RECIPE_PHASE.SELECT.PHASE_EDIT_MASK 511, 512
BT.RECIPE_PHASE.SELECT.PHASE_EQUIPMENT 511
BT.RECIPE_PHASE.SELECT.PHASE_ITEM 511
BT.RECIPE_PHASE.SELECT.PHASE_LABEL 511
BT.RECIPE_PHASE.SELECT.PHASE_LABEL1 512
BT.RECIPE_PHASE.SELECT.PHASE_LABEL2 512
BT.RECIPE_PHASE.SELECT.PHASE_NAME 511
BT.RECIPE_PHASE.SELECT.PHASE_OPERATION 511
BT.RECIPE_PHASE.SELECT.PHASE_OPERMSG 513

614
Index B0193YB – Rev C

BT.RECIPE_PHASE.SELECT.PHASE_OPERMSGINT 512
BT.RECIPE_PHASE.SELECT.PHASE_STATUS 511
BT.RECIPE_PHASE.SELECT.PHASE_UNITPROC 511, 522
BT.RECIPE_QUES.COMM.HANDSHAKE 507
BT.RECIPE_QUES.QUESTION_LIST.FIRST_ITEM 506
BT.RECIPE_QUES.QUESTION_LIST.ITEM 506
BT.RECIPE_QUES.QUESTION_LIST.NUM_ITEMS 506
BT.RECIPE_QUES.SECURITY.CHECKBY 507
BT.RECIPE_QUES.SECURITY.CHECKBY_PWD 507
BT.RECIPE_QUES.SECURITY.DONEBY 507
BT.RECIPE_QUES.SECURITY.DONEBY_PWD 507
BT.RECIPE_QUES.SELECT.QUESTION 507
BT.RECIPE_QUES.SELECT.QUESTION_ITEM 507
BT.RECIPE_QUES.SELECT.QUESTION_TYPE 507
BT.RECIPE_QUES.SELECT.SECURITY 507
BT.RECIPE_SELECT.COMM.HANDSHAKE 518
BT.RECIPE_SELECT.INSTANCE_LIST.ITEM 517
BT.RECIPE_SELECT.INSTANCE_LIST.NUM_ITEMS 517
BT.RECIPE_SELECT.SECURITY.CHECKBY 518
BT.RECIPE_SELECT.SECURITY.CHECKBY_PWD 518
BT.RECIPE_SELECT.SECURITY.DONEBY 518
BT.RECIPE_SELECT.SECURITY.DONEBY_PWD 518
BT.RECIPE_SELECT.SELECT.INSTANCE_ITEM 517
BT.RECIPE_SELECT.SELECT.UNIT_NAME 518
BT.RECIPE_SELECT.SELECT.UNIT_STATUS 518
BT.RECIPE_SELECT.UNIT_LIST.FIRST_ITEM 518
BT.RECIPE_SELECT.UNIT_LIST.ITEM 518
BT.RECIPE_SELECT.UNIT_LIST.NUM_ITEMS 518
BT.SAVE_RECIPE.COMM.HANDSHAKE 532
BT.SAVE_RECIPE.INPUT.AUTHOR 531
BT.SAVE_RECIPE.INPUT.CLB 531
BT.SAVE_RECIPE.INPUT.OPTION_MASK 531, 532
BT.SAVE_RECIPE.INPUT.RECIPEID 531
BT.SAVE_RECIPE.INPUT.VERSION_COMMENT 532
BT.SAVE_RECIPE.SECURITY.CHECKBY 532
BT.SAVE_RECIPE.SECURITY.CHECKBY_PWD 532
BT.SAVE_RECIPE.SECURITY.DONEBY 532
BT.SAVE_RECIPE.SECURITY.DONEBY_PWD 532
BT.SCHEDULE.COMM.HANDSHAKE 496
BT.SCHEDULE.COMM.INFO 496
BT.SCHEDULE.RECIPE_LIST.ITEM 494
BT.SCHEDULE.RECIPE_LIST.NUM_ITEMS 494
BT.SCHEDULE.SCHED_LIST.ITEM 494
BT.SCHEDULE.SCHED_LIST.NUM_ITEMS 494
BT.SCHEDULE.SCHED_MODE.EXECINORDER 494
BT.SCHEDULE.SECURITY.CHECKBY 496
BT.SCHEDULE.SECURITY.CHECKBY_PWD 496
BT.SCHEDULE.SECURITY.DONEBY 496
BT.SCHEDULE.SECURITY.DONEBY_PWD 496
BT.SCHEDULE.SELECT.RECIPE_ID 495
BT.SCHEDULE.SELECT.RECIPE_ITEM 495
BT.SCHEDULE.SELECT.RECIPE_NAME 495

615
B0193YB – Rev C Index

BT.SCHEDULE.SELECT.RECIPE_STATE 495
BT.SCHEDULE.SELECT.RECIPE_TYPE 495
BT.SCHEDULE.SELECT.SCHED_BATCH 495
BT.SCHEDULE.SELECT.SCHED_CAMPAIGN 495
BT.SCHEDULE.SELECT.SCHED_ITEM 495
BT.SCHEDULE.SELECT.SCHED_LOT 495
BT.SCHEDULE.SELECT.SCHED_MODE 495
BT.SCHEDULE.SELECT.SCHED_RECIPEID 495
BT.SCHEDULE.SELECT.SCHED_SIZE 495
BT.SCHEDULE.SELECT.SCHED_TRAIN 495
BT.SCHEDULE.SELECT.STATE 496
BT.SCHEDULE.SELECT.STATE_ITEM 496
BT.SCHEDULE.SELECT.TRAIN_ITEM 495
BT.SCHEDULE.SELECT.TRAIN_NAME 496
BT.SCHEDULE.SELECT.TYPE 496
BT.SCHEDULE.SELECT.TYPE_ITEM 496
BT.SCHEDULE.STATE_LIST.ITEM 494
BT.SCHEDULE.STATE_LIST.NUM_ITEMS 494
BT.SCHEDULE.TRAIN_LIST.FIRST_ITEM 494
BT.SCHEDULE.TRAIN_LIST.ITEM 494
BT.SCHEDULE.TRAIN_LIST.NUM_ITEMS 494
BT.SCHEDULE.TYPE_LIST.ITEM 494
BT.SCHEDULE.TYPE_LIST.NUM_ITEMS 494
BT.VIEW_TRANS.COMM.HANDSHAKE 529, 530
BT.VIEW_TRANS.EXP_LIST.ITEM 530
BT.VIEW_TRANS.EXP_LIST.NUM_ITEMS 530
BT.VIEW_TRANS.FOCUS.CLB 529
BT.VIEW_TRANS.SECURITY.CHECKBY 530
BT.VIEW_TRANS.SECURITY.CHECKBY_PWD 530
BT.VIEW_TRANS.SECURITY.DONEBY 530
BT.VIEW_TRANS.SECURITY.DONEBY_PWD 530
BT.VIEW_TRANS.SELECT.EXP 530
BT.VIEW_TRANS.SELECT.EXP_ITEM 530
BT.VIEW_TRANS.SELECT.TAG_ITEM 530
BT.VIEW_TRANS.SELECT.TAG_NAME 530
BT.VIEW_TRANS.SELECT.TAG_VALUE 530
BT.VIEW_TRANS.SELECT.TRANS_ITEM 529
BT.VIEW_TRANS.SELECT.TRANS_LABEL 529
BT.VIEW_TRANS.SELECT.TRANS_NAME 529
BT.VIEW_TRANS.TAG_LIST.ITEM 530
BT.VIEW_TRANS.TAG_LIST.NUM_ITEMS 530
BT.VIEW_TRANS.TRANS_LIST.ITEM 529
BT.VIEW_TRANS.TRANS_LIST.NUM_ITEMS 529
BTVT-SEL-TRANSDES 529
Building a Recipe Procedure 260
Bulk ingredients 193
By-Product 193, 207
defining 201

C
Campaign 204

616
Index B0193YB – Rev C

Campaign ID 86, 318

Capabilities
Overview of I/A Batch 1
CfgModelDB 45, 87
Change Application Parameter Values 59
Change Batch list 321
Change Operation Name 285, 286
Change Process Class Name 97
Change Unit Name 94
Changing Information Server Assignment on a Batch Server 586
Changing Passwords 455
Changing Process Class Names 97
Changing the Batch Schedule List 321
Changing the Batch Server Assignment on an Information Server 587
Characteristic Name 204
Characteristics 204
-CHECKBY 491
Check-by security 450
-CHECKBY_PWD 491
ChgPwd 12, 455
CLB 318
CLB filtering in Batch Scheduler 313
Colors, meaning in Batch Display 350
Comma 463
Comment 207
CommentApp 11
Comments
entering for phases 352
Comparison of Model Approaches 69
Completed Archives 583
Complimentary Process Phase 68
Comprehensive Model 67
config_A folder 7
Configuration
Security System 444
Update 50
Configuration and Runtime Programs
Summary of 9
Configuration Procedures 189
Configuration Programs
Summary of 9
Configurations
Managing 7
Configure Formula Parameters, additional information 155
Configuring I/A Series Subsystems for NT support 599
Connection 67
Connection Tag
Description of 78
Guideline 80
Connection Tags 78, 121
Connectionless Model 68

617
B0193YB – Rev C Index

Connections 117
Assigning to Transfers 125
Description of 71
Editing 118
Contention for Shared Equipment 369
Control Buttons 468, 482
additional configuration 148
Configuring for Process Class Phase 105
Configuring for Transfer Class Phase 129
Description of 74
Control Inputs 468
Control Outputs 468
Control Processor
Using TIM Tags 188
Control Recipe
Description of 207
Control Signals 166
Control System Alarm Destination 551
Control System Code Structure 471
Control System Memory Configuration, with phases 470
Control System Synchronization 375
Control/Status Activity 104, 128
Copying Procedure Objects 277, 278
create trains 304
Creating Reports 422
Crystal Reports
Predefined 422
Cutting Procedure Objects 277, 278

D
Data Class 83
Data Points 2
Database
Backup utility 588
Process Log 425
Database Conversions
Log File 36
Database Manager
Viewing Status of 51
Date Received 204
DBCOPY utility 588
DbCvt.txt 36
Default Batch Size 207
Default Environment System Parameters 56
Default TagMap Functionality 166
Default Values for Process Parameters 155
Define Lot Tracking Information 204
Define Materials 203
Defining a Batch 318
Defining Materials 201

618
Index B0193YB – Rev C

Delete Application Parameters 61

Delete Operation Object 262, 263
Delete Phase Object 265
Delete Process Class 98
Delete Unit 95
Delete Units from a Train 305
Deleting a Branch 283
Deleting a Branch Leg 281
Deleting a Loop 284
Deleting a Phase 279
Deleting a Transition 279
Deleting an Operation 279
Deleting Connections
effect of 88
Deleting Model Component
Warning 88
Deleting Procedure Objects 279
Deleting Process Classes 98
effect of 88
Deleting Recipes 218
Deleting Reports 586
Deleting Transfer Classes
effect of 88
Deleting Units, effect of 88
Delimiters 463
Destination Class Charge Phase 68
Destination Instance
Assigining 241
Destination Process Class
Assigning 123
Destination Unit
Assigning 118
dflt_cfg folder 7
Diagram 369
Batch Management Overview 309
Function Block 468
Parts of a Recipe 207
Process Instances in recipes 231
Process Logging 425
Process Modeling 84
Recipe Formula 208
Transfer Instances in recipes 231
Discrete Tags 83
Using with Control Buttons 74
Display Manager
Foxboro SFC/ST 344
Display Phase Sequence
Security 344
Done 320
Done By, as Recipe Author 217
-DONEBY 491

619
B0193YB – Rev C Index

Done-by security 450

-DONEBY_PWD 491
Download Phases 72
Drag operation 265, 267

E
Edit Connections 117
Edit Equipment Status 144
Edit Formula
Inputs 244
Outputs 248
Parameters 354
Edit Formula Parameters
additional information 153
Edit Phase Configuration 288
Edit Phase Properties 287
Edit Phases and Parameters, TIM tags 520
Edit Segments 143
Edit System Parameters 55
Edit Transfers 122
Edit Units 93
Editing an Expression 459
Editor
Process Modeling 67
End Of Batch Operation 371
Enter Batch Comments 508
Enumeration Data
Description of 76
Enumeration tag 83
EnvEdit 9
Environment
Update 49
Environment Display 45, 46
Description of 45
File Menu 47
Help Menu 51
Menus
File/Exit 47
File/Exit and Shutdown 48
File/Terminate App 48
Update
Configuration 50
Environment 49
Runtime 49
View/Status 50
Starting Runtime Applications 52
Stopping Runtime Applications 52
Update Configuration 88
Update Menu 49

620
Index B0193YB – Rev C

Using 46
View Menu 50
Environment Editor 45, 203
Adding Applications to the Environment 56
Application Parameters 59
Batch Manager 367
Description of 45
Edit Menu 54
File Menu 54
Help Menu 56
Instances, Configuring 58
Menus
Edit/System Parms 55
File/Exit 54
Phase/Batch Status parameter 343, 360, 361
Starting 53
Unit States parameter 343
Environment Management System 45
Description of 45
Environment Manager 45, 46
Description of 45
Process Log Manager
Configuring 437
Starting 64
EnvMngr 10
Equipment Allocation Changes
TIM tags 547
Equipment Allocation Queue 343
Equipment Allocation window 342
Equipment dependent recipe 208, 231, 234
unit assignments 230
Equipment independent recipe 208, 231
Equipment Requirements 207
Description of 208, 230
Equipment Requirements Editor, Using 230, 231
Equipment Selection 352
Equipment Status 144
Description of 76
ERP 6
Error
Unexpected Status 359
Error Queue Administration 574
Errors
Batch Runtime 371
Batch Schedule 373
Batch Schedule, Viewing 315
Evaluate Equipment for Allocation, TIM tags 542
Event Manager 61
Example
Formula Parameter 155

621
B0193YB – Rev C Index

Process Model 85
Example Equipment Requirements 237
Example Transfer Instance Selection 242
Execute multiple operation 274
Execute multiple phases 274
Execute Type 274
Execute Type All
description of 275
Execute Type One
description of 276
Exercising Phases 486
Export Recipes 222
Export Units of Measure 147
Expression
Editing 459
Operators 461
Expression Building Rules 463
Expression Editor
Defining Process Log Criteria 425
Description of 459
Edit Buttons 460
Question Length 274
Using 459
using for transitions 272
Expression Elements 461
Expression Examples 464
Expression Functions 462
Expression triggered reports 405
Expressions
viewing during batch execution 356
Extensibility 6

F
Factory Suite Licensing 259
FIFO 367
Materials Parameter 203
Filter Recipes 215
Filtering
Batch Schedule List 313, 314
Find 215
Find Button
Materials Editor 203
Finished Goods 193, 207
defining 201
-FIRSTITEM tag 490
Flexibility 1
Flexible batch management 1
Force to True 356
Formula 207
defining 243

622
Index B0193YB – Rev C

recipe
description of 208
Formula Parameter Configuration
Manual Transfer Phases 142
Formula Parameter Examples 155
Formula Parameters 468, 480
Automatic and Semi-Automatic Transfer Phases 136
Automatic Process Phases 112
Configuring for Process Class Phases 109
Configuring for Transfer Class Phases 133
Description of 74, 153, 211
Manual Process Phases 117
Types 74, 112, 136
Formula quantities 207
FoxAlert 1
Batch Display 344
Foxboro SFC/ST Display Manager 344
FoxSFC 1
Security 344
FoxView 1
FU.ALLOC_CHANGE.COMM.HANDSHAKE 548
FU.ALLOC_CHANGE.INFO.CLB 547
FU.ALLOC_CHANGE.INFO.EQUIPMENT 548
FU.ALLOC_CHANGE.INFO.MODE 547
FU.ALLOC_CHANGE.INFO.RECIPE 547
FU.ALLOC_CHANGE.INFO.SIZE 547
FU.ALLOC_CHANGE.INFO.STATUS 548
FU.ALLOC_CHANGE.INFO.TRAIN 547
FU.ALLOC_CHANGE.SEGMENT_LIST.ITEM 548
FU.ALLOC_CHANGE.SEGMENT_LIST.NUM_ITEMS 548
FU.ALLOC_CHANGE.SELECT.SEGMENT 548
FU.ALLOC_CHANGE.SELECT.SEGMENT_ITEM 548
FU.EVAL_EQUIP.COMM.HANDSHAKE 544
FU.EVAL_EQUIP.INFO.CLB 543
FU.EVAL_EQUIP.INFO.EQUIPMENT 544
FU.EVAL_EQUIP.INFO.INSTANCE 544
FU.EVAL_EQUIP.INFO.MODE 543
FU.EVAL_EQUIP.INFO.RECIPE 543
FU.EVAL_EQUIP.INFO.SIZE 543
FU.EVAL_EQUIP.INFO.STATUS 543
FU.EVAL_EQUIP.INFO.TRAIN 543
FU.EVAL_EQUIP.SEGMENT_LIST.ITEM 544
FU.EVAL_EQUIP.SEGMENT_LIST.NUM_ITEMS 544
FU.EVAL_EQUIP.SELECT.SEGMENT 544
FU.EVAL_EQUIP.SELECT.SEGMENT_ITEM 544
FU.LOG_EQUIP.INFO.CHECKBY 545
FU.LOG_EQUIP.INFO.COMMENT 546
FU.LOG_EQUIP.INFO.DONEBY 545
FU.LOG_EQUIP.INFO.FIELD 546
FU.LOG_EQUIP.INFO.LASTRECIPEID 545
FU.LOG_EQUIP.INFO.NEW_STATUS 545

623
B0193YB – Rev C Index

FU.LOG_EQUIP.INFO.OLD_STATUS 545
FU.LOG_EQUIP.INFO.RECIPEID 545
FU.LOG_EQUIP.INFO.UNIT_SEGMENT 545
FU.PHASE.COMM.HANDSHAKE 542
FU.PHASE.INFO.CLB 540
FU.PHASE.INFO.EQUIPMENT 540
FU.PHASE.INFO.MODE 540
FU.PHASE.INFO.PHASE 540
FU.PHASE.INFO.RECIPE 540
FU.PHASE.INFO.SIZE 540
FU.PHASE.INFO.STATUS 540
FU.PHASE.INFO.TRAIN 540
FU.PHASE.PARAM_EXT_LIST.ITEM 541
FU.PHASE.PARAM_EXT_LIST.NUM_ITEMS 541
FU.PHASE.SELECT.PARAM_DATA_CLASS 541
FU.PHASE.SELECT.PARAM_EXT 541
FU.PHASE.SELECT.PARAM_EXT_ITEM 541
FU.PHASE.SELECT.PARAM_EXT_VALUE 542
FU.PHASE.SELECT.PARAM_NAME 541
FU.PHASE.SELECT.PARAM_TYPE 541
Function Block Diagram 468
Function Security
enabling 453
requests 456
Functions
Description of 462
inserting in expressions 461

G
General High Deviation 201
General Low Deviation 201
General Tolerances, in Recipes 248
Guideline
Batch Manager system interactions 308
Control System Memory Configuration 470
Creating a Process Log Group 432
Creating a train 304, 305
Expression Building 463
Phase Block Design 467
Phase Block Memory 471
Process Modeling 2
Recipe Procedure Development 213

H
-HANDSHAKE tag 490
Header 207
description of 207
Held 320
Help

624
Index B0193YB – Rev C

Environment Display 51
Environment Editor 56
Materials Status 200
Process Modeling 93
Recipe Editor 259
High Deviation
Material 201
High Deviation Element 137
Process Phase 113
Transfer Phase 137
High Limit Element
Process Phase 113
Transfer Phase 138
History
Logging Process Data 426
Viewing for a Recipe 220
History Administration 572
History and Batch Manager
Description of 308
History Archiving 576
History Queue
Viewing Status of 51
Hold a Batch 360
Hold Propagation Modes 343
Hybrid Model 68

I
I/A Batch
Overview of Capabilities 1
I/A Batch Server
Installed Components 7
I/A Link Editor (IALink) 488
I/A Series
Batch Link Editor Operation 174
Control Processor 551
Control Strategy 553
Linker 165
TIM Shared Variable Utility 12
IADriver 10, 61
IALink 9, 89, 165
II0003 174
II0004 174
II0007 185
II0008 185
Import Recipes 222, 223
Import Units of Measure 147
InBatch
redundancy 558
INBATCHSFC.OCX 12
Index 463

625
B0193YB – Rev C Index

InfoMngr 10
InfoMngr_ _See Information Manager 438
Information Manager
Description of 438
Information Server
Changing Assignment on the Batch Server 586
Information Server Administration 571
Information Server Configuration 575
Ingredient, Defining 201
Ingredients 193, 207
Initialization
Description of 307
Initializing batches
train 266
initializing batches, train 269
Input and Output Control 483
Input formula parameters 203
Input Material Settings
Editing for Recipes 247
Input Materials
Adding to Recipe 245
Changing in Recipe 246
Input parameter elements 112
Input parameters 136
Insert a Function 461
Insert a Phase 270
Insert a Tag Operand 461
Insert an Operation 269, 270
Insert Branch Object 274
Insert Loop Object 277
Insert Transition Object 271
Inserting Procedure Objects 269
Installation Overview 15
Installing
I/A Series Batch Configuration Client 23
I/A Series Batch Information Server Components 19
I/A Series Batch Runtime Client 22
I/A Series Batch Server 21
Internet Information Server (IIS) 25
Microsoft Internet Explorer 5 25
Microsoft SQL Server 7.0 SP2 25
Seagate Crystal Reports Professional 8.0 18
Station Types 17
Instance
Description of 56
Instances 56, 58
Adding 56
Error Message 56
Instruction List 350
Instrument Society of America 1
Integrated Control Configurator (ICC) 185

626
Index B0193YB – Rev C

Intelligent Scheduler 305

Interfaces 162
Interlocks 468, 482
additional information 151
Configuring for Process Class Phases 107
Configuring for Transfer Class Phases 131
Description of 74
interlocks
viewing with Phase Logic Testing Tool 486
Intermediates 193, 207
defining 201
ISA S88.01 1, 3
-ITEM# 490
-ITEM# tags 490

J
Jump Mode
Description of 370

L
Library, Operations 253, 254
Licensing
Viewing 56, 259
LIFO 367
LIFO Materials Parameter 203, 367
List Tags 489
lm_tcp 46, 64
Load Operation 262, 268
Loading an Operation 266, 268
Locked 321
Locking 321
Log Equipment Status, TIM tags 545
Log Interval
Description of 426
Process Log Group Editor 426
Log Trigger
Description of 425
Process Logger Group Editor 425
LogEdit 9
LogMngr 11, 60
LogMngr_ _See Process Log Manager 437
Loop 261, 263, 264
Loop Object 276
Description of 209
Insert 277
Loop, Deleting 284
Lot 204
Lot Code Element
Process Phase 113

627
B0193YB – Rev C Index

Transfer Phase 138

Lot ID 86, 318
Lot Tracking 204, 206
Low Deviation Element 137
Process Phase 113
Transfer Phase 137
Low Limit Element
Process Phase 113
Transfer Phase 138

M
Managing I/A Batch Configurations 7
Manipulate Recipe Focus
TIM tags 505
Manipulate the Batch Schedule
TIM tags 492
Manual Addition
using a connected scale 365, 367
using an unconnected scale 365, 368
with scale and without scale 365
Manual Addition, with Scale and without Scale 368
Manual Allocation and Release
unit 359
Manual Batch Execution 320
Manual Batch Mode 362
Manual Operation
phase execution 338
precautions 376
Warm Restart 376
Manual Phase 72, 73, 103, 127
Manual Process Phases 116, 364, 366
Manual Process Phases with Material Input Parameters 365
Manual Tag Creation and Assignment 151, 155
Manual to Automatic mode change 363
Manual to Semi-automatic mode change 363
Manual Transfer Phase 134, 140, 367
examples of 140
Manual Unit Selection 364
Master Recipe
Description of 207
Material Characteristics 201, 203
Material Description 201
Material ID 201
Material ID Element
Process Phase 114
Transfer Phase 138
Material Location Assignment Editor
Starting 204
Using 203
Material Name 201

628
Index B0193YB – Rev C

Material Resource Planning 3

Material Status
viewing 195
Material Tracking 203
MaterialEdit 9
Materials
Adding to Recipe 249
Defining 201
Formula Inputs 243
Formula Outputs 243
Process Variables 243
Materials Editor 193
Defining Materials 203
Defining Materials for 203
Description of 193
Printing Materials Status 196
Starting 202
Using 201
Materials Status
Filtering the Unit Assignment List 199
Help Menu 200
Menus
Edit/Material Locations 199
Edit/Materials Editor 198
File/Exit 198
File/Print 196
File/Print Preview 197
File/Print Setup 198
File/Validate 195
View/Assigned Units 199
View/Find 200
View/Full List 200
View/Partial List 199
Reports 197
Materials Status Window
Starting 194
Using 194
Materials Tracking Management
Description of 3
Max Attribute 236
Maximum Batch Size 207
Menu
I/A Batch Program 7
Min Attribute 236
Minimum Batch Size 207
Mode/Status filtering in Batch Scheduler 314
Model Approach Comparisons 69
Model Editor 87
Connections Tab 117
Edit Equipment Status Tab 144

629
B0193YB – Rev C Index

Edit Menu 92
Edit Segments Tab 143
File Menu 90
Menus
Edit/Connections 92
Edit/Equipment Status 92
Edit/Processes 92
Edit/Segments 92
Edit/Transfers 92
Edit/Units 92
Edit/Units of Measure 92
File/Exit 92
File/Print 91
File/Print Preview 91
File/Print Setup 92
File/Validate 90
Starting 89
Transfers Tab 122
Units Tab 93
ModelDB 88
ModelEdit 9
Modeling 89
Modeling_ _Model Editor 89
Monitor and Control Active Batches 500
Monitor and Control Active Phases
TIM tags 508
Monitor and Control Equipment 525
Monitor and Respond to Batch Questions
TIM tags 506
Monitor and Respond to Errors
TIM tags 532
Monitor Batch Messages
TIM tags 518
Moving Procedure Objects 285
MRP 3, 193
Multiple Instances
in recipes 208
Multiple Operation Execution 274
Multiple Phase Execution 274
Multiple Process Instances 234

N
Nesting branches 275
Nesting Procedure Objects 285
Nodes
Description of 163
Not 463
NUM_OP 185
-NUMITEMS tag 490

630
Index B0193YB – Rev C

O
OCXBATCH.OCX 12
One Time Schedule 414
Open 320
Operands
Description of 462
Operation
Description of 210
Insert 269, 270
Save 285
Storing 266
Validity of 266
Operation Branch
Insert 274
Operation Loop
Insert 277
Operation Name
Changing 285
Operation Name, Changing 286
Operation Properties 286
Operation Transition 261, 263
Insert 271
Operation, Loading 266, 268
Operation, Save 287
operation, validity of 268
Operations
Examples of 210
Operations Library 253, 254
Using 254
Operations Toolbar 262
Operator Display and Edit Configuration 155
Operator Stations 449
description of 446
Operator Stations Editor 450
Operator Stations, security 445
Operators
Expressions 461
OPNAM 185
Other Applications 62
Other Materials 193
Defining 201
Output Formula Parameters 204
Output Material Settings
Editing for Recipes 251
Output Materials
Changing in Recipe 250
Output Parameter Elements 112
Output Parameters 136, 211

631
B0193YB – Rev C Index

P
P&ID,Using for Process Model 67
Parameter Extensions
Description of 481
Parameter Status 104, 128
Parameter Type Extensions 480
Parameter Types 480
Parameters
Application Parameters 60
Applications
Assigning with Environment Editor 59
Formula 74
Phase 74
Parentheses 463
Password 441, 448
changing 441, 448
security editor 441
Password Encryption 448
Password Reuse 444
Password Timeout 444, 448
Phantom Batch
description of 338
displaying 348
Phase 103, 127
Insert 270
Process 71
Phase Block
Components of 471
Description of 467
Operational Flow Chart 469
Rules of Operation 468
Phase Block Design Guideline 467
Phase Block Interface 168
Phase Block Memory Guidelines 471
Phase Branch 264
Insert 274
Phase Comments 352
Phase Configuration, additional information 147
Phase Control 477
Phase Control and Status 353
Phase Control and Status Bits
Description of 74
Phase Control Bits 468
Phase Control Buttons 350
Phase Control/Status Bits
Additional Information 149
Configuring for Process Class Phases 106
Configuring for Transfer Class Phases 130
Phase Interlock
tags 153

632
Index B0193YB – Rev C

Phase Interlocks 352

Phase List 349, 353
Phase Logic 71, 73
Automatic Phases 110
Description of 73
Phase Logic Blocks 73
Phase Logic Testing Tool 484
Description of 484
File Menu 485
Help Menu 485
Menus
File/Exit 485
Using 484
Phase Loop 264
Insert 277
Phase Parameter Editor
Using during Batch Execution 354
Phase Parameter List 350
Phase Parameters
Automatic and Semi-Automatic Transfer Phases
Examples of 136
Description of 74
Phase Prepare/Complete 539
Phase Properties 287
Phase Status 478
Bits 468
System Shutdown 375
Phase Tab
Phase Properties 288
Phase Transition 264
Insert 271
Phase Types
Description of 72, 271
Process Class 103, 127
Phase/Batch Status parameter 343
PHASE_EXEC 187
PHASE_EXEC Block 185
PHASE_EXEC Configuration File, Description of 186
PhaseLogic 12
Phases
Connectionless Model 68
in Recipe Procedures 209
in Recipes 210
Phases and Parameters
edit using TIM tags 520
Phases Toolbar 264
Preact
Description of 118
Preact Element
Process Phase 113

633
B0193YB – Rev C Index

Transfer Phase 138

premix 247
Premixes 193
Previewing Reports from Model Editor 91
Printing
Recipes 225
Printing from Model Editor 91
Procedure 207
Recipe
Description of 209
Procedure Layout 260
Procedure Objects 261
Process and Instrumentation Diagrams 67
Process and Transfer Capabilities 71
Process and Transfer Instances 266, 269
in Recipes 208
Process and Transfer Phases
in recipes 211
Process and Transfer Tags
when to use 80
Process Capabilities
Defining 71
Description of 71
Process Class
Assign Units to Processes 98
Assigning 96
Attributes 100
Deleting from Recipe 232
Description of 71
Edit Process Class Phases 103
Edit Process Class Tags 102
Phase Types 103, 127
Unit Attribute Values 101
Unit Control Tags 98
Unit State Tags 98
Process Class Attributes
in Recipes 236
Process Class Instance Editor 233, 235
Process Class Instances
Assign Units 234
Attributes 236
Unit Selection 235
Process Class Phase
Control Buttons 105
Formula Parameters 109
Interlocks 107
Phase Control/Status Bits 106
Save History 104
Process Class Tag 102
Process Classes

634
Index B0193YB – Rev C

Assign to Recipe 232

Assigning in Recipes 232
In Recipes 230
in recipes 208
Process Classes and Generic Phases in Recipe Editor 85
Process Instances 233
Assign to Operation 270
Assign to Recipe 234, 235
Defining for Recipes 233
Deleting from Recipe 233
In Recipes 230
Example 231
Process Log Configuration
Creating 432
Description of 425
Process Log Database
Description of 425
Process Log Editor 425
Configuring Process Logs 431
Creating Log Configuration 427
Deleting Log Configuration 429
File Menu 427
Group Editor 432
Menus
Edit/Groups 432
File/Exit 431
File/New 427
File/Open 428
File/Print 429
File/Print Preview 430
File/Print Setup 431
File/Save 428
File/Validate 429
Menus File/Delete 429
Printing Log Configuration 429
Reports 430
Starting 427
Using 427
Using Expression Editor 459
Validating Log Configuration 429
Process Log Group
Creating 432
Process Log Group Editor
Log Interval 426
Logging to a Printer 426
Logging to History 426
Process Log Manager 425
Configuring 437
Description of 437

635
B0193YB – Rev C Index

Information Manager 438

Restarting 427
Runtime 438
Starting 437
Stopping 438
Using 437
Process Logger Group Editor
General Logging Criteria 425
Log Trigger 425
Process Logging 425
Description of 425
Process Model
Comprehensive 67
Connection Tag 78
Connectionless 68
Example 85
Hybrid 68
Process Tag 78
System Tag 78
Transfer Tag 78
Unit Tag 78
Process Model Database 252
Trains 301
Process Model Editor 87, 96
Formula Parameters 211
Starting 89
Process Model Tag, Description of 76
Process Modeling 67, 87
Adding Process Classes 97
Adding Units 94
Change Process Class Name 97
Change Unit Name 94
Deleting a Process Class 98
Deleting a Units 95
Description of 1
Diagram of 84
Edit Connection Tags 121
Edit Connections 117
Edit Equipment Status 144
Edit Processes 96
Edit Segments 143
Edit Transfer Tags 125
Edit Transfers 122
Edit Unit Tags 95
Edit Units 93
Editing Connections 118
Editing Transfers 123
Editor 67
Guideline 2

636
Index B0193YB – Rev C

Help Menu 93
Phase Logic 73
Process Classes
Unit Control Tags 98
Unit State Tags 98
Process Modeling Editor 252
Process Class Attributes 236
Process Modeling Steps
Guideline 70
Process Phase
Description of 71
Process Phase Types
Automatic 72
Manual 72
Semi-Automatic 72
Process Phases 364, 366
Entering as process tags 95
Process Phases with Material Input Parameters 364
Process Phases with Material Output Parameters 366
Process Status Display 184
Process Tag
Description of 78
Example of 85
Guideline 80
Process Tag to Unit Tag Resolution by Batch Manager 86
Process Variable Editor 243
Process Variable Elements 112
Process Variable Parameters 136, 211
Changing 252
Description of 112
Process Variables 136, 252
Processes_ _See Process Class 71
Processing capabilities 2
ProcStatus 12, 184
Product ID 207
Product Name 207
Production Tracking Record 203
Program Menu
I/A Batch 7
Proprietary Format
Recipe 223
Purge Job 579

Q
Quantity 204
Quantity Assignment
Batch Size 319
Question List 349
Quotes 463

637
B0193YB – Rev C Index

R
Raw Materials 193
Read/Write tags 84
Read-only tags 84
Ready 320
Reassigning a Valid Unit 196
Recipe
Approval 220
Approved for Production 219
Approved for Test 219
Creating 260
Deleting 218
Done By as Author 217
equipment dependent 208
equipment independent 208
Parts of 207
Saving 217
Validate 219
Recipe Allocation and Release, unit 358
Recipe Approval Levels 219
Recipe Approvals 219
Recipe Assignment to a Batch 319
Recipe Editor 207
Edit Menu 227
File Menu 214
Help Menu 259
Hi and Low Elements 138
Menus
Edit/Formula Inputs 244, 248
Edit/Operations Library 254
Edit/Process Variables 252
Edit/Recipe Header 227
Edit/Recipe States 255
Edit/Recipe Types 256
Edit/Zoom In Operations 259, 346
Edit/Zoom In Phases 259, 346
Edit/Zoom Out Operations 259, 346
Edit/Zoom Out Phases 259, 346, 347
File/Approvals 219
File/Delete Recipes 218
File/Exit 226
File/History 220
File/Import/Export 222
File/New 214
File/Open 215
File/Print 225
File/Print Preview 226
File/Print Setup 226
File/Save 217

638
Index B0193YB – Rev C

File/Synchronize Recipes 223

File/Validate 219
Printing Recipes 225
Process Classes and Generic Phases 85
Reports 226
Starting 213
Using 213
Using Expression Editor 459
View Menu 257
Recipe filtering in Batch Scheduler 314
Recipe Header
Editing 227
Recipe History
Viewing 220
Recipe ID 86, 207
Recipe Management
Description of 3
Recipe Name 207
Recipe Procedure Creation
Basic Steps 213
Recipe Procedure Mechanics 269
Recipe State 207
Defining 255
Recipe Synchronization 223
Recipe Type 207
Assigning 229
Defining 256
RecipeEdit 9, 12, 213
Recipes
Copying 222
Moving 222
Security for saving 217
Security options for 449
Redundancy 558
Redundancy Manager 64
Viewing Status of 51
Registry
Editing the Batch Server name 587
Editing the Information Server name 587
Release Phase
in Recipes 211
Removing a Unit Assignment 196
Report Configuration 406
Report Editor
Using Expression Editor 459
Report Schedule Properties 413
Report Scheduling 410
Report Triggering during batch execution 371
Report Viewing 419
Reporting System 401

639
B0193YB – Rev C Index

Reports 289
Deleting 586
expression triggered 405
Predefined 422
Train Editor 303
Restart a Batch 361
Restarting
Process Log Manager 427
Restore Job 581
Restrict access to applications 450
Retain Recipe Approvals 339
Retries 444
Run 320
Runtime
Update 49
Runtime Programs
Summary of 10
Runtime Recipe Procedure Jumps 307
Description of 370
Runtime Security 455

S
S88.01 Standard 1, 3, 207
Save Control Recipe 338, 531
Save History
Process Class Phase 104
Transfer Class Phase 128
Save Operation 266, 285, 287
Save Runtime Equipment 339
SCADA 78
Schedule window 340
Scheduling
Description of 307
SE.SECURITY.COMM.HANDSHAKE 536
SE.SECURITY.INPUT.APPLICATION 536
SE.SECURITY.INPUT.FUNCTION 536
SE.SECURITY.INPUT.NEWPASSWORD 536
SE.SECURITY.INPUT.OPSTATION 536
SE.SECURITY.INPUT.PASSWORD 536
SE.SECURITY.INPUT.RECIPEID 536
SE.SECURITY.INPUT.SECURITYLEVEL 536
SE.SECURITY.INPUT.USERID 536
SE.SECURITY.INPUT.VERIFYPASSWORD 536
SecEdit 10, 440
SecMngr 11, 46
Security
Adding a New Function 453
Adding Applications 451
Application Security Requests 456
Applications-Functions 450

640
Index B0193YB – Rev C

Checked 453
Disable 444
Display Phase Sequence 344
Done By 453
Enable 444
Enabling Application 452
Enabling Function Security 453
Function Security Requests 456
Recipe approvals 219
Saving recipes 217
Security API 439, 451, 453, 457
Security Application Program Interface 439
Security Clearance Request 441
Security Editor 439
Default password 441
Edit Menu 443
File Menu 442
Help Menu 443
Menus
Edit/Applications-Functions 443
Edit/Operator Stations 443
Edit/Security Levels 443
Edit/User Accounts 443
File/Exit 442, 443
File/Print 442
File/Print Preview 442
File/Print Setup 443
Using for the first time 441
Security for FoxSFC 344
Security Level 448
Assigning 444
Security Manager 64, 439, 455
Security System 439
Description of 439
Recipe Author 217
Viewing Status of 51
Security System Configuration 444
Security System Interface
TIM tags 535
Security System Interface Handshake Errors
TIM tags 537
Segment 67
Description of 75
Segments 143
Assigning 120
Select Equipment for Allocation, TIM tags 517
-SEL-tag 490
Semi-Auto On Abort 363
Semi-Automatic Batch Execution 320
Semi-Automatic Batch Mode 362

641
B0193YB – Rev C Index

Semi-Automatic Phase 72
Semi-automatic to Automatic mode change 363
Semi-automatic to Manual Mode mode change 363
Semi-Automatic Transfer Phase 134
Semi-Automatic Transfer Phases 367
Sequence of Operations 260, 350
Sequence of Phases 260, 350
Sequence Unsuspend scriptApplication 551
Services
Windows NT 52
Setting up an I/A Series Batch System 17
SFC Toolbar 349
SFC/ST Display Manager 344
Shared Equipment Contention 369
Shared Variable 488
Shared Variable Utility 182
Shutting Down Environment Display 48
SimMngr 10, 60
Using with IADriver 61
Simulation
Using IADriver with SimMngr 61
Sleep
For delaying batch file execution 66
Source Class Discharge Phase 68
Source Instance
Assigining 241
Source Process Class
Assigning 123
Source Unit
Assigning 118
Space Character
In Recipe Find 216
Starting
Environment Editor 53
Environment Manager 64
Material Location Assignment Editor 204
Materials Editor 202
Materials Status Window 194
Model Editor 89
Process Log Editor 427
Recipe Editor 213
Starting the Expression Editor 459
Starting the Security Manager 455
State
Find recipes by 216
Recipe 255
Station Type Software Requirements 15
Status
Of a batch 320
Storing an Operation 266
string items 173

642
Index B0193YB – Rev C

string tag 83
naming 83
StrMap Default Configuration File 173
Synchronization
Control System 375
Synchronize Recipes 223
SysTagMngr 10
System Class tags 78
System Connection tags 78
System Segment tags 78
System Shutdown
Phase Status 375
System Tag
Description of 78
Equipment Status 145
System Unit tags 78

T
Tag
Access Mode 84
Connection Tag 78
Data Class 83
Definition 81
Description of 2, 76
Entering a Description for 83
Equipment Status 145
Process Model 76
Process Tag 78
System Tag 78
Transfer Tag 78
Unit Tag 78
Using with Control Buttons 105, 129
Tag Generation, TIM 491
Tag Interface Management, when to use 487
Tag Linker 488
Tag Operand 461
Tag Types and Usage 76
TagMap 187
TagMap File 166
Tagname
Automatically Generated 82
Definition 81
Delimiters 82
Description of 81
Naming Convention 82
Structure 82
Tags
assigning to control buttons 149
Phase Control/Status 106, 130

643
B0193YB – Rev C Index

phase interlock 153

Using with Phase Logic, Guideline 80
Target Element
Process Phase 112
Transfer Phase 137
Templates
Crystal Reports 422
Terminate App
Timeout Value 48
Terminating an Application 48
The BT.PHASE_ED.INPUT.PARAM_VALUE 524
TIM
when to use 487
TIM Batch Function tags 491
TIM Batch Process (TIMBatch) 489
TIM Editor 488
TIM Function Library Process (TIMFunc) 489
TIM Runtime Applications 549
TIM Runtime Operation 549
TIM Security Process (TIMSec) 489
TIM Shared Variable Utility 488
TIM System Configuration 488
TIM System Runtime 489
TIM Tags
Using with a Control Processor 188
TIMBatch 11
Runtime 549
Time remaining
Active transition 356
TIMEdit 9
TIMEOUT variable 65
TIMFunc 11
Runtime 549
TIMMap File 172, 488
TIMSec 11
Runtime 549
Tolerances
in Recipes 248
Train 86
Additional units 234
In a Recipe 207, 230, 234
Multiple Path Issues 317
Train Assignment to a Batch 319
Train Attributes 305
Train Creation
Guideline 304, 305
Train Editor 89, 301
Description of 301
File Menu 303
Menus
File/Exit 303, 304

644
Index B0193YB – Rev C

File/Print 303
File/Print Setup 304
Help Menu 304
Help/About Train Editor 304
Help/Help Topics 304
Using 301
Train filtering in Batch Scheduler 314
TrainEdit 9
Trains
Assigning Units to 304, 305
Deleting Units from 95
Transfer Capabilities
Defining 71
Description of 71
Transfer Class
Description of 71, 122
Edit Phases 127
Transfer Class Instance Editor 239
Transfer Class Phase
Control Buttons 129
Formula Parameters 133
Interlocks 131
Phase Control/Status Bits 130
Save History 128
Transfer Classes 122
Transfer Instance 239
Assign to Recipe 240
Defining for Recipes 239
Deleting from Recipe 240
In a Recipe 230, 240
example 231
Transfer Phase
Configuration 134
Types 134
Transfer Phases
In Recipes 230
Transfer Phases with Material Input Parameters 366
Transfer Phases with Material Output Parameters 368
Transfer Tag 125
Description of 78
Guideline 80
Transfers
Editing 123
Transfers_ _See Transfer Class 71
Transition 261, 263, 264
Transition Expression
Examples 273
Transition Logic
In Objects 271
in Recipe Procedures 209

645
B0193YB – Rev C Index

in Recipes 212
Operators 212
Transition Object 271
Description of 271
Insert 271
Transition Properties
Loops 277
Transition Wait
Displayed in Batch Display 356
Type
Assigning 229
Defining for Materials 201
Find recipes by 216
Recipe 256

U
Undo 262, 263, 265
Objects 279
Unexpected Status Error 359
UnilinkMngr 10
Unit 67, 70
Assign Materials to 205
Assigning a Material to 204
Assigning for material tracking 203
Description of 70
Unit Abort Tag 98
Unit and Connection Tags
when to use 80
Unit Attribute Values 101
Unit Block 185
Unit Block Interface 171
Unit Control 185, 343
Bits 475
Tag 98
Description of 98
Unit Control/State Tags 98
Unit Hold Tag 98
Unit of Measure 251
Material 201
Unit Restart Tag 98
Unit Selection 235
At Runtime 235
Process Class Instances 235
Unit Selection Mode and Allocation 357, 363
Unit State system tags 343
Unit State Tags
Description of 98
Unit Tags 95
Description of 78

646
Index B0193YB – Rev C

Guideline 80
Unit-centric focus 489
Units of Measure
Description of 76
UOM_IN.txt 146
UOM_OUT.txt 147
Update
Configuration 50
Environment 49
Runtime 49
Update Runtime
Materials Editor Unit Selection 206
Upgrade an existing I/A Series Batch 7.x System 30
URL
Batch Administration 571
Batch Reporting 405
User Accounts 574
Configuring for SQL Server 574
Security 446
User Defined Applications 62
Using
Environment Display 46
Phase Logic Testing Tool 484
Train Editor 301
Using Batch Display 336, 356
Using Batch Scheduler 309, 326
Using Expression Editor 459
Using Security Editor 440
Using the Phase Logic Testing Tool 484
Utility Programs 12

V
Valid Characters for Tagnames 82
Validate
Security configuration 442
Validation
Materials Database 195
Process Model 90
Recipe 219
Validation Errors
Correcting for Materials Database 196
Verification
Batch Initialization 316
View
System Application Status 50
View and Adjust Allocation Queue 498
View Doc/Ack Doc Button 350
View Partial List check box
Materials Editor 203
View/Force Transition Logic, TIM tags 528

647
B0193YB – Rev C Index

Viewing Material Status 195

W
Wait 356
WaitHour 463
WaitMin 463
WaitSec 463
Warm Restart 373
Warning
Batch Client Security 452
Batch Manager and Trains 317
Deleting Model Components 88
Phase Logic Testing Tool 485
Process Log Manager, Stopping 438
Restarting Batches 375
Tags in Expressions 464

Z
Zoom In 262, 263, 265
Zoom Out 262, 264, 265

33 Commercial Street
Foxboro, Massachusetts 02035-2099
United States of America
www.foxboro.com
Inside U.S.: 1-866-PHON-IPS (1-866-746-6477)
Outside U.S.: 1-508-549-2424 or contact your local Foxboro representative.
Facsimile: 1-508-549-4999
Printed in U.S.A. 0701