0% found this document useful (0 votes)

142 views

Premier User Guide

Wonderware InBatch User's Guide

Uploaded by

gsanchez57

Available Formats

Download as PDF, TXT or read online on Scribd

0% found this document useful (0 votes)

142 views

Premier User Guide

Wonderware InBatch User's Guide

Uploaded by

gsanchez57

Available Formats

Download as PDF, TXT or read online on Scribd

You are on page 1/ 732

InBatch™ User’s Guide

Invensys Systems, Inc.

Revision E
Last Revision: August 26, 2010
Copyright
© 2008–2010 Invensys Systems, Inc. All Rights Reserved.
All rights reserved. No part of this documentation shall be reproduced, stored in a
retrieval system, or transmitted by any means, electronic, mechanical,
photocopying, recording, or otherwise, without the prior written permission of
Invensys Systems, Inc. No copyright or patent liability is assumed with respect to
the use of the information contained herein. Although every precaution has been
taken in the preparation of this documentation, the publisher and the author
assume no responsibility for errors or omissions. Neither is any liability assumed
for damages resulting from the use of the information contained herein.
The information in this documentation is subject to change without notice and does
not represent a commitment on the part of Invensys Systems, Inc. The software
described in this documentation is furnished under a license or nondisclosure
agreement. This software may be used or copied only in accordance with the terms
of these agreements.
Invensys Systems, Inc.
26561 Rancho Parkway South
Lake Forest, CA 92630 U.S.A.
(949) 727-3200
http://www.wonderware.com
For comments or suggestions about the product documentation, send an e-mail
message to [email protected].

Trademarks
All terms mentioned in this documentation that are known to be trademarks or
service marks have been appropriately capitalized. Invensys Systems, Inc. cannot
attest to the accuracy of this information. Use of a term in this documentation
should not be regarded as affecting the validity of any trademark or service mark.
Alarm Logger, ActiveFactory, ArchestrA, Avantis, DBDump, DBLoad, DT Analyst,
Factelligence, FactoryFocus, FactoryOffice, FactorySuite, FactorySuite A2, InBatch,
InControl, IndustrialRAD, IndustrialSQL Server, InTouch, MaintenanceSuite,
MuniSuite, QI Analyst, SCADAlarm, SCADASuite, SuiteLink, SuiteVoyager,
WindowMaker, WindowViewer, Wonderware, Wonderware Factelligence, and
Wonderware Logger are trademarks of Invensys plc, its subsidiaries and affiliates.
All other brands may be trademarks of their respective owners.
3

Contents

Welcome.......................................... 17
Documentation Conventions.............................................17
Technical Support .............................................................18

Chapter 1 Overview of InBatch ............................ 19

Overview ............................................................................19
Flexible Recipes and Process Lines ...............................20
Process Modeling ...........................................................20
Tag Creation and Linking..............................................22
Materials Tracking Management ..................................22
Recipe Management .......................................................23
Batch Management ........................................................23
Batch History..................................................................25
Batch Reports .................................................................25
InBatch Integration...........................................................26
Tag Management............................................................26
Tag Communications......................................................26
Batch Alarms ..................................................................27
Terminal Services Support ...............................................27
Extensibility ......................................................................27
Managing InBatch Configurations...................................28
InBatch Programs .............................................................28
Configuration Programs.................................................28
Run-Time Programs .......................................................29

InBatch User’s Guide

Chapter 10 History System ................................ 445

Overview .......................................................................... 446
History Database Tables................................................. 447
ArchiveHistory ............................................................ 447
AuditEvent ................................................................... 447
BatchAdmin ................................................................. 448
BatchDetail .................................................................. 449
BatchIdLog .................................................................. 449
BatchQuestion ............................................................. 450
CodeTable .................................................................... 450
Config ........................................................................... 453
DocViewEvent ............................................................. 454
EquipStatus ................................................................. 454
ErrorQ .......................................................................... 455
Event ............................................................................ 455
MaterialChar ............................................................... 456
MaterialInput .............................................................. 456
MaterialInputChange ................................................. 457
MaterialOutput ........................................................... 458
OperatorComment........................................................ 458
PhaseInstruction .........................................................459
ProcessLog ................................................................... 460

InBatch User’s Guide

Index ............................................. 715

InBatch User’s Guide

Welcome

The InBatch User’s Guide is a general overview and

discussion of the capabilities of the InBatch software,
including process modeling, creating and using tags, recipe
management, materials tracking, batch management,
history and reporting. It explains the interface between
InBatch software and your control system, including
alarming and utility programs.

Documentation Conventions
This documentation uses the following conventions:

Convention Used for

Initial Capitals Paths and file names.

Bold Menus, commands, dialog box names,
and dialog box options.
Monospace Code samples and display text.

InBatch User’s Guide

18 Welcome

Technical Support
Wonderware Technical Support offers a variety of support
options to answer any questions on Wonderware products
and their implementation.
Before you contact Technical Support, refer to the relevant
section(s) in this documentation for a possible solution to the
problem. If you need to contact technical support for help,
have the following information ready:
• The type and version of the operating system you are
using.
• Details of how to recreate the problem.

• The exact wording of the error messages you saw.

• Any relevant output listing from the Log Viewer or any

other diagnostic applications.

• Details of what you did to try to solve the problem(s) and

your results.

• If known, the Wonderware Technical Support case

number assigned to your problem, if this is an ongoing
problem.

InBatch User’s Guide

Chapter 1

Overview of InBatch

This section provides a general overview and discussion of

the capabilities of the InBatch software, including process
modeling, creating and using tags, recipe management,
materials tracking, batch management, history, and
reporting. It describes the interface between InBatch
software and your control system, including alarm and utility
programs.

Overview
InBatch is a flexible batch management system that you can
configure quickly and easily after you understand its
fundamental concepts. It is extremely important that you
understand these concepts before attempting to use the
InBatch system.
InBatch is Consistent with the ISA-88 standard. You can
create recipes quickly and easily and simulate their
processing against a model of the process – all before you
write one line of control code. You can also access complete
production history and materials genealogy.
InBatch provides out-of-the-box batch management
functionality that eliminates the need for unsustainable
custom code in a programmable logic controller (PLC) or
distributed control system (DCS) and dramatically reduces
your 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 system also supports redundancy for critical
applications.

InBatch User’s Guide

20  Chapter 1 Overview of InBatch

Flexible Recipes and Process Lines

Within the InBatch control system, you can easily change
recipe procedures. For new product introductions, you can
reconfigure formula and process lines instead of
re-engineering them. The InBatch system is flexible because
it enables you to 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 occur 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 is made up of units and connections.
The five main components of the process model are:
• Units

• Process classes (processes)

• Connections

• Transfer classes (transfers)

• Processing capabilities.

Units
A unit is any vessel that can hold or process materials. Some
units have no processing capabilities, such as bulk storage
vessels, manual add stations, and hold tanks. Other units
have significant processing capabilities, such as 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
Connections are the equipment that is necessary for
transferring a product from one unit to another. Examples
are pumps, valves, separators, condensers, and flow meters,
Many plants have units that are connected to more that one
unit and some plants have multiple connections between the
same two units.

InBatch User’s Guide

Overview21

Process Classes and Transfer Classes

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.
Grouping units and connections into classes allows for a
flexible batch system.

Phases
Processing and transferring capabilities are defined by
phases. Each phase is an independent action that can contain
a unique set of parameters. Parameters configure the phase
based on recipe requirements. Phases can be automatically
processed by the control system or manually run by an
operator.

Process Modeling Work Flow

Defining the plant processing capability is called process
modeling and involves the following steps:
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 the status of equipment.
9 Define trains.
10 Develop phase logic.

InBatch User’s Guide

22  Chapter 1 Overview of InBatch

Tag Creation and Linking

An integral part of process modeling involves defining
specific data points, called tags, for units, processes,
connections, and transfers. Tags enable data to move
between the batch system and the control system. You must
define tags before you configure any of the batch system
application modules. The number of tags allowed in the batch
system is limited only by the amount of mass storage in the
system.
When you create the process model, you create tags for units,
connections, segments, phases, and phase parameters.
You must link the model and its tags to control system
addresses using the InBatch TagLinker. The TagLinker
provides automatic and manual linking of tags to external
systems.

Materials Tracking Management

Materials tracking management includes the ability to define
materials as ingredients, intermediates, finished goods,
by-products, and others. You can define characteristics for
each material entered in the system.
You can use the Materials Editor to track the location of
materials that are stored in units. This tracking capability
pertains to bulk ingredients and work in process materials.
The batch management system uses the ingredient location
data to determine where to obtain ingredients when a batch
is to be produced. This capability allows ingredient locations
to be independent of recipes and control programs and
permits ingredients to change locations with no effect on
recipe processing.
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, plant personnel can
enter the unit location into the Materials database. You can
also assign a lot identification to the material. You can store
multiple lots of the same ingredient 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 gives you easy access to
work-in-progress (WIP) information. You can also use the
database to update higher level material management and
material resource planning (MRP) systems with ingredient
usage information, WIP, and finished goods production. The
Materials Editor is not an inventory management system,
but you may use it to complement existing systems.

InBatch User’s Guide

Overview23

Recipe Management
The batch control system manages and constructs recipes
according to the guidelines outlined in the ISA-88 Flexible
Batch Specification.

Master Recipes
You can construct and edit master recipes. Master recipes
are not specific to process lines, but are independent of
equipment. You can assign master recipes to any process line
(train) that has units belonging to the classes of process
equipment defined in the recipe.
A master recipe is not size specific, but is scalable to the
batch size defined by production scheduling. You can enter
all formula quantities for ingredients, intermediates,
by-products, and finished goods as either actual quantities or
as a percent of the total batch size. Quantities expressed in
percentages are scaled by the batch management system
when the batch runs.

Control Recipes
A master recipe becomes a control recipe as the units defined
in the train are dynamically allocated and used in producing
a batch.

Recipe Editor
Use the Recipe Editor to construct and alter recipes. You can
save, retrieve, and print recipes. A revision control system
provides you with an accurate time-stamped history of all
changes and revisions that have been made to the recipe.

Batch Management
Batch management consists of scheduling batches,
initializing batches, coordinating the processing of batches
with the control system, interfacing with operators, and
storing all batch activity. You perform these tasks using the
Batch Manager, Batch Scheduler, and Batch Display
programs.

Batch Scheduling
Use Batch Manager to dispatch to plant floor operators the
batches that are ready to run. To schedule a batch, you
manually enter the batch identification, master recipe, batch
size, and train (process line) into the Batch Scheduler. After
you enter the batch, you can initialize it.

InBatch User’s Guide

24  Chapter 1 Overview of InBatch

Batch Initialization
You must initialize each batch before you can run it. The
initialization process involves validating 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
equipment requirements are satisfied by the train, and
verifying that the Process Model database is compatible with
the recipe.

Batch and Unit Management

The Batch Manager directs and supervises the processing of
each batch. The Batch Manager interprets recipes and
enables the control system. Based on the recipe procedure,
blocks of control software, referred as phase blocks, are
signalled to run by the Batch Manager. Phase block control
logic, located in the control system, controls the process.
Before enabling each phase block, the Batch Manager
verifies that the phase block is ready to be processed. If so,
phase parameter values are downloaded to the block, and the
block starts.
The Batch Manager also interacts with batch display
programs. The batch display programs provide operators
with information about all batches that are initialized or
running in the system. Through these displays, operators can
put a batch or phase on hold, as well as restart and cancel
batches or phases. Operators can change phase parameter
values, acknowledge the processing of phases, review phase
interlock statuses, and enter comments while the batch is
running.
The Batch Manager coordinates how process units are used
for each batch. The Batch Manager can run a large number
of batches simultaneously. Each batch is a separate entity
and contends along with other batches to possess the process
units it needs. The Batch Manager allocates ownership of
units to batches as units become available and releases units
when the batch no longer requires the unit.
In flexible batch systems that use controllers, the
supervisory workstation becomes an active participant in
processing a batch. Unit management is very sophisticated in
a flexible batch system. Most controllers do not have the
ability to program a unit manager that is capable of
interpreting and processing the recipe procedures that are
constructed in the batch control system.

InBatch User’s Guide

Overview25

A master recipe uses classes of process units, not specific

units. Thus, phases pertain to a class of units rather than a
specific unit. When the Batch Manager runs 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 the units that can be used. The Batch Manager
automatically converts the master recipe to a control recipe
based on the units found in the train.

History
Batch Manager captures and stores all processing and
operator activity when a batch runs.

Batch History
InBatch uses Microsoft SQL Server for its historical
database.
The batch management system logs all information related to
the production of a batch to the history database. This data
includes all 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
InBatch uses Wonderware® Information Server (WIS) for
reporting. WIS provides a flexible and open platform so that
you can easily build custom reports. You can use a set of
pre-defined report templates to design reports.
You can retrieve batch reports using the run-time reporting
system. You can automatically trigger reports while a batch
runs or at the end of a batch.

InBatch User’s Guide

26  Chapter 1 Overview of InBatch

InBatch Integration
InBatch integrates with a number of other Wonderware
applications.

Tag Management
InBatch interfaces to other Wonderware components like
InControl™, I/O servers, DAServers, and InTouch® software
through tags. Also, you can integrate InBatch with the
Wonderware Application Server and leverage the full
capabilities of both components to extend the boundaries of
the implementation.

Model Editor
Use the Model Editor 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 InBatch to communicate with PLC or DCS
systems.

TagLinker
Use the InBatch TagLinker to link the tags you create in the
Model Editor to control system addresses. The TagLinker
provides capabilities to link tags automatically using default
links, manually through the graphical user interface, or by
external interfaces using a comma separated variable format
import or export file. The TagLinker also validates model
tags.

Tag Communications
InBatch communicates with other applications or
components through OPC, Suitelink, or Message Exchange
(MX). Tag communications are used to interface to unit
control logic, phase logic, and operator displays. The Phase
Logic and TagView tools are available to diagnose,
troubleshoot, and exercise tags communications.

Phase Logic Testing Tool (PhaseLogic)

Use the Phase Logic tool to test and exercise the handshake
interface between the Batch Manager and the control system
phase logic. PhaseLogic is a testing tool and should not be
used during normal operation.

TagView Tool
Use the TagView tool to monitor InBatch tags at run time.

InBatch User’s Guide

Terminal Services Support27

Batch Alarms
Batch alarms are captured, associated with a batch, and
stored in the history database. The Unit or Connection Name
parameter of the tag is the key in accomplishing this. All
alarms from a designated InTouch application are monitored
by the batch control system. If the first portion of the tag
name corresponds to a unit, connection, or segment name in
the InBatch model, the alarm is automatically logged to the
InBatch history and associated to the batch that was active
in the named equipment at the time of the alarm.

Terminal Services Support

InBatch supports Terminal Services. Terminal Services
allow InBatch development clients and InBatch run-time
client applications to run on a terminal server in such a way
that the client computers themselves function as terminals
rather than independent systems. The server provides a
multi-session environment that runs the InBatch
applications and other Windows-based programs on the
clients.
Because all the InBatch software is resident on the terminal
server, you do not need to install InBatch client software on
remote systems. For any application that requires upgrade or
modification, Terminal Services is an efficient, highly
manageable way to provide user workstations with the most
current version of the application.

Extensibility
InBatch includes ActiveX objects, ActiveX Servers, and a
library of API functions that allow integration with external
applications such as ERP and scheduling systems. You can
develop custom applications that access the batch control
system that share and exchange formulas and recipes,
materials, and production results.
InBatch uses Microsoft SQL Server for its historical
database.
These features make it easy for you to integrate with
enterprise resource planning (ERP) and advanced planning
systems (APS), by allowing InBatch to be a key link in
successful supply chain management initiatives.

InBatch User’s Guide

28  Chapter 1 Overview of InBatch

Managing InBatch Configurations

When you install the InBatch server software, a default
folder structure is created. We recommend that you do not
modify this structure except for the configuration folder.
The InBatch configuration that you create is located in the
InBatch\cfg\config_A folder. When InBatch runs, it must
find your configuration in the config_A folder. If you intend to
develop other configurations, you should create a different
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.

InBatch Programs
InBatch programs include configuration programs, run-time
programs, and utility programs.

Configuration Programs
You can use the following configuration programs to develop
and manage your batch system.

Environment Editor (EnvEdit)

(Required) Use the Environment Editor to define the batch
configuration and run-time applications that are to be run.

Process Model Editor (ModelEdit)

(Required) Use the Process Model Editor to create a Process
Model database. Only one Process Model Editor can run in a
system at a time.

Tag Linker Editor (TagLinker)

(Required) Use the Tag Linker Editor to associate InBatch
tags with a control system. You can also use the Tag Linker
Editor to associate InBatch tags with InTouch tags. The Tag
Linker also exports InBatch tags to a comma-separated
variable file that populates the InTouch tag dictionary with
memory and I/O tags.

Train Editor (TrainEdit)

(Required) Use the Train Editor to create production lines on
which batches are scheduled.

InBatch User’s Guide

InBatch Programs29

Materials Editor (MaterialEdit)

(Required) Use the Materials Editor to create and edit a
Materials database both online or offline. You can run
multiple Materials Editors in a system to enable multiple
users to edit the same database simultaneously.

Recipe Editor (RecipeEdit)

(Required) Use the Recipe Editor to create and edit a recipe
database both online or offline. You can run multiple Recipe
Editors in a system, which enables multiple users to edit the
same database simultaneously.

Process Log Editor (LogEdit)

(Optional) Use the Process Log Editor to create, edit, and
print batch-related data logging configurations.

Batch Reporting (BatchReport)

(Optional) Use the BatchReport icon to open a web browser
that provides access to the InBatch web-based reporting
system.

Security Editor (SecEdit)

(Optional) Use the Security Editor to define InBatch system
users, user security roles, user access, and recipe access for
each user and to enable or disable applications and functions
that require security.

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

Environment Manager (EnvMngr)

(Required) The Environment Manager manages the
processing of the InBatch 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 single interface for
starting and stopping all InBatch system GUI applications.

Note When the User Account Control (UAC) is enabled in the

operating system, the component prompts you to grant
administrative privileges when you start the Environment Display
Module. The UAC prompt appears whenever administrative
privileges are required. For more information, see Chapter 22,
System Administration.

InBatch User’s Guide

30  Chapter 1 Overview of InBatch

Log Viewer
(Optional) The Log Viewer displays messages for all system
activity, including the InBatch server, run-time clients and
development clients such as startup, shutdown, warnings
and errors, as well as time and date stamps.

Unilink Manager (UnilinkMngr)

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

InBatch Client (IBCli)

(Required) The InBatch Client (IBCli) is the link to I/O
servers that communicate with plant-floor systems, including
programmable logic controllers (PLC) and distributed control
systems (DCS). IBCli communicates with tag server
components using OPC, or SuiteLink protocols.

Note The latest Windows operating systems do not support the

NetDDE protocol.

InBatch Message Exchange (IBMX)

(Required if using Galaxy data) The InBatch Message
Exchange (IBMX) is the link to Galaxy data using
Wonderware Application Server. It enables mapping InBatch
Tags with Galaxy attributes to transfer data between both
environments. The communication between InBatch and
Wonderware Application Server uses the Message Exchange
protocol.

Memory Tag Manager (MemTagMngr)

(Required) The Memory Tag Manager generates all InBatch
memory tags, including the system tags, for all the
equipment in the process model.

Simulation Manager (SimMngr)

(Required for Simulation) The Simulation Manager replaces
the communication drivers for an InBatch system and
enables the system to be run without the presence of control
system hardware.

Information Manager (InfoMngr)

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

InBatch Server (IBServ)

(Required) This run-time server application enables
SuiteLink client applications (such as InTouch) to use control
system tags.

InBatch User’s Guide

InBatch Programs31

InBatch Function Server (IBFServ)

Note InBatch 8.1 is the last release to support batch function
tags. We strongly suggest you use the BatchHook Active X
automation server interface for customizing the batch engine.

Batch Manager (BatchMngr)

(Required) The Batch Manager interacts 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 processes all recipes,
manages unit allocation, moves batch information to the
history database queue, and triggers reports.

Batch Scheduler (BatchSched)

(Optional) The Batch Scheduler interacts with the Batch
Manager. Use the Batch Scheduler to construct a schedule of
batches to be run. 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 processing of a single batch. Multiple batch
displays can run in a system.

Process Log Manager (LogMngr)

(Optional) The Process Log Manager controls the data
logging of any tag in the system according to the logging
configuration.

Security Manager (SecMngr)

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

Recipe Automation Server (RecipeEdit)

The Recipe Automation Server is an integral part of Recipe
Editor and is installed on the InBatch server and the InBatch
development client. For more information, see the InBatch
COM Technical Reference Guide.

Batch Talk ActiveX Control (OCXBATCH.OCX)

The OCXBATCH.OCX is a background server supporting
ActiveX technology that includes all functionality provided
by the Batch Talk API. This server is installed in the InBatch
server, run-time client and development client. For more
information, see the InBatch COM Technical Reference
Guide.

InBatch User’s Guide

32  Chapter 1 Overview of InBatch

Recipe Procedure SFC Active X Control

(INBATCHSFC.OCX)
The SFC ActiveX Control is a GUI-based control for the
recipe procedure. This control is installed in the InBatch
server, run-time client, and development client. For more
information, see the InBatch COM Technical Reference
Guide.

Material Automation Server (MATERIALSVR.EXE)

The Material Automation Server provides access to the
Material database using ActiveX technology. This server is
installed in the InBatch server, run-time client, and
development client. For more information, see the InBatch
COM Technical Reference Guide.

Batch Function Interface Type Libraries

(BATCHOBJSRV.DLL & BATCHVBSERVER.DLL)
You can use the Batch Function Interface Type libraries to
construct a Batch Manager in-process server. The libraries
provide access to the key events during batch processing. For
more information, see the InBatch COM Technical Reference
Guide.

Tools
Use the following tools to assist your development and
run-time processes.

Phase Logic Testing Tool (PhaseLogic)

(Optional) The Phase Logic testing tool permits individual
phase processing independent of any batch operation.

Change Password (ChgPwd)

(Optional) Use the Change Password tool to interact with the
security system from the command line to change an
employee’s password. The Change Password utility is part of
the security system.

TagView Utility (TagView)

(Optional) The TagView application permits you to monitor
and change any of the InBatch equipment.

InBatch User’s Guide

InBatch Configuration Architecture33

InBatch Configuration Architecture

The following diagram shows the InBatch configuration
architecture.

ModelEdit TrainEdit MaterialEdit RecipeEdit ReportEdit

CfgModelDB RecipeDB ReportDB

MaterialDB

TagLinker EnvEdit SecEdit LogEdit

LinkDBImp/Exp

CfgLinkDB DBLoadFiles EnvDB SecurityDB LogDB

InBatch User’s Guide

34  Chapter 1 Overview of InBatch

InBatch Run-time Architecture

The following diagram shows the InBatch run-time
architecture.

InBatch User’s Guide

I/A Series Differences35

I/A Series Differences

Starting with InBatch 9.0 with SP1, I/A components can be
installed on non-I/A systems. In such cases, any updated
models placed in the Config_A folder can be subsequently
moved to systems where I/A Series is installed.
The following information is applicable to I/A Series only.

I/A Series Integration

The following topics are applicable only to I/A Series.

I/A Series Tag Management

I/A Series Batch interacts with other I/A Series Control Suite
components such as Control Processors and FoxView
software through tags. Several I/A Series Batch components
create, edit, link, validate, communicate, and generally
manage 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 is used to interact with unit control logic, phase
logic, and operator displays. Two utilities or tools are
available to diagnose, troubleshoot, and exercise tag
communications between I/A Series Batch and I/A Series
Control Suite.

Process Status (ProcStatus) Tool

You can use the ProcStatus tool 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. 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 compound or block in the I/A Series
control station. When the Batch Manager allocates
equipment to a batch, it writes the Batch ID to the system
tags of the equipment. These tags are linked to the
COMPOUND.LOOPID parameter of the equipment. When
alarms occur in the compound, an alarm message is sent to
I/A Series Batch, where it is stored in the history database
and annunciated in FoxAlert.

InBatch User’s Guide

36  Chapter 1 Overview of InBatch

The I/A Series Batch Display can start FoxAlert so that you
can view the alarms for a selected batch. Additionally, from
FoxAlert, you can select an alarm and append a comment to
it using the Alarm Comment Editor.

I/A Series Batch Programs

The following batch programs are either different from
InBatch or have different names.

I/A Series Link Editor (IALink) – Configuration

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

I/A Series Tag Driver (IADriver) – Run-Time Program

(Required for run time) The I/A Series Tag Driver (IADriver)
uses the FoxAPI to read and write tags between I/A Series
Batch components and I/A Series Control Suite components,
such as FoxView software and control stations.

System Tag Manager (SysTagMngr) – Run-Time

Program
(Required) The System Tag Manager generates the system
tags for all the equipment in the process model.

Batch Logger (wwlogvwr) – Run-Time Program

(Optional) The Batch Logger shows messages for all system
activity for the InBatch server, run-time clients, and
configuration clients, such as startup, shutdown, warnings,
and errors, as well as time and date stamps.

Alarm Comment Application (CommentApp) –

Run-Time Program
(Optional) The Alarm Comment application starts from
FoxAlert after a batch alarm is selected. Operators use this
application to enter comments that are appended to batch
alarms.

ProcessStatus (ProcStatus) – Utility Program

(Optional) Use the ProcessStatus application monitor and
change any of the I/A Series InBatch equipment tags.

InBatch User’s Guide

I/A Series Differences37

I/A Series Batch Configuration Architecture

The following diagram shows the I/A series batch
configuration architecture.

ModelEdit TrainEdit MaterialEdit RecipeEdit

CfgModelDB MaterialDB RecipeDB

LogEdit EnvEdit SecEdit

SecurityDB EnvDB SecurityDB

TAGMAP

IALink
CfgIALinkDB

STRMAP

InBatch User’s Guide

38  Chapter 1 Overview of InBatch

I/A Series Batch Run-time Architecture

The following diagram shows the I/A Series batch run-time
architecture.

RecipeEdit MaterialEdit EnvMngr

EnvDB

Lock Manager
.BatchWR (lm_tcp)
RecipeDB MaterialDB BatchDB

BatchSched
(OCX Batch)

InfoMngr BatchMngr
SQL
Server
BatchDispl
(OCX Batch,
SFCOCX)

Batch History
TrainEdit UniLinkMngr SysTagMngr
ModelDB

SimMngr LogMngr
IADriver
IALinkDB

LogDB

IA Series
ControlState

InBatch User’s Guide

Chapter 2

Environment Management
System

Use the Environment Management System to manage the

running of applications within the batch system. The system
consists of the following components:
• The Environment Editor. Use the Environment Editor to
configure the applications that run on the batch server.
• The Environment Manager. Use the Environment
Manager to start and stop applications, manage
databases, and control the system.

• The Environment Display. Use the Environment Display

to interact 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.

InBatch User’s Guide

To stop the Environment Display

 On the File menu, click Exit.

Terminating a Batch Application

You can terminate applications that failed to start or stop in
the batch system (the default timeout is two minutes). You
can select the Terminate App option only when applications
are available for termination.

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

Note By default, the Environment Manager waits 120 seconds

before declaring that an application is available for termination.
It may be necessary to increase this system timeout value. For
more information on changing the default system timeout value,
see Setting the Environment System Timeout on page 64.

InBatch User’s Guide

44  Chapter 2 Environment Management System

Stopping All System Components

You can stop the Environment Display, Environment
Manager, Security Manager, History Queue Manager,
database Lock Manager (lm_tcp), all active batch system
applications (such as Model Editor and Recipe Editor) and all
active run-time applications.

Important An Exit and Shutdown command completely stops the

batch system. If you are not logged on to the operating system
with administration privileges, you cannot 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 Exit
and Shutdown function using the security system.

To exit and shut down all system components

 On the File menu, click Exit and Shutdown.
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.
For more information on configuring security, see
Configuring Security Modes on page 523.

Re-Initializing the Environment

You can re-initialize the Environment Manager 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.

To edit system parameters

1 Start the Environment Editor.
2 On the Edit menu, click System Parms.
The Edit System Parameters dialog box appears.

3 In the Parameters list, select the item that you want to

edit.
4 In the Value box, type the required value in accordance
with the table below.

Parameter Description

Max locked files The maximum number of database files under lock
manager control. The default is 256.
Max locks in queue The maximum size of the file lock request queue. The
default is 128.
Max users The maximum number of users lock manager may control.
The default is 32.
Redundancy Time-out The number of seconds that the backup computer waits
when a communication failure occurs before it becomes a
master (applicable to redundant systems only).
User ID Time-out The number of seconds that the current User ID is
retained before it must be reentered. The default value of 0
retains the User ID indefinitely.
Number Recipe Levels Number of levels to the recipe procedure. Valid values are
2 and 3. The default is 3.
Allow Sync Approvals Allows the Recipe Edit user to optionally retain all recipe
approvals when syncing recipes. Options are 1 or 0. A
value of 0 completely removes this feature from
RecipeEdit. The default is 1.

InBatch User’s Guide

52  Chapter 2 Environment Management System

Parameter Description

Default Domain Determines the default domain that appear in most dialog
domain or user boxes. However, all domain or user boxes
are editable. For the default domain name to be enabled,
you must exit and shut down the Environment Display.
Debug OS Security Determines the amount of information stored in the
WWLogger. A value of 1 records detailed OS security event
information in OS security mode concerning the user or
domain. A value of 0, which is the default, records only
basic user information in OS security mode. For more
information on security, see Security System on page 517.
Max Shutdown Time Determines the maximum allowed time in seconds to
properly shot down all services. We suggest setting this
value to 120.

5 Click Change.
If you do not click Change, the values that you entered do
not update.
6 Click Close.

Note System parameter changes do not take effect until you shut
down and restart your batch system.

Adding Applications to the Environment

You can 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 message
appears.
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
characters maximum) should describe the purpose of the
application.
Application names, including instances, appear as icon labels
in the Environment Display dialog box. They are also listed in
the Runtime Application Display dialog box.

InBatch User’s Guide

Adding Applications to the Environment53

When you add an instance, a unique name is automatically

Parameters Description

Seconds per Phase Length of time for which each new phase runs. The default
value is30 seconds.
Write R/O Tags Enables writing to read-only tags in the batch system.

Process Log Manager (LogMngr)

The following table lists the parameter and its description for
Process Log Manager.

Parameters Description

ProtTimer (msecs) I/O Server toolkit setting.

Verbose Mode Enables extensive messaging for IBFServ application errors
and information.

InBatch User’s Guide

60  Chapter 2 Environment Management System

InBatch Server (IBServ)

The following table lists the parameters and their
descriptions for the InBatch Server.

Parameters Description

ProtTimer (msecs) I/O Server toolkit setting.

Verbose Mode Enable extensive messaging for IBServ application errors and
information.

InBatch MX Service(IBMXService)
The following table lists the parameters and their
descriptions for the InBatch MX service.

(optional), and select Client Of and Server To designations
(optional).

Note The Name must be unique from all other applications in the
environment. If the Name is not unique, the environment
database might become corrupted.

InBatch User’s Guide

Adding Custom Applications and System Parameters63

3 Select a Type from the list.

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 Runtime Applications Display dialog box. The
order that the applications are listed is essential for proper
batch system operation. Editors do not appear in the Runtime
Application Display dialog box and are placed at the end of the
Applications list in the Add Applications dialog box.

User-Defined Application Parameters

You can define parameters for your application. These
application parameters are available for selection in the
Assign Applications Parameters dialog box after the your
application is added to the environment system.

To add parameters to a user-defined application

1 On the User Defined Applications dialog box, click Edit
Parameters.
The User Defined Application Parameters dialog box
appears.

InBatch User’s Guide

64  Chapter 2 Environment Management System

2 Type a Name (20 characters maximum), optional

Description (120 characters maximum) and
Parameter value.
You can assign multiple parameters to your applications.
3 If your application requires parameters, select the
Parameter Required check box.

Using the Environment Manager

The Environment Manager is an operating system service
that manages batch system application processing.
Use the Environment Manager to start up and shut down the
following functions:
• Database Lock Manager (lm_tcp)

• Security Manager

• Redundancy Manager (if enabled)

• Any batch system run-time application

If you successfully install the batch system, the Environment

Manager starts automatically when your computer starts. If
you exit and shut down the batch system, the Environment
Manager restarts when the Environment Display initiates.

Setting the Environment System Timeout

By default, the Environment Manager assumes that an
application is available for termination if it has not started
after 120 seconds. For most applications associated with the
Batch System, the timeout value of 120 seconds is sufficient.
However, run-time applications such as IBCli sometimes
require a longer period of time on larger systems to properly
start. The length of time required varies depending on your
particular application and the number of tags associated
with IBCli. Unless you are experiencing a conflict as a result
of an insufficient timeout, we recommended that you do not
change the default value.

Note Changing the Timeout value has a global effect; that is,
Environment Display waits the specified amount of time before it
reports any application that is available for termination.

InBatch User’s Guide

Automatic Startup and Shutdown of Run Time65

To change the Environment System timeout

1 Open the Control Panel.
2 Double-click the System icon.
The System Properties dialog box appears.
3 Click the Environment tab.
4 In the System Variables list, add a variable named
TIMEOUT, and type the required Value (integer value in
seconds).
5 Click Set and then click OK.
6 To enable the change of the Timeout value, you must shut
down and restart Windows.

Automatic Startup and Shutdown of Run Time

This section describes how you can automatically start up or
shut down your batch system without the intervention of a
person. Normally, you would use Runtime Application of the
Environment Editor to do this. In some instances, however,
you might need to start up or shut down your batch system
when no employees 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.

Automatic Shutdown Requirements

The main requirements for automatic shutdown in a batch
process are:
• The Batch Server computer must be connected to an
uninterruptable power supply (UPS), which maintains
power to the server computer for a minimum of five
minutes.
• The server software must recognize external commands
initiated from the UPS that allow it to shut down
gracefully with no manual intervention.
• On computer restart, either through power restoration or
manually, the batch system must completely restart
run-time operation with no manual intervention.

InBatch User’s Guide

66  Chapter 2 Environment Management System

Using the etcmds.exe Program

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 coordinating these two phases as
part of the recipe procedure. Coordination of unit-to-unit
management is the responsibility of the operator or control
system.
Proper material tracking within a connectionless transfer
requires the definition of input parameters 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 connectionless models. It allows you
to configure a process in a way that maximizes the benefits of
both approaches by providing all of 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 of 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 71.
The most beneficial advantage of the hybrid approach 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.

InBatch User’s Guide

Types of Process Models73

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

Approach Benefits Liabilities Usage

Comprehensive Automatic unit-to-unit Possibility of many Mostly

Model batch management connections and associated static
Complete material connection tags for flexible (fixed)
genealogy paths transfers
Intuitive for recipe
builder and operator
Assignment of bulk
material sources for
automatic lot tracking
One phase to conduct
material transfers
minimizes recipe
complexity
Connections and
segments provide some
automatic interlocking
functionality when
moving materials
between units
Connectionless Complete material Requires complementary Totally
Model genealogy process phases in recipes dynamic
Eliminates many for all material movement transfers
connections and More training for recipe
connection tags for builder and operator
flexible paths Operator or control system
must guarantee the
coordination of units
Requires extensive control
system logic and
interlocking when moving
materials between units
Automatic tracking of input
materials requires
definition of parameters for
the source process phase
Automatic tracking of
output materials requires
definition of parameters for
the destination process
phase

InBatch User’s Guide

74  Chapter 3 Process Modeling

Approach Benefits Liabilities Usage

Hybrid Model Complete material Liabilities of Partially

genealogy comprehensive and fixed and
Minimizes flexible connectionless models are partially
connections and present for areas defined flexible
preserves static with and without transfers
connections connections
Benefits of
comprehensive and
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.

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 X X X
define attributes.
5. Define all connections between X
units.
6. Define all fixed connections between X
units.
7. Group connections into transfer X X
classes.
8. Define the phases of each process X X X
class.
9. Define the phases of each transfer X X
class.
10. Define the segments and assign to Optional Optional
connections.

InBatch User’s Guide

Process Modeling Components75

Modeling Steps Comprehensive Connectionless Hybrid

11. Define the possible equipment X X X

statuses that units and segments can
assume.
12. Define Tags for transferring the X X X
specific phase data points between the
batch and control systems.
13. Develop phase logic. X X X

Process Modeling Components

The following section describes components of the process
model.

Units
A unit is a group of processing equipment that performs one
of the following functions.
• The unit processes materials. Examples are reactors,
mixers, blenders, and retorts.

• 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.

Process Classes (Processes)

A process class is a group of units. Each unit in the class has
the same processing capabilities 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 can 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.

InBatch User’s Guide

76  Chapter 3 Process Modeling

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 InBatch 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 flow meters that transfer materials from a
source unit to a destination unit. When you configure the
process model, you must define all connections between
units. Some processes may have more than one connection
between the same two units. In this case, you define each
connection separately.

Transfer Classes (Transfers)

You must assign each connection to a transfer class. Transfer
classes are similar to process classes, except where process
classes are associated with units transfer classes are
associated with connections. 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 Ingredient 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.

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 processing of a phase. You can
construct phase logic to automatically accommodate formula
parameter values received during run time. Parameter
values originate within a recipe.

InBatch User’s Guide

Process Modeling Components77

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

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, discharge, heat, and mix.

Manual Phases
Manual phases are executed by the InBatch Management
System in conjunction with an operator. The control system
is not involved in the processing 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 be defined only for transfer phases.
Successful processing 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.

InBatch User’s Guide

78  Chapter 3 Process Modeling

Data Phases (InBatch Only)

Data phases are processed by the InBatch Management
System. They have no phase control or status tags for
handshaking with the control system and do not require
operator acknowledgement. They do not have control button
capability but do allow formula parameter assignments.
When a data phase is encountered during batch processing,
the InBatch manager automatically writes (downloads) all
parameter values to the control system.

Note Data phases are intended to be used to write a target value

to a controller. If the process model has only parameter target
tags created, the target value is written to both the Target and
Actual in history. If Actual tags have been created in the process
model, the Actual value from the controller is written to history.

Class Class Type Phase Phase Type

BulkBlnd Transfer BulkAdd Automatic

DrumBlnd Transfer DrumAdd Semi-Automatic
Blenders Process Blend Automatic
BlndCook Transfer Discharg Automatic
Cookers Process AgitOn Automatic
AgitOff Automatic
Heat Automatic
Cool Automatic
Soak Automatic
Sample Manual
CookHold Transfer Discharg Automatic

InBatch User’s Guide

Process Modeling Components79

Download Phases (IA Series Only)

Download phases are run by the Batch Management system.
They have no phase control or status tags for handshaking
with the control system and do not require operator
acknowledgement. They do not have control button capability
but do allow formula parameter during batch processing, the
batch manager automatically writes (downloads) all
parameter 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, the Target value is written to both the Target
and Actual in history. If Actual tags have been created in the
process model, the Actual value from the controller is written in
history.

Class Class Type Phase Phase Type

BulkBlnd Transfer BulkAdd Automatic

InBatch User’s Guide

80  Chapter 3 Process Modeling

Phase Logic
Phase logic refers to the steps and sequences in a control
system that are exercised during the processing of a phase.
Phase logic makes the control system program very
structured. Phase logic 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
or semi-automatic phase defined for each connection
assigned to a transfer class. The logic for each can be
identical; however, the physical I/O and internal address
assignments are different for each blender in the class.
Manual phases are processed by the InBatch Management
system through interaction with operators and do not require
phase logic.
The following diagram shows the structured interface
between phase logic and the InBatch Management system.

InBatch User’s Guide

Process Modeling Components81

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 control 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 parameters are used to define and track
material transfer quantities. Process variable parameters
define set points. 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 Control Bits

Phase control and status control bits are used by the InBatch
Management System during run-time to control and monitor
the processing of each phase.

Interlocks
Each phase logic block may require interlocks. Interlocks
provide safety and security for personnel and equipment by
preventing the processing of a phase when other equipment
or operators are not ready. You can assign all tags within the
system as an interlock to a phase. There is no limit to the
number of interlocks that you can assign 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 showing the status of
interlocks.

Control Buttons
Operators use control buttons to initiate or alter process
actions during phase processing. Control buttons are
included in user interfaces for batch processing displays.
Each phase has two available control buttons. Control
buttons are associated with the values of discrete tags.

InBatch User’s Guide

82  Chapter 3 Process Modeling

A summary of all phase parameters is shown in the following

table.

Parameter Type Elements

Transfer Phase Control the Model Editor
Buttons automatically creates one
Transfer Phase Control Bits 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
Class Process Phase Formula internal batch control system
Parameters tags and are updated by the
Transfer Phase Formula InBatch Management
Parameters System.
Note 2: System Class tags
Recipes: are automatically generated
Transition Logic for each process and transfer
class defined in the process
model.
System All SCADA Applications No Note 1: System Unit tags are
Unit automatically created for
each unit assigned to a
process class.
System All SCADA Applications No Note 1: System Connection
Connection tags are automatically
created for each connection
assigned to a transfer class.
System All SCADA Applications No Note 1: System Segment tags
Segment are automatically created for
each defined segment.

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

InBatch User’s Guide

86  Chapter 3 Process Modeling

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 correspond to a specific address in a
control system. Process tags are indirectly associated to the
control 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 system. Process tags
represent a set of unit tags. Process tags become unit tags
when a batch is executed in a process. Process tags can 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 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 executed in a process. Transfer tags may be
used as part of recipe transition logic.

InBatch User’s Guide

Process Modeling Components87

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

• System segment tags

System class tags are identical to process and 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.
The following table shows the system class tagnames for
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 unit is allocated to.
Last_Recipe_ID ID of last recipe produced within unit.

InBatch User’s Guide

88  Chapter 3 Process Modeling

Description System Class Tagname Data/Information

Lot_ID Lot ID of batch unit is allocated to.

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 connection is allocated to.
Campaign_ID Campaign ID connection is allocated to.
Last_Recipe_ID ID of last recipe produced within
connection.
Lot_ID Lot ID connection is allocated to.
Segment Allocation Possible Values:
Information Ready
Allocated
Batch_ID Batch ID segment is allocated to.
Campaign_ID Campaign ID segment is allocated to.
Last_Recipe_ID ID of last recipe produced within
segment.
Lot_ID Lot ID segment is allocated to.
Status Current status of segment. Possible
values are defined by user in the
Equipment Status tab within the process
model editor.

InBatch User’s Guide

Process Modeling Components89

Using Process and Transfer Tags versus Unit and

Connection Tags
The following guidelines can help you decide when to define a
tag as a process, transfer, unit, or connection tag.
• Any data point that is common to all units in a process
class can be entered as a process tag.
• Any data point that is common to all connections in a
transfer class can be entered as a transfer tag.

• Any data point that is not common to all units in a

process class must be entered as a unit tag.

• Any data point that is not common to all connections in a

transfer class must be entered as a connection tag.
• Any data point that is to be used in recipe transition logic
must be entered as either a process or transfer tag.
• 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 InBatch Management System
to control, monitor, and configure a phase based on the
requirements of a recipe.

The following table lists the critical phase logic data

points.

Item Data Point

Phase Control Bits Start

Hold
Restart
Abort
Reset
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

InBatch User’s Guide

90  Chapter 3 Process Modeling

Item Data Point

Formula Parameter Elements: Target

Input Actual
High Deviation (%)
Low Deviation (%)
Preact
Lot Code
Material ID
Formula Parameter Elements: Target
Output Actual
Material ID

Working with Tags

A tag consists of a structured name. Each tagname must be
unique within the batch control system. The terms tagname
and tag are used throughout the documentation to refer to
tags in the process model.
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.

Tagname Structure
The following table shows the tagname structure.

Number of
Name Characters

Unit or Connection, Process Class or 16

Transfer Class
Phase Name 16
Parameter Name 16
Element Name 5
Attribute Name (InTouch dot field) 16

InBatch User’s Guide

Working with Tags91

Valid Characters for Tagnames

You can use the following characters in a tagname:
• A through Z
• a through z

• 0 through 9

• !,@,?, #, $, %, _, &

Delimiters
The following table shows the delimiters for tagnames.

Delimiters

Item InTouch ArchestrA

Between Names dash (-) period (.)

Before Attribute period (.) period (.)

Automatically Generated Tagnames

The following table shows tagnames that are automatically
generated.

Automatically
Tag Appended
Classification Parameter Name Element Name Description

Unit System Not used CAMPN Campaign ID

Tags LOTID Lot ID
BATCH Batch ID
RECID Recipe ID
RECNM Recipe Name
BATSZ Batch Size
BATST Batch Status
BATMD Batch Mode
USTAT Unit Status
ALLOC Unit Allocation
LASTR Last Recipe ID
USTATE Unit State
Connection Not used CAMPN Campaign ID
System Tags LOTID Lot ID
BATCH Batch ID
AVAIL Connection
ALLOC Availability
LASTR Connection Allocation
Last Recipe ID

InBatch User’s Guide

92  Chapter 3 Process Modeling

Automatically
Tag Appended
Classification Parameter Name Element Name Description

Segment Not used CAMPN Campaign ID

System Tags LOTID Lot ID
BATCH Batch ID
USTAT Segment Status
ALLOC Segment Allocation
LASTR Last Recipe ID
Phase Control CONTROL_STATUS START Start
Tags HOLD Hold
RSTRT Restart
ABORT Abort
RESET Reset
Phase Status CONTROL_STATUS READY Ready
Tags HELD Held
RUN Run
DONE Done
ABRTD Aborted
INTLK Interlocked
Unit Control Not used UHOLD Unit Hold
Tags URSTR Unit Restart
UABRT Unit Abort
Phase Parameter Name ACT Actual
Parameter TAR Target
Tags HIDEV High Deviation
LODEV Low Deviation
HILMT High Limit
LOLMT Low Limit
PRACT Preact
LOTCD Lot Code
MATID Material ID

InBatch User’s Guide

Working with Tags93

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 can have many states. String tags are
identified by an alphanumeric value and may contain up to
80 characters. Enumeration tags are identified by an integer
value which represents a textual enumeration name.

Access Mode
Access Mode defines whether a tag is Read-only or
Read/Write. A check box is used to select the access mode for
a tag.

InBatch User’s Guide

94  Chapter 3 Process Modeling

Process Modeling Summary

The following figure shows a summary of the process model.

Trains
A group of units on which
a recipe is processed.

Connections
Each connection consists
of a source unit and a
destination unit.

Process Classes Equipment Status Transfer Classes

A group of units that User-defined state of a A group of connections
have the same processing unit or a segment. where the source units are
capability or function. in the same class and the
destination units are in the
same class.

Segments
A division of a
connection.

Process Tags Process Transfer Transfer Tags

Tags that define process Capabilities Capabilities Tags that define transfer
phase control, status, Capabilities defined Capabilities defined phase control, status, control
control button, and formula by phases by phases button and formula
parameters for a process and parameters. and parameters. parameters for a transfer.
class. Process tags Transfer tags are connection
are unit independent. independent.

Unit Tags Segment Tags Connection Tags

Example Plant
The following diagram shows an example plant structure.

Bulk Bulk Bulk

Tank 1 Tank 2 Tank 3

Water Supply

Material Add Material Add

Station 1 Station 2

Reactor A Condenser 1 Reactor B Condenser 2

Liquid/Oil Liquid/Oil
Separator 1 Separator 2

Mix Tank 1 Mix Tank 2

Receiving Receiving
Tank 1 Tank 2

Fill Station 1 Fill Station 2

Example Plant

InBatch User’s Guide

98  Chapter 3 Process Modeling

Using the Model Editor

Use the 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.
The Model Editor guides you and verifies, where possible,
that your entries and assignments are made correctly. It is
ultimately your responsibility to accurately define the
process model.

Copying Your Configuration to the Run-Time

Database
After all the configuration changes have been made, you
must use the Environment Display dialog box menu option
Update > Runtime to copy the Process Model configuration
database to the Process Model run-time database. This action
allows the run-time system to access the configuration
changes. Use the menu option Update > Configuration to copy
the Process Model run-time database to the Process Model
configuration database.

WARNING! Use caution when you update your configuration

from the Environment Display dialog box. When you update the
configuration, the Process Model configuration database is
overwritten by the Process Model run-time database. All
configuration changes are lost.

InBatch User’s Guide

Using the Model Editor99

Understanding Dialog Box Conventions

The following conventions apply to editors:
• Whenever you enter new elements you must click Add.
• If you make changes to an element, you must click
Change.

• To remove elements, click Delete.

The following conventions apply when you select items and

apply values in dialog boxes:
• Select and deselect list items by clicking the item. You
can select multiple entries by holding down the control
(or shift) key while simultaneously clicking the desired
items.
• After making your selection, click Apply if you want the
dialog box to remain open so that you can continue the
operation for other items.
• To apply your selections and close the associated dialog
box, clicking OK

• To close a dialog box after you have performed multiple

operations, click Close.

InBatch User’s Guide

100  Chapter 3 Process Modeling

Deleting Model Components

WARNING! When you delete a unit, process class, connection,
or transfer class, other elements of the overall process model
are also deleted. Always back up your work before you make
changes. The following table describes the effect of 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 All process tags associated with the class
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 All transfer tags associated with the transfer
Class 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, the train names in which the unit has been
assigned are be listed in the Log Viewer.

For more information on creating trains, see Opening the

Train Editor on page 260.

InBatch User’s Guide

Using the Model Editor101

Opening the Process Model Editor Dialog Box

Use the Process Model Editor dialog box to define and edit all
your process model.

To start Model Editor

 On the Environment Display dialog box, double-click the
ModelEdit icon.

Note The Model Editor dialog box does not open if you are
running the Train Editor or the TagLinker. You cannot start more
than one instance of Model Editor.

The Process Model Editor dialog box appears.

InBatch User’s Guide

102  Chapter 3 Process Modeling

Defining the Process Model (Units Tab)

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

To activate the units tab

 On the Process Model Editor dialog box, click the Units tab.
The Units tab becomes active. All the available units in
your process model are listed in the Units list. The
selected unit name appears in the Name box. Optional
information about the unit appears in the Description box.

InBatch User’s Guide

Using the Model Editor103

Adding and Editing Units

Follow these steps to add a unit to the process model or to
edit information about an existing unit.

To add or edit a unit

1 In the Name box, type a name for the unit (16 characters
maximum).
2 In the Description box, you can optionally type text that
describes the unit (120 characters maximum).
3 Click Add to include the new unit in the Units list or click
Change to update the unit.
The editor verifies all unit names to ensure validity and
uniqueness. You are be prompted to change the unit
name in the event you enter a duplicate.

Deleting Units
Follow these steps to delete a unit from the process model.

To delete a unit

WARNING! Deleting a unit affects other elements of the overall

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, a
warning box appears, and the unit is not deleted. In this
case, you must first delete the unit from the train, and
then delete the unit from the model.

InBatch User’s Guide

104  Chapter 3 Process Modeling

Associating Tags with a Unit

Each unit in a process model can have tags associated with
it. Use Edit Unit Tags dialog box to associate 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, 16 characters maximum)

• Parameter Name (optional, 16 characters maximum)

• Element Name (required, 5 characters maximum)

• Description (optional, 120 characters maximum)

• Data Class (required: Enumeration, Analog, Discrete, or

String)

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

Assigning Units to a Process Class

A process class can have one or more units assigned to it. Use
the Assign Units button on the Processes 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 Classes list.
All the units that are currently assigned to the selected
Process Class are shown in the Units list.

3 In the Value box, type the value of the attribute for the
selected unit.
4 Click Change.
The value appears in the Attribute and Value list.

InBatch User’s Guide

Using the Model Editor113

Defining Process Class Tags

Each process class may have tags associated with it. You
must use the Edit Process Tags dialog box to enter all the tags
that are associated with a process phase or that are common
to all of the units within the process class.
Enter the following information for a process tag:
• Phase Name (optional, 16 characters maximum)

• Parameter Name (optional, 16 characters maximum)

• Element Name (required, 5 characters maximum)

• Description (optional, 120 characters maximum)

• Data Class (required: Analog, Discrete, String, or

Enumeration)
• Access Mode (required: Either Read-Only or Read/Write)

• Attribute (optional, 16 characters maximum: select from

available InTouch dot fields)

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

Configuring Formula Parameters for Automatic

Process Phases
There are three types of formula parameters; input, output,
and process variable. Process variable parameters are used
to represent data such as set points and rates, input and
output parameters are used when material tracking is
required. Also, you must assign a specific data class type to
each formula parameter. The available data class options are
analog, discrete, string, and variable type parameters. 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 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. Elements define the
members of the family. The six elements for process variables
are Target, Actual, High Deviation, Low Deviation, High
Limit, and Low Limit.

InBatch User’s Guide

Using the Model Editor125

The configuration of the parameter type, data class, and

Each connection can consist of zero, one, or more segments. A
segment is a subsection of a connection, and can be shared by
more than one connection. Using segments is optional.
Before you can assign segments you must define them using
the Segment Editor.
For more information on defining segments, see Defining
Segments (Segments Tab) on page 168.

To assign a segment to a connection

Note If you have not assigned segments, the Segments list is

empty.

1 On the Connections tab, click Assign Segments.

The Assign Segments to Connection dialog box appears.

All available segments are shown in the Segments list

box. Segments that were previously assigned are selected
by default. In the example shown, the selected segments
are being assigned to the Bulk Tank1 to ReactorA
connection.
2 Select the appropriate Segments from the list.
3 Click OK.

InBatch User’s Guide

138  Chapter 3 Process Modeling

Associating Tags with Connections

Each connection in a process model can have tags associated
with it. Use the Edit Connections Tags dialog box to associate
tags with a connection. Connection tags are virtually
identical to unit tags, except that connection tags are
associated with the connections between units.
A connection tag consists of the following elements:
• Phase Name (optional, 16 characters maximum)

• Parameter Name (optional, 16 characters maximum)

• Element Name (required, 5 characters maximum)

• Description (optional, 120 characters maximum)

• Data Class (required: Analog, Discrete, String, or

Enumeration)

142  Chapter 3 Process Modeling

Editing Transfer Class Names

To edit a transfer class name

1 In the Name box, type a name for the transfer
(16 characters maximum).
2 In the Description box, you can optionally type text
describing the transfer (120 characters maximum).

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 use descriptive transfer names. These names
are referenced in the recipe procedure editor. Therefore, it is
helpful if the names describe the purpose of the transfer.
Your facility might have more than one type of connection
between the same two classes of equipment. This situation is
shown as a diagram in the ‘Example Plant section’ of Batch
Manager Resolves Process Tags into Unit Tags. 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.

To assign source and destination process classes

1 On the Process Model Editor dialog box, click Source
Process Class.
The Select Source Process Class dialog box appears.

2 From the Process Class list, select an appropriate process

class.
3 Click OK.

InBatch User’s Guide

Using the Model Editor143

4 Click Destination Process Class.

The Select Destination Process Class dialog box appears.

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 Assign Connections.
The Assign Connections to Transfer dialog box appears. All
unassigned connections, and any connections previously
assigned to a transfer that have source and destination
units belonging to the transfer source and destination
process class assignments, are shown in the list. All
previously assigned connections are selected.

2 Select the appropriate connections from the list.

InBatch User’s Guide

144  Chapter 3 Process Modeling

3 Click OK to assign the connections to the transfer.

In the this example, the source process class is Bulk
Tanks and the destination process class is Reactors. The
assignment dialog box lists 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.

Associating Tags with a Transfer Class

Each transfer class can have tags associated with it. Use the
Edit Transfer Tags dialog box to associate tags with a transfer
class.

Note It is important to remember that for every transfer tag that

you create, 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.
However, the transfer class tags are available to the recipe
builder through the transition logic expression builder.

A transfer tag consists of the following elements:

• Phase Name (optional, 16 characters maximum)

• Parameter Name (optional, 16 characters maximum)

• Description (optional, 120 characters maximum)

• Phase Type (required: Automatic, Semi-Automatic,

Manual, or Data)

• Control Buttons (optional, two available buttons)

• Interlocks (optional, available for all tags)

• Formula Parameters (optional, assign as required for the

phase)

• Save History (optional: Save Control/Status Activity, and

Parameter Status)
• Phase Control/Status (required for Automatic and
Semi-Automatic phases, Select/Assign tags to the phase
control and status bits)

To add or edit a transfer class phase

1 On the Transfers tab, click Phases.
The Edit Phases dialog box appears. All Phases previously
assigned to the Transfer Class are listed.

2 Type the appropriate Name and Description as described

earlier in this section.
3 Click the Phase Type arrow, and select Automatic,
Semi-Auto, Manual or Data as desired.
4 Click Add to include the phase in the list or click Change if
you have edited an existing phase.
5 Configure additional phase options as described in the
following text.

InBatch User’s Guide

148  Chapter 3 Process Modeling

Saving History Information

Use the Control/Status Activity and Parameter Status check
boxes in the Save History area to configure the type of phase
activity that is stored in the History database. All data stored
in the History database is stamped with the time and date.
You can enable both check boxes if required. The History
feature is optional.

To enable Save History options

1 In the Edit Phases dialog box, enable the Control/Status
Activity or Parameter Status check boxes.
• 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.

Configuring 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 data
type phases.

To configure control buttons

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

2 Enable Button 1 or Button 2 as required.

3 In the Label box, type the text (8 characters maximum)
that you want to appear on the button.

InBatch User’s Guide

Using the Model Editor149

4 Click Assign Tag.

3 Select the required tags from the list.

4 Click OK to assign the selected tags to the Tags list on the
Edit Transfer Interlocks dialog box.

InBatch User’s Guide

• Phase Name: DrumAdd (Semi-Automatic)

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 runs. 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.

Phase Interlocks
Phase Control/Status and
Phase Logic Parameters Formula 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- Yes Yes Quantity As Needed
Automatic

Configuring Formula Parameters for Automatic and

Semi-Automatic Transfer Phases
There are three types of formula parameters: input, output,
and process variable. Process variable parameters represent
data such as set points or rates. 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 process variable
parameter.
Input parameters have seven elements. The parameter name
defines a family of information. 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.

InBatch User’s Guide

Using the Model Editor157

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 information. 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 InBatch Management
System controls a phase and interact with both the control
system and the operator based on the configuration of the
parameters. The following information provides a detailed
explanation of the results that can be expected for different
parameter configurations.

Target Element
The target element is available for all parameter and data
class combinations.

To configure the Target element

1 If the target value is to be listed during the run-time
processing of the phase, select the Enable Display check
box. If a tag is assigned to the element, the value
assigned in the recipe is written to the control system by
the InBatch 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, select the
Edit Allowed check box.
3 If the operator must modify the target, select the Edit
Required check box.
4 You can assign a default value to the target element for
process variable parameters of any data class.

InBatch User’s Guide

158  Chapter 3 Process Modeling

Actual Element
The actual element is available for all parameter and data
class combinations.

To configure the Actual element

1 If the Actual value is to be listed during the run-time
processing of the phase, select the Enable Display check
box. If a tag is assigned to the element, the InBatch
Management System reads the value of the tag, in real
time, from the control system during the processing of the
phase.
2 If the operator is allowed to modify the actual value,
select the Edit Allowed check box.
3 If the operator must modify the actual, select the Edit
Required check box.

High and Low Deviation Elements

The high and low deviation elements are available for analog
process variable parameters and analog input parameters. If
tags are assigned, the InBatch 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 deviation value of 10.

To configure High and Low Deviation elements

1 If either of the element values is to be listed during the
run-time processing of the phase, select the appropriate
Enable Display check box. 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, select the Edit Allowed check box.
3 If the operator must modify either of the deviation
values, select the Edit Required check box.
4 You can assign a default value to the high and low
deviation elements for analog process variable
parameters only.

InBatch User’s Guide

Using the Model Editor159

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 InBatch Management System to prevent the
entry of out of range values. If tags are assigned, the InBatch
Management System writes the limit values to the control
system prior to the start of the phase.

To configure High and Low Limit elements

1 If either of the element values are to be shown during the
run-time processing of the phase, select the appropriate
Enable Display check box.
2 You can assign a Default Value can be assigned to the high
and low limit elements.

Preact Element
The preact element is available for analog input parameters.

To configured the Preact element

 If the Preact value is to be shown during the run-time
processing of the phase, select the Enable Display check
box.
If a tag is assigned to the element, the preact value
defined in the process model is written to the control
system by the InBatch Management System before the
phase starts.

Lot Code Element

The lot code element is available for analog input
parameters.

To configure the Lot Code element

1 If the lot code value is to be shown during the run-time
processing of the phase, select the Enable Display check
box.
2 If the operator is allowed to modify the lot code, select the
Edit Allowed check box.
3 If the operator must modify the lot code, select the Edit
Required check box.
4 If a tag is assigned to the element, the value assigned by
the operator or the control system is to be written to the
InBatch Management System during phase processing.

InBatch User’s Guide

160  Chapter 3 Process Modeling

Material ID Element
The material ID element is available for analog input and
output parameters.

To configured the Material ID element

1 If the material ID value is to be shown during the run-
time processing of the phase, select the Enable Display
check box.
2 If the operator is allowed to modify the material ID,
select the Edit Allowed check box.
3 If the operator must modify the material ID, select the
Edit Required check box.
Formula parameter configurations for the automatic and
semi-automatic transfer phase examples presented
earlier are shown in the following table.

Parameter Parameter Assign Edit Edit

The following table shows the valid phase parameter

configurations for the manual and data transfer phase
examples described in this section.

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.
Fill No No Quantity No interlocks.
Control buttons
as needed.
External No No As needed N/A

Configuring Formula Parameters for Manual and Data

Transfer Phases
The formula parameters that are available for manual and
data 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 or data transfer phases, see Configuring Formula
Parameters on page 178.

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
states that the segment already exists. If you attempt to
delete a segment that is assigned to a connection, a warning
message appears. Deleting segments can affect other
portions of your process model.

To activate the Segments tab

 On the Process Model Editor dialog box, click the Segments
tab.
The Segments tab becomes active. All the segments that
have been defined for the process model appears in the
Segments list.

InBatch User’s Guide

Using the Model Editor169

To add or edit a segment name

1 On the Segment tab, type the Name (16 characters
maximum) and optional Description (120 characters
maximum).
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 Connections' in Defining
Materials and Product Paths (Connections Tab) section.

Defining Equipment Status (Equipment Status

Tab)
Use the Equipment Status tab to define, edit and delete
process model statuses for units and segments. Equipment
Status names must be unique. If you attempt to enter a
duplicate name, a message indicates that the equipment
status already exists. Deleting an equipment status item can
affect other portions of your process model.
Equipment statuses represent the various states that a unit
or segment can possess at any point during the process. You
must define one default status. The default status defines the
initial state that the InBatch Management System assumes
for all of the units and segments. All status changes are
recorded in the History database.
A system tag is automatically generated for each unit or
segment that you define in the process model. The equipment
statuses define the possible values of this system tag. The
statuses are used by the InBatch Management System when
it evaluates 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 InBatch 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 of the segments that comprise the connection. If
a connection does not contain one or more segments, the
connection is always available.

InBatch User’s Guide

170  Chapter 3 Process Modeling

To activate the Equipment Status tab

 On the Process Model Editor dialog box, click the
Equipment Status tab.
The Equipment Status tab becomes active. All the statuses
that have been defined for the process model appears in
the Status list.

To add or edit an equipment status

1 On the Equipment Status tab, type a Name (16 characters
maximum) and optional Description (120 characters
maximum).
2 Select or clear the Available or Default check boxes as
required.

Additional Phase Configuration Information175

Additional Phase Configuration Information

The following section provides detailed information about
configuring the following items:
• Phase control and status control bits

• Formula parameters

Configuring Phase Control and Status Bits

There are eleven possible phase control and status bits.
These tags are created and assigned only when you define
automatic process phases and automatic or semi-automatic
transfer phases.
These tags define the structured interface that exists
between the selected phase and the control system. The
InBatch Management System is responsible for
manipulating the phase control tags. The Control System is
responsible for manipulating the phase status tags.
The InBatch Management System and the Control System
must work together to successfully execute the phase. The
two approaches to creating and assigning tags for the phase
control and status tags are Automatic and Manual.

InBatch User’s Guide

176  Chapter 3 Process Modeling

Automatic Tag Creation and Assignment

Use the Edit Phase Control/Status dialog box to automatically
create and assign tags.

Use any of the following methods to automatically create

phase control and status tags:
• Select the desired control and status tags by enabling the
appropriate check box for each option.
• Click the Select Required button to enable the check box
for the Start, Reset, Ready, and Done options. They
represent the minimum set of tags that must be created.

• Press the Select All button to enable the check boxes for
all the options.

Using the Interface Buttons

After the check boxes are enabled for the required control
and status options, click Create Tags to create and assign the
appropriate tags.

InBatch User’s Guide

Additional Phase Configuration Information177

Use Clear All to clear the all check boxes for all of the control
and status options.
Use Delete Tags to remove the tags from the options selected.
A warning message must be acknowledged before you can
delete the tags.
Use Clear Tag to remove the tags from the option selected.

Example – Automatic Tagnames

Process Class: Reactors
Phase Name: Heat

Given the above Process Class and Phase Names, the

tagnames shown in the following table is created.

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

InBatch User’s Guide

178  Chapter 3 Process Modeling

Manual Tag Creation and Assignment

Manually creating and assigning phase control and status
tags involves two steps.
1 Manually create the tag using the appropriate tag editor.
For more information on creating tags, see 'Defining
Process Class Tags' in Defining Process Class Units
(Processes Tab) or 'Associating Tags with a Transfer
Class' in Defining Transfer Classes (Transfers Tab).
2 Enable the check box corresponding to the control or
status parameter that you want to configure.
3 Click the Assign Tag button to open the Tag Selection
dialog box.
A list of all available read/write discrete process or
transfer tags are shown in the list. You can select only
one tag.
4 Click OK or Apply to assign the appropriate control or
status bit.

Configuring Formula Parameters

Formula parameters represent all the configurable
information that a phase needs to run properly. 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 InBatch Management
System in specific ways when recipes are processed. Phase
information that does not change for different recipes and
does not need to be defined as a formula parameter.
Formula parameter configurations consist of the following
information:
• Name (required, 16 characters maximum)

• Description (optional, 120 characters maximum).

• 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)

• Data Class (required: analog, discrete, string, or

enumeration)

InBatch User’s Guide

Additional Phase Configuration Information179

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.

Note Use the Data Class control to change the data class of a
process variable. If you change the data class by accident and
answers No to the dialog box prompt, the control may not reset to
the true data class. In this situation, reselect the correct data
class.

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.

Elements Elements Elements Elements

Parameter (Analog Data (Discrete Data (String Data (Enumeration
Type Class) Class) Class) Data Class)

Process Target Target Target Target

Variable 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

Tag Linker includes powerful filtering and selection tools so

that you can make changes to multiple tags at once. You can
select tags and export their configuration to a
comma-separated variable (.csv) file and then import the
information into InTouch using the DBLoad utility.

Overview
Within the InBatch environment, tags are used to
interconnect with the batch control program. Each tag has a
unique name and is associated with a specific class of data.
You create tags during InBatch application development.
For InBatch applications to communicate with other
applications and control systems, you must properly
configure all the required tags. Communication between
InBatch and other applications is accomplished using
SuiteLink. InBatch can also integrate to an ArchestrA
environment using the Message Exchange (MX) protocol.

Note It is required that only SuiteLink I/O Servers be used with

InBatch. SuiteLink provides the robust and reliable
communications protocol that InBatch demands.

InBatch User’s Guide

188  Chapter 4 Tag Linker

Use Tag Linker to select, edit, and then export InBatch tags
to a comma separated variable (.csv) file. The .csv file
contains InTouch-compliant tagnames, including access
names. You can then import the tags in the .csv file into the
InTouch application using the InTouch DBLoad utility.

For more information on browsing and referencing remote

InBatch tags from InTouch, see Chapter 19, InTouch Batch
Tag Browsing and Referencing.
Tag Linker is associated with two categories of InBatch tags;
process model tags and InBatch function tags.
Process model tags are all the unit, connection, and
segment tags that are generated when you develop the
process model. These are the only tags that are shown and
can be edited by the Tag Linker. Process model tags are
divided into two types: system tags and equipment tags.
• System tags are associated with units, connections, and
segments and are generated by InBatch as the units,
segments, and connections are created in the model.
System tags are not associated with phases and are
therefore distinguished by a triple-dot in the tagname.

Most of these tags are string tags. Although the Access of

these tags can be changed, we strongly recommend that
these tags be left as InBatch memory tags. Adverse
performance can occur if these tags are written to by
anything but InBatch. The exception to this rule is the
equipment status tag (Unit...USTAT or
Segment...USTAT).

InBatch User’s Guide

When to Use Tag Linker189

• Equipment tags are associated with a specific phase or

phase parameter and are generated when a phase is
created. These tags are generally owned by an I/O Server,
InTouch, or another server application; however, they
can be defined as InBatch memory tags for simulation
purposes.

Note Your work is dynamically saved in the configuration link

database as you edit and make changes to the linker
configuration.

When to Use Tag Linker

We recommend that you develop your application in the
following order:
1 Develop your InBatch process model.
2 Use Tag Linker to assign required tags to appropriate
control systems or InTouch nodes.
3 Develop your InTouch application scripts and animation
links.
You can use Tag Linker to import export information to a file
you can open in a spreadsheet application, such as Microsoft
Excel. This allows you to easily configure the batch system
tags.

Starting Tag Linker

Use Tag Linker to define the data sources and assign the
appropriate sources to the InBatch tags. You can also use
TagLinker to export the definitions as a .csv file for loading
into an InTouch client application.
Only one instance of the Tag Linker can be active. Also, Tag
Linker cannot start if the Process Model Editor or Train
Editor is running.
You perform the following high-level tasks with Tag Linker:
• Create your Access Names.

• Configure the tags.

To select Control System or InTouch as the Access Name

1 From the Access Name list, select either Control System
or InTouch as appropriate.
2 In the Access Name box, you can type another name
(16 characters maximum), but you cannot delete the
default name.
We recommended that you change the default name for
ControlSystem and InTouch to relate to your application.
3 In the Application box, type the name of the application.
4 In the Topic box, type the name of the topic.

InBatch User’s Guide

194  Chapter 4 Tag Linker

Example Access Name for InTouch

If you are assigning tags to InTouch, you must supply the
following information:
• The Access Name must be VIEW.

• The Topic must be TAGNAME.

Application identifies the node and name of an InTouch

application, such as \\BEN\VIEW. The node name \\BEN,
identifies a specific network path where the InTouch
application is located. VIEW is the name required for
InTouch server conversations.
The Topic identifies the group of elements within the
application through which conversations are established.
You must select the InTouch Node check box for the InTouch
Access Name to indicate that this access is connecting to an
InTouch node. All Access Names associated with InTouch
require the Application name, VIEW, and Topic, TAGNAME.

Example Access Name for ControlSytem

The Application must be the computer name where the DAS
server is installed and the name required for server
conversations. An example Application is
\\STRIPER\DASABCIP. STRIPER is the computer name
where the DAS server is installed. DASABCIP is the name
required for server conversations.
The Topic must be the topic name defined in the DAS
server.An example Topic is InBatchFST.

InBatch User’s Guide

Configuring Tags195

Configuring Tags
This section describes how to configure tags in a batch
system.

Selecting Tags
By default, the Tag Linker dialog box is initially empty to
indicate that no tags are selected.
To select tags, you can filter information by using the View
Filter Selection dialog box.

To filter tags
1 On the View menu, click Filter.
The View Filter Selection dialog box opens.

The View Filter Selection dialog box lists all the Units,
Connections and Segments that are available in the
current configuration Process Model database.
2 Select appropriate equipment from each list. Use the Ctrl
or Shift key to select multiple items.
3 Select the Analog, Discrete, String, Enumeration, or
Attributes option to refine filtering based on data class.
Data classes are defined when tags are created.
4 Click OK or Apply to update the lists in the Tag Linker.

tag. Not all tags from the InBatch model are necessarily
required for an InTouch application. If a tag is going to be
used within the InTouch application and is contained in
the InTouch tagname dictionary, you must select the
option. If a tag is not required, you can clear the check
box.

Note Exporting tags that are not required in the InTouch HMI is
acceptable and perhaps convenient. However, batch utilities
constantly monitor and manage InBatch and InTouch processes. A
high quantity of unnecessary tags can degrade overall system
performance.

For more information on alternatives to exporting tags

from InBatch and loading the tags into InTouch, see
Chapter 18, InTouch Batch Tag Browsing and
Referencing.
6 In the Scaling Options area, configure the scaling for
analog tags.
• In the Min Raw and Max Raw boxes, type the values
associated with the values output from a source such
as a PLC.
• In the Min Scaled and Max Scaled boxes, type the
scaling factors associated with InBatch.
7 In the Data Type area, set the type of numeric data with
which an analog tag is associated. The options are either
Float (floating point) or Integer.
8 Click Change.

Validating Tags
Validation consists of verifying all accesses, attributes, and
links. Depending on the size of the process, validation may be
time consuming.

To validate tags
 On the File menu, click Validate.
• If the validation is successful, a Validate message
appears.
• If validation errors occur, the associated tags are
shown along with an error or warning message. You
must correct error messages. You do not need to
correct warning messages, however, before system
operation.

InBatch User’s Guide

Exporting Tags199

Exporting Tags
Use Tag Linker to select tags and create a comma-separated
variable (.csv) file of the configuration information. You can
then import the contents of the .csv file into the InTouch
HMI using the DBLoad utility.
In the InTouch HMI, you can define remote tag sources from
which tags can be viewed and remotely referenced in an
application. InBatch can be one of these external sources. If
tags are remotely referenced, it is not necessary to use the
DBLoad utility to import the InBatch tags from the exported
.csv file.

Note InTouch does not support tags that are greater than 32
characters or have names that contain dots (.).

For details about the limitations of InTouch tag names, see the
InTouch documentation.

Performing a Simple Export

For a simple export, you cannot filter the tag list. The
exported file contains an exact image of the configuration
Tag Linker database (CfgLinkDB). After you export the file,
you can modify the tag configuration information.
Modifications to the file affect only the configuration of the
tags in the CfgLinkDB based on the changes you made to the
exported file.
You should not add tags to or remove tags from the exported
file. If you delete tags from the file and then import the tags,
the configuration of those tags within the configuration link
database is not modified. If you add tags to the file and then
import, the additional tags are ignored because they do not
already exist in the database.
The default file location is the current configuration
(config_A) folder. The file format is comma-separated
variable (.csv).

To perform a simple tag export

1 On the File menu, click Export.
The Export File Selection dialog box appears.

InBatch User’s Guide

200  Chapter 4 Tag Linker

2 In the File box, type the name of a file to which all Tag
Linker configuration data is to be written. The name
must include the complete patch and the .csv extension.
3 Click OK. If the specified file exists, you are prompted to
overwrite it.

Using the Export Editor to Group Tags for Export

You can group tags according to their Access Names and then
export them.
You can select which Access Names (tag groups) are to be
exported to the .csv file. You can create multiple csv files for
different InTouch applications such as an operator
workstation, a supervisory node, or a batch scheduling node.
Each different type of InTouch application is called a Client
Type.

To group tags for export

1 On the Edit menu, click Export.
The Export Editor dialog box appears.

2 In the Client Type box, type a client type name

(14 characters maximum).

InBatch User’s Guide

Exporting Tags201

3 In the Export Access as InTouch Memory Tags and Export

Access as InTouch IO Tags lists, select the Accesses for
which to include the tags in the csv file. For more
information, see Using Client Types on page 201.
4 In the Output Path/Filename box, type the path and name
of the .csv file for the export. For more information, see
Export File Name on page 201.
5 Click Add.
The new client type appears in the Client Types dialog
box.

Using Client Types

Client types typically represent your batch control system
architecture. Before you can export tags, you must answer
the following questions for each client type:
• Does the associated InTouch node provide tag data?

• Does the InTouch node require access to data from an

external control system or InBatch?

• Does the InTouch application use Batch Function Tags?

• What is the name of the .csv file that you want to export
to?

If the InTouch application provides tag data to InBatch,

select the appropriate access name from the Export Access as
InTouch Memory tags list.
If the InTouch application requires access to tag data that is
associated with external control systems or InBatch, select
the appropriate access names from the Export Access as
InTouch IO Tags list.
You can associate an access name, such as InTouch, with
either the Export Access as InTouch Memory tags or the Export
Access as InTouch IO Tags classification, but not both.

Export File Name

You must specify a .csv file name for the export. Include the
full path and file name, including the .csv extension. If you do
not specify a path, the file is put in the current InBatch
configuration (config_A) folder.

InBatch User’s Guide

202  Chapter 4 Tag Linker

Access Name Tags Technical Details

The following table shows how Access Names are created in
an InTouch application for tags that you export from Tag
Linker and then import using the DBLoad utility. The Node
Name for each corresponds to the host name of the
appropriate computer (such as InBatch server and I/O
server) and has been omitted from the table. The TI direct
I/O server (TIDIR) has been used as an example for the
control system interface.

AccessName Application Topic Description

ControlSystem TIDIR TI_TOPIC Accesses for Control System

tags directly to the I/O servers.
Control System tags are set to
this access names after a
Runtime Export operation is
run.
IB_CTRLSYS_TAGS IBSERV IB_TAGS Accesses for Control System
tags using InBatch as the
server. Control System tags
are set to this access name
after a Simulation Export
operation is run.

Performing a Simulation Export

Note This feature is obsolete.

You perform a simulation export of the current process model

tag configuration. You can export all requested tags as
InBatch Memory tags.
You should use this option if the InBatch Simulation
Manager (SimMngr) is running the phases.

To perform a simulation export

1 On the Edit menu, click Export.
The Export Editor dialog box appears.
2 In the Client Type box, type a client type name.
3 In the Export Access as InTouch IO Tags list, select
ControlSystem.
4 In the Output Path/Filename box, type the path and name
of the .csv file for the export.
5 Click Add.
The new client type appears in the Client Types dialog
box.

InBatch User’s Guide

Exporting Tags203

6 On the File menu, click Validate.

This action validates the list of tags to be exported.
7 On the File menu, click Simulation Export.
The Export Results dialog box appears to show the
progression and status of the export.
8 Load the .csv file into InTouch using the DBLoad utility.

Performing a Run-Time Export

Note This feature is obsolete.

You can export all process model tags using the configuration
information defined in the Tag Linker.
Perform a run-time export if the control hardware (such as
InControl or PLC) is running the phases.

To perform a run-time export

1 On the Edit menu, click Access.
The Access Editor dialog box appears.
2 Define the appropriate accesses for the tags in the
process model.
3 On the View menu of the Tag Linker main dialog box, click
Filter.
The View Filter Selection dialog box appears.
4 Select the appropriate tags and define using the tag
configuration options available in the Tag Linker main
dialog box.
5 On the Edit menu, click Export.
The Export Editor dialog box appears.
6 In the Client Type box, type a client type name.
7 In the Export Access as InTouch IO Tags list, select
ControlSystem.
8 In the Output Path/Filename box, type the path and name
of the .csv file for the export.
9 Click Add.
The new client type appears in the Client Types dialog
box.
10 On the File menu, click Validate.
This action validates the list of tags to be exported.

InBatch User’s Guide

204  Chapter 4 Tag Linker

11 On the File menu, click Runtime Export.

The Export Results dialog box appears, showing the
progression and status of the export.
12 Load the .csv file into the InTouch HMI using the
DBLoad utility.

Understanding the .CSV File Format

The following table describes the format of each line in the
csv file except for line one. The first line of the .csv file
contains a text header that describes each column in the file.

Column Identity Range/Length Type Description

1 Tag ID long_min, long InBatch internal tag id

long_max (READ-ONLY)
2 Tag Name 85 characters string InBatch tag name
(READ-ONLY)
3 Data Class Analog, enum Tag data class (READ-ONLY)
Discrete String
4 DataAccess ReadOnly, enum Tag read/write characteristics
ReadWrite (READ-ONLY)
5 Link Type Item,TagName, enum Link type specifier
or Memory (READ-WRITE)
6 Item 128 characters string Tag corresponding Item.
Applicable to Link Type =
"Link" (READ-WRITE)
7 Initial 131 characters string Tag initial value. Applicable to
Value link type = "Memory". NOTE:
Can represent a numeric value
conversion based on tag actual
data type. (READ-WRITE)
8 Access 15 characters string The Access Name that owns this
tag. The Access Name must
exist in TagLinker. Assigned a
value for Link Type =
"Memory". (READ-WRITE)
9 Export NoExport, enum Tag export flag. (READ-WRITE)
Flag Export
10 Min Raw long_min, double Tag minimum raw value.
long_max Applicable to tags with Data
Class Analog. Value = 0 if not
relevant. (READ-WRITE)

InBatch User’s Guide

Exporting Tags205

Column Identity Range/Length Type Description

11 Max Raw long_min, double Tag maximum raw value.

long_max Applicable to tags with Data
Class Analog. Value = 0 if not
relevant. (READ-WRITE)
12 Min Scaled long_min, double Tag minimum scaled raw value.
long_max Applicable to tags with Data
Class = "Analog". Value = 0 if
not relevant.
(READ-WRITE)
13 Max scaled long_min, double Tag maximum scaled raw value.
long_max Applicable to tags with Data
Class = "Analog". Value = 0 if
not relevant.
(READ-WRITE)
14 Data Type Float, Integer, enum Tag actual data type. Applicable
or empty to tags with Data Class ="Analog".
Empty if not relevant. (READ
WRITE)

InBatch User’s Guide

206  Chapter 4 Tag Linker

Importing Tags
If you edited the exported .csv file, you need to import it back
into Tag Linker for validation. The default file location is the
current configuration (config_A) folder.
The InTouch HMI allows you to define remote tag sources
from which tags can be viewed and remotely referenced in an
application. InBatch can be one of these external sources. If
tags are remotely referenced, using the DBLoad utility to
import the InBatch tags from the exported .csv file is
unnecessary.

To import tags back into Tag Linker

1 On the File menu, click Import Tags.
The Import File Selection dialog box appears.

2 Type the name of the edited .csv file to import to Tag

Linker. The name must include the complete path and
the .csv extension.
3 Click OK.

Interacting with the Control System

This section provides guidelines for interacting with a PLC.
The guidelines assume that you have a functional simulation
system and that the system has a server and at least one
client.

Guidelines for Control System Interfacing

Use the following guidelines to interact with a control
system.
1 Select the PLC and develop the required phase logic.
2 Select an I/O Server for your PLC (Available from your
distributor).
3 Use the Tag Linker Access Editor dialog box to define an
Access Name for the I/O Server.
4 Use the Tag Linker View Filter Selection dialog box to
select tags.
5 Assign the appropriate Item Names to the tags.

InBatch User’s Guide

Interacting with the Control System207

6 Configure parameters if necessary (such as scaling).

InBatch User’s Guide

211

Chapter 5

I/A Series Tag Management

You can use the following Tag Management editors, tools,

and run-time components to automatically manage tags in
I/A Series Batch:
• Model Editor

• I/A Series Linker

• I/A Series Batch Tag Driver (IADriver)

• ProcStatus Tool

I/A Series Batch interfaces to the I/A Series Control Suite

using tags. There the following I/A Series Batch components
create, edit, link, validate, communicate, and manage tags in
general:
• Model Editor

• I/A Series Linker

• I/A Series Batch Tag Driver (IADriver)

• ProcStatus Tool

I/A components can be installed on non-I/A systems. In this case,

any updated models placed in the Config_A folder can be
subsequently moved to systems where I/A Series is installed.
Note that run-time I/A components, such as I/A drivers and
so on, will not function on non-I/A systems.
For more information see the InBatch Installation Guide.

InBatch User’s Guide

212  Chapter 5 I/A Series Tag Management

Overview
Use the Model Editor to construct the plant model, which
includes 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 String Map

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.

**READY INTERLOCKED

START

*HOLD

RUN HELD

*RESTART

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.

Application Logic detecting unit

phases are active (Run, Held, Done,
Abort); then unit has Run state

Abort *READY
Logic
Application Logic that detects all unit
phases are inactive (Ready or
Inerlocked)
ABORT

Application Logic to detect if a unit is

in an Alarm state (optional)
RUN

Restart Logic

HOLD RESTART Alarm Detection Logic to change the

unit state to Alarm when appropriate

HELD ALARM
Hold
Logic
Application Logic should change the state
to Held after an Alarm is cleared or Reset

LEGEND

STATE *Initial State

HLBL Logic
CONTROL

On I/A Series Batch displays, when a batch (not a phase)

Hold, Restart, or Abort action is initiated, 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 controls 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 processing, I/A Series Batch sends batch status
information (Run, Held, and Aborting) to all the unit blocks
associated with the batch.

InBatch User’s Guide

222  Chapter 5 I/A Series Tag Management

StrMap File
The StrMap file defines how I/A Series Control Suite integer
values are mapped to I/A Series Batch strings. You can
define more than 32,000 integer-string combinations. You
must make sure that the integer-string combination is
unique. Use the I/A Series Linker to edit the default
configuration in the StrMap file.

Default StrMap Functionality

The default configuration for the StrMap file is shown below.
This configuration file allows integer 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.
4 Run
5 Held
6 Aborting
7 Locking
8 Locked
100 OK
101 NOT_OK

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.
Integer values in this StrMap file cannot be duplicated. Each
integer value can only be used one time 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.

InBatch User’s Guide

I/A Series Linker (IALink)223

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

If you try to start IALink while the Process Model Editor
(ModelEdit) is running, a lock-file error appears. Only one
editor can open and access the Process Model database at a
time.

To start I/A Series linker

1 Open the Environment Display.
2 Double-click the I/A Series Linker (IALink) icon.

Database Synchronization
Assuming that no errors are detected at startup, the
configuration Link database (cfgLinkDB) is synchronized
with the Process Model database. The first time IALink
starts, synchronization can take several minutes. For
subsequent starts, the time is significantly reduced.
During synchronization, each Model tag is retrieved and
verified against the Link database. 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.

InBatch User’s Guide

224  Chapter 5 I/A Series Tag Management

As each tag is added to the Link database, I/A Series Linker

determines what tag mapping category should be assigned
and stored with the tag. When the Link database is
synchronized with the Model database, the I/A Series Linker
dialog box appears.

InBatch User’s Guide

Managing Tags225

Managing Tags
Use the File menu to access the I/A Series Linker system
functions.

Exporting Tags
You can export tags by clicking Export Tags on the File menu.
The Export File Selection dialog box appears.
Enter the name of the file to which the I/A Series Linker
configuration data is to be written. The filename must
include a complete path name. The default location of this
file is the current configuration (config_A) directory. The file
format is comma-separated variable (csv). If the specified file
exists, a message appears, prompting you to overwrite the
file.
The tag list is not filtered. The exported file contains an exact
image of the configuration I/A Series Linker (CfgIALinkDB)
database. You can modify the tag configuration information
as a spreadsheet, text file, and so on.

Note 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 are deleted from the
configuration link database. Any changes that you 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.

Importing Tags
You can import tags into the Link database. On the File
menu, click Export Tags.
You must specify the name of the file from which the
I/A Series Linker appears import tags. The default location of
this file is the configuration (config_A) folder. The file format
is comma-separated variable (csv).

InBatch User’s Guide

226  Chapter 5 I/A Series Tag Management

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 that describes each column in the file.

Range/
Column Identity Length Type Description

1 Tag ID long_min, long I/A Batch internal tag id

long_max (READ-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 Compound 12 characters string Compound Name
(READ-WRITE)
6 Block 12 characters string Block Name (READ-WRITE)
7 Parameter 12 characters string Parameter Name
(READ-WRITE)
8 Shared 14 characters string Shared Variable Name
(READ-WRITE)
9 Hostname 6 characters string Shared Variable Hostname
(READ-WRITE)
10 Bit 1 -16 Integ Control Status Bits
2 characters er (READ-WRITE)

11 Equipment 0-3 enum Equipment Type

Type 1 character (READ-ONLY)

12 Data Class 1-4 enum Data Class Type

1 character (READ-ONLY)

13 Data Access 1-2 enum Data Access Type

1 character (READ-ONLY)

14 OMType 1 - 10 enum Object Manager Type

2 characters (READ-ONLY)

InBatch User’s Guide

Managing Tags227

Validating Tags
Note Only run the validation of the link database while the Batch
Manager is not running. The validation of a large set of tags may
impact the operation of Batch Manager and cause unexpected
failures.

To initiate a validation of the Link database, click Validate on

the File menu.

Note All shared variable type tags must be created prior to

validation.

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.

The IA Linker dialog box is blank while a validation is in

progress.

I/A Series Batch I/A Series Control

Tag Class 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.

Note The Validate menu command is not available when I/A

components are installed on non- I/A Series systems.

InBatch User’s Guide

228  Chapter 5 I/A Series Tag Management

Generating Tags
To open the Generate I/A Series Tags dialog box, click Generate
on the File menu. You can then select from tag types shown
in the following table.

Option Description

Control/Status All Phase Control/Status and Unit

Tags Control tags are linked.
Parameter Tags All Phase Parameter tags are linked.
System Tags All Equipment System tags are linked

Tag Generation Errors

When you generate tags, the Tag Mapping files are verified.
If the files are incorrect or do not exist, an error appears.
After you correct the problem, you can again attempt to
regenerate the tags.

Link Generation
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 that determines if the Model
tag is a Phase Control or 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.

Tag Type Mapped To

Analog I/A Series Real input parameters

Discrete I/A Series Boolean input parameter
String I/A Series String input parameters
Enumeration I/A Series Integer input parameters.

The tag used for a parameter must have a phase name for
automatic generation to function properly.

InBatch User’s Guide

Mapping Tags229

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

A PHASE_EXEC Block (an independent sequence block) is
required for all of the compounds that interface with
I/A Series Batch.
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 interface 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 folder.

InBatch User’s Guide

234  Chapter 5 I/A Series Tag Management

Use the Integrated Control Configurator (ICC) to extract a

copy of the default PHASE_EXEC. Position the copy
immediately following the unit block in the selected
compound. Then you can configure PHASE_EXEC
specifically for that compound. For more information, see
PHASE_EXEC Configuration File Description on page 235.
As you configure the file, follow these guidelines:
• You must specify the number (NUM_ID) and names of all
compounds (IDNAMn) that are to use the Batch ID data
in their LOOPID register.
• You must specify the number (NUM_OP) and names of
all sequence blocks (OPNAMn) in the compound being
controlled by I/A Series Batch.
• PSTATUS is the assignment for each phase block status
word. Every phase block must have status word
assignment. II0008 is the default assignment. This must
also correspond to the default assignment for this status
word in the FB_CONST.inc file (assignment for Ready,
Held, Run, Done, Aborted, and Interlocked).
• UNITAVAIL is the unit availability indicator. II0008 is
the default assignment that the PHASE_EXEC uses. In
the PHASE_EXEC block, this item should be ICC
connected 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 prevents all
these phase blocks from being started.
• UNITCONTROL is the unit control assignment. All batch
Hold, Restart, and Abort control signals are addressed to
this designation in the unit block. If you are configuring
the PHASE_EXEC 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 must also
correspond to the default assignment for unit control tag
extensions in the TagMap file.
• PCONTROL is the 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).

InBatch User’s Guide

PHASE_EXEC Sequence Block235

• ABORT_STEP is the parameter assigned for the

termination step of each phase. II0006 is the default
assignment in each phase. Make this assignment 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.

Bit
Physical Model PHASE_EXEC Value 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.

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

InBatch User’s Guide

236  Chapter 5 I/A Series Tag Management

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 u

#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 */

InBatch User’s Guide

I/A Series Batch Configuration Procedures237

Default configurations for phase block status values and for

unit block batch control values should correspond to both the
TagMap and PHASE_EXEC files as shown in the following
table.

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

I/A Series Batch Configuration Procedures

The following guideline shows the minimum steps required
to establish communication between the I/A Series Batch
system and the I/A Series Control system for models and
recipes:
1 Start the Environment Display.
2 Use Model Editor to build your process model. To make
I/A Series Batch operational using the default
configuration directory, you must configure at least one
equipment status.
3 Validate the finished model.
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
Manager environment parameter). When the parameter
is enabled, sequence code (possibly associated with the
unit block) should continually update the unit status
value to ensure that it contains the current value.

InBatch User’s Guide

238  Chapter 5 I/A Series Tag Management

4 Build and validate each recipe. Ensure that the recipes

are approved for production.
5 View the model and recipe processing using Simulation
Mode.
6 Use the I/A Series Linker to edit the StrMap
configuration file. Configure the process model
equipment status. Configure ASCII values with their
associated unique integer values. 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. Configure equipment status values as
corresponding values in the StrMap file, the TagMap file
and the model/equipment status. You should also
configure the integer value associated with the default
equipment status value as a default value in II0004 of all
corresponding unit blocks using the ICC.
7 Use the I/A Series Linker to edit the Tag Map
configuration file, if you want. For example, you might
want to add a CAMPAIGN_ID and LOT_ID as equipment
system tag extensions (that is, by removing pound signs
(#) and assigning unit block string parameters).
8 Install a copy of the PHASE_EXEC File Configuration
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 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).

InBatch User’s Guide

I/A Series Batch Configuration Procedures239

• 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.
9 Using the I/A Series Linker, Link I/A Series Batch Tags
to I/A Series Control Tags. To do this, select the Generate
function. The Generate function uses the configuration
data in the TagMap configuration file to automatically
generate all the required I/A Series Control Suite
Compound:Block.Parameter assignments. You must use
the I/A Series Linker to modify any of the default
assignments that require additional definition or
modification.
Some recipe parameters may require modification.
Recipe parameters are designated in four categories:
String, Discrete, Analog 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 (as shown on
the I/A Series Linker display) starting with an
assignment of RI0001. Assignments progress
incrementally for all unused RI locations. Consider this
rule when you make manual sequence code assignments,
because using similar sequence code assignments reduces
link editing requirements. If sequence block integer
assignments are required for any I/A Series Batch analog
type tags, then you must manually do these configuration
assignments using I/A Series Linker assignments.

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, when 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.

Use the Materials Editor to define materials, assign material

Required or
Item Optional Description

Type Required Each material must be defined as an Ingredient,

Intermediate, Finished Good, By-Product, or
Other.
Material ID Required 16 characters maximum.
Name Optional 40 characters maximum. You can use this name
to represent the actual name of the material.
Description Optional 120 characters maximum.
Unit of Measure Optional 12 characters maximum.
High Dev 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 Dev 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 Each material can have an unlimited set of
characteristics. Characteristics help distinguish
materials from one another. They also allow you
to separate lots of the same material. A
characteristic consists of a Name (16 characters
maximum), Data Type (Real, Integer, or String)
and a Default Value. Examples of characteristics
include potency, density, color, and brix.

InBatch User’s Guide

Using the Materials Editor247

Opening the Materials Editor

Use the following steps to open the Materials Editor

To open the Materials Editor

1 Open the Materials Status dialog box.
2 On the Edit menu, click Materials Editor.
The Materials Editor dialog box appears.

InBatch User’s Guide

Defining Lot Tracking Information

You can enter lot tracking information for each unit assigned
to a material.

Note The Materials Editor does not require you to define lot
tracking information for all materials used in production. The
InBatch Management System records the lot tracking information
to the History database if this information is defined, but if the
information is not defined, the InBatch Management System still
processes all batches that use the material.

To assign lot tracking information

1 Open the Materials Status dialog box.
2 Select a material ID.
3 On the Edit menu, click Material Locations.
The Material Location Assignment Editor dialog box
appears.
4 In the Unit Assignment list, click a unit.
5 In the Campaign, Lot, and Batch boxes, type the required
information. The Batch box is limited to a 16 character
maximum. You must specify at least one of these items.
6 In the Date Rcvd list and Quantity box, click and type the
required information.
7 Click Add.

To assign an actual value to a unit assignment

1 Open the Materials Status dialog box.
2 Select a material ID.
3 On the Edit menu, click Material Locations.
The Material Location Assignment Editor dialog box
appears.
4 In the Unit Assignment list, click a unit.
If the selected unit does not have a defined characteristic,
you cannot enter an Actual Value.
5 In the Actual Value box, type a value for the
characteristic.
6 Click Change.

InBatch User’s Guide

Validating the Materials Database Entries253

Validating the Materials Database Entries

You can validate Materials database entries. Validation
makes sure that all of the units assigned to the materials
exist within the process model.
If validation errors occur, the associated tags are shown as
an error message. A validation error occurs when a unit to
which a material had been previously assigned no longer
exists in the process model. You can correct this error by
reassigning a valid unit or by removing the invalid unit
assignment from the associated materials.

To reassign a valid unit

1 Open the Materials Status dialog box.
2 Select the Material ID.
3 On the Edit menu, click Material Locations.
The Material Location Assignment Editor dialog box
appears.
4 In the Unit Assignment list, click a unit.
If you select an invalid unit, a Record Not Found! message
appears.
5 Acknowledge the error.
6 Click Delete.
7 Click Add.
The Unit Selection dialog box appears.
8 Select a valid unit.
9 If other materials have invalid unit assignments, repeat
steps 2 through 8 for each material.

To remove a unit assignment

InBatch User’s Guide

254  Chapter 6 Materials Editor

Viewing Materials Status

You can:
• View a list of the materials that are assigned to units.
• Filter the materials ID list by specifying a portion of a
material ID.

• Search for a Material ID.

Viewing Assigned Units

You can view a list of all of the Unit to Material assignments.

To view assigned units

InBatch User’s Guide

259

Chapter 7

Train Editor

Use the Train Editor to create lines of production, called

InBatch User’s Guide

265

Chapter 8

Recipe Editor

The batch control system coordinates the construction and

management of recipes in accordance with the guidelines
outlined in the ISA-88 Flexible Batch Specification.
Consistent with this standard, the Recipe Editor supports all
three sublevels of the recipe procedure.
The batch control system provides a recipe management
system that enables you to construct and edit master recipes.
Master recipes are not specific to a process line. You can
assign master recipes 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 InBatch Management System. A control
recipe is specific to a process line.
A master recipe may or may not be size specific. All formula
quantities for ingredients, intermediates, 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 when the batch is scheduled and
initialized.
You can save, retrieve, and print recipes. You can also import
and export recipes. A revision history capability enables you
to enter, save, and review the change history for each recipe.

InBatch User’s Guide

266  Chapter 8 Recipe Editor

Recipe Components
A recipe consists of four parts. They are the Header, the
Equipment Requirements, the Formula, and the Procedure.

Header Component
A recipe header identifies and documents each recipe. The
header consists of the following items:
• Recipe ID

• Recipe Name

• Recipe State

• Recipe Type

• Product ID

• Product Name
• Minimum Batch Size

• Maximum Batch Size

• Default Batch Size

• Comment

InBatch User’s Guide

Recipe Components267

Equipment Requirements Component

Equipment requirements specify the process classes and
attributes required by a recipe. When you define 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
Capacity attribute are 500 and 1000, respectively. When a
very specific characteristic is required, the minimum and the
maximum should be assigned the same number.
When you define trains, multiple destination units can be
available for a given transfer. There might be times when
you want to give an operator the flexibility to select a
destination 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 process classes defined in
the equipment requirements. These are the only phases that
you can use to build a recipe procedure.

Process and Transfer Instances

In addition to specifying process classes, you can define
specific instances of each process class. You must define
process multiple instances when your recipe procedure uses
more than one unit of the same class. When the recipe is
processed, each process instance corresponds to an actual
unit. You can assign a specific unit to a process instance, or
you can allow the unit to be selected when the recipe runs.
When one or more process instances have specific units
assigned to them, the recipe is called an equipment
dependent recipe. The recipe always uses specific equipment
for its processing. When process instances are not assigned to
specific units, the recipe is called an equipment independent
recipe.
Normally, whenever you define process instances, you also
define all the resulting transfer instances. Defining multiple
instances enables you 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. Using multiple instances
enables you to create recipes that are equipment
independent or dependent.

InBatch User’s Guide

268  Chapter 8 Recipe Editor

Formula Component
The formula specifies the inputs (such as raw materials and
ingredients), outputs (such as intermediates, finished goods,
and by-products), and process variables for a recipe. You can
enter input and output quantities as actual values or as
percentage value. Process variable values must be actual
quantities. Default tolerances for ingredients and process
variables automatically appear. However, you can change the
default tolerances for the current recipe or disabled them.

Procedure Component
The procedure defines the sequence of process actions needed
to process one batch of a recipe. You construct a procedure by
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. You define operations during recipe construction. You
define phases when you create the process model.
You configure phases with parameters. A parameter is
assigned a value when you enter the recipe formula.
Parameter types are either input, output, or process
variables. When the recipe is processed by the InBatch
Management System, the values assigned to the parameters
are written to the control system.

InBatch User’s Guide

Recipe Components269

Transition logic enables you to redirect the processing of a

procedure based on the result of a Boolean expression. You
can construct expressions by using process class or instance
tags, transfer class or instance tags, and predefined functions
such as questions that prompt an operator. These questions
appear and must be answered by an operator when the recipe
procedure is processed.
Branch objects enable you to run simultaneous unit
procedures, operations, and phases, run one of many unit
procedures, operations or phases, and run operations
simultaneously on two or more units.
Loop objects enable you to re-run unit procedures,
operations, and phases based on an evaluated transition logic
expression.

Unit Procedures
A unit procedure is a process action consisting of one or more
operations. You define unit procedure names when you build
a recipe. You must assign a process instance to each unit
procedure that you create. 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 shown
in the following table.

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

InBatch User’s Guide

270  Chapter 8 Recipe Editor

Operations
An operation is an independent process action that identifies
one or more phases. You define an operation by assigning a
name to it. Some examples of operations are:
• Add and Process

• Transfer-MixTank

• Fill and Package

• Transfer-RcvTank

Phases
A phase is an independent processing action. Automatic and
Semi-Automatic phases are run by the control system using
phase logic. Phase logic is constructed so that it is
automatically configured through phase parameters and
enabled and monitored by the batch management system
when recipes are processed.
Manual and Data phases have no phase logic and are run by
the InBatch Management System. Typically, you use a
Manual phase to instruct an operator to perform a function
such as manually adding an ingredient, or performing a test
sample. You can use a Data phase to read or write values to
the control system or an external device with operator
interaction or formal phase logic.
Some recipe procedures require an operator to acknowledge
certain conditions before a phase can be processed. A recipe
procedure can also require an operator to acknowledge the
completion of a phase. Additionally, a recipe procedure can
require the operator to enter comments before batch
processing can continue. You can configure all these
situations as part of the recipe procedure.

InBatch User’s Guide

Recipe Components271

Several examples of process and transfer phases are shown

in the following table.

Class Category Phase Type

Blenders Process Blend Automatic

Reactors Process Heat Automatic
Cool Automatic
Soak Automatic
Agitate Automatic
Q/A Test Manual
ManAdd Manual
EqStatus Download
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, you

can use two special phases 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 released as part of the recipe procedure or the batch
finishes, or until an operator manually releases it.
All processes and transfer classes and instances defined in
the recipe equipment requirements can be allocated or
released. No parameters are associated with Allocate and
Release phases.

Parameters
You can use formula parameters to further define the
processing of a phase. You define formula parameters in the
Process Model editor.
The three types of parameters are:
• Inputs

• Outputs

• Process variables

InBatch User’s Guide

272  Chapter 8 Recipe Editor

Parameters act as mailboxes for data. Input parameters

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.

Class Category Phase Parameters Type

Blenders Process Blend Speed Process variable

Time Process variable
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
Process EqStatus Status Process variable
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
processing, you can control (enable or inhibit) the processing
of the parts of a recipe procedure based on operator decisions
or process conditions, unit status, and batch information
through the use of transition logic.

InBatch User’s Guide

Recipe Components273

With transition logic, you construct a Boolean expression to

be evaluated. If the expression evaluates to True, the
processing of the recipe moves to the point below the
transition logic. If the expression evaluates to False, the
recipe processing stops and waits for the transition logic to
evaluate to True.
Construct transition logic with the expression builder using
the following items:
• Process Class and Instance Tags

• Transfer Class and Instance Tags

• Pre-defined Functions (Ask, Not, WaitSec, WaitMin,

WaitHour)
• Constants

The following table shows all the available transition logic

operators.
For detailed information on building expressions, see
Chapter 14, Expression Editor.

Creating a New Recipe281

Saving a Recipe
You can save changes to an open recipe. You should save a
new recipe after you create the recipe header.

To save a recipe
1 From the File menu, select Save.
The Save Recipe dialog box appears.

2 If this is the first time that you are saving a recipe, type a
unique identifier in the Recipe ID box (16 characters
maximum).
If you enter a Recipe ID that is not unique, a warning
message prompts you to overwrite the current version.
3 In the Author box, type the name of the recipe author
(30 characters maximum).
All subsequent changes to a recipe require you to enter
an Author.

Note There are occasions when either the Recipe ID 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. The Author 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, a security clearance is required whenever you click Save.

4 Optionally type comments that describe any details or

changes that you want to document.
5 Click Save.

Tip You can copy a recipe by saving it with a unique Recipe ID.

InBatch User’s Guide

282  Chapter 8 Recipe Editor

Assigning Equipment to a Recipe

You must define recipe equipment requirements before you
can construct a recipe procedure.

To open the Equipment Requirements Editor

 From the Edit menu, select Equipment Requirements.
The Equipment Requirements Editor dialog box appears.
All previously assigned Process Classes are listed.

process instances necessary for recipe construction. Instance
names must be unique. The editor verifies the name to
ensure validity and uniqueness.You use the instance names
when you assign phases to an operation during recipe
procedure development.

Important Deleting a process instance also removes all transfer

instances that were defined using the deleted process instance. If
you delete all of the instances for a process class, no instances
are available for assigning operations in the Procedure Editor. You
can define new instances, or you can delete the process class and
reassign it using the Equipment Requirements Editor to return the
default instance name. All of the phases that were assigned to a
deleted process instance must be manually deleted from the
recipe procedure. The recipe becomes invalid until the phases are
removed.

If your recipe procedure requires multiple process instance

Selecting Process Class Instance Attributes

On the Process Class Instance Editor dialog box, use the
Attributes list and Min and Max text boxes to provide
additional equipment requirements for a recipe.

Note Using Attributes is optional.

The InBatch 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. You define attributes for the process class in
the Process Model Editor.
For more information on Process Class Attributes, see
Chapter 3, 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 InBatch Management System. If a
recipe requires a unit with an attribute range, you must
enter the minimum and maximum attribute values 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 shown in the
following table. Included with each definition is the action
that the InBatch Management system takes.

Minimum Value Maximum Value Batch Management Action

0 0 Attribute ignored by the InBatch 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
InBatch Management System.
50 50 Only units in the process class that have an
attribute value of 50 can be used by the InBatch
Management System.

Note If you have assigned a specific unit to a process instance,

you cannot define an attribute range. The InBatch Management
System is required to allocate the assigned unit when the recipe is
processed as part of a batch.

InBatch User’s Guide

290  Chapter 8 Recipe Editor

Example Equipment Requirements

The following example demonstrates how you can configure
the equipment requirements for a recipe and how the
requirements are used by the InBatch Management System
during the processing 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 shown, and the bulk can be
transferred to both reactors simultaneously.

The following instance of the Process Class Instance Editor

represents one possible configuration for this example.

InBatch User’s Guide

Creating a New Recipe291

In the example, the InBatch Management System must

allocate a reactor as the destination unit to process the bulk
addition. The unit selection mode and the capacity attribute
range defined in the recipe are evaluated by the InBatch
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 InBatch
Management System for the previous example.

Minimum Maximum
Process Unit Capacity Capacity
Instances Assigned Selection Attribute Attribute Resultant Unit
Defined Units Mode Value Value 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 initialized
because train
does not
contain an
acceptable
unit.
Reactors None Manual 0 0 User selects
Reactor A or
Reactor B
Reactors None Manual 0 2000 User selects
Reactor A or
Reactor B
Reactors None Manual 0 1000 Reactor A is
automatically
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

InBatch User’s Guide

292  Chapter 8 Recipe Editor

Minimum Maximum
Process Unit Capacity Capacity
Instances Assigned Selection Attribute Attribute Resultant Unit
Defined Units Mode Value Value Selected

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
Second_Reactor None Manual 0 2000 Reactor B
selected for
the
First_Reactor
instance. The
other reactor
would be
selected for
the
Second_React
or instance.
First_Reactor None Manual 0 2000 The user must
Second_Reactor None Manual 0 2000 manually
select Reactor
A or
Reactor B for
the
First_Reactor
instance. The
other reactor
would be
automatically
selected for
the
Second_React
or instance.
First_Reactor ReactorA N/A N/A N/A Reactor A is
Second_Reactor None Automatic 0 2000 allocated for
the
First_Reactor
instance.
Reactor B is
allocated for
the
Second_React
or instance.

InBatch User’s Guide

Creating a New Recipe293

Minimum Maximum
Process Unit Capacity Capacity
Instances Assigned Selection Attribute Attribute Resultant Unit
Defined Units Mode Value Value Selected

First_Reactor ReactorA N/A N/A N/A Reactor A is

Second_Reactor ReactorB N/A N/A N/A allocated for
the
First_Reactor
instance.
Reactor B is
allocated for
the
Second_React
or instance.

Assigning Transfer Instances

You can assign the specific transfer instances necessary for
recipe construction. Instance names must be unique. The
editor verifies the name to ensure validity and uniqueness.
Use the names defined for the instances while you are
building a recipe and are assigning phases to an operation.
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 processing.

Note If you are creating multiple transfer instances 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, you must be sure that the
physical process model contains a connection that is represented
by the defined transfer instances.

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 you have defined multiple
process instances for a process class, you must define
multiple transfer instances 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.

InBatch User’s Guide

294  Chapter 8 Recipe Editor

If multiple transfer instance names are required, change the

name of the default instance first, then add any other
required instances.

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 Open the Equipment Requirements Editor.
2 Click Transfer Instances.
The Transfer Class Instance Editor dialog box appears. All
available transfer classes along with their source and
destination classes defined in the process model are
listed.

3 Select a transfer class item from the list.

InBatch User’s Guide

Creating a New Recipe295

4 Click Source Instance.

The Source Instances dialog box opens.

5 Select the source instance from the list and click OK.
6 Click Destination Instance.
The Destination Instance dialog box appears.

7 Select the required destination instance from the list and

click OK.

InBatch User’s Guide

296  Chapter 8 Recipe Editor

Example Transfer Instance Selection

The following dialog box shows how you can 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, which allowing the
recipe builder to select the appropriate transfer phase
depending on the process instance operation being defined.

InBatch User’s Guide

Creating a New Recipe297

Defining Formulas
You can define the inputs, outputs, and process variables
that are used in the recipe procedure. You define these
parameters using the Formula Inputs Editor dialog box, the
Formula Outputs Editor dialog box, and the Process Variables
dialog box.

Process Overview
You must define a formula to the Materials database before
you develop the recipe. You must select inputs and outputs
for a recipe before they can be used in the procedure. After
being defined, the inputs and outputs are available for
assignment in phases that have input or output parameters
defined. You can make value assignments for each material
from the respective dialog box or locally at each phase.
The Process Variables dialog box shows all the process
variable type parameters that are used in phases in the
recipe procedure. You must edit phases with process variable
parameters in the procedure editor before the phases can
appear in the Process Variables dialog box. You can make
value assignments for each process variable while you
construct the recipe procedure or from the Process Variables
dialog box after you construct the procedure.

Defining Formula Inputs

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 Select an item from the Tolerances list.

7 In the High Deviation and Low Deviation boxes, type
values that are consistent with the tolerance that you
selected.
8 Click Change.

InBatch User’s Guide

Creating a New Recipe307

Using the Unit Procedures Library

Unit Procedure Name (16 characters maximum) and optional
comments 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 Open the Recipe Editor dialog box.
2 On the Edit menu, click Unit Procedures Library.
The Unit Procedure Library dialog box appears. All the
unit procedures that have been previously saved appear
in the list.

3 In the Unit Procedure Name box, type an appropriate

name.
4 In the Comments box, type a description for the unit
procedure (optional).
5 Click Change and then Close.

InBatch User’s Guide

308  Chapter 8 Recipe Editor

Editing the Operations Library

You can create and initially save recipe operations during
recipe construction.
For more information on saving operations, see Building a
Recipe Procedure on page 322.
Operation Name (16 characters maximum) and optional
comments of unlimited length. The Operation Library is
recipe independent. You can store an unlimited number of
operations.

To edit the Operations Library

1 Open the Recipe Editor dialog box.
2 On the Edit menu, click Operations Library.
The Operations Library dialog box appears. All the
operations that have been previously saved appear in the
list.

3 In the Operation Name box, type an appropriate name.

4 In the Comments box, type a description for the operation
(optional).
5 Click Change and then Close.

InBatch User’s Guide

Creating a New Recipe309

Validating a Recipe
You can validate the current recipe. The validation process
verifies the following elements:
• The Process Model database information used in the
recipe exists. This information includes process classes,
phases, parameters, and tags.
• The Material database information used in the recipe
exists.

• The minimum, maximum, and default batch sizes defined

in the recipe header are appropriate. (Minimum <=
Default <= Maximum).
• All the formula parameters defined in the recipe
procedure are linked to the appropriate information.

• All transition logic, including loop logic, is valid.

Notes:
• The validation process verifies only user-configured
information. Because of the flexibility provided in
constructing recipe procedures, it is impossible to verify a
recipe design. This verification is the your responsibility.
• The validation does not check the document path
specified for a document that is to be viewed as part of
the phase processing.
• The validation process does not verify the existence of
reports on the History Server. This verification is your
responsibility.

To validate a recipe
 On the File menu, click Validate.
If the validation is successful, Recipe is Valid is shown in
the Validate dialog box. If validation errors exist, the
associated tags appear along with a validation error
message.

InBatch User’s Guide

310  Chapter 8 Recipe Editor

Approving a Recipe
You can approve any recipe in the database for production or
for testing.

To approve a recipe
1 From the File menu, select Approvals.
The Approvals dialog box appears.

2 Select the appropriate level command button on the and

type information required. Levels can be approved in any
order.
The required levels of approval are configured in the
Security Editor. If security is not enabled, you must
manually select the Approved for Production or Approved
for Test check box each time that you save the recipe. Five
levels of recipe approval are permitted. The first level
corresponds to the author. You can assign the remaining
levels of approval based on your requirements.

Tip To prevent the same person from approving recipes at

different levels, assign each level of approval to a different
security role.

For more information on configuring security, see

Chapter 13, Security System.

InBatch User’s Guide

Working with Existing Recipes311

3 Enable the Approved for Production or Approved for Test

check boxes after all the required levels have been
satisfied.
You cannot schedule a recipe as part of a batch unless
you have enabled the Approved for Production or
Approved for Test check box.
You can enable or disable the Approved for Production or
Approved for Test check box at any time for recipes in
which all levels of approval have been satisfied.
4 Click Close.

Note Recipe approvals made on version 8.0 and later show the
time/date stamp of the electronic signature. If recipe approvals
were made on a prior version of the batch software, the
time/date of the electronic signature is not available.

Working with Existing Recipes

This section explains how to work with recipes that you have
already created.

Opening an Existing Recipe

You can open an existing recipe on the Recipe Editor dialog
box.

To open an existing recipe

1 On the File menu, click Open.
The Recipes – Open dialog box appears.

All the recipes in the Recipe database are listed. You can
sort the list by clicking a list heading.
2 Click Open.
3 Double-click the required list item.

InBatch User’s Guide

312  Chapter 8 Recipe Editor

Using Recipe Find and Filter

If your facility uses many recipes so that 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 On the Recipes - Open dialog box, slick Find.
The Recipe Find dialog box appears.

Printing Recipes
You can select one or more pre-formatted reports, and then
print the section(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.
A PostScript printer is required for printing graphical
recipes. Do not install the PostScript printer on the Batch
Server node. To enable PostScript printing on the InBatch
Development client, copy the PostScript folder and its
content (api.ps, bm.ps and header.ps) to the
…\Wonderware\InBatch folder.
You can preview your selections before actually printing
them.

To preview a recipe
1 On the File menu, click Print Preview.
2 Select one or more reports and then click OK to preview
your selections.

To print a recipe
1 On File menu, click Print. The Print window appears.

2 In the Select Reports list, select item(s) that you want.

3 In the Report Format area, select the type of format for
printing.
4 Click OK.

InBatch User’s Guide

322  Chapter 8 Recipe Editor

Building a Recipe Procedure

A Recipe procedure defines the sequence in which operations
and phases are processed when the recipe is scheduled and
run by the InBatch Management System. Use the Recipe
Editor dialog box to create the recipe sequence of events. An
overview of the Recipe Editor dialog box and all of the major
components is shown below. Each of these items is described
in more detail later in this section.

Recipe Editor Dialog Box Components

The Recipe Editor dialog box is divided into three re-sizeable
panes: Unit Procedures, Operations, and Phases.

Unit Procedures Pane

Use the Unit Procedures pane to lay out the sequence of unit
procedures that are to run when the recipe is scheduled as
part of a batch. Each unit procedure should contain at least
one phase. You can construct the operation sequence using
any procedure objects.

InBatch User’s Guide

Building a Recipe Procedure323

Sequence of Operations Pane

The Sequence of Operations pane is used to create a sequence
of user-defined operations that are processed when the recipe
is scheduled as part of a batch. Each operation must contain
at least one phase. You can construct the operation sequence
using any of the procedure objects described later.

Sequence of Phases
The Sequence of Phases pane is used to create a sequence of
phases that are processed within an operation. You define
the phases in the process modeling editor. You can construct
the phase sequence using any of the procedure objects
described later.

Using Procedure Objects

You can construct recipe procedures 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 Icons

The following table describes the functions of the various

icons on the Unit Procedures Toolbar Familiarly used icons
such as those for Cut, Copy, and Paste are not described.

Icon Name Purpose

Add Unit Enter a unit procedure.

Procedures The unit procedure name and the associated process
instance name appear on the object.
If a recipe contains two or more unit procedures for
the same name, then the automation server cannot
distinguish them. There is not a way to access
operations within the second unit procedure. The
same is true for Operations. If two or more have the
same name, then only the phases in the first such
operations are visible through the automation
interface.
Load Unit Load a pre-defined unit procedure from the Unit
Procedure Procedures Library.

Add Unit Procedure Enter a transition logic object.

Transition

InBatch User’s Guide

324  Chapter 8 Recipe Editor

Icon Name Purpose

Add Unit Procedure Enter a branch object.

Branch

Add Unit Procedure Enter a loop object.

Loop

Delete Unit Delete an object.

Procedure

Undo Undo the most recent change. Only one level of undo
is available. Undo is applicable only to the creation
and deletion of objects.
Zoom In Enlarge the Unit Procedure pane. There are 10 levels
of magnification available.

Zoom Out Reduce the sequence of operations. There are 10

levels of reduction available.

Operations Toolbar Icons

The following table describes the functions of the various

icons on the Operations Toolbar Familiarly used icons such as
those for Cut, Copy, and Paste are not described. Descriptions
for Delete, Undo, Zoom In, and Zoom Out are provided in the
previous table.

Icon Name Purpose

Add Operation Enter an operation. The operation name appears on

the object.
If a recipe contains two or more unit procedures for
the same name, the automation server cannot
distinguish them. There is no way to access
operations within the second unit procedure. The
same is true for operations. If two or more operations
have the same name, only the phases in the first such
operations are visible through the automation
interface.

InBatch User’s Guide

Building a Recipe Procedure325

Icon Name Purpose

Load Operation Load a pre-defined operation from the Operation

Library.

Add Operation Enter a transition logic object into the sequence of

Transition operations.

Add Operation Enter a branch object into the sequence of operations.

Branch

Add Operation Loop Enter a loop object into the sequence of operations.

Phases Toolbar Icons

The following table describes the functions of the various

icons on the Phases Toolbar Familiarly used icons such as
those for Cut, Copy, and Paste are not described. Descriptions
for Delete, Undo, Zoom In, and Zoom Out are provided in the
table for unit procedure icons.

Icon Name Purpose

Add Phase 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 shown on the object.
Add Phase Enter a transition logic object into the sequence of
Transition phases.

Add Phase Branch Enter a branch object into the sequence of phases.

Add Phase Loop Enter a loop object into the sequence of phases.

InBatch User’s Guide

326  Chapter 8 Recipe Editor

Storing Unit Procedures

As you create your recipe you can use either of the following
methods to store a unit procedure in the library.
• Double-click the target operation to open the Unit
Procedures Properties dialog box and click Save Unit
Procedures to store the operation.

• Click the Unit Procedures Library icon on the toolbar to

open the Unit Procedures Library dialog box. 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 can 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.

Loading a Unit Procedure

As you create your recipe you can use either of the following
methods to load a unit procedure from the main toolbar.

To load an operation (method 1)

1 On the Unit Procedures toolbar, click the Load Unit
Procedure icon.
The Load Unit Procedure dialog box appears.
2 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.

To load an operation (method 2)

1 Click the Unit Procedures Library icon.
2 Drag the target operation onto the recipe procedure.

InBatch User’s Guide

Building a Recipe Procedure327

Unit Procedure Validity Checking

When you attempt to load a unit procedure into a recipe
procedure, the following checks are performed 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 appears and the load
fails.
• If the process class exists, the process instance is
automatically added to the recipe equipment
requirements. You must acknowledge the message for
each instance.
• Materials included in the unit procedure definition can
optionally be added to the recipe formula. You must
acknowledge the message 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 requirement has 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, you cannot initialize
the batch.

Storing Operations
As you create your recipe you can use either of the following
methods to store the operation in the library.

To store an operation (method 1)

1 Double-click the target operation on the Operation
Properties dialog box.
2 Click Save Operation.

InBatch User’s Guide

328  Chapter 8 Recipe Editor

To store an operation (method 2)

1 Click the Operations Library icon on the toolbar to open
the Operations Library dialog box.
2 Drag the target operation onto the Operations 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.

Note Operations in the library can have the same name.

However, each operation is individually maintained. Also, you can
sort the operations in the library by clicking the appropriate
column header.

InBatch User’s Guide

Building a Recipe Procedure329

Loading an Operation
As you create your recipe you can use either of the following
methods to load an operation from the Recipe Editor toolbar.

To load an operation (method 1)

1 On the Operations toolbar, click the Load Operation icon.
The Load Operation dialog box appears.

2 Select the Operation that you want to load from the list.
3 Click OK.
The operation is added to the procedure beneath the
location of the cursor.

To load an operation (method 2)

1 Click the Operations Library icon.
2 Drag the target operation into the recipe procedure.

InBatch User’s Guide

330  Chapter 8 Recipe Editor

Operation Validity
When you attempt to load an operation into a recipe
procedure, the following checks are performed to ensure the
validity of the operation:
• The process class assigned to the operation must exist in
the Equipment Requirements Editor. If the class does not
exist, an error message appears and the load fails.
• If the process class exists, the process instance is
automatically added to the recipe equipment
requirements. You must acknowledge the message for
each instance.
• Materials included in the operation definition can
optionally be added to the recipe formula. You must
acknowledge the message for each material.

Note Remember that adding operations from the library can

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, you cannot initialize
the batch.

Creating Recipe Procedure Steps

InBatch User’s Guide

334  Chapter 8 Recipe Editor

d Click Change.
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. However, the Label must be unique. If it is
not, a warning message appears.
5 On the Expression tab, click Expression.
The Expression Editor dialog box appears.

Cutting and Copying Procedure Objects

You can cut objects from the respective procedure sequence
and paste objects into another procedure sequence.

Note 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.

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 operation, 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 the procedure objects, loops, transition logic and other
branches that are in the selected leg are included.

InBatch User’s Guide

Building a Recipe Procedure341

Pasting Procedure Objects

You can paste objects into the respective procedure sequence.

Note 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.

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 you want to paste
into.
2 Click the Paste icon.

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.

InBatch User’s Guide

Building a Recipe Procedure345

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 loop which includes a
Heat phase, an Agitate phase, and two phase transitions.

InBatch User’s Guide

346  Chapter 8 Recipe Editor

Moving and Nesting Procedure Objects

You can drag and drop unit procedure, operation, phase, and
transition objects into a procedure. This capability enables
you to quickly make recipe procedure changes. 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 enables you
to nest branch and loop objects to create very complex
procedures.

Editing Unit Procedure Properties

You can edit the properties of any unit procedure object.

To edit unit procedure properties

 Double-click an the unit procedure object.
The Unit Procedure Properties dialog box appears.

To change a unit procedure name

1 Type the new Unit Procedure Name in the box.
2 Click Change.

InBatch User’s Guide

Building a Recipe Procedure347

To save a unit procedure in the unit procedure library

1 Open the Unit Procedure Properties dialog box.
2 Click Save Unit Procedure.
The Save Unit Procedure dialog box appears.

3 Type a Unit Procedure Name (16 characters maximum)

and an optional Comments (unlimited length).
For more information on the use of the operation library,
see Using the Unit Procedures Library on page 307.

Operation Properties
Use the Operation Properties dialog box to edit the properties
of any operation object.

To edit operation properties

1 Double-click an the operation object.
The Operation Properties dialog box appears.

2 Type a new name in the Operation Name box.

InBatch User’s Guide

348  Chapter 8 Recipe Editor

3 Click Save Operation.

4 Click Change.

To change an operation name

1 Double-click an the operation object.
The Operations dialog box appears.

2 Type a new name in the Operation Name box.

3 Click Change.

To save an operation in the operations library

1 On the Operation Properties dialog box, click Save
Operation.
The Save Operation dialog box appears.

2 Type an Operation Name (16 characters maximum) and

an optional Comments (unlimited length).
For more information on the use of the operation library,
see Editing the Operations Library on page 308.

InBatch User’s Guide

Building a Recipe Procedure349

Editing Phase Properties

Use the Phase Properties dialog box to edit specific elements
of the phase including its phase definition, instructions,
parameters and document properties.

To open the phase properties dialog box

 In the Recipe Editor Phase pane, double-click the phase
that you want to edit.
The Phase Properties dialog box appears.

InBatch User’s Guide

350  Chapter 8 Recipe Editor

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 dialog box, click the Phase tab.
The Phase tab becomes active.

2 In the Label field, type a unique name.

By default, the Label is automatically assigned (as a
unique numeric value) when the phase is created.

InBatch User’s Guide

Building a Recipe Procedure351

For Input Phase Parameters, the Parameters tab has the
following appearance.
For more information on Input Parameters, see Defining
Formulas on page 297.

InBatch User’s Guide

356  Chapter 8 Recipe Editor

Output Phase Parameters

For Output Phase Parameters, the Parameters tab has the
following appearance. For more information on Output
Parameters, see Defining Formula Outputs on page 302.

InBatch User’s Guide

Building a Recipe Procedure357

Process Variable Parameters

For Process Variable Parameters, the Parameters tab has the
following appearance. For more information on Process
Variable Parameters, see Defining Process Variables on
page 305.

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 processing. Acknowledgment
can be specified to occur at the start of the phase (On Entry) or
as the last step (On Exit) of the phase. When the phase
processes, 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. Furthermore, you might have the
material safety data stored in an HTML document on a
network at the address http://Material_Safety.html.

InBatch User’s Guide

InBatch User’s Guide

365

Chapter 9

Batch Management System

The InBatch Management System consists of scheduling,

initializing, coordinating the processing of batches with the
control system, interfacing with operators, and directing
batch activity to the historical database. The functions that
are provided by the InBatch Management System are
available through the Batch Scheduler, Batch, and Batch
Manager applications. By applying these applications, you
can achieve a flexible, reliable, and intuitive solution to
managing all of your batch processes.

Overview
The following section provides an overview of the functions of
the Batch Management System.

Scheduling
Batch Scheduler prepares the batches to be processed. You
must manually enter the batch identification, master recipe
identification, quantity to be produced, and train
identification. After you have entered this information, you
can initialize the batch.

Initialization
You must initialize each batch before it can be processed. The
initialization process involves:
• Validating the recipe

• Verifying that the train exists

InBatch User’s Guide

366  Chapter 9 Batch Management System

• Verifying that the bulk materials defined in the recipe

are found in the Materials Database

• Verifying that the recipe equipment requirements are

satisfied by the train
• Verifying that the Process Model database is compatible
with the recipe.

Batch and Unit Management

The Batch Manager directs and supervises the processing of
each batch. The Batch Manager interprets a recipe and
enables the control system. Based on the recipe procedure,
the Batch Manager signals blocks of control software,
referred to as phases, to run. Automatic and Semi-Automatic
phases are programmed logic blocks that exist in the control
system. They are responsible for controlling functions
associated with a unit or a connection. Before enabling each
phase, the Batch Manager verifies that the phase is ready to
be processed. If so, phase parameter values are downloaded
to the phase, and the phase is started.
The Batch Manager also interacts with the batch application.
InBatch provides operators with information about all
batches running in the system. Operators can put a batch or
phase on Hold, restart and abort batches or phases, and
change the batch processing mode. The Batch Manager also
has a Jump mode that allows you to change the processing
point of an active batch that is on hold. Operators can use
this feature to either jump ahead during recipe processing or
repeat phases that have already run. In addition, operators
can change phase parameter values, acknowledge the
processing of phases, review phase interlock status, and
enter comments. All of these can be done while a batch is
running.
The Batch Manager coordinates the usage of process units for
each batch. Each batch is a separate entity and contends
along with other batches to own the process units that it
needs. The Batch Manager assigns (allocates) ownership of
units to batches as units become available and releases units
when they are no longer required by the batch.
You must design flexible batch control systems with the
supervisory workstation as an active participant in the
processing of a batch. Unit management is very sophisticated
in a flexible batch system. Most control systems do not have
the ability to program a unit manager capable of interpreting
and running complex recipe procedures.

InBatch User’s Guide

Overview367

A master recipe uses classes of process units rather than

specific units. That is, phases pertain to a class of units, not a
specific unit. When the Batch Manager runs 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. The Batch
Manager automatically converts the master recipe to a
control recipe based on the units in the train, whether or not
they are available.
After a batch is done, the operator has the option of saving
the as-built recipe to the recipe database. 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-run
at a later date.

History
The Batch Manager captures all batch processing events and
operator activity during the processing 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 10, History System.
Only one instance of Batch Manager can be active in your
batch management system. There are no restrictions on the
number of InBatch run-time clients that you can have in a
system. The Batch Manager interacts with several databases
as well as with the clients. The following information
describes the interaction of Batch Manager and the
databases:
• Master recipes are retrieved from the Recipe Database
(RecipeDB) when a batch is initialized.

• 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 the Batch
Manager when materials are used and when materials
are produced.
• All batch processing events and operator activity are
logged to the History Database.

InBatch User’s Guide

368  Chapter 9 Batch Management System

• The Batch Scheduler manipulates the Batch Database

through the Batch Manager. Several Batch Schedulers
can be running on a system, but there is only one
schedule database.
• InBatch run-time clients and InBatch provide a dialog
box into the 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
processing of a batch is provided.
• The Batch Manager interacts with phase logic (phases)
located in the control system. As each phase is to be
processed, the Batch Manager checks to see if the phase
is ready. If the phase status is ready, any configured
phase parameter values are written to the phase, and
then the phase is started. When the phase completes its
task, it informs the Batch Manager by setting the Done
status. The Batch Manager responds by enabling the
Reset command and returning the phase to Ready status.

Batch Management Diagram

The following diagram shows the components of the InBatch
Management System.

InBatch User’s Guide

Using the Batch Scheduler369

Using the Batch Scheduler

Use the Batch Scheduler dialog box to manually schedule and
dispatch batches that are to be run by the Batch Manager.
The Batch Scheduler is not designed to optimize a schedule.
The batch database can be accessed by external scheduling
applications such as those that use the Batch ActiveX
controls.
A batch is defined by a Campaign ID, Lot ID, Batch ID,
Recipe, Quantity (8 characters maximum), Train, and Mode
of operation. The scheduler verifies all new batch names to
ensure validity and uniqueness.

Identifying Batches
Each batch is identified by a unique three-part hierarchical
name. The highest level is the Campaign ID, followed by the
Lot ID, and finally the Batch ID. An operator must manually
enter the Batch ID. It is not necessary to use all three of the
identification fields. The Campaign ID field is required. The
Lot ID and Batch ID fields are optional.
All historical information about a batch is logged to history
using the Batch ID. If the Batch ID is not unique, duplicates
can exist in the historical database. The Batch Scheduler
verifies only that the Batch ID is unique among the batches
currently in the Schedule dialog box. The Batch Scheduler
does not verify that the identification for a batch is unique
throughout the History database.

Note The Batch Manager must be running before you start Batch
Scheduler.

InBatch User’s Guide

370  Chapter 9 Batch Management System

Defining a Batch
You can define a batch by using the Batch Scheduler dialog
box.

To open the Batch Scheduler

 On the Environment Display dialog box, double click the
BatchSched icon.
The Batch Scheduler dialog box appears. Use this dialog
box to schedule, initialize, and monitor batches. Use the
menu or the toolbar to access system functions and
options for the Batch Scheduler.

To Define a Batch
1 In the Campaign box, type a campaign ID (16 characters
maximum). This is a required item.
2 In the Lot box, optionally type a lot ID (16 characters
maximum).
3 In the Batch box, optionally type a batch ID
(16 characters maximum).

InBatch User’s Guide

Using the Batch Scheduler371

4 Click Recipe to open the Recipes dialog box.

5 Select a recipe in one of the following ways:

• Double-click a list item. The list contains the recipes
in the recipe database that have been approved for
production or approved for test.
• Click 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.
• Click the Filter button to filter recipes based on their
ID, Name, State, or Type.
Recipe filtering is applied only when the Recipes
dialog box is open, and you have defined specific
filtering criteria. When you close the Recipes dialog
box, any previous filtering criteria is no longer
applicable.
6 In the Quantity box, type the size of the batch to be
produced.
If you do not enter a quantity, the default quantity from
the recipe is used.

InBatch User’s Guide

Therefore, it is extremely important when multiple paths

are possible through a train, to determine if the recipe
can process properly for all possible paths. If not, a
change in the train must be made.

To initialize a specific batch

1 On the Batch Scheduler dialog box, select a batch. The
batch must have a status of Open.
2 On the toolbar, click the Single batch icon.

To initialize multiple batches

1 On the Batch Scheduler dialog box, check to make sure
that all the batches have a status of Open.
2 On the toolbar, click the Multiple Batch icon.

InBatch User’s Guide

376  Chapter 9 Batch Management System

Sorting the List of Scheduled Batches

You can sort the batch schedule list in various ways. You can
also return the new sorting order to its original state.

To sort the list of scheduled batches

1 Open the Batch Scheduler dialog box.
2 On the toolbar, click the Filters icon.
The Schedule Filters dialog box appears.
3 Use the various tabs to filter data.

To undo sorting
1 Open the Batch Scheduler dialog box.
2 On the View menu, click Undo Sorting.

CLB Tab
Use the CLB tab to sort the list of scheduled batches based on
any combination of campaign, lot, and batch.

InBatch User’s Guide

Using the Batch Scheduler377

Recipe Tab
Use the Recipe tab to sort the list of scheduled batches based
on any combination of Recipe IDs, Types, and States.

Train Tab
Use the Train tab to sort the list of scheduled batches based
on one or more train assignments.

InBatch User’s Guide

378  Chapter 9 Batch Management System

Mode/Status Tab
Use the Mode/Status tab to sort the list of scheduled batches
based on any combination of batch processing mode and
status.

Running Batches in a Specific Order

You can run batches for each train in the order on which they
appear in the schedule.

Note If you sorted the Batch Schedule list using the Filter option,
batches are processed in the order defined by your sort
preferences. In this case, the Execute in Order option is not
available.

To run batches in a specific order

1 Open the Batch Scheduler dialog box.
2 On the toolbar, click the Execute in Order icon.
This option remains in force until you turn it off. The icon
acts as a toggle.
Or, on the Options menu, you can click Execute in Order.

InBatch User’s Guide

Using the Batch Scheduler379

Using Standard Batch Operations

You can use the Batch Scheduler dialog box to perform the
following standard operations:
• Delete a selected batch from the schedule. You can select
only batches with a status of Open, Ready, Done, or
Aborted.
• Remove all batches from the schedule list that have a
status of Done or Aborted. Perform this operation on a
regular basis to minimize the size of the Batch Scheduler
list.
• Move batches up or down in the schedule. These options
are 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 processed in the order defined by your sort
preferences. In this case, the Move options are not available.

Using the Batch Display383

Functional Areas on the Batch Display Dialog Box

This section describes the various functional areas on the
Batch Display dialog box.

Batch Identification
Across the top of the Batch main dialog box 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 is 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 the user the ability to start
the batch, hold the batch, restart the batch, abort the batch,
and change the batch mode.

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 parameter values.

Instruction List
The Instruction List provides a list of instructions associated
with the phase selected in the Phase List.

Ack Doc Button

The View Doc button provides the necessary operator
interface to view a document that is specified as part of a
phase. Once the document is viewed, the button label
changes to Ack Doc, requiring operator acknowledgement in
order to continue processing.

Phase Control Buttons

The Batch Control Buttons give the user 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 comment, view phase interlocks, and
manually select equipment for phase processing.

InBatch User’s Guide

384  Chapter 9 Batch Management System

Sequence of Unit Procedures and Operations

The Sequence of Procedures and Operations dynamically
show the current Procedure and Operation that are running
in the selected batch. The status of each unit procedure and
operation in the SFC is represented with colors.

Color Description

Cyan Continue mode processing

Gray Inactive
Green Active
Yellow Completed

Sequence of Phases
The Sequence of Phases dynamically shows the current
phases running in the selected batch for the selected
operation. The status of each phase in the SFC is represented
with colors.

Color Description

You can perform the following standard operations on the
Batch Display dialog box:
• View messages associated with a batch.

• View errors associated with a batch.

• Save the recipe associated with a completed batch

(control recipe) to the recipe database.
• Show or hide toolbars.

• Show or hide the status bar

• Show or hide various panes of the dialog box.

• Zoom in and out on various panes of the dialog box.

• Increase or decrease the size of icons.

• If you are using I/A Series components, you can do the

following:

• View the Alarm Manager.

• View the Foxboro SFC/ST Display Manager.
• Show or hide the Fox toolbar.

Viewing Messages Associated with a Batch

You can view all messages associated with the batch that you
are currently viewing. It also shows messages to alert
operators about other batches that require operator action.
The following list shows a summary of message types:
• 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, operation, and phase requiring
the acknowledge is provided in the message.

InBatch User’s Guide

Using the Batch Display391

• Waiting for the operator to edit one or more phase

parameters. The equipment, operation, 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 identification information is
provided for the batch requiring the action.

To view the Batch Messages dialog box

1 Open the Batch Display dialog box.
2 On the toolbar, click the Batch Messages icon.
The Batch Messages dialog box appears.

Viewing Errors Associated with a Batch

You can view all errors associated with a batch.

To open the Batch Errors dialog box

1 Open the Batch Display dialog box.
2 On the toolbar, click the Errors icon.
The Batch Errors dialog box appears.

Saving a Control Recipe

You can save the recipe associated with a completed batch to
the recipe database. 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 check box. Additionally, you can
retain recipe approvals by enabling the Retain Recipe
Approvals check box. This selection enables the recipe to be
immediately scheduled. The operator also has 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.

InBatch User’s Guide

392  Chapter 9 Batch Management System

Regardless of the options selected, the operator must enter

their 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 cannot save it

with the same Recipe ID. However, you can save it with a
different Recipe ID.

To save a control recipe

1 Open the Batch Display dialog box.
2 On the Actions menu, click Save Control Recipe.
The Save Control Recipe dialog box appears.

3 Type your name in the Author box.

4 If you want to save the run-time equipment used for the
batch, select the Save Runtime Equipment check box.
5 If you want to retain the approvals that were originally
designated for the recipe, select the Retain Recipe
Approvals check box.
6 Optionally type comments in the Version Comments box.
7 Click Save.

Showing or Hiding Toolbars

You can show or hide the following toolbars on the Batch
Display dialog box:
• Main toolbar

• SFC toolbar

InBatch User’s Guide

Using the Batch Display393

To show or hide toolbars

1 Open the Batch Display dialog box.
2 On the View menu, click the name of the toolbar that you
want to show or hide. These options toggle the toolbars on
and off.

Showing or Hiding the Status Bar

You can show or hide the Status Bar on the Batch Display
dialog box.

To show or hide the Status Bar

1 Open the Batch Display dialog box.
2 On the View menu, click Status Bar.

Showing or Hiding Panes

You can show or hide the following panes on the Batch Display
dialog box:
• Unit Procedures

• Operations

• Phases

To show or hide panes

1 Open the Batch Display dialog box.
2 Do one of the following:
• On the toolbar, click the appropriate icon.
• On the View menu, click the name of the pane that
you want to show or hide.

Icon Function

Unit Procedure pane

Operation pane

Phase pane

InBatch User’s Guide

394  Chapter 9 Batch Management System

Zooming in or Out on Panes

You can zoom in or out on the following panes. Ten levels of
magnification are available.
• Unit Procedures

• Operations

• Phases

To zoom in or out on panes

1 Open the Batch Display dialog box.
2 Click the various Zoom In or Zoom Out icons for the
panes or select an item on the View menu.

Icon Function

Unit Procedure zoom in

Unit Procedure zoom out

Operation zoom in

Operation zoom out

Phase zoom in

Phase zoom out

Increasing or Decreasing the Size of Icons

You can toggle back and forth between large and small icons
on the Batch Display dialog box.

To increase or decrease the size of icons

1 Open the Batch Display dialog box.
2 On the View menu, click Large Icons.
• If the icons were large, they become small.
• If the icons were small, they become large.

InBatch User’s Guide

Monitoring and Controlling Operations395

Using I/A Series Components

The following activities apply only to I/A Series systems:
• Viewing the Alarm Manager. For more information on
the Alarm Manager, see your Foxboro documentation.
• Viewing the Foxboro SFC/ST Display Manager. You can
enable security for this functionality.

• Show or hide the SFC toolbar.

• Show or hide the Fox toolbar.

• Enable the Status Bar menu item.

To view the Alarm Manager

1 Open the Batch Display dialog box.
2 On the toolbar, click the Alarm Manager icon or on the
Windows menu, click Alarm Manager.

To view the Foxboro SFC/ST Display Manager

1 Open the Batch Display dialog box.
2 On the toolbar, click the Display Phase Sequence icon or
on the Windows menu, click Phase Sequence.

To show or hide the Fox toolbar

1 Open the Batch Display dialog box.
2 On the View menu, click Fox Toolbar.

Monitoring and Controlling Operations

The Batch Display is used by operators to monitor and
control the processing of batches. The Batch Display main
dialog box provides the functionality described in the
following list. More detailed information on many of these
features is described later in this section.
You can:
• View a list of all active batches in the schedule at any
time. An active batch is any batch that has a status of
Ready, Run, Held, Done, or Aborted.
• View a list of all phases for the selected batch.

• View the recipe procedure for each batch. The recipe

procedure shows the status of each phase.
• Control batches with the following buttons: Start, Hold,
Restart, and Abort.

InBatch User’s Guide

396  Chapter 9 Batch Management System

• Control phases with the following buttons: Start, Hold,

Restart, and Abort.

• View and control current Phase Status, Parameters, and

Instructions.
• Enter Comments associated with a phase or with the
batch.

• View and Acknowledge external documents.

• View Interlocks for each phase.

• View a list of Transition Logic Questions and answer the

questions.

• View a Message Line that shows 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 dialog box).

Controlling Batches
Batches that are initialized have a status of Ready. If a batch
is Ready, you can select it from the Schedules dialog box and
start it with the Batch Start button. Batches that are running
have a status of Run. If a batch has a status of Run, the batch
can be put in Held status. If a batch has a status of Held, the
batch can be Restarted or Aborted.

Monitoring and Controlling Operations399

Batch View has the same functionality for interfacing with
the Batch Manager as Batch Display. 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 location, filter and several other parameters are
configured using the Properties dialog box.
Batch Manager must be running before you start Batch
View.

Configuring Batch View

You enable the Batch View configuration mode when you
start Batch View from FoxView with the configuration
parameter <-c> set. Each Batch View configuration is
identified with 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 items 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.

• Location of Batch Editor

• Set Display to Always Be on Top.

Using Batch Manager

Batch Manager is the most fundamental and integral part of
the InBatch Management System. The processing of every
batch is controlled and monitored by Batch Manager.
Another of its responsibilities is to manage the processing of
multiple batches and to disseminate all the batch
information to Batch Scheduler and Batch. Each batch server
supports a single instance of Batch Manager.

Starting Batch Manager

Batch Manager is started by the Environment Manager
when the run-time applications are initiated. There is no icon
shown for Batch Manager. Batch Manager runs as an
operating system service.

Running Batch Processes

Batch Manager is responsible for the processing of all the
batches running in the system at any point in time. There are
many different areas of functionality that Batch Manager
must coordinate while running batches. These include
allocation of equipment, batch processing modes and mode
changes, unit selection, process phase processing, and
transfer phase processing.
Each of the batches may have any combination of the
following options.
Equipment Allocation Types
The following three types of equipment allocation are
available:
• Automatic
• Recipe

• Manual
Batch Processing Modes
The three modes of batch processing are:
• Automatic

• Semi-Automatic

• Manual
Modes for Selecting Units
The two methods for selecting units for a batch are:
• Automatic

• Manual

InBatch User’s Guide

Using Batch Manager411

Phase Categories
Thee are two categories of phases are:
• Transfer
• Process
Phase Types
The three types of phases are:
• Automatic

• Semi-Automatic

• Manual

Allocating Equipment
To run any phase as part of a batch, equipment must be
allocated to the batch. If suitable equipment had been
previously allocated to the batch, that equipment is used. If
equipment has was not been previously allocated, the
InBatch Management System must allocate suitable
equipment to the batch before it can proceed with phase
processing. The three approaches to allocating equipment for
a batch are described in the information that follows.

Automatic Allocation and Release

Automatic allocation is performed by default by Batch
Manager. Automatic allocation occurs whenever a phase
needs to be run and appropriate equipment (unit or
connection) is not currently allocated to the batch. Batch
Manager allocates the equipment required and releases the
equipment automatically when 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 run.
As part of the evaluation criteria for unit allocation, Batch
Manager uses the equipment status (such as Clean or Dirty),
equipment availability (such as in use by another batch),
train definition (such as, Is the unit in the train assigned to
the batch?), equipment attribute requirements (such as
capacity and material of construction), and the equipment
state (such as Ready, Run, Held, or Alarm). When there are
multiple units to select from, 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.

InBatch User’s Guide

412  Chapter 9 Batch Management System

Connection allocation is a result of source and destination

unit allocation. When multiple connections are available
between two units, Batch Manager selects the first
connection that it encounters. 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 that it encounters. 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 run a transfer phase.
Allocated equipment is automatically released when it is no
longer needed or at the end of the batch. Therefore, units are
automatically released after a transfer phase in which the
unit that is the source is complete or at the end of the batch.
Connections and segments are automatically released after
the transfer phase on the connection and segments are
complete.

Recipe Allocation and Release

Recipe allocation takes precedence over Automatic allocation.
Recipe Allocation refers to the allocation of units or
connections through the inclusion of an Allocate Process
Instance or Allocate Transfer Instance phase in the recipe
procedure.
With Recipe allocation, equipment (unit or connection) is
reserved for exclusive use by the batch in which the phase is
run. 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 by
using the rules of automatic allocation. If it is required to
also reserve the destination unit, then the Allocate Process
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 run.
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 corresponding recipe release phase is
encountered in the recipe procedure or until the batch is
complete.

InBatch User’s Guide

Using Batch Manager413

Recipe allocation phases are treated the same as other

phases in a recipe. Recipe processing is not proceed until a
unit or connection defined by the Allocate phase is assigned
to the batch.

Manual Allocation and Release

Manual Allocation takes precedence over Automatic
allocation and Recipe allocation. Manual allocation refers to
the allocation of equipment (unit and connection) by a user
through the Equipment Allocation dialog box within Batch.
Any unit or connection defined in the train assigned to the
batch can be allocated with this dialog box. However only
equipment that has an available equipment status (such as
Clean or Dirty), an available equipment state (such as
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 connection 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 manually
allocated are released when the operator manually releases
the unit or connection from the Equipment Allocation dialog
box or when the batch is complete.
Manual allocation is especially important when running
batches in Manual mode. Only the phases associated with
manually allocated units or connections can be run.
Furthermore, if a batch is started in Manual mode, there are
no units or connections allocated. Units and connections
must be allocated manually before any phases are available
for processing.

Using Batch Processing Modes

The three different modes of batch processing are Automatic,
Semi-Automatic, and Manual. Batch Manager responds to
batch control commands differently depending on the mode.
Each option is explained in the following section.

Using Automatic Batch Mode

The following section describes the various phases of
Automatic batch mode.

InBatch User’s Guide

414  Chapter 9 Batch Management System

Starting a Batch
When an operator selects the Batch Start button, the recipe
procedure begins processing. Equipment must be allocated to
run phases. The allocation takes place according to the rules
that you defined in the allocation section. If the required
equipment cannot be allocated, the phases go to the Wait
status. While in Wait status, the availability of the
equipment is continually monitored. As soon as equipment is
available, it is allocated to the batch, and the phase starts.
Only the equipment in the assigned train is available to
Batch Manager for allocation.
After the correct equipment is allocated, the status of the
phase to be run is evaluated. If the phase status is Ready,
Batch Manager downloads the values of the formula
parameters to the control 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 message appears. An operator must
acknowledge the error message, 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 the IBCli service 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 appears. Examples of
conditions that can cause tag read and write failures include
bad I/O points or the unintentional deletion of a block
parameter in the control system. When failures occur, an
operator must take the necessary action to correct the
problem and then initiate a batch Restart to resume
operation. If the failure cannot be resolved but the operator
wants to batch processing to continue, the phase associated
with the failed tag can be Aborted by the operator, and then a
batch Restart can be initiated to resume batch processing.

InBatch User’s Guide

Using Batch Manager415

Holding a Batch
When an operator selects the Batch Hold button, Batch
Manager puts the batch in Held status. The actions taken in
response to a batch Hold depend on how Batch Manager is
configured in the Environment Editor. If the configuration
uses the defaults (that is without any application parameters
in the Environment Editor), when the Hold command 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 system logic to alter the status of
the phases associated with the units. 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 pressed it is possible that

the Batch Abort becomes available before all the phases are in
the Held status. If an operator quickly presses the Batch Abort
button before all the phases are in the Held status, any phase not
in the Held state does 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 catch status remains
Aborting until all phases have completed. Phases in Run are
completed normally or can be manually held and aborted. To
resolve this situation, verify that all phases are in Held status
before pressing the Batch Abort button, manually abort all phases
in Held status, or assign security to the Batch Abort button. In
most cases this allows enough time for all phases to go to the Held
state.

418  Chapter 9 Batch Management System

If Batch Manager is started with the Phase/Batch Status

application parameter defined in the Environment Editor,
Batch Manager manages all phase abort activity. 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 with Hold
commands, an individual phase abort does not cause the
batch and all other phases to abort. Also, after all phases
have completed or aborted, the batch status changes to
Aborted.
The batch abort concept is not as effected 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.
Error messages do not appear 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 the operator’s responsibility to avoid the conditions that

are described. If either condition exists, the operator must
manually change the unit state.

Using Semi-Automatic Batch Mode

When Batch Manager is running in semi-automatic mode,
operation is exactly the same as automatic mode, except that
the operator is required to acknowledge the start of each
phase.

InBatch User’s Guide

Using Batch Manager419

Using Manual Batch Mode

When Batch Manager is running in manual mode, any phase
in the recipe for any unit or connection allocated to the batch
can be run. When a batch is started in manual mode, no
equipment is allocated to the batch. An operator must use
the Equipment Allocation dialog box to manually allocate the
desired units or connections. Any manually allocated
equipment must be released manually or that equipment
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 is available for processing. 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.

Changing Batch Processing Modes

The following section describes what happens when you
change from one batch processing mode to another.

Automatic to Semi-Automatic
Operation continues normally except that any new phase
requires an operator to acknowledge the start of the phase.
You can configure Batch Manager to switch from Automatic
to Semi-Automatic after a phase is aborted. The batch then
continues to run in Semi-Automatic mode. To enable this
capability, you must use Environment Editor to assign the
Semi-Auto On Abort parameter to Batch Manager. If you
enable this feature, 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 2, 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 run. Batch Manager
maintains its position in the recipe procedure, and the
operator can manually run any of the phases associated with
allocated equipment.

InBatch User’s Guide

420  Chapter 9 Batch Management System

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 run. Batch Manager
maintains its position in the recipe procedure, and an
operator can manually run any of the phases associated with
allocated equipment.

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,
recalculate the target quantity, and re-run 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, enter
the actual weight, and 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-runs the phase.
This activity 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.

InBatch User’s Guide

424  Chapter 9 Batch Management System

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, to
enter the actual weight, and then to acknowledge the
completion of the phase.
When the addition requires multiple lots of same
material, an 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-runs the phase.
This activity 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 can 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, enters the material lot code, and then
acknowledges the completion of the phase. Batch
Manager decrements the actual quantity from the target,
recalculates the target quantity, and re-runs 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 acknowledge the
completion of the phase.
For the this manual addition to function properly, control
system logic must be designed to disable the scale input
when the operator enters the actual bag weights. You
could assign a control button to do this. The control
button would disable the scale from overwriting the
entered value.

InBatch User’s Guide

Using Batch Manager429

Using Transfer Phases with Material Output

Parameters
When Batch Manager encounters a transfer phase that has
an output type parameter, the appropriate destination unit
and connection 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 actual value entered by the operator, 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 that the actual is equal to the target and
both are logged.
For automatic transfer 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 identification (Campaign ID, Lot ID, and
Batch ID) are logged to history.

Using Continue Mode Processing

5 Click the Jump Mode button to complete the

repositioning.
The Jump mode cursor is replaced with the normal
mouse pointer.
6 Click Restart Batch.
When the batch restarts, recipe processing begins at the
point you selected.

Triggering Reports
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 was defined, Batch Manager signals
Wonderware Information Server after the batch is
completed. Batch Manager passes the name of the report, the
Campaign ID, Lot ID, and Batch ID.

Ending Batch Operation

When the recipe procedure has run to completion or a batch
is aborted, Batch Manager releases any allocated units and
triggers an End of Batch report if configured.

Working with Errors

The following section describes error messages that you can
encounter during batch processing and scheduling.

Batch Run-time Errors

The following errors can appear during batch processing. In
all cases, when an error occurs, an error appears.

Error: Cannot change mode of <manual operation name> batch!

Reason: Manual Mode is the only valid batch processing mode in a manual
operation.
Corrective Action: Acknowledge the error message.

Error: Unexpected phase status of READY!

Error: Unexpected phase status of RUN!

Error: Unexpected phase status of HELD!

InBatch User’s Guide

Working with Errors435

Error: Unexpected phase status of DONE/ABORTED!

Error: Unexpected phase status of INTERLOCK!
Reason #1: You are trying to run the same phase in parallel in your recipe
procedure, 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 run the
recipe.
Corrective Action: Make sure the batch is assigned to a train that can
properly run the recipe.
Reason #3: The connection has not been entered in the process model.
Corrective Action: Abort the batch. Stop processing 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.

InBatch User’s Guide

436  Chapter 9 Batch Management System

Error: Invalid Query Data

WARNING! It is strongly recommended that the Restarting

Batches option be used only by personnel that are very familiar
with the operation of the batch system, the operation of the
control system, and the process itself.

InBatch User’s Guide

440  Chapter 9 Batch Management System

Synchronizing the Control System

In cases where the control system phase logic is reset or is
run 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 InBatch Management System is able to
recover from such a failure. However, there are times when
the InBatch Management System is unable to resolve the
phase transition, or it is unsafe for the phase to be initiated.
The following table 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 shutdown 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 InBatch Management System can recover.
Re-Sync entries correspond to situations from which the
InBatch 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.

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

InBatch User’s Guide

Performing a Warm Restart441

For example, suppose the InBatch Management System was

controlling a phase that was previously in a status of Run. If
the batch control system is shut down and the phase in the
control system continues processing and becomes Done
before the batch control system is restarted, the InBatch
Management 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 continues on to the
next phase.

Using Manual Operation

You can schedule a selected batch run in a fully-manual
operation mode, known as phantom batches. Manual
Operation provides the capability to run the phases for all
the units and connections in the process model. Manual
Operation is especially helpful during startup and system
verification. The Manual Operation option is available only
when the Manual Operations application parameter is
configured for the Batch Display using the Environment
Editor dialog box.

Precautions and Considerations

If you need to access manual operation, you must be aware of
the phases that are running 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 the Batch
Display for Target, Hi Dev, and Lo Dev values when tags are
assigned to them.
If you are using manual operation and a system failure
happens, the following sequence of events occur. Operator
actions are required to rectify the manual operation status.
1 All equipment that had been manually allocated to run
phases through the manual operation batch are 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 had been previously
manually allocated, and starting the phases that had
been previously active.

InBatch User’s Guide

442  Chapter 9 Batch Management System

4 Upon restarting the previously active phases, the status

of the phase is the current status 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.

Note Manual operation can be made accessible only to personnel

with the proper security clearance. Therefore, it is their
responsibility to clean up the manual operation phases following a
system failure. Failure to properly clean up the manually
operating 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 status
and that none of these batches can automatically allocate
equipment that is needed to clean up any phase that was run
using manual operation.

Batch Display Attribute Considerations

If you are using manual operation and have created and
configured tags for the Target, Hi Dev, or Low Dev elements
in your process model, you must be aware that the elements
shown in the 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 analog data class. For the Hi Dev
element, you may have disabled the Edit Allowed attribute.
When you schedule and run a phantom batch, the Edit
Allowed attribute of the tag is enabled. The Batch Display
therefore allows the Hi Dev value to be edited even though
your process model was configured 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.

Tag Attributes:

Tag Data Class and Element Enable 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

InBatch User’s Guide

Performing a Warm Restart443

Running a Phantom Batch

You can run a phantom batch from the Batch Display dialog
box. Within the InBatch Management System, a phantom
batch is identified as follows.

Field Value

Campaign ID <manual oper>

Lot ID <manual oper>
Batch ID <manual oper>
Mode Manual

When you run a phantom batch, all the phases for any
allocated units can be processed. For phases to run, you must
manually allocate units from the Equipment Allocation dialog
box. A phantom batch has no associated history of activity.
You remove a phantom batch from the schedule by putting
the batch on Hold and then selecting Abort.

To run a phantom batch

1 Open the Batch Display dialog box.
2 Select a batch.
3 From the Actions menu, click Manual Operation.

InBatch User’s Guide

444  Chapter 9 Batch Management System

InBatch User’s Guide

445

Chapter 10

History System

The History System databases are located on an InBatch

server. The History server uses Microsoft SQL Server to
store and archive all information related to the production of
a batch, such as:
• Events

• Process data

• Production information

• Material usage

• Operator comments

Code Description

201 Batch received Start

202 Batch received Hold
203 Batch received Restart
204 Batch received Abort
205 Batch set Done
206 Batch set Closed
207 Batch Warm Restart
208 Batch Redundancy Switchover
209 Batch Set Aborted
210 Allocate
211 Release
221 Wait for Allocate
222 Received Allocate
223 Wait for Entry Ack
224 Received Entry Ack
225 Received Interlock
226 Received Ready
227 Set Start
228 Received Run
229 Set Hold
230 Received Held
231 Set Restart
232 Set Abort
233 Received Aborted
234 Received Done
235 Set Reset
236 Received Bad Ready
237 Received Bad Run
238 Received Bad Held

InBatch User’s Guide

452  Chapter 10 History System

Code Description

239 Received Bad Done Aborted

InBatch User’s Guide

History Database Tables455

Field Allow Null Type Length

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

ErrorQ
The ErrorQ table is used by the History Queue.

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
The Event table stores all InTouch alarms and events that
the batch system can associate to specific batches.

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 char 3
Event_Comment No varchar 50
Group_Name No varchar 32

InBatch User’s Guide

456  Chapter 10 History System

Field Allow Null Type Length

Operator_ID No varchar 16
Priority No smallint 2
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 controls the data in this table.

Field Allow Null Type Length

Batch_Log_ID No char 10
Material_Char_Value No varchar 16
Material_Characteric No varchar 16
Material_ID No varchar 16
Material_Instance_ID No varchar 16

MaterialInput
The MaterialInput table contains a record for every material
consumed in a batch. Batch Manager controls the data in this
table.

Field Allow Null Type Length

Actual_Qty No float 8
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 40
Material_Parameter No varchar 16
Mtrl_Batch_ID No varchar 16
Mtrl_Campaign_ID No varchar 16

InBatch User’s Guide

History Database Tables457

Field Allow Null Type Length

Field Allow Null Type Length

Actual_Value No varchar 80
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 char 10
Phase_Label No varchar 9
Target_Value No varchar 81
UnitOfMeasure No varchar 16
UnitOrConnection No varchar 16
UnitProcedure_ID No varchar 16

InBatch User’s Guide

History Database Tables461

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 controls the data in
this table.

Field Allow Null Type Length

Batch_Log_ID No char 10
CheckBy_User_ID No varchar 64
DateTime No datetime 8
DoneBy_User_ID No varchar 64
New_Target_Value No varchar 80
Old_Target_Value No varchar 80
Operation_ID No varchar 16
Parameter_ID No varchar 16
Phase_ID No varchar 16
Phase_Instance_ID No varchar 10
Phase_Label No char 8
UnitOfMeasure No varchar 16
UnitOrConnection No varchar 16
UnitProcedure_ID No varchar 16

ReportDef
The ReportDef table contains the configuration data of the
reports.

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

Name No varchar 50

InBatch User’s Guide

464  Chapter 10 History System

Batch_Log_ID No char 10
comment No varchar 256
DateTime No datetime 8
EnteredBy_User_ID No varchar 16
messageId No uniqueidentifier 16
SeqNum No int 4

AnalogAlarm
The AnalogAlarm table contains one record for each
I/A Series Analog Alarm generated during batch processing.

Field Allow Null Type Length

ack_state No char 1
alarm_limit No float 8
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

InBatch User’s Guide

466  Chapter 10 History System

Field Allow Null Type Length

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 16
messageTxtType No varchar 30
messg_text No varchar 81
Messg_Type No int 4
monotonictime No int 4
opr_err No int 4
parametername No varchar 8
pnt_no No int 4
point_name No varchar 15
priority No int 4
real_value No float 8
sbxno No char 1
sct_no No int 4
state_text No varchar 33
stepno No int 4
subrno No char 1
symbolicname No varchar 64
tenths No char 1
unit_txt No varchar 33
valid_time No int 4

InBatch User’s Guide

History Database Tables467

BooleanAlarm
The BooleanAlarm table contains one record for each
I/A Series Boolean Alarm generated during batch processing.

Allow
Field Null Type Length

ack_state No char 1
alarm_limit No float 8
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 16
messageTxtType No varchar 30
messg_text No varchar 81
Messg_type No int 4
monotonictime No int 4
opr_err No int 4
parametername No varchar 8
pnt_no No int 4
point_name No varchar 15
priority No int 4
real_value No float 8
sbxno No char 1
sct_no No int 4
state_text No varchar 33

InBatch User’s Guide

468  Chapter 10 History System

Allow
Field Null Type Length

stepno No int 4
subrno No char 1
symbolicName No varchar 64
tenths No char 1
unit_txt No varchar 33
valid_time No int 4

CodeTable
The following items apply only to I/A Series.

Code Description

500 Unit Procedure Received Run

501 Unit Procedure Received Done
502 Operation Received Run
503 Operation Received Done

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 controls the data in this table.

Allow
Field Null Type Length

ActionType No tinyint 1
block_name No varchar 15
compound_name No varchar 15
DateTime No datetime 8
Description No varchar 64
Messg_Type No int 4
[Pad] No tinyint 1
parametername No varchar 8
Station No varchar 8

InBatch User’s Guide

History Database Tables469

OperatorActions
The OperatorActions table contains a group of one or more
records for every action of an operator during a batch. Batch
Manager controls the data in this table.

Field Allow Null Type Length

ActionType No tinyint 1
Batch_Log_ID No char 10
block_name No varchar 15
compound_name No varchar 15
DateTime No datetime 8
Description No varchar 64
Messg_Type No int 4
[Pad] No tinyint 1
parametername No varchar 8
Station No varchar 8

SequenceBlock
The SequenceBlock table contains a record for each
I/A Series Sequence Block associated with a batch.

Allow
Field Null Type Length

InBatch User’s Guide

470  Chapter 10 History System

Allow
Field Null Type Length

loopId No varchar 33
messageId No uniqueidentifier 16
messageTxtType No varchar 30
messg_text No varchar 81
Messg_Type No int 4
monotonictime No int 4
opr_err No int 4
parametername No varchar 8
pnt_no No int 4
point_name No varchar 15
priority No int 4
real_value No float 8
sbxno No char 1
sct_no No int 4
state_text No varchar 33
stepno No int 4
subrno No char 1
symbolicName No varchar 64
tenths No char 1
unit_txt No varchar 33
valid_time No int 4

InBatch User’s Guide

471

Chapter 11

Reporting System

The reporting system enables you to configure, schedule,

view and print reports relating to the batch history that is
stored on the InBatch History Server. Wonderware
Information Server acts as a portal for InBatch reports.
For details about the software that you need to use the
reporting system, see the InBatch Installation Guide.

Reporting System Architecture

The following diagram is a high level overview of the
reporting system.

InBatch User’s Guide

472  Chapter 11 Reporting System

Reporting System Components

The reporting system uses a variety of software components.
Some are industry standard components and others are
unique to the batch system. This section describes the
primary components of the reporting system. It is
recommended that you familiarize yourself with the
components as this enables you to more clearly understand
how to deploy the reporting system.

InBatch Server
The InBatch Server contains one reporting system
component, the History Queue Manager. The History Queue
Manager is installed with the InBatch Server.

History Queue Manager

The History Queue Manager transmits data to the History
Server. This guaranteed delivery is accomplished by
maintaining the data locally in the case of a disconnection
and then transmitting the data when the connection is
restored. All data is time stamped by the InBatch Server so
that if data communications to the History Server are
interrupted, the time and date stamps are still accurate.

InBatch History Server

The InBatch History Server is dedicated to the storage of
historical information.
The InBatch History Server uses Microsoft SQL Server, a
History Queue, and a History Queue Reader Service.

History Queue
The History Queue is a first-in-first-out (FIFO) queue which
is located on the InBatch History Server that is responsible
for transferring all historical data from the Batch Manager
on the InBatch Server to the Batch History database. 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 processing task
(service) which runs on the InBatch History Server and is
responsible for reading historical data and report requests
from the history queue, storing the data on the Microsoft
SQL Server, and queuing report jobs to the SQL Server
database.

InBatch User’s Guide

Reporting System Components473

Wonderware Information Server

When you install the reporting components on the
Wonderware Information Server, they enable you to
configure, schedule, and view reports. You can define
schedules for the reports or interactively request a report on
an as-needed basis.

Report Queue
The Report Queue is a First-In-First-Out (FIFO) queue
located on the InBatch History Server that handles all
requests for reporting activity. The queue also contains all
parameter data necessary for the processing of the report.

Report Queue Reader

A background processing task (service) that coordinates the
generation of reports as directed from the report queue.

Report Client
The report client is any PC that has Microsoft Internet
Explorer. Based on your Wonderware Information Server
permissions, you can configure, schedule, and view reports.
You can also run reports on demand.

To Configure Reports for using a remote InBatch History DB

1 Open the Wonderware Information Server portal.
2 In the Wonderware Information Server Navigation pane,
expand Administration and click Data Source Manager. A
list of configured data sources appears.
3 Select your InBatchSDS data source name, and click
Modify. The Data Source Manager page appears.

InBatch User’s Guide

474  Chapter 11 Reporting System

4 Click Test Connection. If your remote data source is

configured properly, the Connection Succeeded message
appears.
5 In the Wonderware Information Server Navigation pane,
expand Reports, and then click InBatch Reports link.
6 Run any of the reports and verify that the report is
generated and appropriate data appears.
If AlarmDB is on a different node than Wonderware
Information Server, only then the Linked server
InBatchAlarm will be created. The linked server must be
configured with SQL credentials to work.

To change the credentials for a linked Server

1 Run the Microsoft SQL Server Management Studio
program.
2 Go to Server Object and click Linked Servers. A Linked
server is created when you install the product using the
Report content with the Alarm sub feature.
3 Go to the properties of Linked server InBatchAlarm.
4 Go to Select a page and click Security below this window,
and select Be made using this security context option and
type the credentials of SQL Server where alarm database
is present.
5 Close the window.
6 Right-click the InBatchAlarm linked server and test the
Test Connection using the shortcut menu. The test should
be successful.
7 Go to reports in the Wonderware Information Server
portal and run Batch Alarm reports.

InBatch User’s Guide

Reporting System Security475

Reporting System Security

Reporting security is handled through Wonderware
Information Server rather than InBatch Security. You can
configure users and groups to have access only to information
that is specific to their needs.
For details about configuring security on Wonderware
Information Server, refer to “Managing Security” in the
Wonderware Information Server Administration Guide.

Administering the Batch Reporting System

The InBatch reporting web pages on Wonderware
Information Server enable you to perform the following
activities:
• Configure reports

• Schedule reports

• View reports

• Interactively run reports on demand

Using Report Templates

The following report templates are provided for you to use as
a basis for creating your own customized reports.
These report templates are intended only to be used as
examples for the development of custom reports. These
templates are stored on the computer where you installed the
reporting software in the following folder:
C:\Program Files\Wonderware\InBatch\Reporting Services

A summary of each template is provided in the following

table.

Report Name Description

Batch Alarms Provides a summary of all alarms for a specific batch.

BatchDetail Provides a summary of all batch processing activity for a
batch.
Batch Events Provides a listing of the batch events for a recipe.
Batch Journal Provides a comprehensive journal of batch history for a
specific batch.
Batch Listing Provides a summary report of all batches produced.
Batch Questions Provides a summary of all questions for a batch.

InBatch User’s Guide

476  Chapter 11 Reporting System

Report Name Description

Batch Transitions Provides a summary of all batch transitions.

Batches By Material Provides a list of batches that used a specific material or
material from a specific vendor.
Document View Events Provides a listing of the Documentation Review events
for a recipe.
EquipmentStatus Provides a listing of all Equipment Status changes that
occurred during batch processing.
Material Characteristics Provides a summary of all material characteristics for a
campaign, lot and batch.
Material Input Changes Provides a summary of the changes made by operators to
the original formula inputs quantities for a batch.
Material Inputs Provides a summary of all materials consumed in a
batch.
Material Outputs Provides a summary of all materials produced by a
batch.
Material Output Totals Totals all materials produced for a batch.
Operator Comments Provides a summary of all operator comments for a
batch.
Phase Instructions Provides a summary of all recipe phase instructions for a
batch.
Process Log1 Provides a summary of all process log values for a batch.
Process Log2 Provides statistical information of all process log values
recorded for a specific tag.
Process Log3 Provides a graphical representation of all process log
values recorded for a specific tag.
Process Variables Provides a summary of all process variable target and
actual values for a batch.
Process Variable Provides a summary of changes made by operators to the
Changes original formula process variables for a batch.
Production Provides a summary report that includes number of
finished products produced, number of lots, number of
batches and total quantity produced.
Production By Lot Provides a summary of all finished products produced.
Security Listing Provides a summary report of all security related
activity for a batch.

InBatch User’s Guide

Administering the Batch Reporting System477

Note InBatch 8.1 and later 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 appear in the list of configured reports on the
Configuration web page. The report names exist in the ReportDef
table in batch history. However, these reports are not generated.

Additional Report Templates for I/A Series

Components

Report Name Description

Batch Analog Alarms Provides a listing of analog alarms issued for a batch.
Alarm comments that were entered for an analog alarm
with the Alarm Comment application are also included
in the report.
Batch Boolean Alarms Provides a listing of Boolean alarms issued for a batch.
Alarm comments that were entered for a Boolean alarm
with the Alarm Comment application are also included
in the report.
Non-Batch Operator Provides a summary of all non-batch-related operator
Action Journal actions that occurred during a batch.
Operator Action Journal Provides a summary of all operator actions during a
batch.
Sequence Block Alarms Provides a listing of sequence block messages issued for
a batch. Comments that were entered for each sequence
with the Alarm Comment application are also included
in the report.

InBatch User’s Guide

478  Chapter 11 Reporting System

Accessing the Batch Reporting Pages

You can use Wonderware Information Server to access
InBatch reporting capabilities.

To change your browser path for reports

1 Click Programs > Wonderware > InBatch > InBatch
Configuration Utility.
2 Click InBatch Reporting Content.
3 In the InBatch History Server Host Name box, type
localhost (only if Wonderware Information Server and the
History Server software on the same node).
4 Click Configure.

To open the Batch Reporting web page

 On the Environment Display dialog box, click the
BatchReport icon.
The Wonderware Information Server base page opens.

Configuring Reports
You can add, view, edit, and delete report configurations to
the reporting system.
You must have administrative rights to be able to access this
capability. For more information about Wonderware
Information Server security, see the Wonderware
Information Server Administration Guide.

InBatch User’s Guide

Configuring Reports479

To access the report configuration menu

1 On the Launch Pad, expand Administration, then InBatch
Manager, and then Reports.

2 Click Configuration.
In the right pane, the Configuration page opens.
You can see a list of configured reports.
The following figure is an example.

InBatch User’s Guide

480  Chapter 11 Reporting System

To add a report configuration

1 Click Add Report.
The Add Report Config form appears.

2 In the Name box, type a name for your report.

3 In the Description box, optionally type a brief description
of the report.
4 From the Report Template box, select a template for the
report.
5 If you want the report to go to a printer, select the Output
to Printer check box.

Note To use this option, you must modify the

InBatch_ReportQueReader service logon to include the account
that was used to log on to the Reporting Content server.

6 If you are outputting the report to a printer, select a

printer name from the Printer box.
7 If you want the report to be saved to a file, select the
Output to File check box.
8 If you are outputting the report to a file, type the
complete path information in the Output Path box.

Important The folder for the file must already exist and be
shared with full permissions. If you do not share the folder, the
reports are not saved to the specified location.

9 If you are outputting the report to a file, select the file

type from the Output Type list.
10 Click Add Report.

InBatch User’s Guide

Configuring Reports481

To view or edit a report configuration

1 In the Launch Pad pane, expand Administration > InBatch
Manager > Reports > Configuration.
2 Click Configuration.
The Configured Report form appears in the right pane.
3 In the Configured Reports list, click the Edit icon for the
report that you want to edit.

The Report Config > Edit Report form appears.

4 Edit the report configuration information as needed.

5 Click Update Report.

InBatch User’s Guide

482  Chapter 11 Reporting System

To delete a report configuration

Note Before you delete any reports, it is recommended that you

perform a back up of your reports.

1 In the Launch Pad pane, expand Administration > InBatch

Manager > Reports > Configuration.
2 Click Configuration.
The Configured Report form appears in the right pane.
3 Click the Delete icon corresponding to the configured
report that you want to delete.
The Report Config > Delete Report form appears.

4 Click Delete Report.

When you delete the report configuration, its definition is
removed from the system and its name is removed from
the History Server database.

InBatch User’s Guide

Configuring Reports483

Scheduling Configured Reports

You can define schedules for the reports that you have
configured. You can schedule reports for one time only or on a
recurring basis. The schedules are stored on the Wonderware
Information Server. You can edit them as your specific
application requires.

To open the Report Schedule page

To schedule a weekly report

InBatch User’s Guide

Configuring Reports489

6 The Report Duration area enables you to designate the

amount of batch data that you want to include by
specifying a period of elapsed time.
• If you select Preset Duration, you can select a period of
elapsed time from the list.
• If you select Custom Duration, you can type a period of
elapsed time in the Minutes box.
7 In the Occurs area:
a Type the frequency of occurrence, in weeks.
b Select the day on which the report is to be run.
8 In the Daily Frequency area, you can select options for the
report to run once or at intervals during the day:
• If you select Occurs Once, enter the time in the box.
• If yo select Occurs Every, enter an interval number in
the box, select an interval type, and enter start and
end times.
9 In the Duration area:
a Type the Start Date in the box.
b Select either No End Date if you want the report to run
on a recurring basis or End Date. If you select End
Date, type an ending date in the box.
10 Click Save Report Data.

InBatch User’s Guide

490  Chapter 11 Reporting System

Scheduling Monthly Reports

If you select Monthly Reports, a specific form appears.

5 Click Save Report Data. The content of the page varies

depending on the type of schedule that you have defined.

InBatch User’s Guide

494  Chapter 11 Reporting System

To delete a scheduled report

1 In the Launch Pad, expand Administration, then InBatch
Manager, then Reports.
2 Click Schedule.
3 In the Schedule New Report list, locate the Name of the
schedule that you want to delete and then click the Delete
icon.
The report schedule is deleted from the Schedule New
Report list.

Scheduling an End of Batch Report

To schedule an end of Batch Report

1 In the Name box, type the name for the scheduled report.
2 Select the Enabled check box.
3 In the Report Selection list, click the End of Batch report
that you previously configured.
4 In the Schedule Type list, click End of Batch.
5 In the Description box, optionally type text that describes
the report.

Administering the Report Log

You can remove reports that are no longer needed from the
location where they were saved. To remove them from the
View Reports web page use the Report Log Admin button.

To remove old reports

1 Locate and delete the reports using Windows Explorer.

Note The location of saved reports was specified during the

configuration process.

2 Open Wonderware Information Server.

3 On the Launch Pad, expand Administration > InBatch
Manager > Reports.
4 Click Report Log Admin.
The Report Log Admin page appears in the right pane.
5 Click Update.
The History Server updates the database so that the
reports that you deleted no longer appear on any web
page.

InBatch User’s Guide

Viewing Automatically Generated Reports495

Viewing Automatically Generated Reports

The View Report web pages enable you to run and view
reports that have been automatically generated by InBatch.
That is, these are reports that you configured and scheduled
to run at a specific time.

To open the report view web page

 In the Launch Pad, expand the InBatch option and click
View Reports.

Note This option is listed separately from the Administration

functions.

All the reports that have been previously defined appear

in the Reports list.

InBatch User’s Guide

496  Chapter 11 Reporting System

To view a report

Note You must have appropriate permissions to be able to view

Using the Date and TIme Area

The following figure shows the Date Time area of the report
form.

1 Select a start date and time.

The current date and time is the default.
2 Select a time offset from the list.
The result is shown in the end data and time box.

Basic Filtering Criteria

Each report form has the following control options that you
can use to affect the data that is returned.
• Auto-populate list boxes

• Show filter criteria on the report

• Show report as expanded or collapsed

Auto-Populate List Boxes

The list of possible values for a field can become very large.
True (the default) disables the retrieval of all possible values
from which to select for each of the filter fields.

Show Filter Criteria

You can select whether or not the filter values that you used
are to be shown as part of the report.

InBatch User’s Guide

Interactively Generating Reports501

Show Report as Expanded or Collapsed

You can select whether the generated report is to be shown
as fully expanded or completely collapsed.

Detailed Filtering Criteria

Each data item on the report has three possible areas for
filtering:
• A box where you can enter wildcard filtering characters.

• Controls that affect whether or not that item is to be used

for filtering.

• A list of possible values to select from.

The following figure shows an example of this filtering

criteria for a data item.

InBatch User’s Guide

502  Chapter 11 Reporting System

Filtering Data with Wildcards

You can use wildcards to filter the reporting data results
according to specified criteria. Use one or more of the
following wildcards.

Wildcard Function and Example

% Any string of zero or more characters.

Example: M%
Matches all values starting with M
followed by any character sequence.
_ (underscore) Any single character.
Example: M_B
Matches all values starting with M
followed by any character followed by B.
[] Any single character within the specified
range.
Example: M[a-z]
Matches all values starting with M
followed by any single lowercase
character.
[^] Any single character not within the
specified range.
Example: M[^a]
Matches values starting with M followed
by any single character that is not a.

InBatch User’s Guide

Interactively Generating Reports503

Viewing the Generated Report

After the generated report appears in the right pane, you can
do any of the following:
• Scroll back and forth through the report pages.

• Zoom in or out.

• Search for specific data.

• Refresh the data.

• Print the report.

• Save the report to one of the following file formats:

• XML
• CSV (comma delimited)
• TIFF (graphic image)
• Acrobat (PDF)
• Web archive (HTML)
• Excel

InBatch User’s Guide

504  Chapter 11 Reporting System

InBatch User’s Guide

505

Chapter 12

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.

Overview
You can 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 control how the
groups of tags and their respective values are sampled and
logged at run time by the Process Log Manager.

InBatch User’s Guide

506  Chapter 12 Process Logging

The Process Logger is designed to handle a low volume of

variables changing at a relatively low rate. For data storage
capabilities that can handle a large volume of data and
high-speed acquisition rates, see the Wonderware Historian
documentation for an optimal solution.

Selecting a log trigger and a log interval are two very
important criteria when you create a process log group.

Log Trigger
The Log Trigger defines the conditions that initiate logging
for the group. The Log Trigger options are Always and On
Event.
• If you select Always, logging begins as soon as the
run-time Process Log Manager starts.
• If you select On Event, a True or False Boolean expression
is evaluated. If the result of the expression is True,
logging occurs.

You define expressions using the Expression Editor. Use the

Expression Editor to create a True or False Boolean
expression using any of the tags in the process model. For
example, a Boolean expression could 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.
For more information on building expressions, see Chapter
14, Expression Editor.

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 you select On Event, you must define a True
or False Boolean expression. Use the Expression Editor to
create a True or False Boolean expression 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.
For more information on building expressions, see Chapter
14, Expression Editor.

Configuring a Log Trigger and a Log Interval

You can configure a Log Trigger and a Log Interval for a
process group. Logging takes place only when the trigger and
interval settings are satisfied.

To select a log trigger and a log interval

1 Open the Process Logger Group Editor dialog box.
2 In the Log Trigger list, click On Event.
3 Click Expression to open the Expression Editor.

InBatch User’s Guide

510  Chapter 12 Process Logging

4 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.

5 Click OK to close the Expression Editor.

The expression that you entered appears in the
expression box of the Process Logger Group Editor.

6 In the Log Interval list, click an interval.

7 Configure the log interval by repeating repeat steps 3
through 5.

InBatch User’s Guide

Process Log Groups511

Selecting a Data Destination

You can define where data is logged to at run time. Data can
be logged to the Historian, a printer, or both.

To select a data destination (printer or Historian)

1 Open the Process Logger Group Editor.
2 To log process data to the history database, select the
Historian check box.
3 To log process data to a printer, do the following:
a Select the Printer check box.
b Click Printer.
The Printer Selection dialog box appears.

c Select the printer and then click OK.

To open a configuration
1 Open the Process Log Editor dialog box.
2 On the File menu, click Open.
The Configurations dialog box appears.

3 Select the configuration that you want to open.

4 Click Open.
If you edited a configuration and did not save it, you are
prompted to save or discard it before opening a different
one.

Deleting a Process Log Configuration

You can delete a process log configuration from the database.
When you delete a process log configuration, it is removed
from the database. However, the Process Log Editor still
shows the Configuration Name and Description of the deleted
configuration. To clear these fields, you must use the File >
New command.

To delete a configuration
1 Open the Process Log Editor dialog box.
2 On the File menu, click Delete.
The Delete dialog box appears.
3 Select a configuration.
4 Click OK.

InBatch User’s Guide

Process Log Groups515

Printing Process Log Configuration Reports

524  Chapter 13 Security System

3 If you are using Standard security mode, you can change

information in the following boxes.
When you are using Operating System or ArchestrA
security, these parameters are managed by the operating
system or ArchestrA settings. Refer to the appropriate
documentation for details.

Security Restriction Description

Retries Designates the number of requests that a user is

permitted to attempt to obtain a security clearance. If
the number of retries is exceeded, an error message
appears and access is denied. For example, if the
retries value is set to 2, the error message appears
following the third invalid entry. If desired, an
operator may immediately re-attempt to obtain
security clearance.
Password Timeout (Days) Specifies the time period, in days, that a password is
valid. Any passwords older than the set period
automatically expire. After a timeout, the user is
required to enter their old User ID and Password
before security clearance is granted. The user is then
required to change their password when security
clearance is requested.
Password Reuse (Days) Specifies the time period, in days, that must pass
before a password can be re-used. This feature
prevents operators from repeatedly using the same
password.

4 Optionally add comments about the security system

configuration.
5 Click Change.

InBatch User’s Guide

Using the Security Editor525

Changing Security Modes

If you are changing security modes, follow this procedure
carefully for changes to be enabled.

5 Click Query.
• If you selected Users, all available users appear in the
list with a blue icon beside the user name.
• If you selected Groups, all available groups appear in
the list with a red icon beside the group name.
• If you selected both Users and Groups, users are listed
first, followed by groups.
The following figure shows a list of both users and
groups.

6 From the User ID/Group Name list, select a user or group.

7 Click OK or Apply as appropriate.

InBatch User’s Guide

Working with User or Group Accounts533

Working with User and Group Accounts in

ArchestrA Mode
If you are using ArchestrA security mode, your choices are
limited by the ArchestrA security settings that are already
configured. You must know which ArchestrA security mode is
being used:
• Galaxy (user-level only)

• OS Users

• OS Groups

Note To be able to browse the Galaxy name space, the IDE must
be installed on the computer you are browsing from.

Your InBatch implementation must also meet the following

prerequisites:
• You must define your Galaxy access name in the Tag
Linker. Otherwise, you see a security error message.

application
• Assign security roles that restrict access to application

• Assign security roles required for the Done-By and

Check-By functions

Enabling Application Security

Enable application security if you need to restrict access
when a specific application starts. You can assign each
application one or more security access roles if security is
enabled and more than one level of user is permitted to
access the application.

Note To properly enable security, you must enable the check box
in the Applications-Functions Editor and define at least one level
of security access.

For more information about enabling AdminWeb and

ReportWeb application security, see Chapter 22, System
Administration.

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 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 can pass a security request.

InBatch User’s Guide

540  Chapter 13 Security System

To enable and assign application security roles

1 Open the Applications-Function Editor dialog box. This
example shows only the Applications area.

2 Select an application.
3 Select the Security Enabled check box.
4 Click Access. All security roles that have been defined
using the Security Roles Editor are shown in the Assign
Security Roles dialog box.
5 Select one or more security roles and click OK.
6 Click Change.

Adding a New Application

Adding a New Function

You can add new functions to applications that you have
developed.
The InBatch Security System includes 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. You cannot change the default
function ID and name. If you alter the ID or name
information, an error message appears.

Note When you design a new function, make sure to use the same
application ID when you make security clearance requests through
the Security API.

To add a new function

1 Open the Security Editor dialog box.
2 On the Edit menu, click Application-Functions.
The Applications-Functions Editor dialog box appears.

3 In the Applications area, select the application that you

have developed.

InBatch User’s Guide

544  Chapter 13 Security System

4 In the Functions area, do the following:

a In the ID box, type a unique identification number
between 1 and 999.
b In the Name box, type a unique name (64 characters
maximum).
c In the Description box, optionally type a description
(120 characters maximum).
d To enable the need for security at function startup,
select the Security Enabled check box.
e To assign security roles to the function, click Done By
and Checked By. See Enabling Function Security on
page 542.
f Click Add.

Validating Your Security Configuration

You can validate your 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 not negative.

To validate your security configuration

 On the File menu, click Validate.
If validation errors exist, the associated tags appear
along with a validation error message.

Using Run-Time Security

The run-time security system interacts with the security
database and the security API to permit or deny requests for
security clearance that are received from the batch control
applications.

Running the Security Manager

If you installed InBatch correctly, the Security Manager runs
as long as the batch server node is turned on and is operating
correctly.

To verify that Security Manager is running

1 Access the Environment Display dialog box.
2 On the View menu, click Status.
The System Application Status dialog box indicates the
current status of the security system.

InBatch User’s Guide

Using Run-Time Security545

Changing Passwords
You can change user passwords if you have appropriate
rights.
You can change passwords only in Standard and Operating
System security modes.

To install the Change Password utility

Note When a user-defined application or function is run, the code

for the application or function must transmit the required
security request to the Security Manager through the Security API.
As with the default applications and function, employees must
enter their ID number and password. If an employee is permitted
to use the application or function, it becomes available. If the
employee is not permitted to access the application or function,
an error message notifies the person that permission has been
denied.

InBatch User’s Guide

549

Chapter 14

Expression Editor

Use the Expression Editor within the Recipe Editor and

Process Log Editor to construct expressions. An expression
consists of predefined functions. For each application, the
expression normally returns a logical true or false result.
Enter expressions when you define recipes or other
configurations. 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 or 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 the Expression Editor

The Expression Editor functions like a calculator, except that
results are not calculated immediately. Instead, expressions
are evaluated and results are returned whenever the
application needs them.
You construct an expressions using the formatting
commands, numeric keypad, operators, delimiters, tags, and
functions. You can enter expressions using the mouse or the
computer keyboard.

InBatch User’s Guide

550  Chapter 14 Expression Editor

Starting the Expression Editor

Whenever an application requires you to define an
expression, you can open the Expression Editor.

Defining an Expression
Define expressions in the edit area of the Expression Editor.
The edit area functions much like a word processor. All
entries are automatically inserted to the right of the cursor.
Therefore, each time you select a numeric key, operand, or
delimiter key, the character is inserted. You can also use
your computer keyboard to enter an expression.
After you complete the expression, click OK or Apply to save
the expression to the target object. If the expression is not
valid, an error message appears to indicate the nature of the
error. The cursor is positioned near or immediately after the
error.

InBatch User’s Guide

Using the Expression Editor551

Using Formatting Commands

Use the formatting commands (Space, Back Space, New Line,
Tab, Store, Recall, Clear, and Reset) to construct expressions.
Store and Recall are two buttons that are especially helpful
for reusing expressions.
Whenever you click the Store button, the expression
appearing in the edit area is stored. Use the Recall button to
retrieve and the stored expression. This feature is extremely
helpful when there are several expressions that are similar.

To use the Store and Recall buttons

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 Select the new target object.
As a result, the edit area is cleared.
3 Click Recall to retrieve the expression.
4 Modify the expression as needed,
5 Click Apply.

Inserting Tag Operands

You can enter functions by typing them in or you can
automatically insert them into the expression by using the
selection dialog boxes. The details of each function are
described in the following pages.

To insert a tag operand

1 Click inside the edit area at the desired position.
2 Click Tags.
The Tag Selection dialog box opens.
3 Select the desired tag.
This action inserts the tag, with the appropriate
delimiters, into the edit area.

InBatch User’s Guide

552  Chapter 14 Expression Editor

Entering Functions
You can enter functions by typing them in or you can
automatically insert them into the expression using the
selection dialog boxes.

To insert a function
1 Click the edit area at the desired position.
2 Click Functions.
The Functions dialog box appears.

3 Select the desired function to insert it, with the

appropriate delimiters, into the edit area.

Expression Elements
The following sections describe the elements available for
constructing expressions.

Operators
An operator is a symbol used to manipulate the value of one
or more operands. The following table describes the valid
operators from highest precedence to lowest.

Operator Symbol Description

Negate – Negates value of the next operand.

Multiply * Multiplies values of the previous and next operands.
Divide / Divides the value of the previous operand by the next
operand.
Modulus % Remainder of the division between the previous operand
and the next operand.

InBatch User’s Guide

Expression Elements553

Operator Symbol Description

Add + Adds values of the previous and next operands.

Subtract - Subtracts value of previous operand by next operand.
Less Than < True if the previous operand is less than next operand;
otherwise, it is False.
Less Than or <= True if the previous operand is less than or equal to next
Equal To operand; otherwise, it is False.
Greater > True if the previous operand is greater than the next
Than operand; otherwise, it is False.
Greater >= True if the previous operand is greater than or equal to the
Than or next operand; otherwise, it is False.
Equal To
Equal To = True if the previous operand is equal to the next operand;
otherwise, it is False.
Not Equal To <> True if the previous operand is not equal to the next
operand; otherwise, it is False.
And & True if the previous operand and the next operand are
True; otherwise, it is False.
Or | True if the previous operand or the next operand is True;
otherwise, it is False.
Assignment := No usable return value. Writes the next operand to the
previous operand.

Operands
Operands can be of type Boolean (True or False; also referred
to as discrete), numeric (any positive or negative number)
and string (alpha-numeric string of any length). The
following table describes the valid operands.

Operand Type Description

Numeric Numeric Numeric values. (for example, 123.456)

Constant
String Constant String String of characters within double quotes. (for
example, "Allocated")

InBatch User’s Guide

554  Chapter 14 Expression Editor

Functions
There are seven functions. All the functions are available in
the Recipe Editor. However, only the Not function is
available in the Process Log Editor applications.

Function Example Description

Ask Ask Used only in the Recipe Editor to ask yes or no

(“Continue?”) type questions of operators.
AskDoneBy AskDoneBy Used only in the Recipe Editor to ask yes or no
(“Continue?”) type questions that require confirmation that the
question has been answered.
AskCheckBy AskCheckBy Used only in the Recipe Editor to ask yes or no
(“Continue?”) type questions that require confirmation and
verification that the question has been answered.
Not Not(Ask("OK?")) Negates the result of the Boolean expression
within the parenthesis. 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, processing is delayed by the
specified number of seconds.
WaitMin WaitMin(30) Used only in the Recipe Editor. When
encountered, processing is delayed by the
specified number of minutes.
WaitHour WaitHour(1) Used only in the Recipe Editor. When
encountered, processing is delayed by the
specified number of hours.

Delimiters
The following five delimiters are used to identify operands
and to build expressions within expressions (recursive
expressions).

Delimiter Example(s) Description

Parentheses - (...) ((10 + 1) * 20) Used for setting precedence.

Ask("OK?") Used to define a function argument.
Not(Ask("OK?")) Used to nest expressions.
Quotes – “...” ‘Text String” Used to identify a string.
Comma -, N/A Used to separate function parameters, which
can be operands or expressions.

InBatch User’s Guide

Expression Building Guidelines555

Expression Building Guidelines

Follow these guidelines when you define expressions:
• Dividing by zero returns a result of zero.
• Negate is only valid on numeric operands.

• Add, Subtract, Multiply, and Divide are valid only when

used with numeric operands.

• Use Modulus only with numeric integer values.

• 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 or
expressions that have a non-Boolean result.
• And and Or operators are valid only when evaluating
Boolean operands or expressions that have a Boolean
result.
• The operand to the left of the Assign operator (:=) must be
a Tag operand.

• You can make tag assignments, but they require a special

format so that the overall expression results in a Boolean
value. You must define assignment expressions with the
following format:
({Tag}:+Value)=1
Examples of tag assignment expressions are provided
later in this section.
• Equipment must be allocated for gats to work properly in
the expression.

WARNING! Tag assignment can be constructed in the

Expression Editor. However, use caution in defining these
expressions. Only tags with an access of Read/Write can be
used in assignment expressions. If you create assignment
expressions using Read Only tags, run-time errors are
generated.

InBatch User’s Guide

556  Chapter 14 Expression Editor

Expression Examples
The following tables show expression examples for tags and
functions.

Tag Examples
The following tags are used in the examples that follow.

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 illustrate the types of expressions

that you can create, as well as expressions that are invalid.

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

InBatch User’s Guide

Expression Examples557

Expression Result Description

{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
operation valid.

Function Examples
The following examples illustrate the types of expressions
that you can create and expressions that are invalid.

Expression Result Description

Ask("Ready?") Valid Operator is asked a question. The Ask function does

not evaluate True or False until the question is
answered.
WaitSec(10) Valid 10 second delay. The WaitSec function does not
evaluate to True until the 10 seconds has expired.
(Note: It has No state True or False before the 10
seconds are up).
5<3 Valid Evaluates to False.
WaitMin(5 + 5) Valid 10 minute delay. Evaluates to True after 10 minutes.
Until then, it is neither True nor False.
Ask("OK?") | Valid This is a valid expression but it may not yield the
WaitSec(10) expected results. Since both functions must evaluate
for the expression to evaluate, the expression acts
more like an And than an Or.
Ask("OK?") & Valid Though not obvious, this expression has exactly the
WaitSec(10) same result as the one above.
WaitSec(10) Or Invalid The Or operator is invalid. Use the | character.
WaitSec(5)

InBatch User’s Guide

558  Chapter 14 Expression Editor

InBatch User’s Guide

• Control inputs

• Control outputs

• Formula parameters

• Control buttons

• Interlocks
• Alarms.

These items are transmitted between the control system and

the batch control system through tags. The phase block acts
on this information to control the process equipment.

InBatch User’s Guide

Designing Phase Blocks563

Understanding Phase Block Operations

There is a logical progression that the phase block logic
should follow. As you can see in the flow chart that follows,
the phase block uses the phase control bits to proceed
through the code as long as the particular phase status bits
are satisfied. You must also write code to provide the phase
block with interlock and alarm conditions.
The sequence of events for a typical phase block is as follows:
1 When a phase block is inactive, the phase status is
Ready. The only way that this cannot be true is when the
phase block is interlocked.
2 When the block is required to operate, the batch control
system sends any required formula parameters followed
by a Start command.
3 When the Start command is received, the phase block
enters the Run state and processes the block logic.
4 During the remainder of the operation, the block can be
put into the Held state through the Batch Control System
phase control Hold command, or if a critical alarm
condition occurs.
5 From the Held state, 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 state and
ends the block operation. The batch control system
monitors this Aborted status, and sends a phase Reset
command to return the block to the Ready state.
6 If the phase block continues to completion, the status
becomes Done.
7 The batch control system monitors the Done status, and
similar to the Aborted status, sends a phase Reset
command to return the block to the Ready state.
This sequence of events is followed each time that the phase
block is included in the current Batch Control System recipe
configuration.

InBatch User’s Guide

564  Chapter 15 Phase Logic Development and Testing

Unit Control and

Status Words

Process 1 Unit 1 Phase 1

Transfer from Unit 2 Phase 2

Process 1 to
Process 2

Unit P Phase Q

Process 2

Transfer from
Process 2 to Connection 1 Phase 1
Process 3

Connection 2 Phase 2

Process N
Connection R Phase S

System Outputs

End of Control
System Program

InBatch User’s Guide

Designing Phase Blocks571

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, the
control system code exists for all of the 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 before 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 these
connections, the control system code exists for all of the
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 vary 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 of the relevant batch Hold, Restart, and Abort
commands from the Batch Control System and performs the
requested action on each of the phases associated with this
unit.

System Alarms
All the logic that generates control system alarms appears in
one section of the program. You can then reference the
specific alarms to affect the operation of a phase.

InBatch User’s Guide

572  Chapter 15 Phase Logic Development and Testing

System Outputs
All the logic required to exercise the control system outputs
is located 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.

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 handles the unit Hold, Restart, and Abort.
When the batch control system needs to change the status of
a recipe, it writes to a tag in the control system that
corresponds to the particular unit control bit. Similar to the
phase control bits, these commands are typically packed into
a word 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 at a time. The particular control bits
are used within each phase block associated with the
particular unit, and the phase operation responds
accordingly.
Transfer phases that use a unit placed on Hold act according
to customer specifications. Usually, when the unit is the
source of the transfer, the phase is Hold, and when the unit is
the destination of the transfer, the phase continues to
completion.
We recommend that the control system also contain unit
status bits. These status bits are not monitored by the Batch
Management System, but they are very useful within the
operation of the control system program.
The batch control system provides an enhanced Unit Control
option which consists of two Hold propagation modes that
you can use to propagate a phase Hold during batch
processing.

Hold
The unit Hold command is enabled by the Batch
Management System for all units that are allocated when a
batch hold command is run. 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 are set.

InBatch User’s Guide

Designing Phase Blocks573

Restart
The unit Restart command is enabled by the Batch
Management System for all units that are allocated when a
batch Restart command is run. The phase blocks associated
with the unit respond according to the user specification.
When the unit Restart bit is enabled, none of the remaining
unit control bits are set.

Abort
The unit Abort command is enabled by the Batch
Management System for all units that are allocated when a
batch abort command is run. The phase blocks associated
with the unit respond according to the user specification.
When the unit Abort bit is enabled, none of the remaining
unit control bits are 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 status
bit is set when there is no processing of any of the phase
blocks associated with the unit and all the phases have been
reset and are ready for processing. When the Ready status
control relay is enabled, none of the remaining unit status
bits should be set.
This status bit is used only within the control system
program and is not monitored by the batch control system.

Run
The Run 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 Run status bit is
set when any of the phase blocks associated with the unit
start and everything in the phase blocks is processing
normally. When the Run status control relay is enabled, none
of the remaining unit status bits should be set.
This status bit is used only within the control system
program and is not monitored by the batch control system.

InBatch User’s Guide

574  Chapter 15 Phase Logic Development and Testing

Held
The Held 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 Held status
bit 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 status
bits should be set.
This status bit is used only within the control system
program and is not monitored by the 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 used only within the control system
program and is not monitored by the batch control system.

Unit Status
The following figure shows the unit block interface between
the Batch Management System and the control system logic.
Note that there is no Start control signal as there is for
phases in the Phase Block Control State Diagram.

Recipe Parameters

Batch Status

Ready
Hold
Run
Unit Restart Unit Unit
Logic Held
Control Abort Status
Alarm

InBatch User’s Guide

Designing Phase Blocks575

Before allocating a unit, the Batch Management System

checks the unit status. If it is an acceptable value, it allocates
the unit.

On Batch Clients, when a batch (not a phase) Hold, Restart,

or Abort action initiates, the Batch Manager sends the
corresponding unit control signal to all the units allocated for
the corresponding batch. The Batch Manager does not verify
that these unit control signals are used.
Control system logic sets the unit status, which is monitored
by the Batch Manager for a satisfactory status before
allocating the particular unit. During batch processing, the
Batch Manager sends batch status information (Run, Held,
and Aborting) to all of the unit blocks associated with the
batch.

InBatch User’s Guide

576  Chapter 15 Phase Logic Development and Testing

Batch Manager generates unexpected status error messages

during phase logic processing if the status change is against
the rules for phase logic. For example, if the phase status
goes from Held to Ready. These messages are not generated
for the following scenarios:
• A unit is not allocated, has an Available status, but has
Run, Held, or Alarm state.

• A unit state goes to Ready while phases for that unit are
still active.

Designing Phase Blocks581

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 formula 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.

Formula Parameter Types

There are three types of formula parameters: Input, Output,
and Process Variable.
• Input parameters define and monitor the addition
(input) of a material to a batch. A common Input
parameter is Quantity.
• Output parameters define and monitor the production
(output) of a material from a batch. A common Output
parameter is Quantity.

• Process Variable parameters define how a phase

should function when the phase is running. 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.

Formula Parameter Type Extensions

Each type of formula parameter has a set of optional
extensions.

Input Parameter Extensions

The following items are Input parameter extensions:
• Target

• Actual

• High Deviation

• Low Deviation

• Preact

• Lot Code

• Material ID

InBatch User’s Guide

582  Chapter 15 Phase Logic Development and Testing

Output Parameter Extensions

The following items are Output parameter extensions:
• Target
• Actual

• Material ID

Process Variable Extensions

The following items are Process Variable extensions:
• Target

• Actual
• High Deviation

• Low Deviation

• High Limit

• Low Limit

Definition of Parameter Extensions

The parameter extensions you can use are as follows.

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 process
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 corresponds
with a Target Value that has been passed to the phase block
from the batch control system and is usually monitored and
shown in the batch control system. The values also generally
consist of process temperatures, timer values, and transfer
quantities. 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 is the time remaining as the soak phase block is
operating.

InBatch User’s Guide

Designing Phase Blocks583

High Deviation
The High Deviation extension is a batch control system
configured value that corresponds to a high tolerance limit
for the Actual Value. Generally, if the Actual Value becomes
greater than the High Deviation value while the phase block
is in the Run state, an alarm is generated.

Low Deviation
The Low Deviation extension is a batch control system
configured value that corresponds to a low tolerance limit for
the Actual Values. Generally, if the Actual Value becomes
less than the Low Deviation value while the phase block is in
the run state, an alarm is generated.

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. The Preact is the amount of an ingredient
that discharges from a source after the command has been
given to stop the flow. An example of a Preact is 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 operator.
The Material ID is assigned in the recipe, but the operator
can change it.

InBatch User’s Guide

584  Chapter 15 Phase Logic Development and Testing

Control Buttons
Each phase block can contain two control buttons for the
functions the phase block needs. These control buttons are
operated from the batch control system screen and are
transferred to the control system through 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 can prevent the
start of a particular phase block. Phase blocks can have any
number of Interlocks, as well as share Interlock conditions
with multiple phase blocks. The Interlocks are found in the
Interlock section of the program that corresponds 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 unavailable if the phase block is in
operation. Some examples of phase block interlocks are:
• A reactor discharge valve that is 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 start.

InBatch User’s Guide

Designing Phase Blocks585

588  Chapter 15 Phase Logic Development and Testing

Testing Phases
You can easily run a phase from the Phase Logic testing tool.
You can generate, export, refresh, and print a report.

To test a phase
1 Start the Phase Logic testing tool.
2 In the Units/Connections list, click the unit or connection
that contains the phase that to run.
The Phases list shows the process or transfer phases
available for the selected unit or connection.
3 In the Phases list, click the phase to run.
The Parameter list shows any formula parameters defined
for the selected phase.

Note Phases are not required to have formula parameters.

4 To modify a formula parameter value, do the following:

a In the Parameter list, click the parameter extension
b Type the new value in the text box.
c Click Change.
The new formula parameter value appears in the
Parameter list.
5 Use the buttons at the bottom of the dialog box 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 commands, see Chapter 15,
Phase Logic Development and Testing.

Note It is very important to Reset each phase when the state of

the phase is either Done or Aborted.

6 Click Interlocks to view any interlock tags assigned to the

phase.
The Interlocks dialog box shows all the interlock tags and
their current values.

InBatch User’s Guide

589

Chapter 16

I/A Series Batch Alarms

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.
• Consists of the Event Manager, Alarm Comment
Application, Sequence Unsuspend Application, and a set
of Batch Alarm report queries.
• Interfaces with the Batch Historian through ODBC to
store and retrieve batch-related alarms.

InBatch User’s Guide

I/A Series Control Strategy – Alarm Considerations593

I/A Series Control Strategy – Alarm

Considerations
The manner in which the InBatch Management System
implements alarming provides several alternatives as to how
you can implement an I/A Series Control Strategy. The
following is an overview of these designs.
• 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.
• One equipment entity is represented by multiple
compounds.

• 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 equipment
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
equipment entity that is associated with the lead
compound.
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 allocated the Batch ID is written to the
LOOPID of the Reactor_A lead compound by
I/A Series Batch. When the filter is used, the Batch
ID should be written to the LOOPID of the compound,
so if alarm occur in the filter the correct Batch ID is
used.

InBatch User’s Guide

Chapter 17

ActiveX GUI Controls

You can use InBatch ActiveX GUI Controls in any compliant

ActiveX container to quickly and easily create custom
InBatch run-time client interfaces. Suitable ActiveX
containers include InTouch WindowMaker, Visual Basic,
C++, and C#. The GUI controls were introduced in InBatch
8.0 and take the place of the old InTouch wizards.
For more information on using WindowMaker, see the
InTouch documentation.
You must have the appropriate client licensing in order to
successfully use the InBatch ActiveX GUI Controls.

Overview
ActiveX controls are graphical components with built-in
processing logic that you can embed in any ActiveX container
application. InTouch Window Maker, Visual Basic, C++, and
C# are examples of ActiveX containers.
Using the GUI controls can greatly reduce application
development time. This chapter describes how to use the
ActiveX GUI controls in the InTouch WindowMaker
environment, but many of the concepts discussed here apply
to Visual Basic, C++, or C# usage.

InBatch User’s Guide

598  Chapter 17 ActiveX GUI Controls

Configuring InTouch WindowMaker to use

InBatch ActiveX GUI controls
You must first add the ActiveX controls to the WindowMaker
environment.

To add the ActiveX controls to the WindowMaker environment

1 From the Configure tree node, select Wizard > ActiveX
Configuration.
This action opens the Wizard/ActiveX Installation dialog
box. Select the four InBatch GUI control classes. These
are:
• Wonderware BatchButton Class
• Wonderware BatchField Class
• Wonderware BatchGuiConfig Class
• Wonderware BatchList Class
2 Click Install.

Note The four classes are provided in a single ocx library. In

Visual Basic, the single component name to add is Wonderware
InBatch GUI Controls.

InBatch User’s Guide

Using InBatch GUI Controls599

Using InBatch GUI Controls

You can access the Active-X controls through InTouch.

To access the Active-X controls

1 Open InTouch.
2 On the toolbar, click the Wizards icon.
3 The Wizard Selection dialog box appears.

To Insert a Control into an Application

1 Click the appropriate wizard and click OK.
2 Click the insertion point in the InTouch application.
Sizing the controls is based on the control type configuration
and font selection. When you double-click an InBatch GUI
control, a property configuration dialog box shows the
current configuration.

InBatch User’s Guide

600  Chapter 17 ActiveX GUI Controls

InBatch GUI Control Descriptions

The four classes of InBatch GUI controls perform different
functions. Each has a different set of properties that you
must configure.

BatchGuiConfig
The BatchGuiConfig control provides central administration
of all Batch GUI controls for an application. The
BatchGuiConfig control is invisible at run time. It has no
graphical component. This control is where the connection to
the InBatch Batch Server is configured.

Note The BatchGuiConfig control sets up the connection

information that is used by all Batch GUI controls for an entire
application. Once this is done, the BatchGuiConfig control is no
longer required and can actually be removed from memory
without affecting the other controls.

Properties
The following properties apply to the BatchGuiConfig
control.

Host1
This selection sets this property to the host name of the
InBatch Batch Server. In a redundant server architecture,
this is the host name of the Primary Batch Server.

Host2
This property is only used with redundant server
architectures. It sets this property to the host name of the
Redundant Batch Server.

InBatch User’s Guide

InBatch GUI Control Descriptions601

AutoInit
When set to 1 (or checked on the property page) this property
initializes the connection to the Batch Server automatically
when the control is loaded in a running application, or the
application is switched from design mode to run mode (such
as WindowMaker to WindowViewer).

Unit
This is a string set to the unit to focus on when running in
Unit-Centric mode. If this property is left blank, the Batch
GUI controls run in Batch-Centric mode.

MessageBoxes
This property is a true or false Boolean type. True specifies
that error message boxes should be shown. False turns off
the error message boxes. The default value of MessageBoxes
property is true.

ServerConnected
This property is available only at run time (not available at
design time). It is set to True (or a non-zero value) when
there is an active connection to the Batch Server.
The following properties define the tcp/ip port definitions for
the connection to the Batch Server. The port definitions are
pre-defined with the default numbers used on the Batch
Server. These must match the port definitions used on the
Batch Server for communications to be successful. Only
change these properties if you have changed the port
definitions on the Batch Server because of a system conflict.
• PortBatchMngr

• PortEnvMngr
• PortInfoMngr
• PortRedMngr

• PortSecMngr

• PortUnilinkMngr

InBatch User’s Guide

602  Chapter 17 ActiveX GUI Controls

Methods
You can use the following methods with BatchGuiConfig.

AltSetCancelMsgBox()
The AltSetCancelMsgBox method is an alternative way to
cancel a message box raised by the ActionError event. (see
ActionError event below). This method has no arguments.

GetOcxBatchObject()
The GecOCXBatchObject method returns a reference to the
underlying the OcxBatch control. This allows for more
custom control of the interface in programming
environments. Since this method returns an object reference,
it cannot be used by InTouch. This method has no
arguments.

Init()
The Init method initializes the connection to the Batch
Server. This is needed only when the connection is lost if the
AutoInit property is set. This method has no arguments.

Term()
The Term method terminates the connection to Batch Server.
This method has no arguments.

Events
You can use the following events with BatchGuiConfig.

ActionError
The ActionError event is called when a non-server generated
error occurs during a batch action. Arguments: ErrorCode:
an integer error code, and CancelMsgBox: an integer
reference. It returns 1 to the CancelMsgBox argument to
prevent the error message box from appearing.

LostServerConnection
The LostServerConnection event is called when the
connection to Batch Server is lost. It has no arguments.

SystemShuttingDown
The SystemShuttingDown event is called when the Batch
Server is shutting down. It has no arguments.

InBatch User’s Guide

InBatch GUI Control Descriptions603

BatchList
The BatchList control provides live list data. You can
configure the BatchList control to be a schedule list, active
batch list, active phase list, or parameter list. You can
configure any list found on Batch or Batch Scheduler with
the BatchList control.

You can configure the BatchList to be any of the following:

BatchView
BatchView has the following components:
• Batch (Active Batch List)

• Message List
• Question List

• Transition:
• Transition List
• Tag List
• Allocation Queue List

• Phase Edit:

• Phase List
• Parameter List
• Equipment Allocation:

• Equipment
• Instance

InBatch User’s Guide

604  Chapter 17 ActiveX GUI Controls

• Select Equipment:

• Instance
• Equipment
• Phase List (Active Phases)

• Parameter List

• Interlock List

ScheduleEdit
ScheduleEdit has the following components:
• Schedule List

• Train List

• Recipe List

Error List

Properties
The following properties apply to the BatchList control.

ColumnHeaders
The ColumnHeaders property is a comma-separated string to
define the column heading names shown on the list control.

Columns
The Columns property is available at run time only. It
returns the number of columns in the list. The property is
Read Only.

ColumnWidths
The ColumnWidths property defines the widths (in
characters) of each column in the list.

Grid
The Grid property sets or returns a value indicating if grid
lines are shown on the control.

Rows
The Rows property is available only at run time. It returns
the number of rows in the list. The property is Read only.

SelectedRow
The SelectedRow property is available only at run time. It
sets or returns the currently selected row number. Row
numbers start at 0. A value of –1 indicates no selection.

InBatch User’s Guide

InBatch GUI Control Descriptions605

BackColor
The BackColor property sets or returns the background color
of the list.

ForeColor
The ForeColor property sets or returns the foreground (text)
color of the list.

Font
The Font property sets or returns the character font used for
the list. The property affects the size of the control.

Methods
You can use the following methods with the BatchList
control.

AltSetBusyMessage()
AltSetBusyMessage is an alternate method for setting the
list busy message from within the BeforeListBusy event (see
BeforeListBusy event below).

GetItemColumnValue()
The GetItemColumnValue method returns the string
contained in any cell of the list. Arguments are Row and
Column numbers.

Events
You can use the following events with the BatchList control.

Afterdeck
The Afterdeck event is called when the control is clicked and
after any batch-specific processing is performed. The event
passes the arguments Row number and Result. The Result
value indicates if it was a double or single click.

AllItemsDeleted
The AllItemsDeleted event is called after the list has been
cleared.

BeforeListBusy
The BeforeListIsBusy event is called before the list is about
to indicate that it is busy.

Click
The Click event is called when a list item is clicked but before
any batch-specific processing is performed. The row number
clicked is passed as an argument.

InBatch User’s Guide

606  Chapter 17 ActiveX GUI Controls

DblClick
The DblClick event is called when a list item is double clicked
but before any batch-specific processing is performed. The
row number double clicked is passed as an argument.

ItemAdded
The ItemAdded event is called after a list item (row) has been
added to the list. The row number of the added row is passed
as an argument.

ItemChanged
The ItemChanged event is called after a list item (row) has
been changed. The row number of the changed row is passed
as an argument.

ItemDeleted
The ItemDeleted event is called after a list item (row) has
been deleted from the list. The old row number of the deleted
line is passed as an argument.

ItemSelected
The ItemSelected event is called after a list item (row) has
been selected. The row number selected is passed as an
argument.

InBatch User’s Guide

InBatch GUI Control Descriptions607

BatchField
The BatchField control is a data field that is linked to a
BatchList control. You can configure the BatchField control
very similarly to the BatchList control. The same
hierarchical list of types is available as in the BatchList
control, but with an extra level of detail. Choose the list in
the Property page and then the data field of the list desired.
Different BatchField controls have different visual
appearances. While most types look like a simple text box
control, some appear as lists, combo boxes, multi-line text
boxes, or even check boxes.

In each case, the node directly above the selected Field type
in the property page indicates the type of BatchList that the
BatchField control is associated with. The linking of the
BatchField to the parent BatchList control is automatic. The
BatchField control has been designed to work with the
BatchList controls so that no programming or scripting is
required for basic batch functionality. You can add
functionality to the control by using scripting or
programming.

Properties
The following properties apply to the BatchField control.

AutoEnabled
The AutoEnabled property returns the current enabled state
of the control. This state is read only at run time. The
internal logic of the control enables and disables the
BatchField control automatically.

Editable
The Editable property sets or returns a value indicating if
the user may write to the control.

InBatch User’s Guide

608  Chapter 17 ActiveX GUI Controls

Label
The Label property specifies the text label to for check box
BatchField controls.

Static
When the Static property is set to true, the BatchField
appears as a label (no surrounding box).

ForceDisable
When the ForceDisable property is set to True, the field is
disabled. The real field state is preserved so that when the
Force Disable is set to False the real condition is restored.
The default is False.

ValueText
The ValueText property sets or returns the current text
value of the control.

BackColor
The BackColor property sets or returns the background color
of the control.

ForeColor
The ForeColor property sets or returns the foreground (text)
color of the control.

Font
The Font property sets or returns the font used by the
control. It is Read-Only at run time. The property influences
the size of the control.

Methods
You can use the following method with the BatchField
control.

AltSetCancel()
The AltSetCancel method provides an alternate way to
cancel a field value change action from within the
BeforeExecute event.

InBatch User’s Guide

1 Drop a BatchButton control onto the window at the lower
left.
2 Double Click the control to open the property page.
3 Select the Batch Button tab.
4 Open the Schedule Edit node of the tree view.
The Schedule list appears as a folder.
5 Open the Schedule list.

InBatch User’s Guide

616  Chapter 17 ActiveX GUI Controls

6 Click Add and then click Apply.

7 Copy this control seven (7) more times and configure the
copies as the Delete, Change, CleanUp, Initialize Batch,
Initialize All, Move Up, and Move Down buttons as shown.

You are now ready to test the scheduler.

InBatch User’s Guide

Building a Simple Batch Scheduler617

Running the Scheduler

To run the schedule application, make sure that you have a
valid model and that you have defined some materials and at
least one recipe. Then start the InBatch run-time
applications on the InBatch Server.

Start the InBatch Server

This is the minimum set of run-time services that you must
run on the InBatch server for our InTouch Scheduler to work
correctly:
• UnilinkMngr – Always required.

• MemTagMngr – Creates the InBatch Memory Tags.

• SimMngr (or IBCli) – SimMngr simulates the phases.
IBCli is hooked up to real I/O.

• InfoMngr – Required for ActiveX client controls:

OcxBatch, BatchSFC, and BatchGUI.
• BatchMngr – The Batch Engine. Always Required.

Note By default, the IBServ application is also in the run-time list

and while not required, it does not hurt anything by being there.
IBServ is responsible for serving up InBatch tag information to
SuiteLink clients. The BatchGUI controls do not use tag
communications, so IBServ is not required. You may wish to use
some of the InBatch system tags elsewhere in your InTouch client
application however, so then IBServ would be required.

InBatch User’s Guide

618  Chapter 17 ActiveX GUI Controls

To start the InBatch Server

1 Navigate to the Environment Display dialog box.
2 Click Runtime Application.
The Runtime Application Display dialog box appears.
3 Click Start All.

Run the InTouch Application

Properties
The following properties apply to the BatchSecurity control.

AutoInit
When the AutoInit property is set to 1 (or checked on the
property page) the property initializes the connection to the
Batch Server automatically when the control is loaded in a
running application, or the application is switched from
design mode to run mode (WindowMaker to WindowViewer).
The Security Manager service on the Batch Server must be
running for the control to connect.

CheckByPassword
Set the CheckByPassword string property to the password
for the Check-By user. This property is used for the
windowless function clearance checks. Its use is described
later in this chapter.

CheckByUserID
Set the CheckByUserID string property to the User ID for
the Check-By user. This property is used for the windowless
function clearance checks. Its use is described later in this
chapter.

DoneByPassword
Set the DoneByPassword string property to the password for
the Done-By user. This property is used for the windowless
function clearance checks. Its use is described later in this
chapter.

InBatch User’s Guide

622  Chapter 17 ActiveX GUI Controls

DoneByUserID
Set this string property to the User ID for the Done-By user.
This property is used for the windowless function clearance
checks. Its use is described later in this chapter.

Host1
Set the Host1 property to the host name of the InBatch Batch
Server. In a redundant server architecture, this is the host
name of the Primary Batch Server.

Host2
The Host2 property is only used with redundant server
architectures. Set this property to the host name of the
Redundant Batch Server.

LastErrorCode
The LastErrorCode property returns the error code (integer)
of the most recent security request. A zero (0) indicates no
error.

LastErrorMessage
The LastErrorMessage property returns the error message
(string) of the most recent security request.

LastErrorRetriesExceeded
The LastErrorRetriesExceeded property returns the retries
exceeded status (integer) of the most recent security request.
The value is 1 if the retry limit has been exceeded.
Otherwise, it is 0. Retries exceeded status can be cleared
with the ResetRetries() method.

SecurityPending
The SecurityPending property returns a value (integer)
indicating if a security request is pending. A non-zero value
indicates a pending request. A zero (0) indicates no requests
are pending. Any pending requests can be cancelled with the
AbortPendingSecurity() method.

PortRedMngr
The PortRedMngr property is the user setting for the tcp
application port definition used by the Redundancy Manager
(RedMngr) on the batch server. It defaults to 9006 and
should be the same as the tcp port definition for RedMngr on
the batch server. This definition is found in the
WINNT\system32\drivers\etc\services file on the batch
server.

InBatch User’s Guide

Using the BatchSecurity Control623

PortSecMngr
The PortSecMngr property is the user setting for the tcp
application port definition used by the Security Manager
(SecMngr) on the batch server. It defaults to 9004 and should
be the same as the tcp port definition for SecMngr on the
batch server. This definition is found in the
WINNT\system32\drivers\etc\services file on the batch
server.

Methods
You can use the following methods with the BatchSecurity
control.

AbortPendingSecurity()
The AbortPendingSecuritiy method aborts any pending
security requests. If a security dialog is open, it closes it.
There is no return code.

ApplicationClearance(ApplicationID, WinType, UserData)

The ApplicationClearance method checks for user application
clearance. The ApplicationID (string) identifies the
application to check for security configuration. The WinType
(secWindowType) argument determines the dialog behavior
for the security check. UserData (long) is a place to store a
user-defined number that is to be passed through to any
events raised by the clearance check. See explanation of
Window Types later in this chapter. The function returns an
integer Result code (secResultType).

ChangeUserPassword(UserID, OrigPassword, NewPassword)

The ChangeUserPassword method allows a user, identified
by UserID (string), to change their password. They must
supply their valid, current password in the OrigPassword
(string) argument in order for the change to take effect. The
password is set to NewPassword (string). The function
returns an integer Result code (secResultType).

InBatch User’s Guide

624  Chapter 17 ActiveX GUI Controls

FunctionClearance(ApplicationID, FunctionID, RecipeID,

WinType, UserData)
The FunctionClearance method authenticates a user for
functional security. The function attempted is identified by
the ApplicationID (long) and the FunctionID (long). The
RecipeID (string) identifies the recipe affected as users may
be configured to only interact with certain recipes. The
WinType (secWindowType) determines the behavior of the
security dialogs (see Window Types later in this section.) and
the UserData (long) argument contains user-defined data
that is to be passed to an events raised in connection with the
security check. The function returns an integer Result code
(secResultType).

GetApplicationName(ApplicationID)
The GetApplicationName method returns the name (string)
of the security application identified by the ApplicationID
(long) argument.

GetFunctionName(ApplicationID, FunctionID)
The GetFunctionName method returns the name (string) of
the security function identified by the ApplicationID (long)
and FunctionID (long) arguments.

GetUserName(UserID)
The GetUserName method returns the name (string) of the
user identified by the UserID (string) argument.

Init()
The Init method initializes a connection to the Security
Manager service running on the Batch Server identified by
the Host1 or Host2 property. The Init method first attempts
to connect to the batch server on Host1, and then attempts
Host2. (See Host1 and Host2 properties above). The security
manager service must be running in order to be successful.

QueryApplicationSecurity(ApplicationID)
The QueryApplicationSecurity method returns an integer
(secRequestType) indicating if security is required for the
application identified by ApplicationID (long). The return
value is 0 if no security is required to access the application,
and 3 if security is required.

QueryFunctionSecurity(ApplicationID, FunctionID)
The QueryFunctionSecurity method returns an integer
(secRequestType) indicating what security is required for the
function identified by ApplicationID (long) and FunctionID
(long). The return value is 0 if no security is required to
access the function, 1 if DoneBy security is required.

InBatch User’s Guide

Using the BatchSecurity Control625

ResetRetries()
The RestRetries method resets the retry count for
authentication attempts. The limit for retries is configured in
the InBatch security system. When the limit is reached, an
error results.

Term()
The Term method terminates the connection to the InBatch
Security Manager.

Events
You can use the following events with the BatchSecurity
control.

ApplicationClearanceComplete(Result, ApplicationID,
UserData)
The ApplicationClearanceComplete event is raised after a
ApplicationClearance method has been called and any
security dialogs or other information has been provided to
the security system. The Result (secResultType) argument
contains the result code: 0 if the clearance request was
successful, 1 if not.

FunctionClearanceComplete(Result, ApplicationID,
FunctionID, UserData)
The FunctionClearance event is raised after a
FunctionClearance method has been called and all security
dialogs or other information has been provided to the
security system. The Result (secResultType) argument
contains the result code: 0 if the clearance request was
successful, 1 if not.

RequestNewPassword(RequestType, UserID, UserData)

The RequestNewPassword event is called when you are
using a secWindowType of secWindowlessEvent with the
ApplicationClearance or FunctionClearance methods. It is
called when a clearance request fails due to the user’s
password expiring and it automatically tries to change their
password based on the new password you return.
If RequestType is secRequestApplication or
secRequestDoneBy, you must set the DoneByPassword
property with a new password before returning from this
event.
If RequestType (secRequestType) is secRequestCheckBy, you
must set the CheckByPassword property with a new
password before returning.

InBatch User’s Guide

626  Chapter 17 ActiveX GUI Controls

This event may be called repeatedly until you have returned

a valid new password. You may call the
AbortPendingSecurity method within this event to cancel the
security request. You may also use the LastErrorCode or
LastErrorMessage properties to determine if there is a
previous access error to report to the user. The UserID
argument specifies the ID for the user whose password must
be changed. The UserData argument is the value that was
passed into the original ApplicationClearance or
FunctionClearance method.

RequestUserInfo(RequestType, ApplicationID,
ApplicationName, FunctionID, FunctionName, UserData)
The RequestUserInfo event is called when you are using a
secWindowType of secWindowlessEvent with the
ApplicationClearance or FunctionClearance methods. It is
called when the clearance request needs some information.
If RequestType is secRequestApplication or
secRequestDoneBy, you must set the DoneByUserID and
DoneByPassword properties before returning from this
event.
If RequestType is secRequestCheckBy, must set the
CheckByUserID and CheckByPassword properties before
returning.
This event may be called repeatedly until you have returned
proper credentials. You may call the AbortPendingSecurity
method within this event to cancel the security request. You
may also use the LastErrorCode and/or LastErrorMessage
properties to determine if there is a previous access error to
report to the user. The other arguments passed into this
event are the values passed into the ApplicationClearance or
FunctionClearance method, except for the ApplicationName
and FunctionName arguments, which are useful if you need
to prompt the user for the information.

InBatch User’s Guide

Using the BatchSecurity Control627

Enumerations
The following enumeration sets are used by the
BatchSecurity control.

secWindowType
This value is used as an argument to the
ApplicationClearance and FunctionClearance methods. The
value of the WinType argument determines the behavior of
the security dialogs and how the user must interact with the
security system.

secWindowModal (0)
This type prompts the user for information as required using
a Modal security dialog. Therefore, the clearance call does
not return until a result has been determined.

secWindowModeless (1)
This type prompts the user for information as required using
a Modeless security dialog. Therefore, the clearance call
returns immediately with a result of secResultPending, and
the actual result is returned through a *ClearanceComplete
event.

secWindowlessEvent (2)
This type requests information as required by firing
RequestUserInfo or RequestNewPassword events. The
program can then provide the required information by
setting various properties on the control from within the
event. It is a modal interface, which means that the clearance
call does not return until a result has been determined.
However, there is no built-in security dialog presented to the
user. This window type is designed to allow the designer to
create their own security dialog boxes, which would be
invoked when the RequestUserInfo and
RequestNewPassword events are raised.

secWindowlessCheck (3)
This type performs a simple one-shot access check, using
information provided before the clearance method is called. It
can be used when you already know the level of security
required and the clearance information. The result of the
clearance request is known upon return. When using this
type of clearance check, you must set the DoneByUserID,
DoneByPassword, CheckByUserID, and CheckByPassword
properties (as needed) before you call the clearance method.
You can determine which ones are required by calling the
QueryApplicationSecurity or QueryFunctionSecurity
methods.

InBatch User’s Guide

628  Chapter 17 ActiveX GUI Controls

secResultType
Many of the functions return one of the following result
types. The LastErrorMessage and LastErrorCode properties
can be used to dig deeper into what a specific problem was.

secResultOk (0)
This type indicates that clearance was granted or the method
succeeded.

secResultFail (1)
This type indicates that clearance was not granted or the
method had some other failure.

secResultPending (2)
This type indicates that clearance was not yet granted and
the result is to be returned later or another security request
is pending, so you cannot perform this action at this time.

secRequestType
This type is mainly used when the control is requesting
information through one of the Request* events. It specifies
what information the security clearance is currently
requesting.

secRequestNone (0)
This type is never passed into the Request events, but can be
returned by the Query* methods to specify that no security is
required for the queried application/function.

secRequestDoneBy (1)
This type is passed into the Request* events when DoneBy
information is required to complete a function security
clearance request. It can also be returned by the
QueryFunctionSecurity method to specify that DoneBy
security is required for the queried function.

secRequestCheckBy (2)
This type is passed into the Request* events when CheckBy
information is required to complete a function security
clearance request. It can also be returned by the
QueryFunctionSecurity method to specify that DoneBy and
CheckBy security is required for the queried function.

secRequestApplication (3)
This type is passed into the Request* events when DoneBy
information is required to complete an application security
clearance request. It can also be returned by the
QueryApplicationSecurity method to specify that DoneBy
security is required for the queried application.

InBatch User’s Guide

Using the BatchSecurity Control629

Security Control Examples

The following InTouch script is secured by InBatch security.
The example starts with the configuration of a custom
security application and function in the InBatch security
editor.

To Configure InBatch Security

1 Add a custom application to the InBatch security system
called InTouch.
2 Add a function to that application called Open Valve.

3 Set the function to require Done By security.

InBatch User’s Guide

630  Chapter 17 ActiveX GUI Controls

Example 1: WinType = secWindowModal

The following InTouch script acts to manually force a valve
only if InBatch security is passed. This is the easiest way to
implement the BatchSecurity control.
{Script to open valve XV101 manually}
{Check InBatch for Security Clearance (Modal Window)}
IF #BatchSec3.FunctionClearance( 99, 1, "", 0, 0) == 0
THEN
{0 means it's OK, open the valve}
XV101_MAN = 1;
ELSE
{There's a problem, show the error message.}
OPR_MESSAGE = #BatchSec3.LastErrorMessage;
ENDIF;

Example 2: WinType = secWindowModeless

The following scripts show how this same function is
accomplished with a modeless window (script continues even
while security dialog is up) The first script is on the valve
icon or button on the graphical.
{Check InBatch Security (Modeless Window)}
{Use 101 to identify the valve in the UserData
argument}
#BatchSec3.FunctionClearance( 99, 1, "", 1, 101);
{END OF SCRIPT (user is still answering security
dialog(s)}

A second script is required for a modeless dialog. Its an event

script on the BatchSec control FunctionClearanceComplete
Event. It gets called when the security information is finally
filled out by the operator.
{{ActiveX Script: FunctionClearanceComplete}
IF #ThisEvent.FunctionClearanceCompleteResult == 0 THEN

{ Security Test Passed. User data tells me what was

requested. }
IF #ThisEvent.FunctionClearanceCompleteUserData ==
100 THEN
XV100_MAN = 1;
ENDIF;

InBatch User’s Guide

Using the BatchSecurity Control631

IF #ThisEvent.FunctionClearanceCompleteUserData ==
101 THEN
XV101_MAN = 1;
ENDIF;

IF #ThisEvent.FunctionClearanceCompleteUserData ==
102 THEN
XV102_MAN = 1;
ENDIF;

ELSE

{ Security failed. error message }

OPR_MESSAGE = #ThisControl.LastErrorMessage;

ENDIF;

Example 3: WinType = secWindowlessEvent

This script is the most complicated case. The
WindowlessEvent interface was designed to allow users to
create their own security dialogs. These dialogs would be
shown to the user when the RequestUserInfo and
RequestNewPassword events are raised. The dialogs must be
modal because the user information must be supplied to the
interface before the event handling routine terminates.
Therefore, this window type should not be used by InTouch,
because InTouch cannot (and should not) modal dialogs.

Note The WindowlessEvent window type should not be used with

InTouch.

The following code sample is of a Visual basic application

wishing to use InBatch security. The command button,
Command1 has some secured functionality.
Private Sub Command1_Click()
BatchSec1.FunctionClearance MyApp, MyFunc, "", _
secWindowlessEvent, MyUserData
End Sub

Private Sub BatchSec1_FunctionClearanceComplete(ByVal

Result As BATCHSECCTRLLibCtl.secResultType, ByVal
ApplicationID As Long, ByVal FunctionID As Long,
ByVal UserData As Long)
If Result = secResultOk Then
' Security is OK.

InBatch User’s Guide

632  Chapter 17 ActiveX GUI Controls

' Do originally requested action encoded in

UserData...
Select Case UserData
Case 1
' Do Case 1
Case 2
' Do Case 2
'...
End Select
Else
MsgBox BatchSec1.LastErrorMessage, , _
"Security Error Code " &
Str(BatchSec1.LastErrorCode)
End If
End Sub

Private Sub BatchSec1_RequestNewPassword( _

ByVal RequestType As
BATCHSECCTRLLibCtl.secRequestType, _
ByVal UserID As String, ByVal UserData As Long)
frmNewPasswordDlg.UserID.Text = UserID
frmNewPasswordDlg.Show vbModal
End Sub

Private Sub BatchSec1_RequestUserInfo( _

ByVal RequestType As
BATCHSECCTRLLibCtl.secRequestType, _
ByVal ApplicationID As Long, _
ByVal ApplicationName As String, _
ByVal FunctionID As Long, ByVal FunctionName As
String, _
ByVal UserData As Long)
frmSecDialog.lblApplication.Caption =
ApplicationName
frmSecDislog.lblFunction.Caption = FunctionName
Select Case RequestType
Case secRequestType.secRequestApplication
frmSecDialog.lblLevel.Caption =
"Application"
frmSecDialog.Show vbModal
BatchSec1.DoneByUserID =
frmSecDialog.UserID.Text
BatchSec1.DoneByPassword = _

InBatch User’s Guide

InBatch User’s Guide

637

Chapter 18

InTouch Batch Tag Browsing and

Referencing

InTouch client applications frequently use InBatch

information. The InBatch data is accessed through tags.
These tags typically exist in the InTouch Tagname
Dictionary and are used in the appropriate scripts and
animation links. As a result, the InTouch application can
have a large number of batch tags.
As an alternative to maintaining the batch tags in the
InTouch Tagname Dictionary, you can remotely reference
them within the InTouch application. You can browse all
InBatch tags from InTouch and do not need define them in
the local Tagname Dictionary. The result is smaller and more
easily managed InBatch client applications.

Note Client software must be installed on an InTouch client.

InBatch User’s Guide

638  Chapter 18 InTouch Batch Tag Browsing and Referencing

Overview
Equipment tags and batch function tags are the two general
categories of InBatch tags. The equipment tags refer to the
phase control and status tags and to the phase formula
parameter tags. The batch function tags provide access to the
InBatch Management System hooks.To use any of these tags
in an InTouch client application, the tag must be accessible
to the application.
The following three methods are available for making these
tags available in the InTouch application:
• Manually define the tags in InTouch.

• Use the Tag Linker to export a .csv file that is imported

into InTouch using the DBLOAD utility. For more
information on exporting tags using Tag Linker, see
Chapter 4, Tag Linker.
• Use the InTouch browsing capability to reference the
batch tags without having to create the tags in the
InTouch Tagname Dictionary.

This section describes the steps that are required to enable

you to browse InBatch tags from InTouch and to remotely
reference the tags in InTouch without having to maintain the
tags in the tagname dictionary.
There are only two required steps:
1 Define the batch tag sources in InTouch.
2 Use the batch tags in the InTouch application.

Note Batch function tags are not accessible through the InTouch
tag browser.

InBatch User’s Guide

Define Batch Tag Sources639

Define Batch Tag Sources

The first required step to browse and reference batch tags in
the InTouch application is to define the batch tag sources.

To define batch tag sources

1 Double-click any blank animation link Tagname or
Expression input box.
The Tag Browser appears.

2 Click the Define Tag Sources button.

The Define Tag Sources dialog box appears.

InBatch User’s Guide

Where:
<ApplicationName> refers to IBCli.
<TagName> refers to any of these: CONNSTAT,
CONNINFO, LCTIME, LDTIME.
<ApplicationInstanceName> refers to the IBCli instance
name.
Examples:
• InBatch:IBCLI_CONNSTAT_IBCLIINS.Value

• InBatch:IBCLI_CONNINFO_IBCLIINS.Value

• InBatch:IBCLI_LCTIME_IBCLI.Value
• InBatch:IBCLI_LDTIME_IBCLI.Value

To view tags in InTouch

1 Create an Access Name in InTouch. The Access name and
Node name are examples only. You can substitute any
name.

2 Use the InBatch tags as per their data type

(analog/string).
3 Assign tags using the syntax for referencing the I/O
status tags.
4 View the tags in InTouch during run time.

InBatch User’s Guide

644  Chapter 18 InTouch Batch Tag Browsing and Referencing

InBatch User’s Guide

645

Chapter 19

InTouch Client Security

You can use the InBatch Security System to define security

5 On the Edit menu, click Operator Stations.

The Operator Stations Editor dialog box appears.

6 Define operator stations for each client instance.

Enabling InBatch Client Security

InBatch client security is automatically installed when the
InBatch run-time client software is installed. However, the
following steps are required to enable client security.
1 Using the InBatch Security Editor, configure the desired
security requirements for the appropriate security
functions available within the InBatch Client application.
These functions correspond to actions performed from an
InBatch client using InBatch ActiveX controls.

653

Chapter 20

Alarm and Event Interface

You can easily associate alarm and event conditions to the

processing of specific batches. Alarms and operator events
from InTouch and Wonderware Application Server are stored
in the InTouch Alarms database.

Overview
InBatch takes advantage of the powerful alarm and event
system provided with InTouch, which is also leveraged by
Wonderware Application Server. Additionally the InBatch
Reports system provides the alarm information in the
context of the batch in which the alarm or event occurred.
The Alarm DB Logger manager processes all the data
logging.

InBatch User’s Guide

654  Chapter 20 Alarm and Event Interface

The following diagram shows the components of the

reporting and alarm system.

For detailed information about configuring the Alarm

system, refer to the InTouch and Application Server
documentation.

Required Configuration
Configure the alarms and events within InTouch or
Wonderware Application Server. All tags must adhere to the
InBatch tag structure for mapping units and connections to a
batch. Only tags with a unit or connection name in the first
eight characters of the tag can be mapped to a batch. Tags
that cannot be mapped to a batch are not associated to the
alarms report.
For more information on the InBatch tag structure, see
Chapter 3, Process Modeling.

InBatch User’s Guide

655

Chapter 21

Redundancy

You can configure redundancy for the batch management

system. A redundant system ensures smooth and continuous
InBatch system processing on a backup computer if
hardware fails on the master server. Redundancy is
particularly useful in critical manufacturing facilities
operating 24 hours a day, seven days a week, where the loss
of the batch system or associated batch data is intolerable.
You initially configure redundancy as part of the InBatch
server installation process. You can configure InBatch
run-time clients to operate with redundant servers.

Important Configuring a redundant batch control system requires

computer network experience. We strongly recommended that
only qualified personnel configure the redundant system.

If you are installing a redundant system, you must configure

your system as described in this section before you install the
batch management system software.

Overview
Redundancy is the capability of the batch management
system to automatically switch batch control to a backup
server if a primary server shuts down because of a hardware
failure or power loss. A secondary network should be
exclusively dedicated to batch system redundancy. This
secondary network supports the heartbeat between the
primary and backup batch servers.

InBatch User’s Guide

656  Chapter 21 Redundancy

Reliable network communications between the servers is

absolutely critical to the proper functioning of InBatch server
redundancy.
The order in which you deploy the components of the
redundant system is important. You must deploy the
redundant system in the following order.
1 Establish a valid network configuration.
2 Install the redundant batch servers.
3 Install and configure batch clients.

Redundancy Operation
InBatch development and InBatch run-time clients are
normally clients of a single InBatch server. A redundant
system has two servers, either of which can operate as the
primary InBatch server. Each client must therefore be
connected to the primary LAN and must also be properly
configured to gain network access to both servers.
The InBatch control system can operate concurrent
configuration and run-time servers. The presence of two
identical servers ensures that the backup server can continue
run-time operation if the master server fails.
All database modifications are written to databases located
on both the master and backup servers. If the master server
fails, the backup server can continue all batch operations
after the failover event.

Master Server Backup Server

Batch System Batch System
( Active ) ( Dormant )

Master Batch Backup Batch

System Databases System Databases

When a failover occurs, the backup server becomes the

master. When the failed Master is restored, it assumes the
role of the backup server.
In a redundant configuration, the InBatch application files
on each server are shared. When you configure redundancy
for a server, all you need to provide is the network name
(host name) of the other redundant server.

InBatch User’s Guide

Failover Conditions657

InBatch Server Roles and Communications

InBatch server roles are determined by the information
contained in the local RedState file on each server.
Redundant InBatch server operation is controlled by a
redundancy manager service running on each server. The
heartbeat is exchanged through the cross-over cable between
the two servers. Each redundancy manager controls the
other local Batch Management processes. When a failover
event occurs, the associated process activity is controlled by
the redundancy manager.
A system parameter in the environment called Redundancy
TimeOut sets the switch-over delay. You can configure the
value. It is specified in seconds.
In the event that a redundant InBatch sever has failed to
detect the heartbeat of the other server, it waits for the
configured time before initiating a failover.

Failover Conditions
The following conditions trigger failovers in a redundant
server configuration:
• Critical Services shutdown – If any of the following
InBatch services fail (crash or do not run):

• InBatch_BatchMngr (Batch Manager)

• InBatch_IBCli (InBatch Client Manager)
• InBatch_LogMgr (InBatch Log Manager)
• InBatch_RedMngr (InBatch Redundancy Manager)
• InBatch_HistQMngr (InBatch History Manager); in
turn shuts down InBatch_BatchMngr
• Exit and Shutdown of the Master server causes a
graceful failover between the batch servers.

Note For the Critical Services shutdown and the Exit and
Shutdown of the Master server, you must configure the InTouch
BatchGuiControl ActiveX control of the client to fail over. To do
this, see Chapter 2 in the InBatch Deployment Guide.

• Complete Communication Failure (Network

Failure) – The InBatch servers fail over but the InTouch
client cannot fail over. Operator intervention is necessary
on both the server side and client side. The operator must
restart the InTouch View client.

For details, refer to the Wonderware eSupport Web Site.

InBatch User’s Guide

658  Chapter 21 Redundancy

• Power Failure (Master) – The InBatch servers fail

over. In this scenario, the InTouch client (using the
BatchGuiControl) does not fail over. An operator must
restart the InTouch View client. The BatchGuiControl
does not detect the change in servers and still thinks that
it has a connection the master server.

For details, refer to the Wonderware eSupport Web Site.

Failover Scenarios
The following section describes basic InBatch server failover
scenarios. Scenarios include failover using two servers and a
recommended failover implementation in the context of
Wonderware Application Server.

Backup Server Failure

When the backup server fails before a master server failure,
the master InBatch control server continues to operate
normally but stops updating the databases of the backup
server.

To recover from backup server failure

1 Correct the problem on the backup server.
2 Restart the server.
Backup databases are automatically re-synchronized.

Master Server Failure

If a master server fails:
• The backup server automatically assumes the master
role (only if the backup server is valid).

• The transition is transparent to the control system. All

batches that were running on the failed master server
continue to run on the backup server that assumes the
role of the master.
• Remote clients to the master server do not continue
working after the master server fails. An operator can
easily restart these clients after connecting to the new
master server.

InBatch User’s Guide

Failover Conditions659

Master Fails While Backup Is in a Failed State

Under this condition, if you restart the Environment Display
on the master server, the redundancy manager does not start
because the master server cannot communicate with the
other server.

To recover from master server failure

Master Server Backup Server

(AW7003) (AW7004)

151.128.8.65 I/A Series I/A Series 151.128.8.66

Windows Station Windows Station
InBatch
I/A Series Mesh Control Network or Nodebus Secondary
Network
InBatch
InBatch Run-Time History Server
Development
Client (AW7005) (HistorySvr)
Client (AW7006)

I/A Series I/A Series Non I/A Series

10.40.20.183 Windows Station 10.40.20.184 Windows Station 10.40.20.185 Windows Station

Control Processors

InBatch User’s Guide

Configuring a Redundant Network665

RedCfg and Lmhosts File Examples

In the example shown in the previous figure, two computers,
AW7003 and AW7004 represent a master server and a
backup server.
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.

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

For details, see Chapter 5, Configuring InBatch, in the
InBatch Installation Guide.

InBatch User’s Guide

666  Chapter 21 Redundancy

Lmhosts File
The lmhosts file contains the structure described below. The
lmhosts file is located in the following folder on your
computer:
C:\winnt\system32\drivers\etc

Master command. When the server starts as a backup, it
synchronizes all the configuration databases with those located on
the master server. Therefore, if the server was previously
operating as the master, the data generated during the previous
processing is overwritten by the synchronization process.

InBatch User’s Guide

670  Chapter 21 Redundancy

Monitoring Redundancy Status

You can use a set of system tags to monitor redundancy
status. These tags are available throughout the InBatch
server application InBatch_IBServ using IB_TAGS as the
topic.
Unlike other system tags, these tags may be monitored on
both the master and backup servers.

Tagname Data Type Description

IBSERV_RED_MASTER Discrete This tag is set to 1 (True) on the

master InBatch server, and 0 (False)
on the valid backup server.
IBSERV_RED_STATE Integer Contains the RedState value for the
InBatch server.
-1: Error
0: Master with invalid backup.
1: Master with valid backup.
2: Invalid backup.
3: Valid backup.
5: Failed master.
6: Not a redundant system.
IBSERV_RED_HEARTBEAT Discrete Contains a heartbeat signal. Value
alternates between 0 and 1.

InBatch User’s Guide

671

Chapter 22

System Administration

This section describes the utilities and procedures that you

can use to administer your Batch Management System
components.

Administering Batch Components on

Operating Systems
The UAC feature on certain Windows operating systems
requires that you grant administrative privileges for starting
and using the Environment Display module.
• UAC for built-in administrator

No prompt will be shown in this case.

InBatch User’s Guide

672  Chapter 22 System Administration

• UAC prompt for a user under the administrators group

You must grant administrative privileges to allow

InBatch modules to function.

• UAC prompt in standard user mode

Enter administrator user credentials in the following

dialog box for proper functioning of InBatch modules.

InBatch User’s Guide

Administering the History Server673

Administering the History Server

You can perform the following administrative tasks for the
history server:
• Create user accounts for the History Administration
pages.
• Administer the history error queue.

• Manage history files.

You can administer the history server in two ways:

• Through Wonderware Information Server (WIS).

In this scenario, security is based on WIS. You must

ensure that the proper permissions are established on
WIS for employees who must access reporting data. For
details about WIS security, see the Wonderware
Information Server Administration Guide.
• Directly on the InBatch history server.

In this scenario, security is based on the InBatch security

mode you are using. For details about InBatch security,
refer to Chapter 13, Security System.

Accessing the History Server through WIS

You can administer the history server through WIS, which
also provides access to other InBatch capabilities, such as
reports.

To access the history server Administration page

1 On the Start menu of your History Server, point to
Programs, Wonderware, Information Server, and then
select Home Page.
The Wonderware Information Server main page appears.

InBatch User’s Guide

674  Chapter 22 System Administration

2 On the Launch Pad, expand Administration > InBatch

Manager.

3 Click History.
The main History page opens in the right pane.

InBatch User’s Guide

Administering the History Server675

Accessing the InBatch History Server through

the Start Menu
If you do not have WIS, you can access the InBatch History
Server through the Start menu.

To access the History Server Administration page

 On the Start menu of your InBatch History Server, point
to Programs, Wonderware, InBatch, InBatch History Server
and then select History Database Administration.
The main History page opens.

Note If you have enabled InBatch security, you are prompted to

enter a valid User and Password to access the administration web
pages. By default, security is not enabled.

1 On the Launch Pad, expand Administration > InBatch
Manager > History.
2 Click Error Queue.
The Error Queue page opens in the right pane.

Note This example shows an error. If no errors exist, the table is

blank.

To access the Error Queue Admin page from the InBatch History
Server
1 On the Start menu of your InBatch History Server, point
to Programs, Wonderware, InBatch, InBatch History Server
and then select History Database Administration.
The main History page opens.
2 Click Error Queue Admin.
3 The Error Queue Admin page opens.

InBatch User’s Guide

Administering the History Server679

To edit an error entry

1 Click the ID of the error statement that you want to edit.
The Edit Error Queue Entry form appears.
2 Edit the data in the Error Statement box as needed to
correct the error.
Here is an example of an edited entry.

3 Click Update Entry.

Note If you decide not to fix the error, you can click the Disable
retry attempts check box.

InBatch User’s Guide

680  Chapter 22 System Administration

Managing History Files

You can manage your history files by setting up the following
jobs.
• Archive jobs enable you to move older data to a separate
location or backup media.
• Purge jobs enable you to clean up the History database
after an archive operation has run.

• Restore jobs enable you to restore the data that you have
backed up.

Before you perform history archiving tasks, make sure that

the SQLServerAgent service has been started on the History
Server.

Caution When the History Archive runs, it overwrites the existing

archive database, effectively deleting the settings associated
with permissions for the database. If you change the BatchAdmin
account, back up the archive database (an empty one) with the
new permission settings. That backup should then replace the
archive template stored on disk.

Note The archiving operation may fail when the location of the
dump file is set to the system root (that is, C:\), depending on the
credentials assigned to the Microsoft SQL services in the History
node. The archiving operation will fail when SQL services (MSSQL
Server, Server Agent) use the "Network Service" account. However,
when the user associated with the services is set to Local User
Account or some other administrator account for SQL Services
(MSSQL Server, SQL Server Agent) archiving will work as expected,
in spite of the location of the dump file.

InBatch User’s Guide

Administering the History Server681

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.

2 In the Job Name box, type a name for the archive job.
3 In the Job Description box, optionally type some text that
describes the archive job.
4 In the Scheduled Date box, type the date that the History
Server is to perform the archive job (mm/dd/yyyy).
5 In the Scheduled Time box, type the time when the
History server is to perform the archive job (hh:mm
am/pm).
6 In the Dump Device Name box, type any device name that
you want to use for the archive job. The History Archive
application creates a backup device in Microsoft SQL
Server with the same name.
7 In the Dump File Name box, type the complete path and
name to be used when the archive job runs.
8 Select a name from the Archive Database Name list.
9 In the History Data Start Date box, type the starting point
for archiving history data (mm/dd/yyyy). This date is
inclusive. All batches completed on or after this date are
archived.

InBatch User’s Guide

682  Chapter 22 System Administration

10 In the History Data End Date box, type the ending point for
archiving history data (mm/dd/yyyy). This date is
inclusive. All batches completed on or before this date are
archived.
11 Select the Purge Data after Archive check box if you want
the archive job to delete the data (defined by the start
and end dates) from the History database when it runs
the archive job.
12 Click Add.

Adding a Purge Job

This section describes how to add a purge job.

Important Use extreme caution when you purge 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.

To add a purge job

1 Click the Add Purge Job button to open the History Archive
- Add Purge page.

InBatch User’s Guide

Administering the History Server683

6 In the History Data Start Date box, type the starting point
for archiving history data (mm/dd/yyyy). This date is
inclusive. All batches completed on or after this date are
archived.
7 In the History Data End Date box, type the ending point for
archiving history data (mm/dd/yyyy). This date is
inclusive. All batches completed on or before this date are
archived.
8 Click Add.

Add Restore Job

This section describes how to restore a previously archived
database.

686  Chapter 22 System Administration

Backing Up InBatch Databases

You can create backup copies of your configuration databases
at any time by using the DBCOPY utility. You do not need to
shut down the InBatch Management System to perform the
backup. The utility, executed from the command line, locks
the specified database and then safely copies it to a location
that you enter.
...\InBatch\bin folder.

Note The DBCOPY utility is designed for use on an active InBatch

server that contains the databases that you want to back up. If
you want to back up databases that are not active, you can use a
standard Windows file copy.

Using the DBCOPY Utility

To Configure the CP
1 From the FoxView process_eng or software_eng
environment display, select the top menu item, Config,
then select CIO_Config to invoke ICC.
2 From the Compound Selection dialog box, select the CP
station compound (for example, CP4001_STA) and click
OK.
The ICC main dialog box appears.
3 From the Compounds list, select the CP station
compound.
4 From the Compound functions list, select View
Blocks/ECBs in this compound.
A new dialog box shows the block name list for the
selected compound.
5 Select the block name STATION.
6 From Block/ECB Functions, select Edit all Block/ECB
Parameters.

InBatch User’s Guide

706  Chapter 22 System Administration

7 Scroll through the parameter list and find CFGOPT.

Select the parameter and type 2 for the value.
8 Click Enter.
9 Click Done.
10 To close ICC, click Exit.

Enhanced Control Processor Software to Support

LOOPID
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 characters maximum). If the LOOPID of the compound is
not blank and the LOOPID of the block is blank, alarms
generated by the block contain the LOOPID information
stored in the LOOPID parameter of the compound. If the
LOOPID of the block 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
through the ICC, the string name is stored as-is. LOOPID
data, when set through the I/A Series Object Manager
function, is padded with trailing blanks (32 characters
maximum).

Configuring the Alarm and Message Destination

Group Device Parameter for Each Compound
A compound that 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 GRxDVn parameters of the compound should be
configured with the value FBFMI. The Event Manager
application processes all batch-related I/A Series messages
by storing them in the relational database of the batch
historian.
As a minimum, you should configure the following alarm
destinations.

Configuration Result

GR1DV1 : FBFMI Sends alarm to BMI

GR1DV2 : FBWP01 Sends to alarm destination2
GR1DV3 : WPNT01 Sends to alarm destination2

InBatch User’s Guide

Configuring I/A Series Subsystems707

To Configure Alarm and Message Destination Group Device

Parameters
1 From the FoxView process_eng or software_eng
environment display, select the top menu item, Config,
then select CIO_Config to invoke ICC.
2 From the Compound Selection dialog box, select the
compound (for example, R210) and then click OK.
The ICC main dialog box appears.
3 From the Compounds list, select the same compound, and
from Compound Functions, select Edit Compound
Parameters.
A new dialog box shows a list of Compound Definitions.
4 From Compound Definitions, select the Group Device
parameter to be configured, (for example, GR1DV1) and
then enter FBFMI in the input field.
5 Click Enter.
6 From the top menu, select Show > Available WPs. This
allows you to select the workstation to be configured.
7 Select the next required Group Device parameter and
double-click a workstation name from the Available WP
list.
8 Click Enter.
9 Repeat steps 1 through 8 for each additional workstation
that you want to configure for the compound.
This configuration process is required for each compound
that sends messages to the BMI.
10 Click Done.
11 To close ICC, click Exit.

InBatch User’s Guide

708  Chapter 22 System Administration

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”

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 LOOPID parameter of the alarm. For FoxAlert (in an I/A
Series operator workstation) to receive batch alarms, you
must configure the station name in the GRxDVn parameter
of the compound.

Configuring FoxAlert to Receive Alarm Messages

For detailed information on how to configure FoxAlert to
receive alarm messages, see Configuring the Alarm and
Message Destination Group Device Parameter for Each
Compound on page 706.
If the FoxAlert display alarm match feature is started
manually, you should be aware of the trailing blanks in the
LOOPID. To find the exact match for a Batch ID string, a
wildcard “*” is required after the Batch ID name, or you must
enter trailing blanks in the LOOPID field (32 characters
maximum).

InBatch User’s Guide

Configuring I/A Series Subsystems709

To Configure the Alm Comment Command Button

You can configure command buttons on the FoxAlert CAD
user interface to start the CommentApp program.
CommentApp enables you to enter a comment associated
with a batch-related alarm. The comment is stored as batch
data in the batch history database. It can then be retrieved
and reported by the Reporting System.

To Configure in FoxAlert
1 A configuration file <install dir>\IA_Config\
BatchAlarmCfg.txt is provided for you to copy and paste
from when you configure the FoxAlert command button.
You must first open this file with 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 menu item Config >
DispalarmCfg.
3 The FoxAlert main dialog box appears. You can use it to
configure a command button for CAD display.
4 From the File menu, click Open.
5 Select the alm database named foxboro and click Open.
6 Click Save As and type the required database file name.
(for example: BatchXP). This procedure retains the
original databases included with the product.
7 On the right side of the main dialog box of the
configuration, select the Alarm Managers option, and then
click New.
8 The Alarm Manager dialog box appears.
9 Type the following parameter values:
• Alarm manager name: AM0000
• Station letterbug: XXXXXX
• Screen: Undedicated
• Alarm Manager Property Scheme: foxDefault
10 Click OK.
11 On the Display and Alarm Managers dialog box, under the
Select group, select the option User Interfaces.
12 From the list of Scheme Names, under the User Interface
group, select foxCAD, and under the Command group,
select Edit.
The User Interface Scheme dialog box appears for foxCAD,
along with the Edit dialog box.

InBatch User’s Guide

710  Chapter 22 System Administration

13 In the Edit dialog box, select the unused button that you
want to configure.
The Pushbutton/Multi-State Button Editor dialog box
appears.
14 Click Edit.

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.

15 In the Label field, enter Alm Comment of the

PushButton State Editor dialog box.
16 In the Button Actions box, 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>&<BlockDesc>&<Compound>&
<LoopId>&<Date[%Y-%m-%d]>&<Time[%H:%M:%S]>&
<Tenths>&<OptionText>

Example: <install dir> = D:\IASeriesBatch

You can leave the Mnemonic box empty.
17 Click Add and then OK to close the Button State Editor
dialog box.
18 On the Multi-State Button Editor dialog box, leave the
Access Code at zero.
19 Click OK on the User Interface Scheme dialog box. This
action closes the Pushbutton/Multi-State Button Editor
dialog box.

InBatch User’s Guide

Configuring I/A Series Subsystems711

To Configure the Seq Unsusp Button

You can configure a second command button on the FoxAlert
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. After
receiving the return-to-normal message, FoxAlert removes
the SENDCONF message from its user interface dialog box.

To Configure the Seq Unsup Button

Use same configuration procedure described earlier for the
Alm Comment button. A separate line is provided for copy and
paste in the BatchAlarmCfg.txt file for this function.
1 From the User Interface Scheme dialog box, click Preview.
The Edit dialog box appears.
2 Click the unused button that you want to configure.
The Pushbutton/Multi-State Button Editor dialog box
appears.
3 Click Edit.
4 In the Label box, type Seq Unsusp.
5 In the Button Actions box, copy and paste the button
command line from the BatchAlarmCfg.txt file that you
modified in the first step:
run <install dir>\bin\seq_unsuspend.bat <Compound>
<Block>
Example: <install dir> = D:\IASeriesBatch
You can leave the Access Code and Mnemonic boxes
empty.
6 Click Add and OK to close the Button State Editor dialog
box.
7 Click OK on the User Interface Scheme dialog box. This
action closes the Pushbutton/Multi-State Button Editor
dialog box.

To Save and Validate the Button Configuration

1 Save the new button configuration into a file.
2 On the DispalarmCfg dialog box, from the Display and
Alarm managers file menu, click Save.
3 Click Validate Record. Validation ensures that all the
schemes are linked properly. A message confirms a
successful validation.
4 Click Create Install File to create a configuration file for
Alarm Manager.

InBatch User’s Guide

712  Chapter 22 System Administration

InBatch User’s Guide

Index 725

Restart 577 Semi-Automatic 77

Start 577 Transfer 332
phase control and status bits 81 PHASE_EXEC configuration file,
phase control bits 175 description 235
configuring 119 PHASE_EXEC sequence block 233
phase control tags, manually PhaseInstruction table structure 459
creatomg 178 PhaseLogic 26
phase logic 76, 80 PhaseLogic, see Phase Logic Testing Tool
development phases
alarms 585 aborting 578
I/O considerations 586 acknowledging 401
testing phases 588 assigning to process class 115
testing tool 32, 586 Automatic 115, 122
starting 586 formula parameters 124
Phase Parameter Editor, using during comments, entering 397
batch processing 402 controlling 577
phase parameters 81 Data 115, 270
control buttons 81 definition 76
formula parameters 81 deleting 341
interlocks 81 holding 577
phase control and status bits 81 in recipe procedures 268
Phase Parameters, Automatic and Semi- in recipes 270
Automatic Transfer Phases, Examples
of 156 inserting into recipe 332
Phase Properties dialog box 349 interlocks 398
Document tab 357 Manual 115, 270
Instructions tab 353 process class
Parameters tab 354 editing 116
formula parameters 122
Phase tab 350
interlocks 120
phase status
properties 349
principles 578
recipes
system shutdown 440
Allocate 271
phase status bits release 271
Aborted 580 restarting 577
Done 580 sequence 384
Held 580 starting 577
Interlocked 580 testing 588
Ready 579 toolbar icons 325
Run 579 transfer 425
phase status word 578 Automatic 425, 426
phase types configuring 154
Allocate Process 332 Manual 425, 427
Allocate Transfer 332 Semi-Automatic 426
Automatic 77 types 332
Data 78 preact
Download (I/A Series) 79 definition 135
manual 77 element 127
Process 332 value parameter extension 583
Release Process 332 procedure objects 323–325

InBatch User’s Guide

726 Index

cutting and copying 340 starting 516

deleting 341 process logging
moving 346 creating a configuration 507
nesting 346 creating a group 508
pasting 341 deleting a configuration 514
process and transfer instances, in log interval 509
recipes 267 log interval, selecting 509
process class instances, assigning log trigger 509
units 288 log trigger, selecting 509
process class phase opening a configuration 514
control buttons 117 printing reports
information to define 115 reports
process class units, defining 107 process log configuration 515
process classes run-time logging criteria 516
adding 108 tags, selecting 512
assigning 283 process model database, trains 259
attributes 289 Process Model Editor 28, 98, 107
defining attributes 111 dialog box 101
defining tags 113 formula parameters 271
defining units 109 process modeling 80, 81, 98
definition 71, 75 comparing approaches 73
deleting 108 comparison of methods 73
deleting, consequences 100 components 75
destination, assigning 142 process classes 75
phases units 75
assigning 115 comprehensive approach 70
editing 116 comprehensive model 70
formula parameters 122 connectionless model 71
interlocks 120 connections 76
save history area 117 Connections tab 134
recipes 267 connections, assigning 143
source, assigning 142 copying configuration to run-time
tags database 98
elements 113 deleting a process class 108
unit control tags 109 deleting components 100
unit state tags 109 edit processes 107
process instances in recipes 285 editing connections 135
Process Log configuration editing transfer class names 142
creating 506 Enumeration tab 173
deleting 514 enumerations 83
printing 515 equipment status 83
Process Log Editor 29 Equipment Status tab 169
Process Log Group example 95
Creating 506 example plant configuration 97
Process Log Manager 31, 516 hybrid model 72
description 516 overview 20, 70
Information Manager 516 phases 76
parameters 57 process classes

InBatch User’s Guide

Index 727

Abort command 573 user accounts, security 528
adding 103 user-defined applications 62
assigning material 251 parameters 63
assigning to process class 109 UserProfile table structure 465
assigning to process class utility programs
instances 288 Change Password 32
assigning to trains 262 phase logic testing tool 32
consequences of deleting 100 TagView 32
controlling 572
definition of 70, 75 V
deleting 103 valid characters for tagnames 91
deleting from trains 262 validation
deleting, consequences 100 errors, Materials Database 253
destination, assigning 135 Materials Database 253
enabling in equipment list 388 process model 185
Hold command 572 recipes 309
process class security configuration 544
defining 107 tags 26
deleting 108 validity checking for operations 330
removing an assignment 253
Restart command 573 W
source, assigning 135 WaitHour function 554
tags 85, 104 WaitMin function 554
attributes 106 WaitSec function 554
editing 105 warm restart 437
elements 104
Warning
when to use 89
Batch Client Security 539
units of measure 83
Batch Manager and Trains 374
description 83
Wonderware Information Server
importing and exporting 172
security and reports 475
Units of Measure tab 171
wwlogvwr, see I/A Series Batch Logger

InBatch User’s Guide

Matrix Visionpro v1 System Manual
50% (2)
Matrix Visionpro v1 System Manual
252 pages
MEBasic Operating en EIO0000003281 03
No ratings yet
MEBasic Operating en EIO0000003281 03
206 pages
D1937en - Software Instal
No ratings yet
D1937en - Software Instal
67 pages
Processor Expert Guide
No ratings yet
Processor Expert Guide
156 pages
Ide
No ratings yet
Ide
468 pages
Handling System Robotic
No ratings yet
Handling System Robotic
54 pages
EcoStruxure™ Process Expert
No ratings yet
EcoStruxure™ Process Expert
1,078 pages
Install Shield User Guide
100% (1)
Install Shield User Guide
2,078 pages
Wonderware Application Server User's Guide: Invensys Systems, Inc
No ratings yet
Wonderware Application Server User's Guide: Invensys Systems, Inc
322 pages
Business Intelligence Platform Administrator Guide
No ratings yet
Business Intelligence Platform Administrator Guide
1,132 pages
Scriptlogic - Implementing Windows Vista
No ratings yet
Scriptlogic - Implementing Windows Vista
74 pages
Ecostruxure Expert - Programing Guide
No ratings yet
Ecostruxure Expert - Programing Guide
762 pages
Wonderware Application Server User's Guide: Invensys Systems, Inc
No ratings yet
Wonderware Application Server User's Guide: Invensys Systems, Inc
262 pages
Intouch HMI Management and Extension Guide
100% (1)
Intouch HMI Management and Extension Guide
240 pages
Proficy: Logic Developer - PLC
No ratings yet
Proficy: Logic Developer - PLC
160 pages
Protection and Control IED Manager PCM600: Getting Started Guide
No ratings yet
Protection and Control IED Manager PCM600: Getting Started Guide
72 pages
EcoStruxure Condition Advisor Guide - B0750cu - D
No ratings yet
EcoStruxure Condition Advisor Guide - B0750cu - D
72 pages
EcoStruxure Machine Expert Programming Guide
No ratings yet
EcoStruxure Machine Expert Programming Guide
818 pages
MultiMove Application Manual
No ratings yet
MultiMove Application Manual
104 pages
PCM600 Getting Started Guide 757866 ENc
No ratings yet
PCM600 Getting Started Guide 757866 ENc
68 pages
Pcp-Users-And-Administrators-Guide 2
No ratings yet
Pcp-Users-And-Administrators-Guide 2
122 pages
6RMC CodeWatch UG
No ratings yet
6RMC CodeWatch UG
152 pages
HP OpenView Operations Guide - b6960-90068
No ratings yet
HP OpenView Operations Guide - b6960-90068
143 pages
1.-Understanding Ifix
No ratings yet
1.-Understanding Ifix
142 pages
Industrial IT, 800xa - Information Management, Display Services Configuration - 01
No ratings yet
Industrial IT, 800xa - Information Management, Display Services Configuration - 01
233 pages
GFK 2486P
No ratings yet
GFK 2486P
126 pages
Allegro User Guide: Getting Started With Physical Design: Product Version 16.3 September 2010
No ratings yet
Allegro User Guide: Getting Started With Physical Design: Product Version 16.3 September 2010
294 pages
Software Distributor Administration Guide For HP-UX 11i
No ratings yet
Software Distributor Administration Guide For HP-UX 11i
520 pages
Mentor Graphics Corporation, Using DesignChecker With SystemVerilog-VHDL Assistant, Release v2018.2
No ratings yet
Mentor Graphics Corporation, Using DesignChecker With SystemVerilog-VHDL Assistant, Release v2018.2
58 pages
Modus Ug Pmbist
No ratings yet
Modus Ug Pmbist
261 pages
sg248129 PDF
No ratings yet
sg248129 PDF
472 pages
SA 7.50 Administration Guide
No ratings yet
SA 7.50 Administration Guide
320 pages
EU System Maintenance 2023R1
No ratings yet
EU System Maintenance 2023R1
106 pages
Dell EMC Avamar Data Migration Enabler User Guide
No ratings yet
Dell EMC Avamar Data Migration Enabler User Guide
100 pages
HyperLynx Signal Integrity Analysis Student Workbook (PDFDrive)
No ratings yet
HyperLynx Signal Integrity Analysis Student Workbook (PDFDrive)
10 pages
ProCash NDC DDC V3021 InstallationManual en PDF
No ratings yet
ProCash NDC DDC V3021 InstallationManual en PDF
432 pages
Replication Server 15.7.1 SP100: Design Guide
No ratings yet
Replication Server 15.7.1 SP100: Design Guide
148 pages
Inbatch Getting Started Guide: Invensys Systems, Inc
No ratings yet
Inbatch Getting Started Guide: Invensys Systems, Inc
106 pages
10-3 Developing Microservices With WM Microservices Runtime
No ratings yet
10-3 Developing Microservices With WM Microservices Runtime
82 pages
Getting Started: Logic Developer - PLC
No ratings yet
Getting Started: Logic Developer - PLC
114 pages
FT Security Sys Config
No ratings yet
FT Security Sys Config
273 pages
Handling System: Comau Robotics Instruction Handbook
No ratings yet
Handling System: Comau Robotics Instruction Handbook
54 pages
Wonderware ® FactorySuite™ (InBatch Premier User's Guide)
100% (1)
Wonderware ® FactorySuite™ (InBatch Premier User's Guide)
710 pages
D1555 Enr 3
No ratings yet
D1555 Enr 3
42 pages
Proces Um003 en P
No ratings yet
Proces Um003 en P
228 pages
3HAC032104-En (Robot Studio Manual)
No ratings yet
3HAC032104-En (Robot Studio Manual)
594 pages
Fpga Reference
No ratings yet
Fpga Reference
336 pages
3BUR002120R3701 en AdvaBuild Engineering Methods User Guide
No ratings yet
3BUR002120R3701 en AdvaBuild Engineering Methods User Guide
152 pages
Software Development Kit
No ratings yet
Software Development Kit
355 pages
Dokumen - Tips NDC DDC v2110 Installationmanual en
No ratings yet
Dokumen - Tips NDC DDC v2110 Installationmanual en
432 pages
EMC Documentum Business Process Suite: Best Practices Guide P/N 300-009-005 A01
No ratings yet
EMC Documentum Business Process Suite: Best Practices Guide P/N 300-009-005 A01
118 pages
29P-071167
No ratings yet
29P-071167
466 pages
3hac032104 001
No ratings yet
3hac032104 001
388 pages
3BSE069489-603 - en Panel 800 Version 6 Panel Builder Programming and Installation 6.0-3 PDF
No ratings yet
3BSE069489-603 - en Panel 800 Version 6 Panel Builder Programming and Installation 6.0-3 PDF
442 pages
3BSE069489-601 - en Panel 800 Version 6 Panel Builder Programming and Installation 6.0-1
No ratings yet
3BSE069489-601 - en Panel 800 Version 6 Panel Builder Programming and Installation 6.0-1
458 pages
3BDS011222-510 F en System 800xa 5.1 Configuration
No ratings yet
3BDS011222-510 F en System 800xa 5.1 Configuration
616 pages
Archestra IDE
100% (3)
Archestra IDE
468 pages
It App Management
No ratings yet
It App Management
236 pages
3BSE038018-600 - en System 800xa 6.0 System Guide Functional Description
No ratings yet
3BSE038018-600 - en System 800xa 6.0 System Guide Functional Description
588 pages
Application Manual: Multimove
No ratings yet
Application Manual: Multimove
104 pages
ChatGPT for Business: Strategies for Success
From Everand
ChatGPT for Business: Strategies for Success
Matthew C. Smith
1/5 (1)
S71x00 PidCompact DOC V2.0 en
No ratings yet
S71x00 PidCompact DOC V2.0 en
43 pages
Guidelines To Make Safe Industrial Robot Systems: Research Report
No ratings yet
Guidelines To Make Safe Industrial Robot Systems: Research Report
31 pages
Robot: Safety Guide
No ratings yet
Robot: Safety Guide
22 pages
Tailoring Autocad Pid and Plant 3d
100% (3)
Tailoring Autocad Pid and Plant 3d
176 pages
Autocad 2013 PDF DXF Reference Enu
No ratings yet
Autocad 2013 PDF DXF Reference Enu
286 pages
25742-Designing With LEDs Ebook 09-29-2010
No ratings yet
25742-Designing With LEDs Ebook 09-29-2010
30 pages
25742-Designing With LEDs Ebook 09-29-2010
No ratings yet
25742-Designing With LEDs Ebook 09-29-2010
30 pages
05 AC800M Hardware - RevC
0% (1)
05 AC800M Hardware - RevC
44 pages
Ansible Hands-On
No ratings yet
Ansible Hands-On
35 pages
Coe 3204 Computer Networks Question Paper Mid (B) Spring22-23
No ratings yet
Coe 3204 Computer Networks Question Paper Mid (B) Spring22-23
3 pages
ELX Licesence 70-80
No ratings yet
ELX Licesence 70-80
4 pages
ISE Wireless Guest Setup Guide & Wizard (For Use With ISE Express)
100% (2)
ISE Wireless Guest Setup Guide & Wizard (For Use With ISE Express)
63 pages
Aws - Sa Notes
No ratings yet
Aws - Sa Notes
68 pages
Reviewer in MIL Reports Only
No ratings yet
Reviewer in MIL Reports Only
8 pages
Ds-2Cd2047G2-L (U) 4 MP Colorvu Fixed Bullet Network Camera
No ratings yet
Ds-2Cd2047G2-L (U) 4 MP Colorvu Fixed Bullet Network Camera
6 pages
2010 10 How-To-jailbreak-iPhone-4-Ip With Limera1
No ratings yet
2010 10 How-To-jailbreak-iPhone-4-Ip With Limera1
27 pages
Brocade Netiron Ces 2000 and Netiron Cer 2000: Hardware Installation Guide
No ratings yet
Brocade Netiron Ces 2000 and Netiron Cer 2000: Hardware Installation Guide
124 pages
Ú Ú Úúú CC Ú Úúú Úúú C C Úúú C CC C Ú ÚÚ C Ú ÚÚ CC C ÚÚ CC C Ú ÚÚ C C Úú C Ú Ú ÚÚ C ÚÚ Ú Úú C CC Ú ÚÚ C C CC Ú Úú C
No ratings yet
Ú Ú Úúú CC Ú Úúú Úúú C C Úúú C CC C Ú ÚÚ C Ú ÚÚ CC C ÚÚ CC C Ú ÚÚ C C Úú C Ú Ú ÚÚ C ÚÚ Ú Úú C CC Ú ÚÚ C C CC Ú Úú C
49 pages
Embedded Syslog Manager (ESM) : Configuration Example
No ratings yet
Embedded Syslog Manager (ESM) : Configuration Example
5 pages
RFS Apxv9r13b-C-A20
0% (1)
RFS Apxv9r13b-C-A20
2 pages
Preparation For Google Cloud Professional Cloud Database Engineer Certification - by Murli Krishnan - Google Cloud - Community - Medium
No ratings yet
Preparation For Google Cloud Professional Cloud Database Engineer Certification - by Murli Krishnan - Google Cloud - Community - Medium
17 pages
PDF
No ratings yet
PDF
4 pages
CN LAB Manual
No ratings yet
CN LAB Manual
34 pages
NE&ME Series Routers License Use Guide
No ratings yet
NE&ME Series Routers License Use Guide
53 pages
ISource Supplier Introduction (English) 20160303
No ratings yet
ISource Supplier Introduction (English) 20160303
21 pages
List Android New Application and Tools 2012
No ratings yet
List Android New Application and Tools 2012
58 pages
Network Attached Storage
100% (1)
Network Attached Storage
48 pages
Effective Google Search Techniques
No ratings yet
Effective Google Search Techniques
6 pages
Dijkstra's Algorithm
No ratings yet
Dijkstra's Algorithm
8 pages
Frequently Asked Questions: Carrier Ethernet 2.0 Certification
No ratings yet
Frequently Asked Questions: Carrier Ethernet 2.0 Certification
7 pages
Here You Will Find Answers To CCNA - Protocols & Services Questions
No ratings yet
Here You Will Find Answers To CCNA - Protocols & Services Questions
5 pages
Application SMSC
No ratings yet
Application SMSC
22 pages
Landmark Earth Engineered Appliance Whitepaper
No ratings yet
Landmark Earth Engineered Appliance Whitepaper
5 pages
H Sơ Scada
No ratings yet
H Sơ Scada
86 pages
NFSHP+16-Trainer-LinGon - Info
No ratings yet
NFSHP+16-Trainer-LinGon - Info
2 pages
Methods To Bypass Cloudflare and Obtain Website Real IP
No ratings yet
Methods To Bypass Cloudflare and Obtain Website Real IP
6 pages
Arman Danesh, Gautam Das-Special Edition Using Linux System Administration (Special Edition Using) - Que (2000)
No ratings yet
Arman Danesh, Gautam Das-Special Edition Using Linux System Administration (Special Edition Using) - Que (2000)
856 pages