User Guide

FactoryTalk® Batch Equipment Editor

Important User Information
Solid-state equipment has operational characteristics differing from those of electromechanical equipment. Safety Guidelines for the Application,
Installation, and Maintenance of Solid State Controls (publication SGI-1.1 available from your local Rockwell Automation sales office or online at
http://www.rockwellautomation.com/literature/ ) describes some important differences between solid-state equipment and hard-wired
electromechanical devices. Because of this difference, and also because of the wide variety of uses for solid-state equipment, all persons responsible for
applying this equipment must satisfy themselves that each intended application of this equipment is acceptable.

In no event will Rockwell Automation, Inc. be responsible or liable for indirect or consequential damages resulting from the use or application of this
equipment.

The examples and diagrams in this manual are included solely for illustrative purposes. Because of the many variables and requirements associated
with any particular installation, Rockwell Automation, Inc. cannot assume responsibility or liability for actual use based on the examples and
diagrams.

No patent liability is assumed by Rockwell Automation, Inc. with respect to use of information, circuits, equipment, or software described in this
manual.

Reproduction of the contents of this manual, in whole or in part, without written permission of Rockwell Automation, Inc., is prohibited.

Throughout this manual, when necessary, we use notes to make you aware of safety considerations.

WARNING: Identifies information about practices or circumstances that can cause an explosion in a hazardous environment, which may lead to
personal injury or death, property damage, or economic loss.

ATTENTION: Identifies information about practices or circumstances that can lead to personal injury or death, property damage, or economic
loss. Attentions help you identify a hazard, avoid a hazard, and recognize the consequence

SHOCK HAZARD: Labels may be on or inside the equipment, for example, a drive or motor, to alert people that dangerous voltage may be
present.

BURN HAZARD: Labels may be on or inside the equipment, for example, a drive or motor, to alert people that surfaces may reach dangerous
temperatures.

Important: Identifies information that is critical for successful application and understanding of the product.

Allen-Bradley, Rockwell Software, and Rockwell Automation ControlLogix, eProcedure, FactoryTalk, RSBizWare, RSBizWare BatchHistorian, RSBizWare Historian, RSBizWare MaterialTrack, and RSLinx are
trademarks of Rockwell Automation, Inc.

Trademarks not belonging to Rockwell Automation are property of their respective companies.
 Table of contents

Chapter 1

FactoryTalk Batch Equipment Additional resources .......................................................................................................... 15

FactoryTalk Batch Equipment Editor security ............................................................ 16
Editor introduction
Open FactoryTalk Batch Equipment Editor........................................................ 17
FactoryTalk Batch Equipment Editor interface .......................................................... 18
Menu bar ...................................................................................................................... 19
Toolbar ......................................................................................................................... 19

Chapter 2

Area models Create a new area model ................................................................................................... 22

Open an existing area model ............................................................................................ 23
Area models migration .............................................................................................. 24
Area models and FactoryTalk Batch Material Manager..................................... 24
Material database changes ................................................................................. 25
Material database is unavailable ....................................................................... 25

Chapter 3

Import and export area XML area models ............................................................................................................... 27

Import an XML area model ..................................................................................... 28
models overview
Import enumerations ......................................................................................... 30
Import system phase classes .............................................................................. 31
Export an area model to XML ................................................................................. 32
Convert XML to binary from the command line overview............................... 33
Convert XML to binary from COM overview .................................................... 34
COM object syntax ............................................................................................ 35

Chapter 4

Enumerations overview System enumeration sets ................................................................................................... 39

Create enumeration sets ................................................................................................... 40
Add enumeration members...................................................................................... 41
Edit enumerations and enumeration sets ...................................................................... 42
Delete enumerations and enumeration sets .......................................................... 43

Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017 3
Table of contents

Chapter 5

Parameters and reports with Parameters and reports in recipes.................................................................................... 45

Parameters example.................................................................................................... 46
FactoryTalk Batch
How parameters and reports work with phase tags..................................................... 46
Additional request, parameter, and report tags for phases ................................. 47
Phase tags ..................................................................................................................... 48
Batch parameters and reports .......................................................................................... 49
Phase class parameters ............................................................................................... 49
Phase class reports ...................................................................................................... 50
Material parameters ........................................................................................................... 50
Types of containers .................................................................................................... 51
Default material parameters ..................................................................................... 52
Scale parameters.................................................................................................................. 53
Verification method for parameter deviations ............................................................. 53
Control strategies overview .............................................................................................. 54
Control strategies example ....................................................................................... 55
Implement control strategies ................................................................................... 56
Parameter and report subsets overview .......................................................................... 57
Phase class with different subsets example ............................................................ 58
Download parameter requests ................................................................................. 58
Upload report requests .............................................................................................. 60
Automatic Upload/Download ........................................................................................ 61
Control strategies with upload/download parameter subsets................................... 62

Chapter 6

Electronic signatures Types of electronic signatures .......................................................................................... 64

How electronic signatures work ...................................................................................... 65
Signature template ............................................................................................................. 67
Edit signature templates dialog box ........................................................................ 68
Add a signature template .......................................................................................... 69
Configure signature template signoffs ................................................................... 71
Assign security permissions for a signoff ........................................................ 73
Remove signoff permissions for a user or group ........................................... 75
Delete a signature template ...................................................................................... 76
Modify a signature template..................................................................................... 77
Command verification policies ....................................................................................... 78
Add a signature requirement to commands .......................................................... 78
Edit command verification policies dialog box............................................. 80
Change the verification policy for a command .................................................... 80
Remove the signature requirement for a command ............................................ 81

4 Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017
 Table of contents

Chapter 7

Recipe approval process Recipe approval tasks ......................................................................................................... 84

Configure recipe approval steps ...................................................................................... 85
overview
Recipe Approvals Configuration dialog box ......................................................... 87
Edit a recipe approval ........................................................................................................ 88
Disable recipe approval ..................................................................................................... 89

Chapter 8

Security authority overview Security authority configuration ..................................................................................... 92

Secure an area model.......................................................................................................... 93

Chapter 9

Data servers overview Data server definition files................................................................................................ 96

Area model data servers ..................................................................................................... 97
Data Servers dialog box ............................................................................................. 98
OPC data servers ................................................................................................................ 99
Add an OPC data server ......................................................................................... 100
RSLinx Enterprise FactoryTalk Live Data server .............................................. 101
Add a data server............................................................................................... 102
RSLinx Enterprise server path ....................................................................... 104
Configure the RSLinx Enterprise server path............................................. 104
Edit a data server ....................................................................................................... 105
Delete a data server................................................................................................... 106
Assign data servers ............................................................................................................ 107

Chapter 10

Resources overview Arbitration of resources .................................................................................................. 110

Define shared resources................................................................................................... 111
Configure general information for resources...................................................... 112
Configure arbitration information for resources ............................................... 113
Configure cross invocation information for resources ..................................... 115
Configure hyperlink information for resources ................................................. 116

Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017 5
Table of contents

Chapter 11

Global binding requirements Unit binding expression builder.................................................................................... 118

Expression operators ................................................................................................ 119
Supported data types................................................................................................ 119
Operands .................................................................................................................... 120
Expression validation ............................................................................................... 120
Create global binding requirements ............................................................................. 122
Edit binding requirements...................................................................................... 123
Delete binding requirements ................................................................................. 124

Chapter 12

Process cell overview Create a process cell class ................................................................................................ 126

Edit a process cell class..................................................................................................... 127
Create and configure process cell instances................................................................. 127
Configure a process cell instance ........................................................................... 128
Configure the general data for a process cell ....................................................... 129
Edit process cell dialog box - General tab .................................................... 130
Configure the arbitration data for a process cell ................................................ 130
Edit Process Cell dialog box - Arbitration tab ............................................ 131
Configure cross invocation data for a process cell ............................................. 132
Edit process cell dialog box - Cross Invocation tab.................................... 133
Configure hyperlink data for a process cell ......................................................... 133
Edit process cell dialog box - Hyperlink tab ................................................ 134
Remove a process cell instance ............................................................................... 134
Verify icon paths............................................................................................................... 135
Unique icons ..................................................................................................................... 136

6 Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017
 Table of contents

Chapter 13

Unit overview Create a unit class ............................................................................................................. 139

Edit a unit class ................................................................................................................. 140
Create a unit instance ...................................................................................................... 141
Unit instance configuration ........................................................................................... 141
Open the Edit Unit dialog box .............................................................................. 142
Configure the general data for a unit.................................................................... 143
Edit Unit dialog box - General tab ................................................................ 144
Configure unit attribute tags data......................................................................... 145
Edit Unit dialog box - Attribute Tags tab ................................................... 146
Configure arbitration data for a unit.................................................................... 146
Edit Unit dialog box - Arbitration tab ......................................................... 148
Configure cross invocation data for a unit .......................................................... 149
Edit Unit dialog box - Cross Invocation tab ............................................... 150
Configure hyperlink data for a unit ...................................................................... 151
Edit Unit dialog box - Hyperlink tab ........................................................... 152
Remove a unit instance ................................................................................................... 152
Link unit instances ........................................................................................................... 153
Share units ......................................................................................................................... 153

Chapter 14

Tags overview Unit attribute tags ............................................................................................................ 158

Add a unit attribute ................................................................................................. 158
Edit a unit attribute ................................................................................................. 160
Delete a unit attribute ............................................................................................. 160
Create a unit attribute tag....................................................................................... 161
Unit Attribute Tags dialog box ..................................................................... 163
Phase tags ........................................................................................................................... 164
Edit tags from the menu.......................................................................................... 165
Default equipment names....................................................................................... 166
Set all tag items to default name and access path ....................................... 167
Global unit attribute........................................................................................................ 168
Create a global unit attribute ................................................................................. 169
Edit a global unit attribute...................................................................................... 171
Delete a global unit attribute ................................................................................. 171
Remove a global unit attribute............................................................................... 172

Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017 7
Table of contents

Chapter 15

Phase class overview Tags ..................................................................................................................................... 174

Create and configure phase classes................................................................................ 175
Configure phase class general attributes .............................................................. 176
Create Phase Class dialog box - General tab ............................................... 178
Configure phase class parameters .......................................................................... 179
Create Phase Class dialog box - Parameters tab.......................................... 181
Configure phase class reports ................................................................................. 184
Create Phase Class dialog box - Reports tab ............................................... 186
Select context IDs..................................................................................................... 188
Configure phase class messages .............................................................................. 189
Create Phase Class dialog box - Messages tab ............................................. 190
Configure phase class control strategies............................................................... 190
Create Phase Class dialog box - Control Strategy tab ............................... 192
Verification policies ......................................................................................................... 193
How verification policies work.............................................................................. 194
Configure the verification policy for parameters and reports ......................... 195
Verification Policies dialog box ..................................................................... 198
How verification policies work with control strategies .................................... 200
How editing target parameters affects report verification policies ................. 200
Material-enabled phases .................................................................................................. 201
Standard phase class with matching parameter and report names ................. 202
Standard phase class with control strategies configured ................................... 202
Disable material on a material-enabled phase class.................................................... 202
Duplicate a phase class..................................................................................................... 203
Copy a phase class..................................................................................................... 203
Cut and paste a phase class ..................................................................................... 204

8 Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017
 Table of contents

Chapter 16

Configure phases Create a phase ................................................................................................................... 206

Configure the general data for a phase ................................................................. 207
Edit Phase dialog box - General tab .............................................................. 209
Configure the tag data for a phase......................................................................... 210
Edit Phase dialog box - Tag tab ...................................................................... 211
Phase tag ............................................................................................................. 212
Set tag items to the default addresses ............................................................ 216
Configure the arbitration data for a phase .......................................................... 217
Edit Phase dialog box - Arbitration tab........................................................ 218
Configure cross invocation data for a phase ....................................................... 218
Edit Phase dialog box - Cross Invocation tab ............................................. 219
Configure hyperlink data for a phase ................................................................... 219
Edit Phase dialog box - Hyperlink tab .......................................................... 220
Configure container data ........................................................................................ 220
Edit Phase dialog box - Containers tab ........................................................ 222
Parameter limit tags ......................................................................................................... 223
Enable parameter limit tags .................................................................................... 223
Edit Phase dialog box - Parameter Limit Tags tab ..................................... 224
Map parameter tags to parameter limit tags........................................................ 225
Report limit tags ............................................................................................................... 226
Edit Phase dialog box - Report Limit Tags tab ................................................... 226
Enable report limit tags ........................................................................................... 227
Map report tags to report limit tags ...................................................................... 228
Configure parameter and report limit tags ................................................................. 229
How edits to parameters, reports, and phase classes affect limit tags ............. 230
Overview of sharing phases and operation sequences between units..................... 231
Share a phase or operation sequence..................................................................... 232

Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017 9
Table of contents

Chapter 17

Operation sequence Create an operation sequence ........................................................................................ 234

Edit Operation Sequence dialog box - General tab ........................................... 234
configuration
Configure the general data for an operation sequence.............................. 235
Edit Operation Sequence dialog box - Arbitration tab ..................................... 236
Configure the arbitration data for an operation sequence ....................... 237
Edit Operation Sequence dialog box - Tags tab ................................................. 238
Configure operation sequence class parameters ......................................... 238
Configure operation sequence class reports ................................................ 240
Overview of sharing phases and operation sequences between units..................... 241
Share a phase or operation sequence..................................................................... 242

Appendix A

Supported area model Area model object warm restart support ..................................................................... 243
Resource classes warm restart support ......................................................................... 244
changes
Resources warm restart support .................................................................................... 244
Unit attributes warm restart support ........................................................................... 245
Unit attribute tags warm restart support..................................................................... 245
Equipment phase tags warm restart support............................................................... 246
Enumeration sets warm restart support....................................................................... 246
Data servers warm restart support ................................................................................ 247
Process cell classes warm restart support ..................................................................... 247
Process cells warm restart support ................................................................................ 248
Unit classes warm restart support ................................................................................. 249
Units warm restart support ............................................................................................ 249
Parameters warm restart support .................................................................................. 250
Added parameters warm restart support ............................................................. 251
Report warm restart support.......................................................................................... 252
Added reports warm restart support .................................................................... 252
Configured messages warm restart support ................................................................ 253
Recipe phases warm restart support ............................................................................. 253
Equipment phases warm restart support ..................................................................... 254

10 Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017
 Table of contents

Appendix B

Troubleshoot issues Unable to access instruction file .................................................................................... 255

Illegal characters encountered in writing instruction file......................................... 256
Unable to access Material Server for material support per container .................... 256
COM-related exception errors ...................................................................................... 257
XML parser error messages .................................................................................... 257
Material-specific errors ............................................................................................ 258
Invalid signoff ................................................................................................................... 260
Resolve invalid signoff caused by deleted group or user.................................... 261
Resolve invalid signoff when required information is omitted ....................... 262
No Signature templates configured within the Area Model ................................... 262
Equipment Editor: Area model is secured to a different FactoryTalk Network
Directory ............................................................................................................................ 263
Recipe Editor: Area model is secured to a different FactoryTalk Network
Directory ............................................................................................................................ 264
Legal Notices Legal Notices ..................................................................................................................... 265
Index

Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017 11
 Chapter 1

FactoryTalk Batch Equipment Editor introduction

Use FactoryTalk Batch Equipment Editor to create and maintain an equipment

database. The area model is the physical component of a batch facility. A database
that consists of all equipment in the facility and all of the tasks that it is capable of
performing. The area model is stored in a file with a .cfg file extension and is
available to all other FactoryTalk Batch programs, including FactoryTalk Batch
Recipe Editor, FactoryTalk Batch View, and Phase Simulator.

For example, during recipe configuration, the area model provides a list of
available units and phases. Later during recipe verification, it verifies that the
designated equipment is capable of executing the procedures. During recipe
execution, resource arbitration functions use the area model to allocate equipment
based on recipe and operator requests.

Arbitration is a form of coordination control that determines how a resource

allocate when there are more requests for the resource than can be accommodated
at one time.

Important: Verify any recipes that run against a new or modified area model, and
restart the FactoryTalk Batch Server service.

As outlined in the ISA S88.01 Batch Control Standard, the facility area model
organizes into model components:

• Process Cell
• Unit
• Phase
• Control Module

Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017 13
Chapter 1 FactoryTalk Batch Equipment Editor introduction

In addition to the creation of an area model, FactoryTalk Batch Equipment

Editor:

• Defines signature templates for electronic signatures and recipe approval

signoffs.
• Configures steps and approval signoffs for recipe approval.
• Enables recipe version control.
• Secures an area model using security authority.
• Specifies server communication functions.
• Specifies FactoryTalk Event Archiver filters and reporting options.

If using FactoryTalk Batch with FactoryTalk Batch Material Manager, set security
for FactoryTalk Batch to access the material database.

See also

FactoryTalk Batch Equipment Editor security on page 16

14 Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017
FactoryTalk Batch Equipment Editor introduction Chapter 1

Additional resources These documents contain additional information concerning related Rockwell
Automation products.

Resource Description
FactoryTalk Batch ActiveX Controls User Guide Quick and easy access to information and instructions required to
use the FactoryTalk Batch ActiveX Custom Controls.
FactoryTalk Batch Administrator Guide Instructions for configuring security and services, and
implementation and use of components not normally accessed or
used by batch operators, such as the FactoryTalk Batch Server,
Simulator, and performance chart.
FactoryTalk Batch Server API Communication Provides quick and easy access to information regarding the
Language Reference Guide interface between the FactoryTalk Batch Server and FactoryTalk
Batch View — the Server Application Programming Interface (API).
It is intended to be used as a reference guide by those who want to
develop custom interfaces.
FactoryTalk Event Archiver User Guide The FactoryTalk Event Archiver collects data from the batch record
files (.evt files) generated by the FactoryTalk Batch Server and
stores the data in a Microsoft SQL Server database.
FactoryTalk eProcedure Client User Guide Provides information and procedural instructions required to create
and command batches using the FactoryTalk® eProcedure® Client,
and can be used as a reference information by the operator.
FactoryTalk Batch PCD Programmer Technical Provides information and instructions about the FactoryTalk®
Reference Guide Batch-PCD interface design. It is intended to be used as a reference
guide.
FactoryTalk Batch PhaseManager User Guide Describes the integration of the FactoryTalk Batch software with the
Studio 5000 Logix Designer™ application and the Logix5000™ family
of controllers. This integration simplifies the configuration and
maintenance of the FactoryTalk Batch automation system, provides
a superior means of communication between the FactoryTalk Batch
Server and the Logix5000 controller, and significantly reduces the
programming effort required to develop the phase logic code that
resides in your Logix5000 controller.
FactoryTalk Batch Recipe Editor User Guide Use FactoryTalk Batch Recipe Editor to create and configure master
recipes for use in batch automation. The interface is based on IEC
61131-3 sequential function charts to graphically organize recipes
into procedures, unit procedures, operations, and phases. Build
recipes using either the SFC format or a table-based format.
FactoryTalk Batch View User Guide FactoryTalk Batch View is used to initiate and execute FactoryTalk
Batch automation processing. FactoryTalk Batch View secured
objects are located in the FactoryTalk Diagnostics and are modified
using the FactoryTalk Administration Console. A system
administrator can customize FactoryTalk Batch View security to
meet the needs of the facility. FactoryTalk Batch View is used in
conjunction with a Human-Machine Interface (HMI).

View or download publications at

http://www.rockwellautomation.com/literature . To order paper copies of
technical documentation, contact the local Rockwell Automation distributor or
sales representative.

Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017 15
Chapter 1 FactoryTalk Batch Equipment Editor introduction

FactoryTalk Batch Security for FactoryTalk Batch Equipment Editor uses the FactoryTalk Security
product policy settings defined in the FactoryTalk Directory. Only FactoryTalk
Equipment Editor security Security users have access to FactoryTalk Batch Equipment Editor.

FactoryTalk Batch Equipment Editor Single Sign-On product policy setting

created in the FactoryTalk Local Directory in conjunction with the FactoryTalk
Use single sign-on system policy setting enables and disables the FactoryTalk
single sign-on. Single sign-on allows users to log on just once, per directory, on a
given computer. Once a user logs on to the FactoryTalk Directory, all
participating FactoryTalk-enabled products that run in that directory, on that
computer, automatically use the logged on user’s security credentials.

When opening FactoryTalk Batch Equipment Editor, the user logged on to the
FactoryTalk Directory automatically logs on to FactoryTalk Batch Equipment
Editor or the Log on to FactoryTalk dialog box opens requiring a user name and
password.

If enabled, the FactoryTalk Use single sign-on system policy setting and
FactoryTalk Batch Equipment Editor Single Sign-On product policy setting is
True, these scenarios are possible when opening FactoryTalk Batch Equipment
Editor:

• If a FactoryTalk Security user with FactoryTalk Batch Equipment Editor

permissions opens FactoryTalk Batch Equipment Editor while currently
logged on to the FactoryTalk Directory, the security permissions are the
same.
• If a Windows-linked user with FactoryTalk Batch Equipment Editor
permissions opens FactoryTalk Batch Equipment Editor, the user logs on to
the FactoryTalk Directory.
• If a user is not found, the Log on to FactoryTalk dialog box opens.
Tip: FactoryTalk Windows-linked user: A user account created in Windows and
then added to the FactoryTalk Directory.

If disabled the FactoryTalk Use single sign-on system policy setting or

FactoryTalk Batch Equipment Editor Single Sign-On product policy setting is
False, then the Log on to FactoryTalk dialog box displays and a FactoryTalk
Security user with permissions to open FactoryTalk Batch Equipment Editor must
be entered.

See also

Open FactoryTalk Batch Equipment Editor on page 17

16 Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017
FactoryTalk Batch Equipment Editor introduction Chapter 1

Open FactoryTalk Batch Use these instructions to open FactoryTalk Batch Equipment Editor.
Equipment Editor
To open FactoryTalk Batch Equipment Editor:

1. Select Start, point to All Programs > Rockwell Software > FactoryTalk
Batch Suite > FactoryTalk Batch, and then select Equipment Editor.

2. (optional) If the Log On to FactoryTalk dialog box displays, type the user
name and password and then select OK.

3. (optional) If a FactoryTalk user name and password is not found in the

FactoryTalk Directory or if the user is not configured to run FactoryTalk
Batch Equipment Editor, the Logon Message dialog box opens.

See also

FactoryTalk Batch Equipment Editor security on page 16

Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017 17
Chapter 1 FactoryTalk Batch Equipment Editor introduction

FactoryTalk Batch Use FactoryTalk Batch Equipment Editor to configure the facility area model.
The components defined in the FactoryTalk Batch Equipment Editor interface
Equipment Editor interface with the facility process-connected devices.

The following illustration shows the FactoryTalk Batch Equipment Editor

interface:

The sections of the FactoryTalk Batch Equipment Editor interface include:

Item Name Description

Menu bar The menu bar shows the available menus.

Toolbar The toolbar shows all the available operations.

Location bar The location bar indicates the unit and process cell currently working. Select
View > Location Bar to show and hide.
Class View Shows the existing cell classes, unit classes, or phases in the active area model. The column
area heading reflects the active level. Double-click (or right-click) an icon to open the Edit dialog
box for that item.
Design View Use this area to construct the area model and display the layout of the active level. In Select
area mode, double-click an item to display the layout of the next lower level. Right-click the item
to open the Edit dialog box.
Status bar The right side of the status bar displays the selected unit, process cell, and current user name.

See also

Menu bar on page 19

Toolbar on page 19

Area models on page 21

18 Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017
FactoryTalk Batch Equipment Editor introduction Chapter 1

Menu bar The Menu bar commands include:

Name Purpose
File Lists options for opening, creating, saving, securing, and importing and exporting area models.
Edit Edit the various area model components, perform a tag import, and configure signoffs for recipe
approval.
Class Create a new class of items for the current level.
View Specify the FactoryTalk Batch Equipment Editor components to display, and indicate the zoom
percentage.
Options Specify directories for area model icons and configure the FactoryTalk Batch Server options. Server
options include project settings (directories, recipe storage file type, recipe versioning enable and
disable), archiver event filters, batch reporting, and other settings.
Help Provides on-line help and information regarding the software and the system.

See also

FactoryTalk Batch Equipment Editor interface on page 18

Toolbar The FactoryTalk Batch Equipment Editor toolbar contains a group of buttons
used to perform commands in FactoryTalk Batch Equipment Editor. The
buttons, from left to right, are:

Graphic Name Description Keyboard

Shortcut
New Creates an area model. CTRL + N
Open Opens an existing area model. CTRL + O
Save Saves the active area model. CTRL + S
Cut Deletes the highlighted item and saves it to the Delete
clipboard.
Copy Copies the highlighted item and saves it to the CTRL + C
clipboard.
Paste Pastes the cut or copied item from the clipboard. CTRL + V
Share Shares the selected unit or phase class. CTRL + H
Go Down Moves down through the levels and displays the next None
lower level.
Go Up Moves up through the levels and displays the next None
higher level.
Zoom Specifies the magnification of the current sequential None
function chart (SFC) display.
Add New Object Opens the appropriate Create dialog box for the active None
level.
Edit Area Edit the area information. CTRL + A
Edit Enumerations Opens the Create Enumeration Sets and CTRL + M
Enumerations dialog box.
Edit Servers Opens the Create Servers dialog box. CTRL + D
Synchronize Synchronizes the equipment area model with the CTRL + L
Logix Designer project file.

Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017 19
Chapter 1 FactoryTalk Batch Equipment Editor introduction

Graphic Name Description Keyboard

Shortcut
Edit Shared Resources Opens the Edit Resources dialog box. CTRL + R
Edit Properties Opens the appropriate Edit dialog box for the selected CTRL + E
item.
Edit Tags Opens the Edit Tags dialog box. CTRL + T
Edit Unit Attributes Opens the Edit Unit Attributes dialog box. CTRL + U
Edit Global Binding Opens the Edit Global Unit Binding Requirements CTRL + B
Requirements dialog box.
Edit Signature Opens the Edit Signature Templates dialog box. None
Templates
Edit Command Opens the Edit Command Verification Policies CTRL + P
Verification Policies dialog box.
Select Instance Changes the cursor to the selection tool. None
Link Units Changes the cursor to the linking tool. Links define the None
upstream and downstream relationships between
units within a process cell. The FactoryTalk Batch
Server uses the links to determine which units are
available for selection when defining equipment
requirements for procedures.
Unlink Units Changes the cursor to the unlinking tool, to unlink the None
units within a process cell.
Invoke Recipe Editor Opens FactoryTalk Batch Recipe Editor. None

See also

FactoryTalk Batch Equipment Editor interface on page 18

20 Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017
 Chapter 2

Area models

The area model contains information about the process equipment used to create
batches. It includes all the components configured for one area of a specific
physical plant. An area model corresponds to a single FactoryTalk Batch Server.
The area model saves as a configuration file (.cfg) for use by FactoryTalk Batch
Recipe Editor, FactoryTalk Batch View, and Phase Simulator.

Create the area model in this order:

• Enumerations
• Data servers
• Resources
• Process cells
• Units
• Phase classes
• Phases

In some cases, re-configure upper-level equipment after defining the lower-level

equipment.

See also

Enumerations overview on page 37

Data servers overview on page 95

Resources overview on page 109

Phase class overview on page 173

Create a new area model on page 22

Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017 21
Chapter 2 Area models

Create a new area model Certain FactoryTalk Batch modules use the area model name to identify the
FactoryTalk Batch system data to associate with the area model.

Important: The area name must be unique for each FactoryTalk Batch Server running
on a network.

To create a new area model:

1. Select Start, point to All Programs > Rockwell Software > FactoryTalk
Batch Suite > FactoryTalk Batch, and then select Equipment Editor.

2. Select File > New. A blank area model opens.

3. Select Edit Area ( ). The Edit Area dialog box opens.

4. In Name, type a unique name for the area.

5. In Version, type a version number.

6. Select OK to return to the Design View area. The area name displays in the
title bar of the Design View area.

7. Select File > Save.

8. Type an appropriate file name, and then select Save to save the area model.

The area model saves to the configuration file and can open at any time for
modification.

Important: Restart the FactoryTalk Batch Server to initiate the changes and re-verify
any recipes that run against any modified area model.
Tip: If running FactoryTalk Batch Material Manager and the FactoryTalk Batch Server
loses communications with the Material Server while creating or editing the area
model, some of the enumeration sets contain only the default values —
NULL_MATERIAL, NULL_CLASS, and NULL_CONTAINER.

See also

Open an existing area model on page 23

22 Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017
Area models Chapter 2

Open an existing area Use these instructions to open an existing area model.

model To open an existing area model:

1. Select Start, point to All Programs > Rockwell Software > FactoryTalk
Batch Suite > FactoryTalk Batch, and then select Equipment Editor.

2. Select File > Open.

3. Locate and select the area model file (.cfg), and then select Open.

If security authority is applied to the area model, and there is a mismatch

between the security authority identifier (SAI) in the area model and the
SAI in the FactoryTalk Network Directory, an error message opens:

4. Make note of the FactoryTalk Network Directory and host computer

information, then select OK to close the error message.

5. To recover a backup of the FactoryTalk Network Directory SAI, or if the

area model in unsecured form is needed.

• Restore the FactoryTalk Network Directory SAI securing the area

model. The dialog box provides the name of the computer that hosts
that SAI. Use the FactoryTalk Administration Console to restore a
saved backup of the SAI. Then use File > Open to open the secured
area model.
• Open a copy of the area model. If you have not previously saved the area
model, save a copy of the area model. A copy of the area model that is
not secured is needed to securing the area model. Once secured the area
model, an option to recovery a secured area model becomes available.

See also

Area models migration on page 24

Area models and FactoryTalk Batch Material Manager on page 24

Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017 23
Chapter 2 Area models

Area models migration When opening area models created using FactoryTalk Batch version 11.00 or
later, the option to have the area model automatically migrated to the latest
FactoryTalk Batch version is available. The existing data migrates to the new
schema. If the area model is not migrated, the current FactoryTalk Batch
Equipment Editor version is unable to open.

Tip: If upgrading from a FactoryTalk Batch version older than the previous major
release (such as from version 10.xx or earlier to version 12.xx), contact the
Rockwell Customer Support Representative to have the area model upgraded to
the new equipment database schema.

See also

Open an existing area model on page 23

Area models and FactoryTalk When opening area models containing enumeration sets of the same name as the
system enumeration sets (YES_NO, and if FactoryTalk Batch Material Manager
Batch Material Manager
is supported, MATERIALS, MATERIAL_CLASSES, and CONTAINERS),
rename these non-FactoryTalk Batch Material Manager enumeration sets.
Renaming the enumeration sets updates all parameters, report parameters, and
unit attribute tags to the renamed enumeration set and creates the new system
enumeration set. If not renamed, the area model cannot open in the current
FactoryTalk Batch Equipment Editor version.

Tip: When using FactoryTalk Batch Material Manager in conjunction with FactoryTalk
Batch, there is a dependency between the area model and the material database.
When an area model opens, the MATERIALS and CONTAINERS enumeration sets
recreate, based on the materials and containers that exist in the material database.
If the Material Server is unavailable, the enumeration sets contain only the default
values — NULL_MATERIAL and NULL_CONTAINER.

See also

Open an existing area model on page 23

Material database changes on page 25

Material database is unavailable on page 25

24 Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017
Area models Chapter 2

Material database changes FactoryTalk Batch Material Manager only.

If a member of the MATERIAL enumeration set previously assigned to a phase

class is no longer in the material database, a warning message displays the error.

• Select Continue to substitute the NULL_MATERIAL enumeration for

the unsupported enumeration.
• Select Cancel to open the area model unchanged. When affected phase
class’s Parameter tab opens, the first enumeration in the alphabetically
sorted list substitutes for the unsupported enumeration.
Important: The controller ID of a material and container is the ordinal value for the
enumeration. If modified the item controller ID in the material database,
the ordinal value of the associated enumeration changes. This change
could affect the phase logic.

See also

Material database is unavailable on page 25

Area models and FactoryTalk Batch Material Manager on page 24

Material database is unavailable The MATERIALS and CONTAINERS enumeration sets recreate each time an
area model creates, opens, or imports. If the Material Server is unavailable, the
enumeration sets only contain the default values — NULL_MATERIAL and
NULL_CONTAINER.

See also

Area models and FactoryTalk Batch Material Manager on page 24

Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017 25
 Chapter 3

Import and export area models overview

FactoryTalk Batch gives the ability to import XML area models or export area
models to XML format. XML provides a standard, non-proprietary format for
distributing the area model configuration.

See also

Import an XML area model on page 28

Export an area model to XML on page 32

XML area models XML schemas and XML instance documents have become the industry standard
for providing implementation of neutral information. With FactoryTalk Batch,
FactoryTalk Batch Equipment Editor can import and export an area model in
XML format. This function allows for the exchange of the area model information
with other companies in a standard, non-proprietary XML format. The area
model information may be edited using text editors or XML editors.

Tip: When securing an area model to a Security Authority Identifier, the Export
command disables, and the area model cannot export.

See also

Import an XML area model on page 28

Export an area model to XML on page 32

Convert XML to binary from the command line overview on page 33

Convert XML to binary from COM overview on page 34

Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017 27
Chapter 3 Import and export area models overview

Import an XML area model When an XML area model imports, FactoryTalk Batch Equipment Editor
constructs the area model in memory. Save the imported area model to the
proprietary binary file or export it to another text file.

FactoryTalk Batch Equipment Editor validates the information provided by the

XML file. Only well-formed, validated XML files import. The XML files must
have the extension .axml to import. FactoryTalk Batch Equipment Editor
attempts to read the files as XML files only if the files have the correct file
extension.

Files with extensions other than .axml read as tab-delimited files. Although the
.txt file extension is expected for the tab-delimited text files, FactoryTalk Batch
Equipment Editor attempts to read all files with extensions other than .axml as
tab-delimited text files.

Tip: The YES_NO, MATERIALS, MATERIAL _CLASSES, and CONTAINERS enumeration

sets recreate each time a new area model creates, opens, or imports. Existing
values are not imported. If the Material Server is not available, the MATERIALS,
MATERIAL_CLASSES, and CONTAINERS enumeration sets create with the
NULL_MATERIAL, NULL_CLASS, and NULL_CONTAINER default values only. (See
Import enumerations for more information.)

To import an XML area model:

1. Select Start, point to All Programs > Rockwell Software > FactoryTalk
Batch Suite > FactoryTalk Batch, and then select Equipment Editor.

2. Select File > Import.

3. From the Files of type list, select XML Files (*.axml).

4. Locate and select the XML file to import.

28 Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017
Import and export area models overview Chapter 3

5. Select Open to initiate the import process. A message box displays the name
of each component imported and validated.

6. Select OK to complete the import process and return to FactoryTalk Batch

Equipment Editor.

7. Select File > Save As to save the newly imported file.

The Save As dialog box opens with Untitled.cfg highlighted in the File
name box.

8. In File name, type the new file name. Give the file the same name as the
currently selected area model to overwrite the current file.

9. Select Save. The new area model saves and the file name displays on the
FactoryTalk Batch Equipment Editor title bar.

Tip: If the file name is anything other than the area model currently selected in the
Server Options dialog box, change the Server Options settings before the new
area model is used.

See also

Import enumerations on page 30

Import system phases on page 31

Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017 29
Chapter 3 Import and export area models overview

Import enumerations Create and maintain these system enumeration sets in FactoryTalk Batch
Equipment Editor:

• PHASE_FAILURES
• YES_NO
• REPORTING_CONTEXTS
• MATERIALS (with an installed Material Server)
• MATERIAL_CLASSES (with an installed Material Server )
• CONTAINERS (with an installed Material Server)

With the exception of PHASE_FAILURES and REPORTING_CONTEXTS,

the data type or the members of these system-maintained enumeration sets cannot
change. The XML file must include these system enumeration sets for validation
against the schema. These system enumeration sets cannot import.

Tip: The PHASE_FAILURES AND REPORTING_CONTEXTS system enumeration sets can

import along with any user-defined enumerations in these enumeration sets.

See also

Import an XML area model on page 28

Import system phases on page 31

30 Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017
Import and export area models overview Chapter 3

Import system phase classes FactoryTalk Batch Equipment Editor creates and maintains these system phase
class sets:

• $NULL
• $TIMER

On import of system phase classes, the entire phase class validates and only those
that match completely import.

Tip: If any of the system phase classes ($TIMER or $NULL) contain errors, only the first
error show.

$NULL phase

The $NULL phase class validates:

• The name of the phase class must be $NULL.

• There must be no configured recipe or report parameters.
• There must be no configured messages.
• There must be no configured control strategies.
• There must be no configured request parameters.
• There must be no configured message partners.
• All other configurable values are not set.

$TIMER phase

The $TIMER phase class validates:

• The name of the phase class must be $TIMER_X (where X is the type of
Timer and the unit of measure; for example, $TIMER_DN_SECOND or
$TIMER_UP_DAY).
• There must be no configured messages.
• There must be no configured control strategies.
• There must be no configured request parameters.
• There must be no configured message partners.

See also

XML area models on page 27

Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017 31
Chapter 3 Import and export area models overview

Export an area model to XML FactoryTalk Batch allows export of an area model to a well-formed XML format.
With the exception of PHASE_FAILURES and REPORTING_CONTEXTS,
the data type or the members of the system-maintained enumeration sets cannot
change. The XML file must include these system enumeration sets for validation
against the schema. These system enumeration sets can export but cannot import.

All system phases ($NULL or $TIMER) export. All associated recipe and report
parameters and associated data (for $TIMER_X phases) are part of the export (for
example, where X is the type of Timer and the unit of measure;
$TIMER_DN_SECOND or $TIMER_UP_DAY).

Tip: The PHASE_FAILURES AND REPORTING_CONTEXTS system enumeration sets

export along with any user-defined enumerations in these enumeration sets.

Tip: When an area model secures to a FactoryTalk Network Directory Security

Authority Identifier, the Export command disables.

To export an area model to XML:

1. Select Start, point to All Programs > Rockwell Software > FactoryTalk
Batch Suite > FactoryTalk Batch, and then select Equipment Editor.

2. Open the area model to export.

3. Select File > Export. The File Export As dialog box opens.

4. Locate and select the file to export the area model or, in File name, type a
new file name.

5. In Save as type, select XML Files (*.axml).

6. Select Save to initiate the export process. If the file already exists, confirm to
replace the file.

7. Select OK to complete the export process and return to FactoryTalk Batch

Equipment Editor.

See also

Import and export area models overview on page 27

32 Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017
Import and export area models overview Chapter 3

Convert XML to binary from the Convert XML area models to the proprietary binary format from the command
command line overview line using the supplied program AreaModelConvert.exe. Only well-formed,
schema-conformed, and program-validated XML files convert.

When exporting from a command line, change to the directory containing

AreaModelConvert.exe and the paths cannot contain any spaces. UNC names
are also supported, as demonstrated in this syntax example:

The syntax for the command line is:

C:AreaModelConvert.EXE InputFile OutputFile LogFile

Where:

• InputFile specifies the path for the input XML filename.

• OutputFile specifies the path for output binary filename.
• LogFile specifies the path for log file.

Example:

C:AreaModelConvert.EXE
\\Batchctl\SampleDemo1\recipes\ice_cream1.axml
\\Batchctl\SampleDemo1\recipes\ice_cream1.cfg
\\Batchctl\SampleDemo1\logs\convert.log

The command line validates the information in the XML file and overwrites the
existing file specified by OutputFile. Error messages append to the log file.

Important: The command line program will not validate material-specific

information, which includes:
• Running status of the Material Server
• Existence of the referenced materials
• Existence of the referenced material classes
• Existence of the referenced containers

Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017 33
Chapter 3 Import and export area models overview

If the command line arguments are valid, the program returns a 0 (zero),
indicating a successful import. If the command line arguments are invalid, the
command line program returns a 1 (one), indicating a failure. View the return
code in the log file to check if the conversion succeeded or failed.

See also

Convert XML to binary from COM overview on page 34

Convert XML to binary from COM A COM object exposes an interface that allows conversion of area models from
XML files to MFC binary files. The COM object,
overview
AreaModelXMLToBinary.exe, installs in the Batch/bin directory and consists
of the:

• AreaModelXMLToBinary.exe must install in the Batch/bin directory.

• AreaModelXMLToBinary.tlb must install in the Batch/bin directory.

The COM object has these characteristics:

• Component: AreaModelXMLToBinary.exe
• ProgID: AreaModelConvert.AModelXMLToBinary.1
• Interface: IAreaModelXMLToBinary
• Method: HRESULT AreaModelXMLToBinary.ConnvertXMLToBinary
(BST InputFile, BST OutputFile)

Access the COM object in any COM-aware programming environment.

See also

COM object syntax on page 35

34 Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017
Import and export area models overview Chapter 3

COM object syntax The syntax of the interface method of the COM object is:

HRESULT AreaModelXMLToBinary.ConnvertXMLToBinary (BST InputFile,

BSTR OutputFile)

Where:

AreaModelXMLToBinary: BSTR InputFile: BSTR OutputFile:

Instance of the interface Specifies the path for the Specifies the path for output
IAreaModelXMLToBinary input XML filename. binary filename.

Example using C++:

If using C++ to create the COM object, the syntax looks like this code sample:

#import AreaModelConvert.tlb
....
IAreaModelConvertPtr piAreaModelConvert;
piAreaModelConvert.CreateInstance("AreaModelConvert.AModelXMLTo
Binary");
HRESUTL hr= piAreaModelConvert ->ConnvertXMLToBinary (InputFile,
OutputFile);
BSTR bstr = piAreaModelConvert ->MessageString();

Example using Visual Basic:

If using Visual Basic to create the COM object, the syntax looks similar to this
example.

Dim obj As Object

Dim returnCode As Integer
Set obj = CreateObject("AreaModelConvert.AreaModelXMLToBinary")
returnCode = obj.ConvertXMLToBinary([InputFile], [OutputFile])
If returnCode = 0 Then
MsgBox ("Conversion Successful")
Else
MsgBox ("Error:" & "Conversion did not complete.")

Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017 35
Chapter 3 Import and export area models overview

Where:

[InputFile] is the path and file name of the XML area model (.axml) and
[OutputFile] is the path and file name of the binary area model file (.cfg).

Spaces are not allowed in the path names unless contained in quotation marks, as
shown in the previous example. UNC names are also supported, as demonstrated
in this syntax example:

returnCode =
obj.ConvertXMLToBinary("\\batchctl\SampleDemo1\recipes\ice_crea
m1.axml", "\\batchctl\SampleDemo1\recipes\ice_cream1.cfg")

See also

Convert XML to binary from COM overview on page 34

36 Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017
 Chapter 4

Enumerations overview

Enumerations are a variable data type consisting of a numeric value (called an

ordinal value) and an associated text string. The process-connected device (PCD)
and the FactoryTalk Batch Server communicate using the numeric ordinal value.
The server then displays the ordinal value associated text string to the operator.
Use enumerations to display meaningful text to an operator, instead of a number.

Enumeration sets contain groupings of related enumerations. The FactoryTalk

Batch and the PCD create and maintain these default system enumeration sets:

• PHASE_FAILURES
• YES_NO
• MATERIALS (for Material Server-installed system)
• MATERIAL_CLASSES (for Material Server-installed system)
• CONTAINERS (for Material Server-installed system)
• REPORTING_CONTEXTS

The data type and the members of the YES_NO, MATERIALS,

MATERIAL_CLASSES, or CONTAINERS system-maintained enumeration
sets cannot change.

Create custom enumerations and enumeration sets within an area model.

Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017 37
Chapter 4 Enumerations overview

Use negative ordinal as shown in this example.

The agitator in Premixer B (Unit #2) might use:

Enumeration Set Name --> MOTORS

Enumeration Name Ordinal String
Enumeration_1 0 OFF
Enumeration_2 1 FORWARD
Enumeration_3 -1* REVERSE

See also

System enumeration sets on page 39

Create enumeration sets on page 40

38 Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017
Enumerations overview Chapter 4

System enumeration sets There are five default system enumeration sets. The data type or the members of
these system-maintained enumeration sets are not allowed to change, except for
the Phase_Failures and Reporting_Contexts enumeration sets.

System Enumeration Set Purpose

PHASE_FAILURES By default, there are no members in this enumeration set. Add enumerations
based on the particular implementation requirements.
Important: PHASE_FAILURES enumerations cannot have ordinal values greater than 32767 or less than 0 (zero).
REPORTING_CONTEXTS This enumeration set makes it possible to add reporting context strings to phase
class parameters and reports. The events about the sets may be more easily
queried and sorted. Add, remove, and edit enumeration set members to this
enumeration set. The default enumeration is NULL, with an ordinal value of 0.
PHASE_FAILURES and REPORTING_CONTEXTS are the only system enumeration sets to which enumerations can be
added. System enumeration sets display in bold text to differentiate them from custom enumeration sets.
YES_NO This is a simple enumeration set that contains two members: NO with an ordinal
value of 0 and YES with an ordinal value of 1. This enumeration set cannot be
modified.
MATERIALS (for Material Represents the set of materials configured in the FactoryTalk Batch Material
Server-installed system) Manager material database. The default enumeration is NULL_MATERIAL, with
an ordinal value of 0. This value allows assignment of an enumeration to a
parameter of type MATERIALS, which delays the actual material assignment until
the recipe is built. All other enumeration set members are recreated each time an
area model creates, opens, or imports, based on the material data in the material
database. The controller ID range for Materials is from 1 through 9999999999.
If the FactoryTalk Batch Material Manager material database is unavailable, the MATERIALS and CONTAINERS
enumeration sets only contain the default enumerations.
CONTAINERS (for Material Represents the set of containers configured in the FactoryTalk Batch Material
Server-installed system) Manager material database. The default enumeration is NULL_CONTAINER, with
an ordinal value of 0. All other enumeration set members are recreated each time
an area model creates, opens, or imports, based on the container data in the
material database. The controller ID range for Containers is from 1 through
9999999999.
The controller ID of a material and container is the ordinal value for the enumeration. If modified the controller ID in the
material database, the ordinal value of the associated enumeration changes, which could affect the phase logic.
MATERIAL_CLASSES (for Material Represents the set of material classes configured in the FactoryTalk Batch
Server-installed system) Material Manager material database. The default enumeration is NULL_CLASS,
with an ordinal value of 0. All other enumeration set members are recreated each
time an area model is created, opened, or imported, based on the material class
data in the material database. The MATERIAL_CLASSES enumeration set
members created from the Material Server have a one-to-one relation with the
material classes in the Material Server. The name of the enumeration member is
the material class name and the ordinal of the enumeration member is the
controller ID of that material class. The Material Class controller ID range is from 1
through 9999999999.

See also

Enumerations overview on page 37

Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017 39
Chapter 4 Enumerations overview

Create enumeration sets Use these instructions to create enumeration sets.

To create enumeration sets:

1. Select Start, point to All Programs > Rockwell Software > FactoryTalk
Batch Suite > FactoryTalk Batch, and then select Equipment Editor.

2. Select Edit > Enumeration Sets.

3. Under Sets, select New.

4. Type the new enumeration set name. Select OK to return to the Create
Enumeration Sets and Enumerations dialog box.

The new enumeration set name displays in the Enumeration Sets column.

Tip: If members are not added to a new enumeration set, the set will not display as an
option in the Enum/E.U. list when updating phase class parameters and reports.

See also

Add enumeration members on page 41

40 Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017
Enumerations overview Chapter 4

Add enumeration members Use these instructions to add enumeration members.

To add enumeration members:

1. Select Start, point to All Programs > Rockwell Software > FactoryTalk
Batch Suite > FactoryTalk Batch, and then select Equipment Editor.

2. Select Edit > Enumeration Sets.

3. Select the enumeration set.

4. Under Enumerations, select New.

Tip: Members to the system enumeration sets cannot be added: YES_NO, MATERIALS,
MATERIAL_CLASSES, and CONTAINERS.

Important: PHASE_FAILURES enumerations only support positive ordinals from 0

through 32767.

5. Type the enumeration name and the ordinal value, or accept the default
ordinal value.

6. Select OK to return to the Create Enumeration Sets and Enumerations

dialog box. The new enumeration name displays under Enumerations.

See also

Create enumeration sets on page 40

Edit enumerations and enumeration sets on page 42

Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017 41
Chapter 4 Enumerations overview

Edit enumerations and Use these instructions to edit enumerations and enumeration sets.

enumeration sets To edit enumerations and enumeration sets:

Tip: The YES_NO, MATERIALS, MATERIAL_CLASSES, or CONTAINERS system

enumeration sets cannot be renamed or edited. PHASE_FAILURES and
REPORTING_CONTEXTS are the only system enumeration sets to which
enumerations can be added. System enumeration sets display in bold text to
differentiate them from custom enumeration sets.

1. Select Start, point to All Programs > Rockwell Software > FactoryTalk
Batch Suite > FactoryTalk Batch, and then select Equipment Editor.

2. Select Edit > Enumeration Sets to open the Create Enumeration Sets and
Enumerations dialog box.

3. Select the enumeration set or enumeration to edit.

4. Select the corresponding Edit button (Sets or Enumerations).

5. If editing an enumeration, type the new enumeration name.

Important: PHASE_FAILURES enumerations support positive ordinals from 0 to 32767

only.

6. If editing an unassigned enumeration set, the Edit Enumeration Set Name

dialog box displays. Type the new enumeration set name and select OK to
return to the Create Enumeration Sets and Enumerations dialog box.

42 Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017
Enumerations overview Chapter 4

If editing an assigned enumeration set, a warning appears with a list of the

items with the enumeration assigned.

7. Select Yes to edit the enumeration set name. The items listed in this dialog
box modify to include the new enumeration set name. Or, select No to
cancel the modification.

8. Select OK to return to the Create Enumeration Sets and Enumerations

dialog box.

See also

Delete enumerations and enumeration sets on page 43

Delete enumerations and Use these instructions to delete enumerations and enumeration sets.
enumeration sets Tip: The system enumeration sets or members (enumerations) of the system
enumeration sets cannot be deleted: YES_NO, MATERIALS, MATERIAL_CLASSES,
and CONTAINERS.

To delete enumerations and enumeration sets:

1. Select Start, point to All Programs > Rockwell Software > FactoryTalk
Batch Suite > FactoryTalk Batch, and then select Equipment Editor.

2. Select Edit > Enumeration Sets to open the Create Enumeration Sets and
Enumerations dialog box.

3. Select the enumeration set or enumeration to delete.

Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017 43
Chapter 4 Enumerations overview

4. Select Delete.

• If deleting an enumeration, continue to step 5.

• If deleting an enumeration set, skip to step 6.

5. To delete an enumeration:

• If the enumeration is not the default for a phase class parameter, a

warning displays verifying deletion of the enumeration. Select Yes to
delete the enumeration. Select No to cancel the deletion.
• If the enumeration is the default for a phase class parameter and Yes is
selected to delete the enumeration, a message displays stating that the
enumeration cannot be deleted and gives the phase class parameter
name with this enumeration as the default value. First, modify the
phase class parameter to remove the enumeration as the default value.
Select OK to close the warning dialog box and return to the Create
Enumeration Sets and Enumerations dialog box.

6. To delete an enumeration set:

Tip: Items that were using the deleted enumeration set are defaulted to Type =
Integer and Eng.Units = Eng.Units.

• A warning displays verifying deletion of the enumeration set. Select Yes

to delete the enumeration. Select No to cancel the deletion.
• A warning displays with a list of assigned items.
a. Select Yes to delete the enumeration set. A message displays the
number of tags, parameters, and reports that change from deletion.
Select OK to close the message dialog box and return to the Create
Enumeration Sets and Enumerations dialog box.

b. Select No to cancel the deletion.

c. Select Close to return to the Design View area.

See also

Edit enumerations and enumeration sets on page 42

44 Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017
 Chapter 5

Parameters and reports with FactoryTalk Batch

The FactoryTalk Batch Server uses parameters to send values to the

process-connected device (PCD). Reports return values from the PCD to the
FactoryTalk Batch Server. Use FactoryTalk Batch Equipment Editor to configure
parameters and reports for the phase. The phase instance inherits the parameters
and reports of the phase class from which it was created.

See also

Parameters and reports in recipes on page 45

How parameters and reports work with phase tags on page 46

Batch parameters and reports on page 49

Material parameters on page 50

Scale parameters on page 53

Parameters and reports in When adding a phase class to an operation-level recipe using FactoryTalk Batch
Recipe Editor, the phase class parameters are formula values, and the phase class
recipes reports are report values. When defining the formula values, the recipe author has
these options:

• Accept the default formula value (this is the corresponding phase class
parameters default value).
• Assign a new value.
• Defer the formula value assignment to the operator or to a recipe formula
parameter - a parameter associated solely with the recipe.

Using parameters can minimize the number of phase classes or recipes needed.

See also

Parameters warm restart support on page 250

Parameters example on page 46

Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017 45
Chapter 5 Parameters and reports with FactoryTalk Batch

Parameters example If a plant has a unit that mixes several different products, define a phase class to
indicate the agitator’s speed in the mixer unit. Either define a different phase class
for each of the required speeds, or define one phase class and configure a parameter
for the agitator speed. When using the phase class in a recipe, assign a value
immediately or later. By deferring the value assignment, one operation is created to
use in multiple recipes.

See also

Parameters and reports in recipes on page 45

How parameters and A phase, which is an instance of a phase class in an area model, uses tags to
communicate with the engineered logic in the process-connected device (PCD).
reports work with phase Each tag in the phase maps to a specific memory address or tag in the PCD where
tags data associated with the phase is stored during the recipe’s execution. The
FactoryTalk Batch Server and the PCD use the tags to exchange information
regarding the phase.

Tip: The configuration for RSLinx Enterprise FactoryTalk Live Data tags is identical to that of OPC tags.

Every OPC phase has a minimum of ten standard tags. When configuring the
phase class from which the OPC phase is created, define the number of tags
required for parameter and report communications, as well as additional request
tags.

Tip: For PhaseManager phases assigned to a Logix5000 CIP data server, it is not necessary to define the number
of parameter, report, and request tags. The correct number of tags automatically configure when the area
model synchronizes with the Logix Designer project.

See also

Additional request, parameter, and report tags for phases on page 47

Phase tags on page 48

46 Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017
Parameters and reports with FactoryTalk Batch Chapter 5

Additional request, parameter, A Request tag is one of the ten standard tags associated with every OPC phase.
and report tags for phases The process-connected device (PCD) uses the Request tag to request service from
the FactoryTalk Batch Server. Sometimes, the PCD needs to communicate more
information to the FactoryTalk Batch Server than can be accommodated by the
single standard Request tag. For this purpose, specify on the phase class, the
number of additional request tags needed for an OPC phase.

Tip: For PhaseManager phases assigned to a Logix5000 CIP data server, do not configure request tags. The
tags automatically create for Logix5000 CIP phases when the area model synchronizes with the Logix
Designer project.

It is possible to configure a different number of phase class parameters and reports

than parameter and report tags for an OPC phase. Some OPC phase logic
programs may not want the number of parameters to match the number of
parameter tags, or the number of reports to match the number of report tags.

To have the number of parameters and reports on the phase class always equal the
number of parameter tags and report tags on the associated phases, enable
Parameter/Tag Locking on the phase class. If Parameter/Tag Locking is
disabled, specify on the phase class the number of parameter and report tags that
exist on the associated OPC phases. This number may be different from the
number of defined phase class parameters and reports for OPC phases.

Tip: For Logix5000 CIP phases, Parameter/Tag Locking always enables, regardless of the setting selected.
When the area model synchronizes with the Logix Designer project file, FactoryTalk Batch Equipment
Editor creates the same number of parameter tags as parameters that exist on the phase class, and the
same number of report tags as reports that exist on the phase class.

In summary, when creating the phase, specify the following:

• The number of parameters and reports associated with the phase class.
• The number of tags in the phase associated with those parameters, reports,
and additional requests. Either enable Parameter/Tag Locking, or specify
the actual number of tags.
Tip: The configuration for RSLinx Enterprise FactoryTalk Live Data tags is identical to OPC tags.

Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017 47
Chapter 5 Parameters and reports with FactoryTalk Batch

When creating the OPC phase instance (phase assigned an OPC data server),
specify:

• The memory addresses or tags in the PCD associated with each of the ten
standard tags.
• The memory addresses or tags in the PCD associated with any configured
parameters, reports, and additional request tags.
Tip: If the number of phase tags does not equal the number of parameters for the specified phase class (the
number of phase tags should be equal to the highest parameter ID number), the Upload/Download
functionality does not operate correctly. Additionally, to correctly pass parameter values, the phase logic
must use request data parameters for specifying how FactoryTalk Batch uploads the parameters.

See also

Phase class overview on page 173

Phase tags on page 48

Phase tags Review the configuration of the process-connected device (PCD) to verify that
the number of tags configured for the OPC phase corresponds to an equal number
of tags in the PCD. The parameter and report data types defined in FactoryTalk
Batch Equipment Editor must be compatible with the corresponding tag data
types in the PCD.

Tip: The configuration for RSLinx Enterprise FactoryTalk Live Data tags is identical to
that of OPC tags.

This table shows each parameter and report data type that can be defined in
FactoryTalk Batch Equipment Editor and its corresponding data types that can be
stored in PCD memory:

FactoryTalk Batch Equipment Editor Data Compatible PCD Data Types

Type
Real Real
Integer Real, Integer
Enumeration Real, Integer
String String

See also

Additional request, parameter, and report tags for phases on page 47

48 Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017
Parameters and reports with FactoryTalk Batch Chapter 5

Batch parameters and Parameters pass values from the FactoryTalk Batch Server to the
process-connected device (PCD). The PCD uses reports for returning values to
reports the server.

Important: Do not use these words or phrases as parameter names or report names:
• all
• length
• recipepath
• outerhtml
• finalinstructions
• stepindex
• submitstring
• submit
Using these phrases as parameter or report names can cause errors during
manual phase control.

See also

Phase parameters on page 49

Phase reports on page 50

Phase class parameters Phase class parameters pass from the FactoryTalk Batch Server to the phase logic
during the recipe phase’s execution. Phase class parameters usually correspond to
phase tags, which are addressed to actual, configured parameters in the process-
connected device (PCD).

When configuring the phase class, define phase class parameters. When
configuring the OPC phase, define the corresponding parameter tags, including
the address or tag in the PCD to which it is addressed.

Tip: For PhaseManager phases assigned to a Logix5000 CIP data server, the parameter
tags automatically create when the area model synchronizes with the Logix
Designer project. Parameter tags for Logix5000 CIP phases do not have to be
defined.

See also

Phase class reports on page 50

Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017 49
Chapter 5 Parameters and reports with FactoryTalk Batch

Phase class reports Phase class reports values pass from the process-connected device (PCD) to the
FactoryTalk Batch Server. Report values contain data that indicates how the phase
functioned. They are in the event journal file (.evt) for the running batch and can
be in FactoryTalk Batch reports. Phase class reports usually correspond to phase
tags addressed to configured parameters in the PCD.

Tip: The configuration for RSLinx Enterprise FactoryTalk Live Data report tags is
identical to that of OPC tags.

When configuring the phase class, define phase class reports for the phase. When
configuring the OPC phase, define the corresponding report tags, including the
address or tag in the PCD to which it is addressed.

Tip: For PhaseManager phases assigned to a Logix5000 CIP data server, the report tags
automatically create when the area model synchronizes with the Logix Designer
project. There is no need to define report tags for Logix5000 CIP phases.

See also

Phase class parameters on page 49

Material parameters If using FactoryTalk Batch Material Manager with FactoryTalk Batch, create
material-enabled phase classes. Material-enabled phase classes use system
parameters that specify the material and amount of material to use within a recipe.

The default parameters associated with a material-enabled phase class are

MATERIAL and AMOUNT. The default report parameters associated with each
material-enabled phase class are ACTUAL_AMOUNT and
FEED_COMPLETE. Each material-enabled phase class can be assigned optional
material parameters: CONTAINER, LOT, LABEL, and MATERIAL_CLASS.
The values of the MATERIAL, LOT, and LABEL parameters are combined to
create the material specification.

The material specification determines the container from which a material is

drawn or into which a material distributes when a batch runs. The material
specification always contains a material name. The specification may include a lot
name, a label, or both based on the container type.

See also

Types of containers on page 51

Default material parameters on page 52

50 Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017
Parameters and reports with FactoryTalk Batch Chapter 5

Types of containers FactoryTalk Batch Material Manager uses three types of containers: Composite,
Plug-Flow and Pallet. All three containers require the material specification to
contain at least a material name. Composite and plug-flow containers support a
material specification that includes a lot name. Pallet containers support a material
specification that includes a lot name, or a label, or both.

If a material specification is only a material name, then any three of the container
types are valid. However, if a material specification includes a material name, lot,
and label, then only the pallet container type is valid.

See also

Default material parameters on page 52

Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017 51
Chapter 5 Parameters and reports with FactoryTalk Batch

Default material parameters Default material parameters:

Parameter Purpose
MATERIAL Generally configured with the default value of NULL_MATERIAL; the actual material is assigned in
the recipe. Assign a material to the parameter, but then the phase class can only be used to feed
that specific material. The combination of the MATERIAL parameter, the unit for the phase in
which the phase class is running, and the high and low values for the AMOUNT parameter
determines if the phase class is going to be an addition of material, distribution, or both.
FEED_COMPLETE Reports that a material addition or distribution is complete. The ACTUAL_AMOUNT report
parameter records the actual quantity of material produced or consumed.
CONTAINER Used to hold the name of the container to which a step is bound when a batch runs. It is created
with a default value of NULL_CONTAINER. The CONTAINER parameter cannot be assigned a value
in the area model or in a recipe. Containers are considered to be equipment outside of the area
model. Either the FactoryTalk Batch Server or the operator determines the appropriate container
to which the step is bound. At that time, the value of the bound container name is assigned to the
CONTAINER parameter. Other than the default value, the parameter only contains a value while
the step is bound during run time.
MATERIAL_CLASS Represents a set of material classes configured in the material database. It is created with a
default value of NULL_CLASS. The only attributes of MATERIAL_CLASS that can be modified are
Default and Download on Start, depending on whether or not control strategies are enabled.
LOT Used to refine the list of materials to which a phase class can be bound. The lot specifies a discrete
quantity of a given material. When this parameter is blank at run time, the FactoryTalk Batch
Server binds to a container without regard to the lot.
LABEL Represents a sublot of a material, which is a discrete quantity of a given material’s lot distributed
to a specific container. In material addition phase classes, the label is used to refine the material
list to which a phase class can be bound. In material distribution phase classes, the label is applied
to the sublot of material distributed into inventory.

Tip: The values of the optional material parameters (except for the
MATERIAL_CLASS parameter) within FactoryTalk Batch Equipment Editor
cannot be edited.

See also

Types of containers on page 51

52 Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017
Parameters and reports with FactoryTalk Batch Chapter 5

Scale parameters Select the Scale check box to set a parameter to automatically adjust
proportionally when a batch containing a phase based on this phase class scaled at
runtime.

For example, if a batch containing a phase based on this phase class runs at a scale
of 200%, the ADD_AMOUNT value automatically increments by 200%. The
ADD_AMOUNT adjusts to 100, since the default is 50. Likewise, if the batch
runs at a scale of 50%, the ADD_AMOUNT adjusts to 25.

See also

Parameters and reports with FactoryTalk Batch on page 45

Verification method for A parameter deviation occurs when the parameter or report value is outside the
acceptable range defined by the designer of the area model. A verification policy
parameter deviations defines the set of acceptable limits for each parameter and the corresponding
action to take when the parameter or report value exceeds or falls short of the
limits. The Verification Method is the policy portion that defines the set of
acceptable limits for a parameter or report. When adding a parameter or report to
a phase class, either accept the default Verification Method, which is No Limits, or
select a different Verification Method.

Tip: To require electronic signatures as part of a Verification Policy, set up Signature Templates before
configuring the Verification Policy.

See also

Verification policies on page 193

Signature template on page 67

Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017 53
Chapter 5 Parameters and reports with FactoryTalk Batch

Control strategies overview Create parameters and reports applicable to a specific phase class in FactoryTalk
Batch Equipment Editor. The parameters and reports are directly associated with
the phase class. All the parameters and reports assume to be applicable to each
recipe that includes the phase class. However, some phase classes may assume
different roles within a single recipe or different roles across different recipes. In
this situation, only a subset of the parameters and reports associated with the
phase class may be required, resulting in unnecessary phase I/O when the recipe
executes. This is where control strategies are helpful.

Control strategies are user-defined groupings of phase class parameters and reports
that can be associated with a single phase class. Organizing parameters and reports
into separate control strategies allows phase classes to assume multiple roles
without generating unnecessary phase I/O.

Create multiple control strategies for a phase class, each with its own parameters
and reports. Within a phase class associate parameters and reports with a single or
multiple control strategies. If a parameter or report is associated with more than
one control strategy, the value range, engineering units, and the engineering units
of the report can be defined independently for each control strategy with which
the parameter or report is associated.

Tip: In FactoryTalk Batch Recipe Editor, when viewing recipe phase class enabled
control strategies, only the parameter values with specified control strategy
display. Associating parameters with specific control strategies eliminates the
need for the recipe author or operator to determine which phase class
parameters, and report parameters are applicable when creating, viewing, and
executing a specific recipe.

See also

Control strategies example on page 55

Implement control strategies on page 56

54 Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017
Parameters and reports with FactoryTalk Batch Chapter 5

Control strategies example This table represents the configured parameters, reports, and control strategies for
a single phase class. The table illustrates the relationship between parameters,
reports, and control strategies. An X placed below a control strategy indicates that
the parameter or report is associated with that control strategy.

Parameter Name CONTROL_STRATEGY_1 CONTROL_STRATEGY_2 Strategy 1 Value Strategy 2

Value
PARAMETER_A X 150
PARAMETER_B X X 200 275
PARAMETER_C X 70
REPORT_A X X 125 125

For example, a phase class contains three phase class parameters,

PARAMETER_A, PARAMETER_B, and PARAMETER_C, and a report
parameter named REPORT_A. As indicated above, a parameter can associate with
only one control strategy as is the case with PARAMETER_A and
PARAMETER_C. Or, a parameter associate with more than one control strategy
as is the case with PARAMETER_B and REPORT_A. Parameters associated with
more than one control strategy can have separately defined values for each control
strategy as indicated by PARAMETER_B.

See also

Implement control strategies on page 56

Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017 55
Chapter 5 Parameters and reports with FactoryTalk Batch

Implement control strategies Configure the phase class in an area model to enable or disable the control strategy
functionality. For phase classes that have the control strategy functionality
enabled, configure one or more strategies for that phase class. Assign phase class
parameters and reports to each control strategy, as well as configure their ranges,
values, and engineering units.

When creating master recipes using FactoryTalk Batch Recipe Editor, specify
which control strategy to use for each instance of the phase class within the recipe.
When the recipe executes, the phase class uses only the parameters associated with
the control strategy specified during recipe creation. Likewise, when the executed
recipe is viewed in the FactoryTalk Batch View or other client program, a control
strategy-enabled phase class only displays the specified control strategy and any
parameters associated with that control strategy. However, the default values of
parameters associated with control strategies can be changed. Additionally, if a
phase class is executed using manual phase control, select which control strategy to
use before running the phase class.

Tip: Configure the tags in the phase and the phase logic in the process-connected
device(s) (PCD) to support control strategy use. When a PCD requests to
download phase class parameters or upload phase class reports, only the
appropriate phase class parameters and reports are loaded, based on the
control strategy. Configure and map the phase class and report parameters to
the tags in the PCD(s).

See also

Configure control strategies on page 190

56 Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017
Parameters and reports with FactoryTalk Batch Chapter 5

Parameter and report Use the download parameter subsets to define subsets of phase class parameters
for Download (DL) on Start and Download (DL) on Transfer of Control
subsets overview (TOC). These subsets provide for a more efficient batch execution. Also, the
upload report subsets allows definition of a subset of the phase class reports for
Upload (UL) on Terminal State or Upload (UL) on Transfer of Control
(TOC). These subsets provide for a more efficient process.

Tip: Transfer of control means that two instances of the same phase exist in a recipe
and are separated by a recipe transition condition containing something other
than <Phase Name>.State = Complete. In this case, the running logic does
not terminate when the transition condition becomes true.

Assign parameters to none, one, or both of the upload/download sets. By assigning

a parameter or report to a subset, that parameter or report, along with the other
members of the subset, are downloaded (parameters) or uploaded (reports) when
the appropriate phase logic request is issued.

Tip: The 145 (Request Failed) command value can be issued by the FactoryTalk
Batch Server when processing a phase logic request experiences an error. This
enhanced error handling phase logic protocol is supported by making a request
where the value is 10,000 greater than the current standard requests.
For example, to upload a report parameter using the enhanced phase logic
request, add 10,000 to the standard request code of 2200 to get the enhanced
request code of 12200.

Important: When using Auto Upload with the FactoryTalk Batch Server
configured for Warm or Warm All Restart, the Server may upload
addition material information twice when a phase is transitioned to
External during the upload. Check the journal file. If the upload has
occurred twice, manually adjust the amount in the material
database. The setpoint of the amount parameter is recalculated with
each warm restart as well. This number may need to be manually
updated.

See also

Phase class with different subsets example on page 58

Download parameter requests on page 58

Upload report requests on page 60

Configure phase class parameters on page 179

Configure phase class reports on page 184

Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017 57
Chapter 5 Parameters and reports with FactoryTalk Batch

Phase class with different This table is an example of a phase class and how its parameters and reports can be
assigned to the different subsets:
subsets example
AGITATE_1
Parameters DL on DL on Reports UL on Terminal UL on TOC
Start TOC State
SPEED X X AGITATE_TIME X X
TIME X X AVG_TEMP X
LEVEL X AVG_SPEED X X
TEMP X AMT_DUMPED X

See also

Parameter and report subsets overview on page 57

Download parameter requests on page 58

Upload report requests on page 60

Download parameter requests Download parameter subsets allows definition of subsets of parameters
downloaded to the process-connected device (PCD) when the appropriate phase
logic requests are sent to the FactoryTalk Batch Server.

• If DL on Start is selected, the FactoryTalk Batch Server downloads these

parameters to the PCD before the FactoryTalk Batch Server issues a
START command to the phase. Once the download is verified, the
FactoryTalk Batch Server starts the phase. The phase logic can explicitly
request this or the phase can be configured for the FactoryTalk Batch Server
to automatically download these parameters before it issues a START
command.
• If DL on TOC is selected, the parameters may be downloaded to the PCD
when a transfer of control situation occurs. Transfer of control means that
two instances of the same phase exist in a recipe and are separated by a
recipe transition condition that contains something other than <Phase
Name>.State = Complete. In this case, the phase’s running logic does not
terminate when the transition condition becomes true. When the transition
condition becomes true, the phase logic must explicitly request the Server to
download the transfer of control subset of parameters to the PCD.

To download only the parameters assigned to the DL on Start subset, use these
download requests:

(OPC or FTD) phases Logix5000 CIP phases

1501 or 11501 request PXRQ instruction,
External request: Download Input Parameters Subset
DINT[0] - 1

58 Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017
Parameters and reports with FactoryTalk Batch Chapter 5

To download only the parameters assigned to the DL on TOC subset, use these
download requests:

(OPC or FTD) phases Logix5000 CIP phases

1502 or 11502 request PXRQ instruction,
External request: Download Input Parameters Subset
DINT[0] - 2

When one of these requests is issued, each parameter is downloaded to the

memory address or tag in the PCD that corresponds to the parameter tag in the
phase.

See also

Parameter and report subsets overview on page 57

Upload report requests on page 60

Configure phase class parameters on page 179

Configure phase class reports on page 184

Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017 59
Chapter 5 Parameters and reports with FactoryTalk Batch

Upload report requests If UL on Terminal State is selected, the FactoryTalk Batch Server uploads this
subset of reports from the process-connected device (PCD) after the phase logic
transitions to a terminal state of COMPLETE, STOPPED, or ABORTED. The
phase logic can explicitly request the server to upload these reports or the phase
can be configured for the server to automatically upload these reports after the
phase logic transitions to a terminal state.

If UL on TOC is selected, the reports are uploaded to the PCD when a transfer of
control situation occurs. In this case, the phase logic must explicitly request the
FactoryTalk Batch Server to upload the transfer of control report subset from the
PCD.

To upload only the reports assigned to the UL on Terminal State subsets:

(OPC or FTD) phases Logix5000 CIP phases

2501 or 12501 request PXRQ instruction,
External request: Upload Output Parameters Subset
DINT[0] - 1

To upload only the reports assigned to the UL on TOC subset:

(OPC or FTD) phases Logix5000 CIP phases

2501 or 12501 request PXRQ instruction,
External request: Upload Output Parameters Subset
DINT[0] - 2

See also

Parameter and report subsets overview on page 57

60 Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017
Parameters and reports with FactoryTalk Batch Chapter 5

Automatic Automatic Upload/Download decreases batch duration time as well as the

amount of phase logic programming required. Automatic Upload/Download
Upload/Download works with Download Parameter Subsets and Upload Report Subsets.
Automatic Upload/Download allows the FactoryTalk Batch Server to
automatically download parameters grouped into the download on START subset
or to upload reports grouped into the upload on terminal state subset. Phase logic
can be developed to make these requests; however, it is not required.

Use Automatic Upload/Download to configure the FactoryTalk Batch Server

to:

• Automatically download the parameters grouped into the download on

start subset when all the conditions required to start the phase are true.
• Automatically upload the appropriate report values grouped into the upload
on terminal state subset when the phase transitions to a terminal state of
COMPLETE, STOPPED, or ABORTED.

Automatic Upload/Download eliminates the need to send the download on

start or upload on Terminal State request from the phase logic to the FactoryTalk
Batch Server.

Tip: Downloading parameters on Transfer of Control and uploading reports on

transfer of control is not automatic and still requires a phase logic request.

The Automatic Download Parameter Upon Start and UL On Terminal State

are configured for each individual phase (as long as the parameters and reports of
the phase class from which the phase was created are grouped into the appropriate
subsets). The Automatic Download parameter Upon Start and UL on
Terminal State may also be configured independently of each other on a phase.
For UL on Terminal State, specify any or all terminal states for which the
automatic function is applicable: COMPLETE, STOPPED, or ABORTED.

Tip: The 145 (Request Failed) command value can be issued by the FactoryTalk Batch Server
when processing a phase logic request experiences an error. This enhanced error handling
phase logic protocol is supported by making a request where the value is 10,000 greater
than the current standard requests.
For example, to upload a report parameter using the enhanced phase logic request, add
10,000 to the standard request code of 2200 to get the enhanced request code of 12200.

See also

Parameter and report subsets overview on page 57

Control strategies with upload/download parameter subsets on page 62

Configure the general data for a phase on page 207

Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017 61
Chapter 5 Parameters and reports with FactoryTalk Batch

Control strategies with If assigned parameters or reports to upload/download parameter subsets, and
enabled control strategies, only those parameters common to all the involved
upload/download subsets and selected control strategy upload or download.
parameter subsets
In this example, the phase class has a number of reports and parameters. The
control strategies are enabled and the CS1 control strategy is the default. When a
phase logic request:

• Is issued for Download on Start, only the SPEED, TIME, LEVEL, and
TEMP parameters are included.
• Is issued for Download on TOC, only the SPEED and TIME parameters
are included.
• For Upload on Terminal State is issued, only the AVG_SPEED,
AGITATE_TIME, AVG_TEMP, and AMT_DUMPED reports are
included.
• For Upload on TOC is issued, only the AVG_SPEED and
AGITATE_TIME reports are included.
AGITATE_1 (Control Strategies enabled; CS1 is the default control strategy)
Parameters DL on DL on CS1 Reports UL on UL on CS1
Start TOC Terminal TOC
State
SPEED X X X AVG_SPEED X X X
TIME X X X AGITATE_TIME X X X
LEVEL X X AVG_TEMP X X
TEMP X X AMT_DUMPED X X

See also

Parameters and reports with FactoryTalk Batch on page 45

62 Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017
 Chapter 6

Electronic signatures

An electronic signature is an electronic representation of a signature and its

associated data, including:

• Signoff meanings (such as review, approval, responsibility, or authorship)

• Signer comments
• Signer security requirements
• Date and time of signature

An electronic signature in the FactoryTalk Batch system can consist of signoffs by

one, two, or three FactoryTalk users or groups.

See also

Types of electronic signatures on page 64

How electronic signatures work on page 65

Signature template on page 67

Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017 63
Chapter 6 Electronic signatures

Types of electronic Signatures can be configured for verification of these runtime FactoryTalk Batch
events:
signatures
• Report parameters for automated and manual (eProcedure) phases.
• Changes to the recipe parameter values made by operators from the
FactoryTalk Batch View or ActiveX controls.
• Completion of eProcedure steps.
• Batch or phase commands issued by operators from FactoryTalk Batch
View or ActiveX controls.
• General usage that can be configured to display at any time when executing
an automated or manual phase.

Electronic signatures are stored in the FactoryTalk Batch Event Journal with their
corresponding electronic records. These electronic signatures include all the
components necessary for compliance with 21 CFR Part 11.

See also

Electronic signatures on page 63

64 Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017
Electronic signatures Chapter 6

How electronic signatures The steps involved in configuring and executing electronic signatures span the
FactoryTalk Batch product suite.
work
• The FactoryTalk Batch system administrator sets up electronic signature
and signoff security.
Important: Changing the FactoryTalk Directory Server after configuring electronic
signatures using FactoryTalk Security is not supported. Doing so may
cause Signature Signoffs to fail.

• In FactoryTalk Batch Equipment Editor, the FactoryTalk Event Archiver

event filters for the signature events to capture for use in FactoryTalk Event
Archiver with Reporting Services reports, or other reports.
• Create signature templates for the area model. To obtain electronic
signatures for recipe parameters and report parameters of specific phase
classes, configure the verification method and signature template to be used
when the phase class is created or edited. To download all the limits
information to the phase logic, map parameter tags and report tags to the
appropriate limit tags on the phases. To require signature verification for
the execution of specific commands, set up command verification policies in
FactoryTalk Batch Equipment Editor using the signature templates that
were created.

When the master recipe builds, the recipe parameter limits that trigger the
verification policy default from the parameter limits specified on the equipment
phase. Change these values at the recipe level in FactoryTalk Batch Recipe Editor.
If configured a phase class to obtain a signature for deviation of report limits,
specify those limits on the report for the phase class in FactoryTalk Batch Recipe
Editor.

When a batch runs and parameter or report deviations occur requiring signature
verification, or the operator issues commands requiring signature verification, a
signature is added to the signature list in FactoryTalk Batch View, the Electronic
Signature ActiveX control, or the eProcedure client, prompting the appropriate
users to enter signatures.

All signatures record as Signature events in the FactoryTalk Batch Event Journal
viewer in FactoryTalk Batch View.

Once signature event data generates, create FactoryTalk Event Archiver reports, or
other reports that capture electronic signature data.

Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017 65
Chapter 6 Electronic signatures

This flow chart shows the sequence of tasks in the setup and configuration,
execution, viewing, and reporting of electronic signatures:

See also

Electronic signatures on page 63

Signature template on page 67

66 Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017
Electronic signatures Chapter 6

Signature template Before setting up phase classes and recipes to require electronic signatures,
establish a set of signature templates. Each signature template defines the number
of signoffs required, the meaning of those signoffs, whether comments are
included with the signoff, and which users or user groups have the required
security permissions to complete the signoff. Create as many templates as needed
to distinguish the different signature types the business processes requires.

The process of creating a signature template consists of three main procedures:

• Add a signature template

• Configure signature template signoffs
• Assign security permissions for a signoff

See also

Edit signature templates dialog box on page 68

Add a signature template on page 69

Configure signature template signoffs on page 71

Delete a signature template on page 76

Modify a signature template on page 77

Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017 67
Chapter 6 Electronic signatures

Edit signature templates The Edit Signature Templates dialog box contains:
dialog box
Name Purpose
General tab
Template Name Displays the name of the template selected in the Signature Templates list. If there are no
templates in the template list, this is disabled.
• Template names must be unique, and can range from 1 through 50 characters in length.
• The name must begin with an alpha character (a-z or A-Z) and may be followed with any
combination of alphanumeric characters or under score.
• Template Name is not case sensitive.
• Spaces are not valid.
Template Index The unique identification number of the template selected in the Signature Templates list.
This value must be a positive integer from 1 to 2,147,483,647.
Signoffs Required The number of signatures required in the verification policy this template represents.
Last Signoff A number indicating which signoff must be completed last, after other signatures have been
entered. If None is selected, the signatures may be entered in any order.
New Template Opens the Create Signature Template dialog box where new templates can be added to the
Signature Templates list.
Delete Template Removes the selected Signature Template form the list. If the selected template is used by
the verification policy of any commands, phase class parameters, or reports, the template
cannot be deleted.
Signoffs tab
Template Name Lists the templates that have been added on the General tab. Select the template to see its
signoff information or to configure signoffs.
Signoff Each number in the list represents a required signature for the selected template. These values
are determined by the value selected in the General tab Signoffs Required box. Select the
number of the Signoffs. Consider which value was selected in the General tab Last Signoff
box.
Meaning (optional) Type a short phrase describing the significance of the selected signoff.
For example, Command Authorized by Signer, Done By Signer, or Checked by Signer.
The Meaning displays as part of the signoff event recorded in the FactoryTalk Batch event
journal. The Meaning box can range from 0 through 80 characters, and can contain any
viewable and printable character. Special control or non-printable characters are not valid.
Comment Select whether a comment is Optional, Required, or Not Allowed by the signer at the time
the signoff is entered.
Security Permissions Displays the users and groups of users that can complete the selected signoff. If this area is
blank, no security permissions have been configured yet. Security Permissions must be
configured for all signoffs before the Edit Signature Templates dialog box can be closed.
Add Opens the Select User or Group dialog box. Select which users and groups have permission
to complete the selected signoff.
Delete Removes the selected user or group from the Security Permissions box, and removes the
user or group permission to complete the selected signoff.

See also

Delete a signature template on page 76

68 Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017
Electronic signatures Chapter 6

Add a signature template Use these instructions to add a signature template.

To add a signature template:

1. Select Start, point to All Programs > Rockwell Software > FactoryTalk
Batch Suite > FactoryTalk Batch, and then select Equipment Editor.

2. Open the area model file.

3. Select Edit > Signature Templates.

4. Select New Template to display the Create Signature Template dialog

box.

5. In the Template Name box, enter a unique name to identify the template.
The name must begin with an alpha character (a through z or A through Z)
and may be followed with any combination of alphanumeric characters or
underscores. This box is not case sensitive. Spaces are not accepted as valid
input.

Tip: Choose a name that easily identifies the template properties or purpose.
The template name is used to identify the signature template when the
command verification policies, phase classes, and recipes are being
configured.

6. (optional) A unique identification number is defaulted in the Template

Index box. If needed, change this number (must be a positive integer).

Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017 69
Chapter 6 Electronic signatures

Important: If a decimal is entered in the Template Index box, the value is automatically rounded up or
down to the nearest integer. If the nearest integer is already assigned to another template, a
duplicate index value error message is opened.

7. Select OK. The Create Signature Template dialog box closes and the new
template is listed in the Signature Templates list in the Edit Signature
Templates dialog box.

8. In the Signoffs Required list, select the number of signatures that must be
obtained for this signature template.

9. In the Last Signoff list, select the number of the signoff that corresponds to
the signature that must be completed last (that is, after other signatures have
been entered). If the signatures do not have to be completed in any
particular order, select None.

10. Configure the signoffs for the signature template.

See also

Configure signature template signoffs on page 71

70 Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017
Electronic signatures Chapter 6

Configure signature template Use these instructions to configure the signature template signoffs.
signoffs
Before you begin:

• Verify the signature template has been added.

To configure signature template signoffs:

1. Select Start, point to All Programs > Rockwell Software > FactoryTalk
Batch Suite > FactoryTalk Batch, and then select Equipment Editor.

2. From the Edit Signature Templates dialog box, select the Signoffs tab.

3. From Template Name, select the template to configure signoff

information.

4. From Signoff, select the number that represents the signoff to configure.

Tip: This Signoff list corresponds to the Signoffs Required list on the General tab. When completing these
steps, keep in mind the number selected for Last Signoff on the General tab.

5. (optional) In Meaning, enter a short phrase that describes the significance

of this signoff.

Tip: The Meaning displays as part of the signoff event recorded in the FactoryTalk Batch event journal.

6. From Comment, select whether signer comments are Optional, Required,

or Not Allowed.

7. Under Security Permissions, assign privileges to the users and groups

authorized to complete this signoff.

Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017 71
Chapter 6 Electronic signatures

When finished assigning security permissions for the signoff, the User and
Group names are displayed in the Security Permissions area. (For detailed
instructions, see Assign security permissions for a signoff.)

8. Select Apply.

9. If creating a template that requires more than one signoff, repeat steps
3 through 7 until all the signoffs have been configured for the template.

Tip: When a signature requires multiple signoffs, each signoff must be made using a unique UserID and
password.

10. When finished configuring all the signoffs for the template, either return to
the General tab to add other signature templates, or select OK to close the
dialog box.

See also

Add a signature template on page 69

Assign security permissions for a signoff on page 73

Remove signoff permissions for a user or group on page 75

72 Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017
Electronic signatures Chapter 6

Assign security permissions for a When configuring signoffs for a signature template, specify which users or groups
signoff may complete each signoff.

Before you begin:

• Add a signature template.

• On the Signoffs tab, enter a Template Name, select a Signoff number and
Comment option, and enter a Meaning.

To assign security permissions for a signoff:

1. Select Start, point to All Programs > Rockwell Software > FactoryTalk
Batch Suite > FactoryTalk Batch, and then select Equipment Editor.

2. From the Edit Signature Templates dialog box, select Signoffs tab.

3. From the Security Permissions area, select Add. The Select User or
Group dialog box opens.

Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017 73
Chapter 6 Electronic signatures

4. In the Select User or Group dialog box, select Show all to view a list of all
users and groups. The list displays all FactoryTalk Security users and groups
and all Windows-linked users and groups defined in the FactoryTalk
Directory Server.

Tip: Changing the FactoryTalk Directory Server after adding users and groups to a
signature template is not supported and may cause signature signoffs to fail.

5. Select the appropriate user or group.

6. Select OK.

Important: Changing the FactoryTalk Directory Server after configuring electronic

signatures using FactoryTalk Security is not supported and may cause
signature signoffs to fail.

See also

Add a signature template on page 69

Configure signature template signoffs on page 71

74 Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017
Electronic signatures Chapter 6

Remove signoff permissions for a Complete these steps to remove authority from an individual or group to
user or group complete a particular signoff.

To remove signoff permissions for a user or group:

1. Select Start, point to All Programs > Rockwell Software > FactoryTalk
Batch Suite > FactoryTalk Batch, and then select Equipment Editor.

2. Select Edit > Signature Templates, select the template, and then select the
Signoffs tab.

3. Under Security Permissions, select the individual or group.

4. Select Delete.

5. Select OK.

See also

Add a signature template on page 69

Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017 75
Chapter 6 Electronic signatures

Delete a signature template A signature template cannot be deleted if it is used in:

• The verification policy for any command.

• The verification policy for phase class parameters or reports.
• The approval process for a recipe.

Before you begin:

• Modify each command verification policy that uses the template to use a
different signature template or to not require signature verification.
• Modify the verification policy for phase class parameters or reports to use a
different signature template or no signature template, or the parameter or
report must be deleted before the template currently in use can be deleted.
• Modify recipe approval step to have a different signature template assigned
to its signoff.

To delete a signature template:

1. Select Start, point to All Programs > Rockwell Software > FactoryTalk
Batch Suite > FactoryTalk Batch, and then select Equipment Editor.

2. Open the area model file.

3. Select Edit > Signature Templates.

4. On the Edit Signature Templates dialog box, from Signature Templates,

select the template to delete.

5. Select Delete Template. The template name is removed from the

Signature Templates list.

6. Select OK.

See also

Command verification policies on page 78

Modify a signature template on page 77

76 Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017
Electronic signatures Chapter 6

Modify a signature template The Template Name or Template Index cannot be modified if the signature
template is currently used in the verification policy of any command, phase class
parameters, or reports, or if assigned to a recipe approval step.

Before you begin:

• Modify each command verification policy that uses the template to use a
different signature template or to not require signature verification.
• Modify the verification policy for phase class parameters or reports to use a
different signature template or no signature template, or the parameter or
report must be deleted before the template currently in use can be deleted.
• Modify recipe approval step to have a different signature template assigned
to its signoff.
Important: If the number of Signoffs Required for a template is changed, the value of Last Signoff may also be
affected. If the change results in the value of Last Signoff being greater than the value of Signoffs
Required, the value of Last Signoff automatically changes to None. To enforce a different signature
as the last signoff, select a different value in Last Signoff.
For example, the value of Signoffs Required is 3 and Last Signoff is 3. If Signoffs Required is
changed to 2, the value of Last Signoff is automatically changed to None.

To modify a signature template:

1. Select Start, point to All Programs > Rockwell Software > FactoryTalk
Batch Suite > FactoryTalk Batch, and then select Equipment Editor.

2. Open the area model file.

3. Select Edit > Signature Templates.

4. On the Edit Signature Templates dialog box, from Signature Templates,

select the template to modify.

5. Select the General tab and modify boxes as needed.

6. Select OK.

See also

Command verification policies on page 78

Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017 77
Chapter 6 Electronic signatures

Command verification Set up command verification policies to obtain signatures for batch or phase
commands issued by operators from FactoryTalk Batch View or ActiveX controls.
policies
Before configuring command verification policies, create signature templates that
describe the signoff policies to use for the commands.

Important: If signature verification for the Remove command is enabled, all AUTOREMOVE executes sent to the
FactoryTalk Batch Server fail and generate an error message. The AUTOREMOVE execute tells the
server to automatically remove a batch when its state reaches COMPLETE.

See also

Signature template on page 67

Add a signature requirement to commands on page 78

Change the verification policy for a command on page 80

Remove the signature requirement for a command on page 81

Add a signature requirement to Use these instructions to add electronic signatures to commands.
commands To add a signature requirement to commands:

1. Select Start, point to All Programs > Rockwell Software > FactoryTalk
Batch Suite > FactoryTalk Batch, and then select Equipment Editor.

2. Select Edit > Command Policies.

78 Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017
Electronic signatures Chapter 6

Tip: The ability to secure FactoryTalk eProcedure instruction files does not currently
exist in FactoryTalk Security, require an electronic signature on Parameter
Change to prevent unauthorized users from executing instructions.

3. Select the check box next to the command that requires an electronic
signature. From Select Template, select the signature template that defines
the signature policy to use for this command.

4. Select OK. The Select Signature dialog box closes, and the signature
template displays in the Signature Template box next to the selected
command.

5. Repeat these steps for each additional command that requires an electronic
signature.

6. Select OK.

See also

Edit command verification policies dialog box on page 80

Change the verification policy for a command on page 80

Remove the signature requirement for a command on page 81

Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017 79
Chapter 6 Electronic signatures

Edit command verification policies The components in the Edit Command Verification Policies dialog box
dialog box include:

Name Purpose
Command This column displays each command that can be configured to require an electronic
signature (view only).
Requires Signature Opens the Select Signature Template dialog box. Select the check box next to each
command that should require an electronic signature when it is executed.
Signature Template Displays the signature template that defines the verification policy for the command. If
the command does not require a signature, this box is disabled. To change the
Signature Template, select browse ( ) and select a different template in the Select
Signature Template dialog box.

See also

Add a signature requirement to commands on page 78

Change the verification policy If a command requires a signature and has a signature template specified, follow
these instructions to change the verification policy for the command.
for a command
Before you begin:

• Verify a signature template already exists that describes the new signoff
policies to use. If not, create one.

To change the verification policy for a command:

1. Select Start, point to All Programs > Rockwell Software > FactoryTalk
Batch Suite > FactoryTalk Batch, and then select Equipment Editor.

2. Select Edit > Command Policies.

3. Select browse ( ) next to the signature template to change.

4. On the Select Signature Template dialog box, from Select Template,

select the signature template that defines the signature policy used for this
command.

80 Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017
Electronic signatures Chapter 6

5. Select OK. The Select Signature dialog box closes. The signature template
chosen displays in the Signature Template box next to the selected
command.

6. Repeat these steps for each additional verification policy to change.

7. Select OK.

See also

Signature template on page 67

Command verification policies on page 78

Remove the signature To remove the verification policy and signature requirement for a command,
complete these steps.
requirement for a command
To remove the signature requirement for a command:

1. Select Start, point to All Programs > Rockwell Software > FactoryTalk
Batch Suite > FactoryTalk Batch, and then select Equipment Editor.

2. Select Edit > Command Policies.

3. Clear the Requires Signature check box next to the appropriate command.

The Signature Template box is disabled and the template name appears
shaded. This indicates that the signature template is not in use for this
command and no signature verification is required.

Tip: To re-enable the signature requirement for a command, select the Requires Signature check box. The
signature template previously used automatically activates.

4. Select OK.

See also

Add a signature requirement to commands on page 78

Command verification policies on page 78

Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017 81
Chapter 6 Electronic signatures

82 Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017
 Chapter 7

Recipe approval process overview

The recipe approval process validates the development and maintenance of batch
recipes. Using signature certification, the recipe approval process safeguards design
workflow in a formalized manner. This ensures each recipe validates by authorized
personnel before being released to production, or released as a component within a
larger recipe.

Configured and enable the recipe approval process in FactoryTalk Batch

Equipment Editor, then execute in FactoryTalk Batch Recipe Editor. When the
approval process completes, the recipe is added to FactoryTalk Batch View,
eProcedure, or the ActiveX controls Recipe List. At that point, production
batches can be made from the recipe.

In addition to the primary approval process with up to six approval steps (three
optional), a two-step expedited approval process is available. Both primary and
expedited processes provide a revert option to allow forward and reverse progress
through the recipe approval process.

See also

Recipe approval tasks on page 84

Configure recipe approval steps on page 85

Edit a recipe approval on page 88

Disable recipe approval on page 89

Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017 83
Chapter 7 Recipe approval process overview

Recipe approval tasks As a necessary first step, a FactoryTalk Batch system administrator sets up
electronic signatures for signoff security.

Typically, an administrator, or a process engineer with full administrative rights,

then defines signature templates in FactoryTalk Batch Equipment Editor.
Signature templates define which users can sign off on recipe approval steps, either
to approve or to revert the step.

Also in FactoryTalk Batch Equipment Editor, a process engineer configures recipe

approval steps according to a defined approval process. The primary approval
process comprises up to six steps (three optional). The expedited approval process
involves just two approval steps.

Finally, the primary approval process (or expedited approval process) itself
executes in FactoryTalk Batch Recipe Editor.

This flow chart shows this sequence of tasks in the setup, configuration, and
execution of signatures for recipe approval.

See also

Configure recipe approval steps on page 85

Edit a recipe approval on page 88

84 Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017
Recipe approval process overview Chapter 7

Configure recipe approval Use the Recipe Approvals Configuration dialog box to configure the steps used
by the primary approval process and expedited approval process. This includes
steps assigning step names, step order, step concurrency and signature templates to the
selected approval steps. Upon saving the area model, FactoryTalk Batch
Equipment Editor stores the current recipe approval process configuration.

Tip: The recipe approval process uses signoffs to progress through the primary approval
process, the expedited approval process, or to revert back from a prior approval.
Determine if existing signature templates are sufficient for the recipe approval
process signoffs or if additional templates must be created.

To configure recipe approval steps:

1. Select Start, point to All Programs > Rockwell Software > FactoryTalk
Batch Suite > FactoryTalk Batch, and then select Equipment Editor.

2. Select Edit > Recipe Approvals Configuration. The Recipe Approvals

Configuration dialog box opens.

Tip: If configured with View Only access rights under FactoryTalk Policies, the OK disables and changes are not
saved.

Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017 85
Chapter 7 Recipe approval process overview

3. Configure the steps for the approval process. Three steps are mandatory: the
first listed step (default label: Begin Approval), Release Recipe as Step,
and Release Recipe to Production must all have Approval and Revert
signoffs configured before enabling recipe approval.

• For each step, select a Signature Template to Approve. Select browse

( ) and select a template from the list of templates on the Select
Signature Template dialog box. Select OK.
• For each step, select a Signature Template to Revert. Select browse ( )
and select a template from the list of templates in the Select Signature
Template dialog box. Select OK.
Tip: Change the step order for the optional steps any time during or after configuration
by selecting the desired number from the Step Order list and then selecting
Refresh Order.

4. (optional) To enable one or more of the three optional steps in the primary
approval process, select the check box next to the desired step. Once
enabled, customize the name and description for these steps if desired. The
optional steps can be named for any approval milestone the methodology
requires.

5. When configured Approval and Revert signature templates for all enabled
steps, select the Enable Recipe Approvals check box. The recipe approval
process enables for all recipes in the current project.

6. Select OK to close the dialog box.

Tip: If configured to have View Only rights in FactoryTalk Batch Equipment Editor, the OK button is
disabled.

7. Save the area model and exit FactoryTalk Batch Equipment Editor. Open
and verify all recipes against the updated area model (in FactoryTalk Batch
Recipe Editor), to activate the approval process.

The actual approval of recipe steps is done in FactoryTalk Batch Recipe

Editor. Either the primary approval process or expedited approval process is
available.

See also

Recipe Approvals Configuration dialog box on page 87

Signature template on page 67

86 Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017
Recipe approval process overview Chapter 7

Recipe Approvals Configuration The Recipe Approvals Configuration dialog box contains:
dialog box Name Purpose
Step Order The order that steps are approved. There can be multiple steps with the same number.
When that happens, all steps of that number must be approved before the recipe can
continue to the next step.
Step Name Name of each approval step. Default names are provided. If needed, edit the name for
the first and optional steps. Names must be unique, and must begin with 0 through 9,
or A through Z. Maximum number of characters allowed is 32.
Approval Approval signoff template.
Revert Revert signoff template.
Description An editable description of each approval step. Maximum number of characters allowed
is 128.

See also

Configure recipe approval steps on page 85

Edit a recipe approval on page 88

Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017 87
Chapter 7 Recipe approval process overview

Edit a recipe approval Use these instructions to edit a recipe approval.

To edit a recipe approval:

1. Select Start, point to All Programs > Rockwell Software > FactoryTalk
Batch Suite > FactoryTalk Batch, and then select Equipment Editor.

2. Select Edit > Recipe Approvals Configuration. The Recipe Approvals

Configuration dialog box opens.

3. Make the necessary modifications. In this example one of the optional

approval steps is enabled, and approval and revert signoffs are assigned:

4. Select OK.

5. Save the area model and select Invoke Recipe Editor ( ) to open
FactoryTalk Batch Recipe Editor.

Tip: FactoryTalk Batch Recipe Editor must be restarted to see the updated area model and recipe
approval changes made.

See also

Disable recipe approval on page 89

88 Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017
Recipe approval process overview Chapter 7

Disable recipe approval Use these instructions to disable recipe approval.

To disable recipe approval:

1. Select Start, point to All Programs > Rockwell Software > FactoryTalk
Batch Suite > FactoryTalk Batch, and then select Equipment Editor.

2. Select Edit > Recipe Approvals Configuration. The Recipe Approvals

Configuration dialog box opens.

3. Uncheck Enable Recipe Approvals.

4. Select OK. A dialog box displays a warning that existing approval signoffs
are removed from all recipes in the current working set when FactoryTalk
Batch Recipe Editor is next opened.

Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017 89
Chapter 7 Recipe approval process overview

5. Select OK.

6. Save the area model.

7. (optional) Select Invoke Recipe Editor ( ) to open FactoryTalk Batch

Recipe Editor.

Tip: FactoryTalk Batch Recipe Editor must be restarted to see the updated area model and recipe approval
changes made.

See also

Edit a recipe approval on page 88

90 Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017
 Chapter 8

Security authority overview

FactoryTalk Batch Security Authority, when enabled, helps protect intellectual

property (as held in the area model) and secures it from unauthorized use.

FactoryTalk Batch Equipment Editor, when directed by an authenticated user to

secure an area model, reads the FactoryTalk Network Directory Security
Authority Identifier (SAI) and stores a copy of it in the area model. Later, when
FactoryTalk Batch Equipment Editor is directed to open and read a secured area
model, the SAI of the area model is compared to the SAI of the current
FactoryTalk Network Directory. If they match, FactoryTalk Batch Equipment
Editor loads the area model. If they do not match, for example when running
under another instance of FactoryTalk or if the SAI has been regenerated, the
editing session does not have the authority to open the area model and stops the
reading process.

Important: If the SAI in a FactoryTalk Network Directory is changed or lost, any area model that is bound to it can
lose access. Rockwell Automation recommends that, before securing an area model, back up the
FactoryTalk Network Directory, and save an unsecured version of the area model in a secure location.

See also

Security authority configuration on page 92

Secure an area model on page 93

Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017 91
Chapter 8 Security authority overview

Security authority This flow chart shows the sequence of tasks in the configuration and use of
security authority.
configuration

Authority to secure area models and recipes is assigned in the FactoryTalk

Administration Console. Security Authority is disabled by default.

Area models are secured within FactoryTalk Batch Equipment Editor using the
Security Authority command. The FactoryTalk Network Directory Security
Authority Identifier (SAI) is written into the area model schema. To subsequently
open and edit the area model, the SAI in the area model must match that of the
current FactoryTalk Network Directory. No match prevents the opening and
editing of an area model and its associated recipes in FactoryTalk Batch Recipe
Editor.

Recipes are secured within FactoryTalk Batch Recipe Editor using the Security
Authority command. The FactoryTalk Network Directory SAI is written into the
recipe header data. To subsequently open and edit the recipe in FactoryTalk Batch
Recipe Editor, the SAI in the recipe must match the one in the current
FactoryTalk Network Directory.

Import and export operations with secured recipes are restricted.

See also

Security authority overview on page 91

Secure an area model on page 93

92 Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017
Security authority overview Chapter 8

Secure an area model Area models are secured using the Security Authority command.

To secure an area model:

1. Open the area model to secure in FactoryTalk Batch Equipment Editor.

Important: Before securing an area model to a specific FactoryTalk Network Directory, Rockwell
Automation recommends backing up the FactoryTalk Network Directory and storing unsecured
versions of the area model file in configuration (.cfg), XML (.axml), or text (.txt) formats in a
secure location.
For backup details, see FactoryTalk Help: Select Start, point to All Programs > Rockwell
Software > FactoryTalk Tools, and then select FactoryTalk Help.
Once an area model is secured with a particular FactoryTalk Network Directory, the area model
cannot be opened if the security authority identifier associated with that directory no longer
exists.

2. Select Edit > Security Authority. The Security Authority dialog box
opens.

3. Select the check box to secure the area model. If the check box is not
enabled, the logged in user account is not authorized to use this feature.

4. Select OK.

See also

Security authority overview on page 91

Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017 93
 Chapter 9

Data servers overview

A FactoryTalk Batch data server is a reference to an OPC, FactoryTalk Live Data,

or Common Industrial Protocol (CIP) data server program and one of its
associated data sources. These data server references provide run-time information
from the process-connected device (PCD) to FactoryTalk Batch View or the HMI
software. Data servers are used to pass data between the FactoryTalk Batch Server
and the PCD. Configure a separate FactoryTalk Batch data server for each data
source, and its associated data server program, that communicates with the
FactoryTalk Batch Server.

In FactoryTalk Batch Equipment Editor, add a data server definition for each data
server program (and its associated data source) that communicates with the
FactoryTalk Batch Server. This allows FactoryTalk Batch to access current tag
data within the PCD, which is necessary to successfully run recipes, arbitrate
equipment, and control single phases or operation sequences.

Tip: The FactoryTalk Live Data protocol is based on the OPC Data Access protocol. The FactoryTalk Batch
Simulator imitates the functionality of a data server and can communicate with the FactoryTalk Batch
Server using OLE for Process Control (OPC) communications. Sample programs are included with the
FactoryTalk Batch Phase Simulator and can be run to simulate batch processes without being connected to
a PCD.

See also

Data server definition files on page 96

Area model data servers on page 97

OPC data servers on page 99

Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017 95
Chapter 9 Data servers overview

Data server definition files Each data server defined in FactoryTalk Batch Equipment Editor must reference a
data server definition file (DSDF). Configuration parameters for data servers are
defined using DSDF files. Each data server program and associated data source
that communicates with the FactoryTalk Batch Server must have its own
associated DSDF file defining that data server type. The configuration values
within the DSDF file define the communication parameters used by the Server
when communicating with data servers of this type. DSDF files must be located in
the Dataservers directory, which is located within the Batch root directory. These
server types (.dsdf files) are included with FactoryTalk Batch:

• Simulator OPC • Rockwell RSLinx Classic OPC

• PCPhase OPC • Logix5000 CIP
• Rockwell RSLinx Classic Gateway OPC • RSLinx Enterprise FactoryTalk Live Data
• RSOPC Gateway • Instruction-based Server (eProcedure only)

Tip: A data server using the Instruction-based Server cannot be created. This data server is created automatically.

Tip: Data server definition files should never be edited directly. For questions regarding DSDF files, contact
Rockwell’s Customer Support.

See also

Area model data servers on page 97

96 Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017
Data servers overview Chapter 9

Area model data servers One data server needs to be defined in the area model. Define a data server before
adding phases or operation sequences to the area model.

Important: The Instruction-Based Server is for use with FactoryTalk eProcedure only. The data server
automatically creates when an area model opens. A new data server using the
InstructionBasedServer data server type cannot be created. If this data server is deleted,
any phases or operation sequences and associated tags are also deleted. The next time
the area model opens, the data server automatically creates again.

FactoryTalk Batch supports these data server protocols:

• OPC Data Access protocol

• FactoryTalk Live Data protocol
• Common Industrial Protocol (CIP)

The Data Servers dialog box provides a list of data servers defined for the active
area model. The first data server in this list is the default. Select the Name header
to sort the list in ascending or descending alphabetical order.

See also

Data Servers dialog box on page 98

Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017 97
Chapter 9 Data servers overview

Data Servers dialog box The Data Servers dialog box contains:

Name Purpose
Name The user-defined name of the data server. Select the Name header to sort the data
servers in ascending or descending alphabetical order.
Type The type of data server, defined by a DSDF file. By selecting the Type header, the data
server types can be sorted in ascending or descending alphabetical order.
Add Opens the Add Data Server dialog box that is used to add new data servers to the
area model.
Edit Opens the Edit Data Server dialog box that is used to edit existing data servers.
Remove Opens the Remove Data Server dialog box that is used to remove an existing data
server. The dialog box displays a list of all associated phases or operation sequences,
phase tags or operation sequence tags, and unit attribute tags that are removed.
Close Closes the dialog box without applying a data server selection.

See also

Area model data servers on page 97

98 Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017
Data servers overview Chapter 9

OPC data servers These items are displayed for OPC data servers.

When adding a data server to the area model, these items must be configured in
the Add Data Server dialog box:

Name Purpose
Name The unique user-defined name for the data server definition.
Type The various choices of data server types are defined within separate DSDF files.
Default Item Access Path The OPC item access path that is the default for the tags on all subsequently
created phases that this data server is assigned to.
To reset the access path for all phase tags to this value, in the Edit Phase dialog
box Tags tab, select Defaults. The tag item names are also reset to include the
name of the phase.
Watchdog Item Access Path The OPC watchdog item access path is for data servers that do not require separate
read and write items. For data servers that require separate read and write items,
this label changes to Watchdog Read Item Access Path and is used only for the
read item access path. This is optional, depending on the data server.
Watchdog Item Name The name of the OPC watchdog item for data servers that do not require separate
read and write items. For data servers that require separate read and write items,
this label changes to Watchdog Read Item Name and is used only for the read
item name.
Location Only used with OPC data servers. The location of the OPC data server. If the data
server is located on the local computer, Local must be selected. If the data server
is located on a remote network computer, Remote must be selected and the
name of the computer where the data server is located must be provided. Enter
the name of the remote computer using the naming scheme of the network
transport. By default, Universal Naming Convention (UNC) names and Domain
Names System (DNS) names are supported.
RSLinx Enterprise Server Path Only used with RSLinx Enterprise FactoryTalk Live Data servers. A string that
defines the path to a data server located in the FactoryTalk Directory. (See RSLinx
Enterprise FactoryTalk Live Data server for more information.)
Watchdog Protocol The type of watchdog protocol to be used by the data server. This can be either the
Standard or Enhanced protocol.
Watchdog Write Item Access Path The OPC access path for the watchdog write item. If the data server does not
require separate read and write items or does not require an access path, this is
disabled.
Watchdog Write Item Name The OPC item name for the watchdog write item. If the data server does not
require separate read and write items, this is disabled.
Scan Rates The default On Control and Off Control scan rates for the data server, in
milliseconds. The valid range of the On Control scan rate is 250 through 30,000
milliseconds. The valid range of the Off Control scan rate is 250 through 60,000
milliseconds. The usage of these rates is determined by the type of data server
selected. Typically, these values do not need to be modified.

See also

RSLinx Enterprise FactoryTalk Live Data server on page 101

Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017 99
Chapter 9 Data servers overview

Add an OPC data server These instructions only apply to OPC data servers.

To add an OPC data server:

1. Select Start, point to All Programs > Rockwell Software > FactoryTalk
Batch Suite > FactoryTalk Batch, and then select Equipment Editor.

2. Select Edit > Data Server. The Data Servers dialog box opens.

3. Select Add.

4. In Name, type a name for the data server.

5. From Type, select the data server definition that corresponds to the
physical OPC data server being defined.

6. If necessary, type the appropriate values for the Default Item Access Path,
Watchdog Item Access Path, and Watchdog Item Name.

7. Under Location, select the appropriate option. If Remote is selected, type

the remote data server name.

8. Select More. Additional options display.

9. Under Watchdog Protocol, select either the Standard or Enhanced

protocol.

10. If necessary, type the appropriate values for the Watchdog Write Item
Access Path and the Watchdog Write Item Name.

100 Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017
Data servers overview Chapter 9

11. Under Scan Rates, type the On Control and Off Control scan rates for the
data server.

12. Select OK to save the data server configuration and return to the Data
Servers dialog box.

See also

OPC data servers on page 99

RSLinx Enterprise FactoryTalk The FactoryTalk Live Data protocol provides services that read and write
real-time manufacturing data from OPC servers and controllers for all
Live Data server
participating FactoryTalk-enabled products in the FactoryTalk Directory.
FactoryTalk Live Data improves on OPC-Data Access (DA) by making
communication with multiple servers easier.

To support FactoryTalk Batch as a FactoryTalk Live Data client, RSLinx

Enterprise must be part of the FactoryTalk system. RSLinx Enterprise is a
communication server that provides plant-floor device connectivity for Rockwell
Automation applications and Logix processors.

See also

Add a data server on page 102

RSLinx Enterprise server path on page 104

Configure the RSLinx Enterprise server path on page 104

Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017 101
Chapter 9 Data servers overview

Add a data server The items necessary to configure an RSLinx Enterprise data server type in
FactoryTalk Batch Equipment Editor are identical to OPC servers with the
exception of the RSLinx Enterprise server path.

Before you begin:

Complete these prerequisites:

• Install and configure RSLinx Enterprise. (For more information, refer to

RSLinx Enterprise Help.)
• Create an Application in the FactoryTalk Directory. (For more
information, refer to FactoryTalk Help located in the FactoryTalk
Administration Console.)
• Add an RSLinx Enterprise data server to the FactoryTalk Application.
Adding a data server to an application provides a link between a hardware
device containing tags and the FactoryTalk Directory. (For more
information, refer to FactoryTalk Help located in the FactoryTalk
Administration Console.)

To add a data server:

1. Select Start, point to All Programs > Rockwell Software > FactoryTalk
Batch Suite > FactoryTalk Batch, and then select Equipment Editor.

2. Select Edit > Data Servers dialog box.

3. Select Add to open the Add Data Server dialog box.

4. In Name, type a name for the data server.

5. From Type, select RSLinx Enterprise. When the data server Type is
RSLinx Enterprise, the RSLinx Enterprise Server Path text box replaces
the Location text box in the Add Data Server dialog box.

102 Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017
Data servers overview Chapter 9

6. If necessary, type the appropriate values for the Default Item Access Path
and the Watchdog Item Access Path. (These are the device shortcut
name(s) assigned in FactoryTalk Live Data.)

7. If necessary, type the appropriate values for the Watchdog Item Name.

8. Type the connection string for the RSLinx Enterprise Server Path found
on the FactoryTalk Administration Console dialog box. Enter the path
that is shown, but without the server name shown at the end of the path.
(See RSLinx Enterprise server path for more information.)

9. Select More to view the watchdog write item access path and name and the
on and off control scan rates for the data server.

10. Select OK to save the data server configuration and return to the Data
Servers dialog box.

See also

RSLinx Enterprise server path on page 104

Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017 103
Chapter 9 Data servers overview

RSLinx Enterprise server path Once an RSLinx Enterprise data server is added to an Application in the
FactoryTalk Directory, to view the RSLinx Enterprise Server Path connection
string that is needed to configure the RSLinx Enterprise server type in FactoryTalk
Batch Equipment Editor, see the Communication Setup title in the
Communication Setup dialog box.

In this example, the RSLinx Enterprise Server Path connection string is:
RNA://$Global/MyApplication/

(Note that the final name in the path (RSLinx Enterprise) does not show at the
end as shown in the image.)

See also

Configure the RSLinx Enterprise server path on page 104

Configure the RSLinx Enterprise Use these instructions to open the FactoryTalk Communication Setup dialog
server path box.

To configure the RSLinx Enterprise server path:

1. Open the FactoryTalk Administration Console and log on to the

appropriate FactoryTalk Directory.

2. Point to MyApplication > RSLinx Enterprise > Communication Setup.

3. Right-click Communication Setup and select Open.

The Communication Setup dialog box opens. The RSLinx Enterprise

Server Path connection string displays as part of the title.

See also

RSLinx Enterprise FactoryTalk Live Data server on page 101

104 Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017
Data servers overview Chapter 9

Edit a data server When editing an OPC or RSLinx Enterprise FactoryTalk Live Data server
associated with a unit attribute tag, a phase or any tag within a phase, Logix5000
CIP does not display in the Type list. One OPC type can be changed to another
or changed from an OPC type to an RSLinx Enterprise FactoryTalk Live Data
type (for example, for a Simulator OPC data server, change Type to Rockwell
RSLinx Classic OPC), but an OPC or RSLinx Enterprise FactoryTalk Live Data
type server cannot be changed to a Logix5000 CIP type data server.

To change the Type to Logix5000 CIP, delete the data server, and add a new one.

To edit a data server:

1. Select Start, point to All Programs > Rockwell Software > FactoryTalk
Batch Suite > FactoryTalk Batch, and then select Equipment Editor.

2. Select Edit > Data Servers to open the Data Servers dialog box.

3. Select the data server definition edit, and then select Edit.

The Edit Data Server dialog box opens.

4. Make any required changes and select OK to return to the Data Servers
dialog box.

All phase tags assigned to the modified data server definition are updated to
reflect the changes.

5. Close the Data Servers dialog box.

See also

OPC data servers on page 99

Delete a data server on page 106

Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017 105
Chapter 9 Data servers overview

Delete a data server Use these instructions to delete a data server.

To delete a data server:

1. Select Start, point to All Programs > Rockwell Software > FactoryTalk
Batch Suite > FactoryTalk Batch, and then select Equipment Editor.

2. Open the Data Servers dialog box.

3. Select the data server to delete, and then select Remove.

• If the data server is not assigned to any phases or operation sequences,

this message displays:

• If the data server is assigned to any phases, operation sequences, or unit

attribute tags, the Remove Server dialog box opens. All the phases,
operation sequences, and unit attribute tags associated with the data
server are listed.
Tip: The displayed phases or operation sequences and all of their tags, as well as the
displayed unit attribute tags, are deleted when the data server is removed.

4. Perform one of the following steps:

• To delete the data server and remove all associated phases or operation
sequences and tags, select Yes.
• To cancel the deletion and return to the Data Servers dialog box, select
No.

5. Close the Data Servers dialog box.

See also

Assign data servers on page 107

106 Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017
Data servers overview Chapter 9

Assign data servers After a data server is added, assign it to either a phase, an operation sequence, or a
unit.

Phase or operation sequence Unit

Assign a data server to a phase or operation Assign the same data server to all phases or operation
sequence to link the equipment piece to the sequences subsequently created in a unit. Select the
specified controller. data server in the Edit Unit dialog box.

See also

Configure the general data for a process cell on page 129

Data servers overview on page 95

Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017 107
 Chapter 10

Resources overview

Resource is a general term for equipment including process cells, units, phases and
shared control modules.

Define the resources in the area model prior to assigning them as shared
equipment. Create resource classes (such as PUMPS) and resource instances (such
as PMP102). After resource instances are defined in the area model, they can be
assigned to process cells, units, phases, and other resources as necessary equipment
that are allocated by the FactoryTalk Batch Server. To configure a resource
instance, assign a name, equipment ID, the maximum number of owners, and any
other equipment requirements for that resource. When the maximum number of
owners are defined, the number of area model components that can
simultaneously use the resource are also defined.

Resources can be simultaneously owned by one or more area model components,

depending on the program. For example, if a pump is physically configured to
charge an ingredient into three different vessels but it has the capacity to charge
only two of the three vessels simultaneously, define the pump as a shared resource
and specify the maximum number of owners as 2.

See also

Arbitration of resources on page 110

Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017 109
Chapter 10 Resources overview

Arbitration of resources Before the recipe procedure executes, all resources needed by the process cells,
units, phase classes, and operation sequence classes in which the recipe procedure
is running must be acquired by the FactoryTalk Batch Server through arbitration.
This example shows how each recipe level behaves when its corresponding area
model component requires resources. Define resources as required by an area
model component in the Edit Process Cell, Edit Unit, Edit Phase, or Edit
Operation Sequence dialog boxes on the Arbitration tab.

Area Model Recipe Recipe Name Behavior of Recipes

Component Requiring Level
Resource
Process_Cell_A Procedure CLS_FRENCHVANILLA The French vanilla recipe
running in Process_Cell_A
cannot begin execution until
resources required by
Process_Cell_A have been
acquired by the FactoryTalk
Batch Server.
Unit_A Unit Procedure CLS_SWEETCREAM_ The unit procedure and
Operation UP:1 operation sweet cream recipes
CLS_SWEETCREAM_ running in Unit_A cannot begin
OP:1 execution until resources
required by Unit_A have been
acquired by the FactoryTalk
Batch Server.
Phase_A Recipe Phase ADD_EGG:1 ADD_EGG:1 running in
Phase_A cannot begin
execution until the resources
required by Phase_A have been
acquired by the FactoryTalk
Batch Server.
Operation_Sequence_A Operation OPERATION_CLS1 OPERATION_CLS1 running in
Sequence Operation_Sequence_A cannot
begin execution until the
resources required by
Operation_Sequence_A have
been acquired by the
FactoryTalk Batch Server.

Tip: When a resource is deleted, it is removed from all equipment lists in which it
previously existed.

See also

Resources overview on page 109

Define shared resources on page 111

110 Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017
Resources overview Chapter 10

Define shared resources Use these instructions to define shared resources.

To define shared resources:

1. Select Start, point to All Programs > Rockwell Software > FactoryTalk
Batch Suite > FactoryTalk Batch, and then select Equipment Editor.

2. Select Edit > Resources.

3. To create a new resource class, select Add Class. The Edit Resource Class
dialog box displays.

a. In Name, type the new resource class name.

b. Select OK to return to the Edit Resources dialog box. The new

resource class displays in the Resource Classes column.

4. To add a resource instance to a resource class, select the new resource class,
and then select Add. The Edit Resources: [Resource Name] dialog box
displays.

The Edit Resources: [Resource Name] dialog box contains four tabs:

• General
• Arbitration
• Cross Invocation
• Hyperlink (eProcedure only)

See also

Configure general information for resources on page 112

Configure arbitration information for resources on page 113

Configure cross invocation information for resources on page 115

Configure hyperlink information for resources on page 116

Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017 111
Chapter 10 Resources overview

Configure general information Use these instructions to configure general information.

for resources To configure general information for resources:

1. Select Start, point to All Programs > Rockwell Software > FactoryTalk
Batch Suite > FactoryTalk Batch, and then select Equipment Editor.

2. Select Edit > Resources.

3. Under Resources, select the resource and then select Edit.

4. In the Edit Resources: [Resource Name] dialog box, select the General
tab.

5. In Name, type the resource name (for example, Pump101, PV203).

6. Type the appropriate Equipment ID, or accept the default ID.

7. Select Apply to save changes and continue, or select OK to return to the

Edit Resources dialog box.

See also

Define shared resources on page 111

Configure arbitration information for resources on page 113

Configure cross invocation information for resources on page 115

Configure hyperlink information for resources on page 116

112 Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017
Resources overview Chapter 10

Configure arbitration On the Edit Resources dialog box Arbitration tab, the Equipment Allocation
information for resources by Resource area contains a hierarchical view in the left pane that displays the
current equipment configuration of the area model. The hierarchy has two roots:
Process Cells and Resources. The right pane is the list of equipment on which this
resource is dependent. Any equipment in the right pane must be acquired by the
FactoryTalk Batch Server before any procedural element requiring this resource
can begin execution.

Expand the Process Cells root to view all the process cells within the area model.
From here, organization is hierarchical, so process cells contain units and units
contain phases.

Expand the Resources root to view a list of all the configured resource instances
within the area model.

To configure arbitration information for resources:

1. Select Start, point to All Programs > Rockwell Software > FactoryTalk
Batch Suite > FactoryTalk Batch, and then select Equipment Editor.

2. Select Edit > Resources.

3. Under Resources, select the resource and then select Edit.

4. In the Edit Resources: [Resource Name] dialog box, select the

Arbitration tab.

Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017 113
Chapter 10 Resources overview

5. In Max Owners, enter the number that represents how many process cells,
units, phases, or other resources can maintain ownership of this resource at
one time.

6. Under Equipment Allocation by Resource, browse the area model’s

equipment hierarchy to specify equipment this resource needed. A plus sign
(+) to the left of the equipment type indicates equipment of that type has
been defined.

• To add equipment to the right pane, select the equipment needed by

the resource in the left pane and select Add. The equipment this
resource needs to acquire displays in the right pane.
• To remove equipment, in the right pane, select the equipment to delete
and select Remove. The selected equipment is removed from the list.

7. Select Apply to save changes and continue, or select OK to return to the

Edit Resources dialog box.

See also

Define shared resources on page 111

Configure general information for resources on page 112

Configure cross invocation information for resources on page 115

Configure hyperlink information for resources on page 116

114 Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017
Resources overview Chapter 10

Configure cross invocation Use the Cross Invocation tab to specify cross invocation labels for different
information for resources resource types.

To configure cross invocation information for resources:

1. Select Start, point to All Programs > Rockwell Software > FactoryTalk
Batch Suite > FactoryTalk Batch, and then select Equipment Editor.

2. Select Edit > Resources.

3. Under Resources, select the resource and then select Edit.

4. In the Edit Resources: [Resource Name] dialog box, select the Cross
Invocation tab.

5. In Cross Invocation Label #, type the cross invocation string contents

information.

6. Select Apply to save changes and continue, or select OK to save changes and
return to the Edit Resources: [Resource Name] dialog box.

See also

Configure hyperlink information for resources on page 116

Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017 115
Chapter 10 Resources overview

Configure hyperlink This feature, allows hyperlinks to be associated with any of the equipment
resources, used in conjunction with eProcedure only.
information for resources
To configure hyperlink information for resources:

1. Select Start, point to All Programs > Rockwell Software > FactoryTalk
Batch Suite > FactoryTalk Batch, and then select Equipment Editor.

2. Select Edit > Resources.

3. Under Resources, select the resource and then select Edit.

4. If hyperlinks are being used, in the Edit Resources: [Resource Name]

dialog box, select the Hyperlink tab.

5. In Hyperlink Label # English, type a valid URL string.

6. Select Apply to save changes and continue, or select OK to return to the

Edit Resources: [Resource Name] dialog box.

7. When finished creating the shared resources, select OK to return to the

Design View area.

See also

Define shared resources on page 111

Configure general information for resources on page 112

Configure arbitration information for resources on page 113

Configure cross invocation information for resources on page 115

116 Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017
 Chapter 11

Global binding requirements

Global unit binding requirements are sets of expressions that tell the FactoryTalk
Batch Server what units are valid binding candidates for a recipe. A binding
requirement can be evaluated against instances of a unit class to determine which
instances of the class are legal bind candidates for a unit requirement. When the
FactoryTalk Batch Server attempts to bind a unit requirement during recipe
execution, the entire set of binding requirements defined for the unit requirement
is evaluated against each potential binding candidate. Units unable to meet every
binding requirement defined for the unit requirement are eliminated as potential
binding candidates.

A global binding requirement is automatically applied to every unit requirement

within a recipe. Pre-configuring global binding requirements in an area model, and
then loading that area model within FactoryTalk Batch Recipe Editor, eliminates
having to manually add the binding requirement to every unit requirement in
every recipe.

For example, a global binding requirement may be Days_since_CleanInPlace < 3.

This binding requirement might be imposed by corporate quality standards. This
means that no unit is considered acceptable for use unless it has been cleaned
within the last three days. As a global unit requirement, this requirement is
required to be applied against every unit requirement in the plant.

See also

Unit binding expression builder on page 118

Create global binding requirements on page 122

Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017 117
Chapter 11 Global binding requirements

Unit binding expression Create expressions in the Unit Binding Expression Builder. The Unit Binding
Expression Builder contains a type list on the left pane, which displays Recipe
builder Header and Unit Attribute data that can be used to build an expression.

When Recipe Header is selected, a list of recipe header parameters displays in the
list view (in the middle). The Recipe Header box names map to the same boxes
defined in FactoryTalk Batch Recipe Editor within a Recipe Header.

When the Unit Attributes is selected, an alphabetic list of all global unit
attributes existing within the area model displays in the list view.

Create or edit an expression by typing directly in the Expression Builder text box,
selecting items in the list view and enumerations view, selecting various operators,
or selecting a combination of items and operators. The Operator buttons of the
Expression Builder are always enabled. When an Operator button is selected, the
corresponding operator is inserted into the expression at the current cursor
position and displays in the Expression Builder text box.

See also

Create a global unit attribute on page 169

Expression operators on page 119

Supported data types on page 119

Operands on page 120

Expression validation on page 120

118 Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017
Global binding requirements Chapter 11

Expression operators Binding expressions support operators. The precedence of the execution depicts
from highest to lowest. An operator with a higher precedence executes before an
operator of lower precedence.

Expression Operator Purpose

() Expressions within parentheses are evaluated before expressions outside of
parentheses.
NOT, - Logical NOT, subtraction.
*, / , AND Multiplication, division, and logical AND.
+, -, OR Addition, subtraction, and logical OR.
<, <=, >, >= Less than, less than or equal to, greater than, and greater than or equal to.
=, < > Equal to, and not equal to.

See also

Unit binding expression builder on page 118

Supported data types on page 119

Operands on page 120

Expression validation on page 120

Supported data types The data types supported are integer, real, string, and enumeration. Data type
examples:

Integer: 423

Real: 423.123456789012

String: The string constant must be in quotes: "READY".

Enumeration: As a string, the enumeration constant must be in quotes:

"BUTTER_PECAN". As an integer, the ordinal for the enumeration may be: 4.

See also

Unit binding expression builder on page 118

Operands on page 120

Expression validation on page 120

Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017 119
Chapter 11 Global binding requirements

Operands Operands used within a global unit binding expression can reference recipe header
data, global unit attributes, and constants.

Examples of allowable expression entities and the required syntax:

Expression Entity Expression Syntax Example

Recipe header data [Recipe header item] [VERSION_NUMBER]
Global unit attribute Unit attribute name CAPACITY
Constant 100

See also

Unit binding expression builder on page 118

Expression validation Although an invalid expression cannot be created, a previously valid expression
may become invalid through subsequent changes elsewhere in the area model.
When the Edit Global Unit Binding Requirements dialog box is invoked all
binding expressions are re-validated. If any current expressions have become
invalid due to subsequent changes, an error message opens and the dialog displays
an asterisk beside each invalid expression.

The expression validates for consistency and syntactical correctness. If the defined
expression validates successfully, the dialog box closes. If the expression is invalid,
then the location of where the first error encountered highlights, a description of
the error displays in a message box, and the dialog box does not close.

120 Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017
Global binding requirements Chapter 11

Validation rules:

• An expression must resolve to either TRUE or FALSE and meet the

criteria:
• An expression must contain at least one operator (+ (addition), -
(subtraction), * (multiplication), / (division), = (equals), > (greater
than), < (less than), <= (less than, or equal to), >= (greater than, or
equal to), <> (not equal to), Not, And, and Or.
Tip: OR transitions fire if at least one side of the expression is TRUE.

• Separate each entity (recipe header, global unit attribute, or constant)

with an operator.
• The operated entities must evaluate to acceptable data types (string
with a string; integer with integer or real; real with integer or real).
• Maximum expression length must not exceed 1023 characters.
• Duplicate expressions are allowed.

See also

Unit binding expression builder on page 118

Create global binding requirements on page 122

Supported data types on page 119

Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017 121
Chapter 11 Global binding requirements

Create global binding Use these instructions to create global binding requirements.

requirements To create global binding requirements:

1. Select Start, point to All Programs > Rockwell Software > FactoryTalk
Batch Suite > FactoryTalk Batch, and then select Equipment Editor.

2. Select Edit > Global Binding Requirements.

3. Select Add Requirement.

4. In the Unit Binding Expression Builder dialog box, select options from
the three different sections or type to build an expression.

Tip: A binding requirement expression evaluates to either a TRUE or FALSE value, TEMPERATURE < 20.3, for
example.

5. Select OK to save the expression and return to the Edit Global Unit
Binding Requirements dialog box.

122 Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017
Global binding requirements Chapter 11

6. Continue building more binding requirements, or select OK to exit the

dialog box.

See also

Unit binding expression builder on page 118

Expression validation on page 120

Edit binding requirements on page 123

Delete binding requirements on page 124

Edit binding requirements Use these instructions to edit binding requirements:

To edit binding requirements:

1. Select Start, point to All Programs > Rockwell Software > FactoryTalk
Batch Suite > FactoryTalk Batch, and then select Equipment Editor.

2. Select Edit > Global Binding Requirements.

3. Select browse ( ) next to the requirement to edit.

4. Make the desired changes, and then select OK.

5. Select OK to close the Edit Global Unit Binding Requirements dialog

box.

See also

Create global binding requirements on page 122

Delete binding requirements on page 124

Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017 123
Chapter 11 Global binding requirements

Delete binding requirements Use these instructions to delete binding requirements.

To delete binding requirements:

1. Select Start, point to All Programs > Rockwell Software > FactoryTalk
Batch Suite > FactoryTalk Batch, and then select Equipment Editor.

2. Select Edit > Global Binding Requirements.

3. Select Delete Requirement, and then select OK to confirm the deletion or

Cancel to keep the requirement.

4. Select OK to close the Edit Global Unit Binding Requirements dialog

box.

See also

Create global binding requirements on page 122

Edit binding requirements on page 123

124 Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017
 Chapter 12

Process cell overview

A process cell is a logical grouping of equipment, including units, required for the
production of one or more batches. It can contain more than one grouping of
equipment if more than one grouping is needed to make a batch. Process cells are
grouped into classes. For each type of process cell in a selected area, a process cell
class must first be created. Once the process cell class has been created, an instance
of that class can be created in the Design View area.

See also

Create a process cell class on page 126

Edit a process cell class on page 127

Create and configure process cell instances on page 127

Configure hyperlink data for a process cell on page 133

Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017 125
Chapter 12 Process cell overview

Create a process cell class Use these instructions to create a process cell class.

Tip: If the icon column is empty, see Verify icon paths.

To create a process cell class:

1. Select Start, point to All Programs > Rockwell Software > FactoryTalk
Batch Suite > FactoryTalk Batch, and then select Equipment Editor.

2. In the Class View area, verify that the column heading is Cell Classes. If
not, select Go Up ( ) until the top level of the area model is shown.

3. Select Class > New Process Cell Class.

4. In Name, enter a name for the process cell class.

5. Under Icon, select an icon.

6. Select OK.

See also

Verify icon paths on page 135

Process cell overview on page 125

126 Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017
Process cell overview Chapter 12

Edit a process cell class Use these instructions to edit a process cell class.

To edit a process cell class:

1. Select Start, point to All Programs > Rockwell Software > FactoryTalk
Batch Suite > FactoryTalk Batch, and then select Equipment Editor.

2. Select the process cell class to edit.

3. Select Edit > Properties. The Edit Process Cell Class dialog box opens.

4. Make the desired changes, and then select OK to return to the Class View
area.

See also

Create and configure process cell instances on page 127

Verify icon paths on page 135

Unique icons on page 136

Create and configure Use these instructions to create and configure process cell instances.

process cell instances To create and configure process cell instances:

1. Select Start, point to All Programs > Rockwell Software > FactoryTalk
Batch Suite > FactoryTalk Batch, and then select Equipment Editor.

2. Select the desired process cell class.

The cursor changes to a c.

3. Place the cursor in the desired location in the Design View area and select.

The process cell icon displays in the Design View area with a default name
of PROCESS_CELL# (where # is a sequentially assigned number starting
with 1).

See also

Configure a process cell instance on page 128

Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017 127
Chapter 12 Process cell overview

Configure a process cell Use these instructions to configure a process cell instance.
instance
To configure a process cell instance:

1. Select Start, point to All Programs > Rockwell Software > FactoryTalk
Batch Suite > FactoryTalk Batch, and then select Equipment Editor.

2. Select a process cell icon in the Design View area.

3. Select Edit > Properties.

The Edit Process Cell dialog box displays with the assigned defaults. The
Edit Process Cell dialog box contains four tabs:

• General
• Arbitration
• Cross Invocation
• Hyperlink (eProcedure only)

See also

Configure the general data for a process cell on page 129

128 Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017
Process cell overview Chapter 12

Configure the general data for a Use these instructions to configure the general data.
process cell
To configure the general data for a process cell:

1. Select Start, point to All Programs > Rockwell Software > FactoryTalk
Batch Suite > FactoryTalk Batch, and then select Equipment Editor.

2. Select a process cell icon in the Design View area.

3. Select Edit > Properties.

4. In the Edit Process Cell dialog box, select the General tab.

5. In Name, type a process cell name.

6. For RSBizWare BatchERP, in ERP Alias, type the SAP R/3 process cell
name.

The ERP alias is the process cell name in SAP. It maps the process cell from
FactoryTalk Batch to SAP.

7. In Equipment ID, type the equipment ID, or accept the default value.

8. Select Apply to save changes.

See also

Edit process cell dialog box - General tab on page 130

Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017 129
Chapter 12 Process cell overview

Edit process cell dialog box - General The General tab of the Edit Process Cell dialog box contains:
tab
Name Purpose
Name The name of the process cell. (The default name is PROCESS_CELL#. The # is a consecutive
number starting with 1 that is assigned to each process cell as it is added to an area.)
Icon The icon selected for the process cell class (view-only).
Class The name of the process cell class (view-only).
ERP Alias (RSBizWare BatchERP only) The SAP name for the phase. The ERP alias maps the equipment
module from FactoryTalk Batch to SAP.
Equipment ID The equipment identification number identifies this process cell. (A default ID is
automatically assigned to the process cell, based on the next available sequential number.
The first item added to an area is assigned ID #1.) To request this process cell, the equipment
ID must be the same as the equipment ID that is used by the phase logic.

See also

Configure the general data for a process cell on page 129

Configure the arbitration data In the Equipment Allocation by Resource area, the left pane is a hierarchical
display of the current equipment configuration of the area model. The hierarchy
for a process cell
has two roots: Process Cells and Resources. The right pane is the list of equipment
this process cell is dependent upon. Any equipment in this list must be acquired by
the process cell before any procedural element linked to this process cell can begin
execution.

Expand Process Cells to view all the process cells defined within the area model.
From here, organization is hierarchical; process cells contain units and units
contain phases.

Expand Resources to view a list of all the configured resources within the area
model.

To configure the arbitration data for a process cell:

1. Select Start, point to All Programs > Rockwell Software > FactoryTalk
Batch Suite > FactoryTalk Batch, and then select Equipment Editor.

2. Select a process cell icon in the Design View area.

3. Select Edit > Properties.

4. In the Edit Process Cell dialog box, select the Arbitration tab.

5. In Max Owners, type the maximum number of owners.

130 Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017
Process cell overview Chapter 12

6. Browse the area models equipment hierarchy to specify equipment the

process cell must acquire. The lack of a plus or minus sign to the left of an
equipment type indicates no equipment of that type has been defined, or
the equipment type cannot be used as a needed equipment item at this level.

• To add equipment, under the Equipment Allocation by Resource

area, select the equipment needed by the process cell and select Add.
The selected equipment displays in the right pane.
• To remove equipment, in the right pane, select the equipment to delete
and select Remove. The selected equipment is removed from the list.

7. Select Apply to save changes.

See also

Edit process cell dialog box - Arbitration tab on page 131

Edit Process Cell dialog box - The Edit Process Cell dialog box on the Arbitration tab contains:
Arbitration tab
Name Purpose
Name The name of the process cell (view-only). The default name is PROCESS_CELL#.
The # is a consecutive number starting with 1 that is assigned to each process cell
as it is added to an area.
Icon The icon selected for the process cell class (view-only).
Class The name of the process cell class (view-only).
Max Owners The maximum number of owners (other process cells, units, phases, or other
resources) that can simultaneously use this process cell. The default is 1.
Equipment Allocation by Resource A list of the equipment for which ownership is required by this process cell in
order for any procedural element linked to the process cell to begin execution.
The default is blank. In general, assign any required resources to the lowest
possible level to allow for maximum efficiency when running multiple processes.
The left pane is a hierarchical display showing the current equipment
configuration of the area model. The hierarchy has two roots:
• Process Cells: Displays all the process cells within the area model. From
here, organization is hierarchical: process cells contain units and units contain
phases and operations sequences.
• Resources: Displays a list of all the configured resources within the area
model.
The right pane is the list of equipment this process cell is dependent upon. Any
equipment in this list must be acquired by the process cell before the process cell
itself can be acquired.

See also

Configure the arbitration data for a process cell on page 130

Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017 131
Chapter 12 Process cell overview

Configure cross invocation data Use these instructions to configure cross invocation data.
for a process cell
To configure cross invocation data for a process cell:

1. Select Start, point to All Programs > Rockwell Software > FactoryTalk
Batch Suite > FactoryTalk Batch, and then select Equipment Editor.

2. Select a process cell icon in the Design View area.

3. Select Edit > Properties.

4. In the Edit Process Cell dialog box, select the Cross Invocation tab.

5. Type the cross invocation string information in the Cross Invocation

Label boxes.

6. Select Apply to save changes.

See also

Edit process cell dialog box - Cross Invocation tab on page 133

132 Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017
Process cell overview Chapter 12

Edit process cell dialog box - Cross The Edit Process Cell dialog box on the Cross Invocation tab contains:
Invocation tab
Name Purpose
Name The name of the process cell (view-only). The default name is
PROCESS_CELL#, where # is a consecutive number starting with 1, assigned to
each process cell as it is added to an area.
Class The name of the process cell class (view-only).
Icon The icon selected for the process cell class (view-only).
Cross Invocation The cross invocation strings indicate the addition of an item to FactoryTalk
Configuration Batch View and the ActiveX control shortcut menus. This includes the caption
for each menu item and the data to be passed to the specified automation
server when the menu item is selected.
The default labels associated with each of the five fields are Cross Invocation
Label # (where # is 1 through 5). These labels can be modified in the Server
Options dialog box, and are seen in the Edit Process Cell dialog box.

See also

Configure cross invocation data for a process cell on page 132

Configure hyperlink data for a This feature is used in conjunction with FactoryTalk eProcedure only. Use these
process cell instructions to configure hyperlink data.

To configure hyperlink data for a process cell:

1. Select Start, point to All Programs > Rockwell Software > FactoryTalk
Batch Suite > FactoryTalk Batch, and then select Equipment Editor.

2. Select a process cell icon in the Design View area.

3. Select Edit > Properties.

4. In the Edit Process Cell dialog box, if hyperlinks are being used, select the
Hyperlink tab.

5. In the Hyperlink Configuration boxes, type a valid URL string.

Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017 133
Chapter 12 Process cell overview

6. Select Apply to save changes.

7. Select OK to return to the Design View area.

See also

Edit process cell dialog box - Hyperlink tab on page 134

Edit process cell dialog box - The Edit Process Cell dialog box Hyperlink tab contains:
Hyperlink tab
Name Purpose
Name The name of the process cell (view-only). The default name is PROCESS_CELL#.
The # is a consecutive number starting with 1 that is assigned to each process cell
as it is added to an area.
Icon The icon selected for the process cell class (view-only).
Class The name of the process cell class (view-only).
Hyperlink The URL associated with each hyperlink label.
Configuration The default labels associated with each of the five fields are Hyperlink Label #
English (where # is 1 through 5). These labels can be modified in the Server
Options dialog box. The labels are used in the eProcedure Client Equipment view.

See also

Configure hyperlink data for a process cell on page 133

Remove a process cell instance Use these instructions to remove a process cell instance.

To remove a process cell instance:

1. Select Start, point to All Programs > Rockwell Software > FactoryTalk
Batch Suite > FactoryTalk Batch, and then select Equipment Editor.

2. Select a process cell icon in the Design View area.

3. Press Delete.

The Remove Process Cell warning displays that lists the associated units
and phases that are removed when deleted the process cell.

4. Select Yes to delete the process cell, or select No to cancel the deletion and
return to FactoryTalk Batch Equipment Editor.

See also

Configure a process cell instance on page 128

134 Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017
Process cell overview Chapter 12

Verify icon paths The directory paths for each type of icon are set by the installation procedure;
modify them only if the bitmaps have been moved to another directory.

To verify icon paths:

1. Select Start, point to All Programs > Rockwell Software > FactoryTalk
Batch Suite > FactoryTalk Batch, and then select Equipment Editor.

2. Select Options > Directories.

3. Verify the directory paths for each type of icon.

4. Select OK to return to the Design View area.

See also

Create and configure process cell instances on page 127

Unique icons on page 136

Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017 135
Chapter 12 Process cell overview

Unique icons Create a graphical representation of a process cell class, unit class, unit class
background, or phase class using a graphic paint program. Create icons specific to
the facility or process. Use the following rules when designing unique icons:

• Icons must be stored in the appropriate directory as a .bmp file.

• The icon must be a square or rectangle, with a width made up of an even
number of pixels. Icons with an odd numbered pixel width will not show.
• The file must not exceed 7K in size (116 x 116 pixels). Icons exceeding the
size limit are displayed as a blank icon with a red question mark.
• Icons are stored in one of these directories:
• Process Cell Class
C:\Program Files\Rockwell
Software\Batch\BMP\PROCCEL
• Unit Class
C:\Program Files\Rockwell Software\Batch\BMP\UNIT
• Unit Class Backgrounds
C:\Program Files\Rockwell
Software\Batch\BMP\UNIT\VESSELS
• Phase Class
C:\Program Files\Rockwell Software\Batch\BMP\PHASE
Tip: New icons that meet these criteria display in the Icon column for process
cell classes, unit classes, and phase classes.

See also

Verify icon paths on page 135

Process cell overview on page 125

136 Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017
 Chapter 13

Unit overview

A unit consists of phases, control modules, or both types of modules centered

around a material-containing vessel that performs one or more major processing
activities. The material contained in the central vessel is usually transformed either
physically, chemically, or biologically. Units run one operation or unit
procedure-level recipe at a time. Process & Instrumentation Diagrams (P&IDs)
are a good source of information for determining unit boundaries.

Often process facilities contain multiple instances of similar equipment, such as

unit vessels, that consist of the same or similar components and functionality.
These groupings of similar equipment can be described as a unit class. In the area
model database, create unit classes (such as MIXER_CLS) and one or many unit
instances of a particular unit class (such as MIXER_A and MIXER_B).

Recipes can be configured to run within a specific unit instance or within a unit
class. The action of specifying the particular unit in which a recipe runs is called
unit binding. If a recipe is configured to run within a unit instance, the unit in
which the recipe runs is specified at the time the recipe is created. If a recipe is
configured to run within a unit class, the recipe can run in any unit instance of
that unit class. The specific unit instance is determined:

• By the operator when the batch is created, prior to starting the batch.
• By the operator, after the batch is started, at the time a unit procedure level
recipe is ready to run (the operator responds to a prompt).
• By the FactoryTalk Batch Server, after the batch is started, at the time a unit
procedure level recipe is ready to run.

Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017 137
Chapter 13 Unit overview

Class-based recipes:

• Minimize the number of recipes that need to be maintained.

• Allow the freedom to choose the most appropriate unit for binding the
recipe at the time the batch is run.
Tip: To navigate to the unit level, double-click a Process Cell icon or select a Process Cell icon and select Go
Down ( ).

See also

Create a unit class on page 139

Edit a unit class on page 140

138 Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017
Unit overview Chapter 13

Create a unit class Use these instructions to create a unit class.

To create a unit class:

1. Select Start, point to All Programs > Rockwell Software > FactoryTalk
Batch Suite > FactoryTalk Batch, and then select Equipment Editor.

2. In the Class View area, verify that the column heading is Unit Classes.

The current unit classes for the selected process cell are displayed in the
Class View area.

3. Select Class > New Unit Class. The Create Unit Class dialog box opens
with the assigned defaults.

• The Unit Attributes area lists non-global unit attributes.

• The Global Unit Attributes area is view-only and lists unit attributes
associated with every unit class in the area model.

4. In Name, type the unit class name.

5. Under Icon, select an icon.

Tip: If the icon column is empty, see Verify icon paths.

6. If unit attributes have been defined and is used with this unit class, select the
check box for the tag(s) to assign to the unit from the Unit Attributes list.

Tip: Global unit attributes are associated automatically with the unit class being created.

7. Select OK.

See also

Verify icon paths on page 135

Add a unit attribute on page 158

Create a global unit attribute on page 169

Edit a unit class on page 140

Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017 139
Chapter 13 Unit overview

Edit a unit class Use these instructions to edit a unit class.

To edit a unit class:

1. Select Start, point to All Programs > Rockwell Software > FactoryTalk
Batch Suite > FactoryTalk Batch, and then select Equipment Editor.

2. In the Class View area, verify that the column heading is Unit Classes.

The current unit classes for the selected process cell are displayed in the
Class View area.

3. Select the unit class to edit and then select Edit > Properties.

4. In the Edit Unit Class dialog box, in Name, type a new unit class name.

5. From Icon, select a new unit class icon or modify the existing unit attribute
tag selection. If any global unit attributes exist, they are listed in the Global
Unit Attributes list (view-only).

6. Select OK.

See also

Create a unit instance on page 141

Unit instance configuration on page 141

Remove a unit instance on page 152

Link unit instances on page 153

Share units on page 153

140 Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017
Unit overview Chapter 13

Create a unit instance Use these instructions to create a unit instance.

To create a unit instance:

1. Select Start, point to All Programs > Rockwell Software > FactoryTalk
Batch Suite > FactoryTalk Batch, and then select Equipment Editor.

2. Select the Unit Class to be placed in the Design View area.

3. Place the cursor in the Design View area where the unit is to be located and
select.

4. Configure the unit instance.

See also

Edit a unit class on page 140

Unit instance configuration Unit configuration includes:

• Specifying a name for the unit.

• Creating unit attribute tags
• Assigning a data server.
• Specifying any equipment resources required by the unit during operation.

See also

Open the edit unit dialog box on page 142

Configure the general data for a unit on page 143

Configure unit attribute tags data on page 145

Configure arbitration data for a unit on page 146

Configure cross invocation data for a unit on page 149

Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017 141
Chapter 13 Unit overview

Open the Edit Unit dialog box Unit configuration is performed using the Edit Unit dialog box.

To open the Edit Unit dialog box:

1. Select Start, point to All Programs > Rockwell Software > FactoryTalk
Batch Suite > FactoryTalk Batch, and then select Equipment Editor.

2. In the Design View area, select the unit icon and then select Edit
Properties ( ). The Edit Unit dialog box displays with the unit defaults
and these five tabs:

• General
• Attribute Tags
• Arbitration
• Cross Invocation
• Hyperlink (eProcedure only)

See also

Configure the general data for a unit on page 143

Configure unit attribute tags data on page 145

Configure arbitration data for a unit on page 146

Configure cross invocation data for a unit on page 149

Configure hyperlink data for a unit on page 151

142 Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017
Unit overview Chapter 13

Configure the general data for a Use these instructions to configure the general data for a unit.
unit
To configure the general data for a unit:

1. Select Start, point to All Programs > Rockwell Software > FactoryTalk
Batch Suite > FactoryTalk Batch, and then select Equipment Editor.

2. In the Design View area, select the unit icon and then select Edit >
Properties.

3. In the Edit Unit dialog box, select General tab.

4. In Name, type the resource name.

5. In Class, type the class.

6. (For use with RSBizWare BatchERP only) In ERP Alias, type the SAP R/3
unit name.

7. In Equipment ID, type or accept the default ID.

8. Select the Data Server.

9. Select Apply to save changes and continue, or select OK to return to the

Edit Unit dialog box.

See also

Open the Edit Unit dialog box on page 142

Edit Unit dialog box - General tab on page 144

Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017 143
Chapter 13 Unit overview

Edit Unit dialog box - General tab The Edit Unit dialog box General tab contains:

Name Purpose
Name The name of the process cell. (The default name is PROCESS_CELL#. The # is a consecutive
number starting with 1 that is assigned to each process cell as it is added to an area.)
Class The name of the unit class.
ERP Alias (RSBizWare BatchERP only) The SAP name for the phase. The ERP alias maps the equipment
module from FactoryTalk Batch to SAP.
Equipment ID The equipment identification number identifies this process cell. (A default ID automatically
assigns to the process cell, based on the next available sequential number. The first item
added to an area is assigned ID #1.) To request this process cell, the equipment ID must be the
same as the equipment ID used by the phase logic.

See also

Configure the general data for a unit on page 143

144 Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017
Unit overview Chapter 13

Configure unit attribute tags Use these instructions to configure the unit attribute tag data.
data
To configure unit attribute tags data:

1. Select Start, point to All Programs > Rockwell Software > FactoryTalk
Batch Suite > FactoryTalk Batch, and then select Equipment Editor.

2. In the Design View area, select the unit icon and then select Edit >
Properties.

3. In the Edit Unit dialog box, select the Attribute Tags tab.

4. Under Unit Attribute Tags, select Add and create the required unit
attribute tags.

Tip: If any global unit attributes have been created for the area model, their associated tags are also listed.

5. To edit an existing tag, select the tag in the Unit Attribute Tags area and
select Edit. The Edit Unit Attribute Tag dialog box opens.

Tip: Unit attribute tags can only be assigned to OPC or RSLinx Enterprise FactoryTalk Live Data servers. They
cannot be assigned to Logix5000 CIP data servers.

6. To remove an existing tag, select the tag in the Unit Attribute Tags area
and select Remove.

Tip: It is not an option to cancel the removal of the unit attribute tag. However, select Cancel and any changes
made to the unit definition are undone.

7. Select Apply to save changes.

See also

Edit Unit dialog box - Attribute Tags tab on page 146

Create a unit attribute tag on page 161

Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017 145
Chapter 13 Unit overview

Edit Unit dialog box - Attribute The Edit Unit dialog box Attribute Tags tab contains:
Tags tab
Name Purpose
Name The unique name assigned to this unit (view-only).
Class The unit class name (view-only). The icon associated with the unit class displays next to
Name and Class.
Unit Attribute Tags Process-connected device data associated with the unit that is used with recipes. Unit
attribute tags are organized by unit attributes. Unit attribute tag instances are created at
the time the unit is configured.

See also

Configure unit attribute tags data on page 145

Configure arbitration data In the Equipment Allocation by Resource area, the left pane is a hierarchical
display of the current equipment configuration of the area model. The tree has
for a unit
two roots: Process Cells and Resources. The right pane is the list of equipment
this unit is dependent on. Any equipment in this list must be acquired by the unit
before any procedural element linked to this unit can begin execution.

Expand Process Cells to view all the process cells within the area model. From
here, organization is hierarchical, so process cells contain units and units contain
phases.

Expand Resources to view a list of all the configured resources within the area
model.

Tip: Units do not have a Max Owners box to define because a unit can execute only one procedural element
(operation or unit-procedure level recipe) at a time. Therefore, all units can have only one owner.

To configure arbitration data for a unit:

1. Select Start, point to All Programs > Rockwell Software > FactoryTalk
Batch Suite > FactoryTalk Batch, and then select Equipment Editor.

2. In the Design View area, select the unit icon and then select Edit >
Properties.

146 Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017
Unit overview Chapter 13

3. In the Edit Unit dialog box, select the Arbitration tab.

4. Browse the area models equipment hierarchy to specify equipment the unit
must acquire. The lack of a plus or minus sign to the left of an equipment
type indicates that no equipment of that type has been defined, or that the
equipment type cannot be used as a needed equipment item at this level.

• To add equipment, under the Equipment Allocation by Resource

area, select the equipment needed by the unit and select Add. The
equipment selected displays in the right pane.
• To remove equipment, in the right pane, select the equipment to delete
and select Remove. The equipment selected is removed from the list.

5. Select Apply to save changes.

See also

Edit Unit dialog box - Arbitration tab on page 148

Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017 147
Chapter 13 Unit overview

Edit Unit dialog box - Arbitration tab The Edit Unit dialog box Arbitration tab contains:

Name Purpose
Name The unique name assigned to this unit (view-only).
Class The name of the class of the unit (view-only).
Class Icon The unit class icon (view-only).
Max Owners An equipment list requiring ownership by this unit in order for any procedural
element linked to the unit to begin execution.
Equipment A list of the equipment for which ownership is required by this unit to begin
Allocation by execution.
Resource The left pane is a hierarchical display showing the current equipment configuration
of the area model. The hierarchy has two roots:
• Process Cells: Displays all the process cells within the area model. From here,
organization is hierarchical: process cells contain units and units contain phases
and operations sequences.
• Resources: Displays a list of all the configured resources within the area model.
The right pane is the list of equipment this unit is dependent upon. Any equipment
in this list must be acquired by the unit before the unit itself can be acquired.

See also

Configure arbitration data for a unit on page 146

148 Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017
Unit overview Chapter 13

Configure cross invocation data Use these instructions to configure cross invocation data.
for a unit
To configure cross invocation data for a unit:

1. Select Start, point to All Programs > Rockwell Software > FactoryTalk
Batch Suite > FactoryTalk Batch, and then select Equipment Editor.

2. In the Design View area, select the unit icon and then select Edit >
Properties.

3. In the Edit Unit dialog box, select the Cross Invocation tab.

4. In the Cross Invocation Label boxes, type the cross invocation string
information.

5. Select Apply to save changes.

See also

Edit Unit dialog box - Cross Invocation tab on page 150

Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017 149
Chapter 13 Unit overview

Edit Unit dialog box - Cross The Edit Unit dialog box Cross Invocation tab contains:
Invocation tab
Name Purpose
Name The unique name assigned to this unit (view-only).

Class The name of the class of the unit (view-only).

Class Icon The unit class icon (view-only).
Cross Invocation The cross invocation strings indicate the addition of an item to
Configuration FactoryTalk Batch View and the ActiveX control shortcut
menus. This includes the caption for each menu item and the
data to be passed to the specified automation server when the
menu item is selected.
The default labels associated with each of the five fields are
Cross Invocation Label # (where # is 1 through 5). These
labels can be modified in the Server Options dialog box, and
are seen in the Edit Process Cell dialog box.

See also

Configure cross invocation data for a unit on page 149

150 Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017
Unit overview Chapter 13

Configure hyperlink data for a This feature is used in conjunction with FactoryTalk eProcedure only. Use these
unit instructions to configure hyperlink data.

To configure hyperlink data for a unit:

1. Select Start, point to All Programs > Rockwell Software > FactoryTalk
Batch Suite > FactoryTalk Batch, and then select Equipment Editor.

2. In the Design View area, select the unit icon and then select Edit >
Properties.

3. If hyperlinks are being used, in the Edit Unit dialog box, select the
Hyperlink tab.

4. In the Hyperlink Configuration boxes, type a valid URL string.

5. Select Apply to save changes.

6. Select OK to return to the Design View area.

See also

Edit Unit dialog box - Hyperlink tab on page 152

Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017 151
Chapter 13 Unit overview

Edit Unit dialog box - Hyperlink tab The Edit Unit dialog box Hyperlink tab contains:

Name Purpose
Name The unique name assigned to this unit (view-only).
Class The name of the unit class (view-only).
Class Icon The unit class icon (view-only).
Hyperlink Configuration The URL associated with each hyperlink label.
The default labels associated with each of the five fields are
Hyperlink Label # English (where # is 1 through 5). These
labels can be modified in the Server Options dialog box.
The labels are used in the eProcedure Client Equipment view.

See also

Configure hyperlink data for a unit on page 151

Remove a unit instance Use these instructions to remove a unit instance.

To remove a unit instance:

1. Select Start, point to All Programs > Rockwell Software > FactoryTalk
Batch Suite > FactoryTalk Batch, and then select Equipment Editor.

2. Select the unit to be removed and press the Delete key.

A warning displays that when the unit is deleted, the phase instances it
contains are deleted.

3. Select Yes to delete the unit, or select No to cancel the deletion and return
to FactoryTalk Batch Equipment Editor.

See also

Link unit instances on page 153

Share units on page 153

152 Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017
Unit overview Chapter 13

Link unit instances Links define the upstream and downstream relationships between units within a
process cell. The FactoryTalk Batch Server uses the links to determine which units
are available for selection when defining equipment requirements for procedures.

To link unit instances:

1. Select Start, point to All Programs > Rockwell Software > FactoryTalk
Batch Suite > FactoryTalk Batch, and then select Equipment Editor.

2. Select Link Units ( ). The cursor changes to +.

3. Select and hold the mouse button on the source unit icon. Drag the cursor
to the destination unit icon, and release the mouse button.

4. Repeat step 2 until all units link as needed.

See also

Share units on page 153

Share units When more than one process cell requires a single unit instance, it must be shared
by all process cells that require it. Create the unit instance in one process cell. This
unit instance is shared by the other process cell(s). Do not create a new instance of
the same unit in the other process cells. Before sharing a unit instance, verify that
the unit can physically be shared.

A unit may have only one owner at a time. Sharing a single unit allows any of the
shared process cells to gain ownership of it during batch execution. But the unit
cannot be owned by more than one process cell at the same time.

When a unit instance is shared, any changes made to it are reflected in each process
cell that contains the shared unit instance, including its physical placement in the
Design View area. When deleted an instance of a shared unit from one process
cell, the unit instance is removed from the selected process cell, but it is still
present in any other process cells to which it belongs.

Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017 153
Chapter 13 Unit overview

To share units:

1. Select Start, point to All Programs > Rockwell Software > FactoryTalk
Batch Suite > FactoryTalk Batch, and then select Equipment Editor.

2. Create the unit to share.

3. Move to the process cell that does not contain this unit.

4. Select Share. The Share Unit Between Process Cells dialog box displays
with a list of existing process cells.

• A plus sign (+) to the left of the process cell indicates defined units
within that process cell. The lack of a plus sign or minus sign to the left
of a process cell indicates that no defined units are within that process
cell.
• Display the units in each process cell by selecting the plus sign (+) for
the appropriate process cell folder.

5. Select the unit to share, and select OK.

The Share Unit Between Process Cells dialog box closes. The icon of the
selected unit, with a small hand at the bottom left corner, displays in both
process cells.

Tip: Deleting an instance of a shared unit only deletes the link to that unit. The unit is not deleted until the last
instance of the unit is deleted.

See also

Link unit instances on page 153

154 Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017
Unit overview Chapter 13

Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017 155
 Chapter 14

Tags overview

FactoryTalk Batch uses tags to communicate with the process-connected device

(PCD). For OPC and RSLinx Enterprise FactoryTalk Live Data phases, define
tags in the area model equipment database. Area model tags point to a specific
memory address or tag in the PCD. The FactoryTalk Batch Server and the PCD
exchange information and communicate through these tags.

Tip: For PhaseManager phases assigned to a Logix5000 CIP data server, do not define
tags. The tags create automatically when the area model synchronizes with the
Logix Designer project.

The area model has two categories of tags:

• Tags associated with a unit

• Tags associated with a phase

Unit attribute tags are items in the area model database that represent a single
piece of PCD information. Unit attribute tags link to a process tag such as a level,
temperature, or flow process variable. Unit attribute tags allow actual process
values in recipe transition conditions.

A phase uses phase tags to communicate with the engineered logic in the PCD.
Every phase has a minimum of ten standard tags with which it is associated. When
defining the phase class from which an OPC or RSLinx Enterprise FactoryTalk
Live Data phase is created, indicate the number of tags required for parameter and
report communications, as well as additional tags for requests from the PCD to
the FactoryTalk Batch Server.

See also

Unit attribute tags on page 158

Create a unit attribute tag on page 161

Phase tags on page 164

Global unit attribute on page 168

Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017 157
Chapter 14 Tags overview

Unit attribute tags Unit attribute tag instances create at the time of unit instance configuration. Unit
attributes (such as LEVEL_PV) organize Unit attribute tag instances (such as
LI101_PV). Each unit attribute tag instance links to a specific tag in the
process-connected device (PCD).

Important: Each unit can have only one unit attribute tag instance of each unit attribute.

A defined unit attribute tag instance is part of the area model database and can be
used in recipe transition conditions for any recipe. In other words, the unit
attribute tag instance can be used in a recipe that is bound to any unit in the area
model (not just the unit for which the unit attribute tag was defined).

Tip: Prior to creating the unit attribute tags, compile a list of data servers and tag addresses to which
FactoryTalk Batch connects. Create unit attribute tags that have an OPC or RSLinx Enterprise FactoryTalk
Live Data server as their data source. Create unit attribute tags that represent tag information from a
Logix5000 CIP data server.

See also

Add a unit attribute on page 158

Edit a unit attribute on page 160

Delete a unit attribute on page 160

Create a unit attribute tag on page 161

Add a unit attribute Use these instructions to add a unit attribute.

To add a unit attribute:

1. Select Start, point to All Programs > Rockwell Software > FactoryTalk
Batch Suite > FactoryTalk Batch, and then select Equipment Editor.

2. Select Edit > Unit Attributes.

158 Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017
Tags overview Chapter 14

3. Select Add.

4. In Name, type a name for the new attribute.

5. From the Type list, select the appropriate tag type.

6. If the tag type is Enumeration, select the appropriate enumeration name

from the Enumeration list.

7. Type the Engineering Units used for the tag.

8. (optional) Type a Description of the attribute.

9. Select OK to return to the Edit Unit Attributes dialog box.

10. Continue adding unit attributes, or select OK to exit. All changes are saved.

See also

Unit attribute tags on page 158

Edit a unit attribute on page 160

Delete a unit attribute on page 160

Create a unit attribute tag on page 161

Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017 159
Chapter 14 Tags overview

Edit a unit attribute Use these instructions to edit a unit attribute.

Important: Deletion or modification of global unit attributes may invalidate existing global
unit binding expressions. Therefore, all global unit binding expressions
configured in the area model are revalidated when OK is selected. If any
expression is found to be invalid, open the Global Unit Binding
Requirements dialog box to correct them.

To edit a unit attribute:

1. Select Start, point to All Programs > Rockwell Software > FactoryTalk
Batch Suite > FactoryTalk Batch, and then select Equipment Editor.

2. Select Edit > Unit Attributes.

3. Under Attributes, select an attribute and select Edit.

4. On the Edit Unit Attribute dialog box, modify as needed and then select
OK to return to the Edit Unit Attributes dialog box.

See also

Delete a unit attribute on page 160

Create a unit attribute tag on page 161

Delete a unit attribute Use these instructions to delete a unit attribute.

To delete a unit attribute:

1. Select Start, point to All Programs > Rockwell Software > FactoryTalk
Batch Suite > FactoryTalk Batch, and then select Equipment Editor.

2. Select Edit > Unit Attributes.

3. Under Attributes, select an attribute and select Remove.

4. To delete all tags and the selected attribute, select Yes.

5. To cancel the removal, select No.

See also

Create a unit attribute tag on page 161

160 Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017
Tags overview Chapter 14

Create a unit attribute tag Use these instructions to create a unit attribute tag.

To create a unit attribute tag:

1. Select Start, point to All Programs > Rockwell Software > FactoryTalk
Batch Suite > FactoryTalk Batch, and then select Equipment Editor.

2. In the Design View area, right-click the appropriate unit.

3. Select Attribute Tags tab.

4. Under Unit Attribute Tags, select Add.

• If a unit attribute exists, the Create Unit Attribute Tag dialog box
opens. Otherwise, a prompt to create a unit attribute displays. If so,
select Yes, and follow instructions in Add a unit attribute.

5. In Name, type the unit attribute tag name.

6. From Attribute, select the appropriate unit attribute.

7. From Type, select the appropriate tag type.

If the tag type is Enumeration, from Enumeration, select the appropriate

enumeration name.

Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017 161
Chapter 14 Tags overview

8. In Engineering Unit, type the engineering units used for the tag.

9. If Static is selected, in Value, type the unit attribute tag value.

Tip: The value of a dynamic unit attribute tag is held in the PCD. The value of a static unit attribute tag is held in
the FactoryTalk Batch Server.

10. If Dynamic is selected:

a. From Data Server, select the appropriate data server. The

corresponding data server type automatically appears in Server
Type.

Tip: Only OPC and RSLinx Enterprise FactoryTalk Live Data servers appear in the selection list. Logix5000 CIP
data servers are not displayed.
b. In Access Path, type the appropriate access path.

c. In Item Name, type the appropriate item name.

d. If the data server requires separate read and write items, in Write
Access Path, type the write access path.

e. If the data server requires separate read and write items, in Write
Item Name, type the write item name.

11. Select OK to return to the Attribute Tags tab.

See also

Unit Attribute Tags dialog box on page 163

Add a unit attribute on page 158

162 Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017
Tags overview Chapter 14

Unit Attribute Tags dialog box A unit attribute tag represents the value of a unit attribute for a specific unit. In
previous releases of FactoryTalk Batch, unit attribute tags were known as unit
tags.

When creating a unit attribute tag, these items are configured in the Create Unit
Attribute Tags dialog box.

Name Purpose
Name Tag name for the unit attribute. Follow the naming conventions.
Attribute Lists the unit attribute name options for the unit attribute tag.
Type Lists the data type selections for the unit attribute tag. Valid types include:
• Real
• Integer
• String
• Enumeration

Enumeration Lists the appropriate enumeration selections. This list is only enabled if the tag type is
Enumeration.
Engineering Unit The engineering units associated with this tag.
Data Source Defines the type of data source, Static or Dynamic.
• If data source is Static, the data is a constant value. The value entered here depends on
the engineering units assigned and associates with a particular unit.
• If data source is Dynamic, the value comes from the PCD, and the data server information
must be defined.
Data Server Displays the data server from which the tag is acquiring data. This list includes all configured
data servers for the active area. Only OPC and RSLinx Enterprise FactoryTalk Live Data servers
display in the selection list. Logix5000 CIP data servers are not displayed.
Server Type Displays the server type that corresponds with the selected data server as defined in the data
server definition (DSDF) files (view-only).
Access Path The access path used with the read item when attempting to subscribe to the tag value or
when performing read operations. This box changes to Read Item Access Path when the
associated data server requires separate read and write items. This is disabled if the data
server does not require an access path.
Item Name The name of the item used when subscribing to a tag value or when performing read
operations. This box changes to Read Item Name when the associated data server requires
separate read and write items.
Write Access Path The OPC access path for the write item. This disables if the data server does not require
separate read and write items.
Write Item Name The item name in the write items process-connected device. This disables if the data server
does not require separate read and write items or does not require an access path.

See also

Create a unit attribute tag on page 161

Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017 163
Chapter 14 Tags overview

Phase tags The number of tags associated with an OPC or RSLinx Enterprise FactoryTalk
Live Data phase depends on the phase class configuration from which the phase is
created. Every phase has a minimum of ten standard tags. When defining the
phase class from which the OPC or RSLinx Enterprise FactoryTalk Live Data
phase is created, define additional tags required for parameter and report
communication as well as additional request tags for requests from the
process-connected device (PCD) to the FactoryTalk Batch Server.

A Request tag is one of the ten standard tags associated with every phase and is
used for the PCD to request service from the server. Occasionally, the PCD needs
to communicate more information to the server than can be accommodated by the
single standard Request tag. Specify, on the phase class, the number of additional
request tags needed for the phase.

If configured the phase class to require any of these additional tags, create
corresponding tags in the OPC or RSLinx Enterprise FactoryTalk Live Data
phase.

Tip: For PhaseManager phases assigned to a Logix5000 CIP data server, do not configure additional request
tags. All required tags automatically create for Logix5000 CIP phases when the area model synchronizes
with the Logix Designer project. FactoryTalk Batch Equipment Editor creates the same number of
parameter tags as parameters that exist on the phase class, and the same number of report tags as reports
that exist on the phase class.

See also

Edit tags from the menu on page 165

Default equipment names on page 166

164 Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017
Tags overview Chapter 14

Edit tags from the menu The Edit Tags dialog box lists all of the tag classes configured for the selected area
model, along with the associated tags.

To edit tags from the menu:

1. Select Start, point to All Programs > Rockwell Software > FactoryTalk
Batch Suite > FactoryTalk Batch, and then select Equipment Editor.

2. Select Edit > Tags.

3. Under Tag Classes, select the appropriate tag class.

4. Under Tags, select the tag to edit

5. Select Edit Tag. The Edit [TagType] Tag dialog box displays, where
[TagType] represents the type of tag being edited (phase or unit).

Tip: Instruction-based tags are view-only.

6. Modify as needed and then select OK.

See also

Phase tags on page 164

Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017 165
Chapter 14 Tags overview

Default equipment names When creating a phase from a phase class in the area model, the default phase
name is <phasename>1. For example, if the phase is AGITATE, the phase creates
from this phase class with the default name of AGITATE1.

The phase's tag items the default name is: <Equipment Module Name>< Tag
Separator><Tag Extension>

For example, if the tag separator is a period (.), the Request tag (RQ) for phase
AGITATE1 would be: AGITATE1.RQ

If the phase name changes, the tag item names do not automatically change to
reflect the new phase name. For example, if the phase name changes from
AGITATE1 to AGITATE_U2, the tag Names reflect the new name
(AGITATE_U2), but the tag Item Names still reflect the original name of the
phases (AGITATE1). The example request tag for the AGITATE_U2 phase
would still be AGITATE1.RQ.

When a phase creates from a phase class in the area model, the tag access path is
the Default Item Access Path specified for the assigned data server. Change the
Access Path for an individual tag on the Edit Phase Tag dialog box.

See also

Set all tag items to default name and access path on page 167

Edit tags from the menu on page 165

166 Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017
Tags overview Chapter 14

Set all tag items to default name and Use these instructions to globally change all the tag Item Names in the area model
access path to reflect the names of their respective phases and reset the Access Path of each
phase tag to the Default Item Access Path specified for its data server.

Tip: To change the tag names for only a single phase, change them on the Tags tab of the phase.

To set all tag items to default name and access path:

1. Select Start, point to All Programs > Rockwell Software > FactoryTalk
Batch Suite > FactoryTalk Batch, and then select Equipment Editor.

2. Select Edit > Set Default Tag Items.

This is an irreversible action! Once selected, all tag item names and access paths are automatically
changed.

3. Select OK to continue.

A message displays indicating all tag items have been set to the tag name and
access paths have been reset.

4. Select OK to return to the Design View area.

Tip: The default character (tag separator) that separates the phase tag item name from its extension may vary
depending on the tag separator defined in the batcheqp.ini file. The available characters are the
underscore ( _ ), slash ( / ), or period ( . ). If changed, the default character is not overridden.

See also

Set tag items to the default addresses on page 216

Phase overview on page 205

Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017 167
Chapter 14 Tags overview

Global unit attribute FactoryTalk Batch associates units within unit classes that represent the common
functionality of all the units in the class. This allows for the construction of
class-based recipes, built against a unit class(es). This aggregation of common
functionality allows for the authoring of recipes that can run against any instance
of the unit class (with the exception of flowpath requirements and FactoryTalk
Batch Material Manager functionality).

However, the set of functionality common across all instances of a unit class may
be so small as to not allow for the creation of useful class-based recipe structures.
There is likely to be significant commonality among some reactors that does NOT
extend to the entire set. For example, some subset of reactors may contain
agitators. Other subset of reactors may contain temperature sensors.

Also, there may be attributes of a unit, such as materials of construction, or

temperature, that make it acceptable, unacceptable, desirable, or undesirable for
use with certain recipes. The batch product has no mechanism for specification or
enforcement of these requirements.

The ability to build class-based recipes that utilize subsets of commonality would
be extremely useful in this case. Global unit attributes provides the ability to build
class-based recipes that utilize subsets of commonality. A global unit attribute is a
unit attribute configured to be automatically applied to all unit classes defined
within the area model. This saves the area model author the effort of having to
manually assign a custom unit attribute to every unit class.

See also

Create a global unit attribute on page 169

Edit a global unit attribute on page 171

Delete a global unit attribute on page 171

Remove a global unit attribute on page 172

168 Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017
Tags overview Chapter 14

Create a global unit attribute Use these instructions to create a global unit attribute.

To create a global unit attribute:

1. Select Start, point to All Programs > Rockwell Software > FactoryTalk
Batch Suite > FactoryTalk Batch, and then select Equipment Editor.

2. Select Edit > Unit Attributes. When an attribute is selected, it populates

with the associated attribute tags. The first attribute tag is selected by
default.

3. Under Attributes, select Add to open the Create Unit Attribute dialog
box.

4. In Name, type a name for the new unit attribute.

5. From Type, select the appropriate tag type.

• If the tag type is Enumeration, select the appropriate enumeration

name from the Enumeration list.

6. In Engineering Units, type the engineering units used for the tag.

7. In Description, type a description of the tag class.

Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017 169
Chapter 14 Tags overview

8. To be a global unit attribute that is applied to all new units, select Global
Attribute.

Tip: If Global Attribute is selected, all unit classes within the area model, both existing and newly created, are
associated with that unit attribute. In addition, all unit instances within the area model, both existing and
those subsequently created, contain a unit attribute tag instance.

9. Select OK to return to the Edit Unit Attributes dialog box.

The new attribute is listed under Attributes. If it is a global unit attribute, it

is associated with all existing unit classes. Attributes and attribute tags are
upper-case and in alphabetic order.

See also

Edit a global unit attribute on page 171

170 Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017
Tags overview Chapter 14

Edit a global unit attribute Use these instructions to edit a unit attribute.

To edit a global unit attribute:

1. Select Start, point to All Programs > Rockwell Software > FactoryTalk
Batch Suite > FactoryTalk Batch, and then select Equipment Editor.

2. Select Edit > Unit Attributes.

3. Under Attributes, select an attribute and select Edit.

4. Make the required modifications, and select OK to return to the Edit Unit
Attributes dialog box.

See also

Delete a global unit attribute on page 171

Remove a global unit attribute on page 172

Delete a global unit attribute Use these instructions to delete a unit attribute.

To delete a global unit attribute:

1. Select Start, point to All Programs > Rockwell Software > FactoryTalk
Batch Suite > FactoryTalk Batch, and then select Equipment Editor.

2. Select Edit > Unit Attributes.

3. Under Attributes, select a unit attribute and select Remove.

A warning displays to verify the removal of all the unit attribute tags of the
unit attribute.

4. To delete all attribute tags and the selected unit attribute, select Yes.

5. To cancel the removal, select No.

See also

Remove a global unit attribute on page 172

Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017 171
Chapter 14 Tags overview

Remove a global unit attribute Use these instructions to remove a global unit attribute.

To remove a global unit attribute:

1. Select Start, point to All Programs > Rockwell Software > FactoryTalk
Batch Suite > FactoryTalk Batch, and then select Equipment Editor.

2. Select Edit > Unit Attributes.

3. Under Attributes, select the unit attribute that to edit and select Edit.

4. Clear the Global Attribute check box, and then select OK.

5. To remove the unit attribute, select Yes.

6. To cancel the removal, select No.

See also

Delete a global unit attribute on page 171

Create a global unit attribute on page 169

172 Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017
 Chapter 15

Phase class overview

A phase class is a reusable, process-oriented function. A phase class is usually a

general representation of a group of equipment that performs a minor processing
activity or a sub-function for a unit but does not describe the details of how that
activity is accomplished. Examples of phase classes include Heat, Agitate, Add, and
Transfer.

Phase classes may have associated parameters and reports. Each phase class
contains attributes common to all phases of that specific phase class type. Phase
classes are used to create recipes in FactoryTalk Batch Recipe Editor.

An instance of a phase class is a phase. Every phase inherits attributes of the phase
class from which it is created. Phase classes and phases link the engineered logic in
the process-connected device (PCD) to the recipe. A phase class describes the
recipe phase, while the phase maps to the equipment operation or equipment
phase in the engineered logic.

Tip: For PhaseManager phases assigned to a Logix5000 CIP data server, do not define the number of
parameter, report, and request tags. The required tags automatically configure when the area
model synchronizes with the Logix Designer.

Every OPC or RSLinx Enterprise FactoryTalk Live Data phase automatically

assigns ten standard tags to communicate with the engineered logic in the PCD.
When defining the phase class from which an OPC or RSLinx Enterprise
FactoryTalk Live Data phase is created, indicate the number of tags required for
parameter and report communications, as well as additional tags for requests from
the PCD to the FactoryTalk Batch Server.

See also

Tags on page 174

Create and configure phase classes on page 175

Verification policies on page 193

Material-enabled phases on page 201

Disable material on a material-enabled phase on page 202

Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017 173
Chapter 15 Phase class overview

Tags One of the ten standard tags associated with every OPC or RSLinx Enterprise
FactoryTalk Live Data phase is a Request tag. The process-connected device
(PCD) uses the Request tag to request service from the FactoryTalk Batch Server.
Sometimes, for OPC and RSLinx Enterprise FactoryTalk Live Data phases, the
PCD needs to communicate more information to the FactoryTalk Batch Server
than can be accommodated by the single standard Request tag. For this purpose,
specify on the phase class, the number of additional request tags needed for the
phase.

Tip: For PhaseManager phases assigned to a Logix5000 CIP data server, do not configure request tags. The tags
automatically create for Logix5000 CIP phases the area model synchronizes with the Logix Designer.
FactoryTalk Batch Equipment Editor creates the same number of parameter tags as parameters that exist
on the phase class, and the same number of report tags as reports that exist on the phase class.

See also

Configure general attributes on page 176

174 Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017
Phase class overview Chapter 15

Create and configure phase Use the Create Phase Class dialog box to create and configure phase classes.

classes To create and configure phase classes:

1. Select Start, point to All Programs > Rockwell Software > FactoryTalk
Batch Suite > FactoryTalk Batch, and then select Equipment Editor.

2. Select a unit icon and then select Go Down ( ). The Design View area
may display the Unit icon, and Classes displays as the column header in the
Classes View area.

3. Select Add New Object ( ) and then select New Phase Class.

4. In the Create Phase Class dialog box, use the tabs to configure the phase
class:

• General
• Parameters
• Reports
• Messages
• Control Strategy (this tab is only available if the Control Strategy box
is enabled on the General tab)

5. Select OK. The new phase class displays in the phase class list.

Tip: To edit the phase class, right-click the phase class to open the Edit Phase Class dialog box.

See also

Configure phase class general attributes on page 176

Configure phase class control strategies on page 190

Configure phase class messages on page 189

Configure phase class parameters on page 179

Configure phase class reports on page 184

Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017 175
Chapter 15 Phase class overview

Configure phase class general Use the Create Phase Class dialog box General tab to configure the phase class
attributes general attributes.

To configure phase class general attributes:

1. Select Start, point to All Programs > Rockwell Software > FactoryTalk
Batch Suite > FactoryTalk Batch, and then select Equipment Editor.

2. With the Create Phase Class dialog box open, select the General tab.

3. In Name, type an appropriate phase class name.

4. In Type, type a phase class type.

Tip: Use names that can easily be understood. Phase class names display to the operator during batch
execution.
a. Under Icon, select an appropriate icon. (If the icon area is empty, see
Verify icon paths.)

b. Under Additional Functionality, do the following:

• Select Control Strategy to indicate whether control strategies are

used for the phase class.
• (optional) If FactoryTalk Batch Material Manager is installed,
select Material Based Recipes to indicate whether the phase class
is material-enabled.
c. Under Parameter/Tag Locking, enable or disable locking for
parameters and tags.

• To edit the number of parameter and report tags associated with

the phases created from this phase class, disable Parameter/Tag
Locking. This option only applies to OPC and RSLinx Enterprise
FactoryTalk Live Data phases created from this phase class. For
Logix5000 CIP phases, Parameter/Tag Locking is always enabled,
regardless of the setting selected.
• If Parameter/Tag Locking is enabled, the Parameter and Report
boxes are disabled and display the number currently enforced by
Parameter/Tag Locking.
• Under Number of Tags, edit the number of tags in Parameter and
Report and enter the appropriate number of tags in Request.

176 Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017
Phase class overview Chapter 15

d. Under Message Partners, in Number, type the appropriate number.

Tip: If the phase class is in a phase link group for communication or synchronization
purposes, first configure the correct number of message partners on the phase
class in the area model.

5. Select Apply to save changes, or select OK to save changes and return to the
Classes View area.

The selected icon displays in the Classes View area.

See also

Create Phase Class dialog box - General tab overview on page 178

Verify icon paths on page 135

Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017 177
Chapter 15 Phase class overview

Create Phase Class dialog box - The phase class general attributes include the phase class name, phase class type,
General tab the number of phase class message partners, and the number of tags associated
with each phase. Select an icon to graphically represent all phases throughout the
area model based on the phase class. Enable or disable the use of control strategies
and material-based recipes for the phase class.

The General tab contains:

Name Purpose
Icon area Displays all of the icons available for selection. Scroll through the icons using the
scroll bar or the up and down arrows in the vertical scroll bar.
Name The name of the phase class.
Type An optional box that can be used to categorize phase classes for reporting
purposes.
Control Strategy Enables the use of separate control strategies for the phase class.
Material Based Recipes (Used with FactoryTalk Batch Material Manager.) Enables the binding of
material references to actual equipment. This makes the phase class a
material-enabled phase class.
Parameter/Tag Locking To have the number of parameters and reports on the phase class to always equal
the number of parameter tags and report tags on the associated phase classes,
enable Parameter/Tag Locking on the phase class.
If Parameter/Tag Locking is disabled, specify on the phase class the number of
tags for the parameters and reports that exist on the associated OPC or RSLinx
Enterprise FactoryTalk Live Data phases. This number may be different from the
number of defined phase class parameters and reports 1for OPC and RSLinx
Enterprise FactoryTalk Live Data phases.
Number of Parameter Tags The number of memory registers within the phase to which FactoryTalk Batch can
write parameter information. Generally equivalent to the number of parameters
defined for the phase class.
Number of Report Tags The number of memory registers within the phase from which FactoryTalk Batch
can read report tag information. Generally equivalent to the number of reports
defined for the phase class.
Number of Request Tags The number of memory registers within the phase to which the phase logic can
write request information.
Number of Message Partners Message partners are two or more phases that need to communicate with each
other during the execution of their respective phase logic for synchronization and
timing purposes. In FactoryTalk Batch Recipe Editor, message partners are
organized into Link Groups that inform the FactoryTalk Batch Server which phases
require messaging.
If the phase is in a phase link group for communication or synchronization
purposes, this is the number of additional phases with which the phase must be
linked in order to operate properly.
Tip: Define the message partners in FactoryTalk Batch Equipment Editor
before defining the corresponding phase link groups in FactoryTalk
Batch Recipe Editor.

See also

Configure general attributes on page 176

178 Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017
Phase class overview Chapter 15

Configure phase class Use the Create Phase Class dialog box Parameters tab to configure phase class
parameters.
parameters
Tip: Use the keyboard to move around in the grid. Pressing the Tab key moves focus to the grid. Pressing
Ctrl+Alt+Home highlights the first editable cell in the grid.

To configure phase class parameters:

1. Select Start, point to All Programs > Rockwell Software > FactoryTalk
Batch Suite > FactoryTalk Batch, and then select Equipment Editor.

2. With the Create Phase Class dialog box open, select the Parameters tab. A
list displays of parameters associated with the phase class.

Tip: If control strategies are enabled for the phase class, the Control Strategy list displays at the top of the
Parameters tab. Only phase class parameters associated with the control strategy selected in the Control
Strategy list are listed. If <All> is selected, then the High, Low, Default, or Enum/E.U. boxes are not
editable for the phase class parameters. The material parameters, including the optional material
parameters (if enabled), are added to each control strategy created. Edit the values for the MATERIAL,
MATERIAL_CLASS and AMOUNT material parameters for each configured control strategy.

3. Select Add Parameter to add a new phase class parameter. A new parameter
displays with default values.

4. Under Name, type a unique name for the parameter.

5. Under Type, select the appropriate parameter type.

• If the Type is Real or Integer, add the High value, Low value, and
Default value, then type the engineering units in the Enum/E.U. box.
• If the Type is Enumeration, choose the appropriate enumeration set
from the Enum/E.U. list and select the appropriate default
enumeration from the Default list.
• If the Type is String, type the engineering units in the Enum/E.U. box
and the default string in the Default box.

Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017 179
Chapter 15 Phase class overview

6. If the parameter must scale within a recipe when a batch scales, select the
Scale check box. (See Scale parameters for more information.)

Tip: The DL on Start and DL on TOC check boxes are unavailable if not enough parameter tags are specified in
Number of Parameter Tags on the General tab. Specify as many parameter tags as actual parameters
to have these check boxes available for each parameter.

7. To add the parameter to the download on start subset, select the DL on

Start check box.

8. To add the parameter to the download on transfer of control subset, select

the DL on TOC check box.

Tip: Material-enabled phase classes do not support transfer of control.

9. To assign a context or descriptor to the phase class parameter for the recipe,
select one or more Context IDs from the Reporting Contexts column.

10. To require electronic signatures or generate deviation events in the

FactoryTalk Batch event journal when deviations from the accepted range
of parameter values occur, see Configure the verification policy for
parameters and reports for instructions.

11. To delete a parameter, select the parameter row header and select Delete
Parameter. Select Yes to confirm the deletion.

12. Select Apply to save changes, or select OK to save changes and return to the
Classes View area.

See also

Create Phase Class dialog box - Parameters tab overview on page 181

Scale parameters on page 53

Select context IDs on page 188

Configure the verification policy for parameters and reports on page 195

180 Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017
Phase class overview Chapter 15

Create Phase Class dialog box - Phase class parameters values pass from the FactoryTalk Batch Server to the phase
Parameters tab logic during the execution of a recipe phase. For PhaseManager phases, which use
a Logix5000 CIP data server, the phase definition includes its parameters. For
other data servers, a phase parameter is defined for the phase class, and a
corresponding parameter tag and tag address is configured in the
process-connected device.

The verification methods of parameter values can be configured for real or integer
phase parameters. The verification methods define the policies for verifying up to
three sets of high and low limits of the parameter. They also define the actions to
be taken if the parameter value falls outside the configured limits.

If Material Based Recipes is enabled, two parameters, MATERIAL and

AMOUNT, can be defined. Add these optional parameters for material-enabled
phases: CONTAINER, LOT, LABEL, and MATERIAL_CLASS.

Tip: If the FactoryTalk Batch Material Manager material database is unavailable, the MATERIALS and
CONTAINERS enumeration sets are read from the Material Server when the FactoryTalk Batch Server starts
up, and only contain the default enumerations.

The Parameters tab contains:

Name Purpose
Control Strategy A list of configured control strategies used to filter the displayed parameters. Separate
control strategies can be selected from the list or all control strategies can be viewed
at the same time. This list is only visible if Control Strategy is enabled.
Add Optional Material Enables the optional material-based recipe parameters (CONTAINER,
Parameters MATERIAL_CLASS, LOT, and LABEL). This check box is only visible if Material Based
Recipes is enabled. This check box only enables if <All> is selected in the Control
Strategy list.
Name The name of the phase class parameter. The name of the material parameters
(MATERIAL, AMOUNT, CONTAINER, LOT, or LABEL) cannot be edited.
ID The identification number of the phase class parameter. If Control Strategy is
enabled after parameters have been defined, the IDs are increased by one, as the
control strategy itself always has the parameter ID of 1.
For material-enabled phases, parameter ID fills in the first available integer greater
than zero. The MATERIAL parameter is the first of the Material Based Recipe
parameters to be assigned an ID (view-only).
Type The phase parameter data type: Real, Integer, String, and Enumeration.
The data type for material-enabled phase parameters cannot be modified:
• MATERIAL, MATERIAL_CLASS and CONTAINER = ENUM
• AMOUNT = REAL
• LOT and LABEL = STRING
Max The maximum limit for the phase parameter. Defaults to 100.

Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017 181
Chapter 15 Phase class overview

Name Purpose
Min The minimum limit for the phase parameter. Defaults to zero (0).
• Addition: Low = 0, High = positive number
• Distribution: Low = negative number, High = 0
• Both: Low = negative number, High = positive number
Tip: For the material-enabled phase parameter AMOUNT, the Min and Max values specify whether the phase is a
material addition, distribution, or both.
Default The default value for the phase parameter. Defaults to zero (0). The value must be set
between the Min and Max values. If a Verification Method of High/Low,
High-High/Low-Low, or High-High-High/Low-Low-Low is selected, the default value
must be within the high and low values.
For material-enabled phases, these are the defaults:
• MATERIAL defaults to NULL_MATERIAL
• MATERIAL_CLASS defaults to NULL_CLASS
• CONTAINER defaults to NULL_CONTAINER
The default value for the CONTAINER, LOT, or LABEL parameters cannot be modified.
Enum/E.U. The engineering units for the phase parameter. If the parameter Type is
Enumeration, the Enum/E.U. value is the name of the enumeration set.
Tip: The Enum/E.U. for the MATERIAL, CONTAINER, LOT, LABEL, or
MATERIAL_CLASS material-enabled phase parameters cannot be
modified.
Scale Indicates whether the phase parameter is scalable with a recipe at batch creation
time.
DL on Start If selected, the parameter can be downloaded by the FactoryTalk Batch Server in
these situations:
• When the phase logic requests the download.
• When the phase is configured to automatically download on the START command.
See Phase overview for more information.)
DL on TOC If selected, the parameters are downloaded by the FactoryTalk Batch Server when a
transfer of control takes place on the phase, when the phase logic requests the
download.
Material-enabled phase classes do not support transfer of control.
Reporting Contexts Reporting contexts allows defining associations between a parameter and a set of
context IDs. The defined context IDs are recorded by the FactoryTalk Batch Server in
the Context ID box of the batch event journal records, whenever a parameter event
logs. The default value for a new parameter is a null string. Select browse ( ) to
open the Reporting Contexts dialog box, to select one or more context strings to be
used for the particular parameter. Context IDs are members of the
REPORTING_CONTEXTS enumeration set.

182 Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017
Phase class overview Chapter 15

Name Purpose
Verification Method The part of the verification policy that defines the set of acceptable limits for a
parameter or report. The phase parameter type must be Real or Integer.
No Limits: To configure a verification policy to enact when the parameter or report
value is within the Minimum and Maximum limits. Also select this option to not use
verification policies.
High/Low: Allows configuration of up to two verification policies. In addition to the
No Limits policy, specify a High and Low limit and a separate verification policy to use
when the parameter or report value exceeds the High limit or falls short of the Low
limit.
High-High/Low-Low: Allows configuration of up to three verification policies. In
addition to the No Limits policy and the High/Low policy, specify a second higher
limit, a second lower limit, and a separate verification policy to use when the
parameter or report value exceeds this second High limit or falls short of this second
Low limit.
High-High-High/Low-Low-Low: Allows configuration of up to four verification
policies. In addition to the No Limits policy, the High/Low policy, and the
High-High/Low-Low policy, specify a third higher limit, a third lower limit, and a
separate verification policy to use when the parameter or report value exceeds this
third High limit or falls short of this third Low limit.
Add Parameter Adds a new parameter to the list.
Delete Parameter Removes the selected parameter from the list.

See also

Configure phase parameters on page 179

Area model data servers on page 97

Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017 183
Chapter 15 Phase class overview

Configure phase class reports Use the Create Phase Class dialog box Reports tab to configure phase class
reports. A phase class report is defined for the phase class, while the corresponding
report tag, including the address or tag in the process-connected device, is defined
for the phase.

To configure phase class reports:

1. Select Start, point to All Programs > Rockwell Software > FactoryTalk
Batch Suite > FactoryTalk Batch, and then select Equipment Editor.

2. With the Create Phase Class dialog box open, select the Reports tab. A list
of phase class reports associated with the phase class is shown.

Tip: Use the keyboard to move around in the grid. Pressing the Tab key moves the focus in the grid.
Pressing Control+Alt+Home highlights the first editable cell in the grid.

3. Select Add Report to add a new phase class report.

A new report displays with default values.

a. Under Name, type a unique name for the report parameter.

b. Under Type, select the appropriate parameter type.

• If Type is REAL, STRING, or INTEGER, type the engineering

units in Enum/E.U. If control strategies are enabled, edit the
Enum/E.U. value for each configured control strategy.
• If Type is ENUM, select the appropriate enumeration set in
Enum/E.U.
Tip: If there are not enough report tags specified on the General tab in the Number of
Report Tags box, the UL on Terminal State and UL on TOC check boxes are
unavailable. Specify as many report tags as actual reports to have these check boxes
enabled for each report.
c. Under Accumulate, select how the FactoryTalk Batch Server handles
uploaded report values. These are the valid values:

• None
• Phase
• Batch

184 Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017
Phase class overview Chapter 15

d. To add the report to the upload on terminal state subset, select UL on

Terminal State.

e. To add the report to the upload on transfer of control subset, select UL

on TOC.

Tip: Material-enabled phase classes do not support transfer of control.

f. To assign a context or descriptor to the report parameter, from the

Reporting Contexts column, select one or more Context IDs.

g. To require electronic signatures or generate deviation events in the

FactoryTalk Batch event journal when deviations from the accepted
range of parameter values occur, see Configure the verification policy
for parameters and reports for instructions.

h. (optional) In ERP Alias, type the SAP R/3 report name.

4. To delete a report, select the report row header and select Delete Report.
Select Yes to confirm the deletion.

5. Select Apply to save changes, or select OK to save changes and return to the
Classes View area.

See also

Configure the verification policy for parameters and reports on page 195

Create Phase Class dialog box - Reports tab overview on page 186

Select context IDs on page 188

Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017 185
Chapter 15 Phase class overview

Create Phase Class dialog box - Phase class reports values pass from the process-connected device (PCD) to the
Reports tab FactoryTalk Batch Server. Report values contain data that indicates how the phase
functioned. They are included in the event journal file (.evt) for the running batch
and can be included in batch reports. For PhaseManager phases, which use a
Logix5000 CIP data server, the phase definition includes its reports. For other
data servers, a phase report is defined for the phase class, and a corresponding
parameter tag and tag address is configured in the PCD.

The verification methods of report values can be configured for real or integer
phase class reports. The verification methods define the policies for verifying up to
three sets of high and low limits of the report. They also define the actions to be
taken if the report value falls outside the configured limits.

If Material Based Recipes is enabled, two phase class reports

(ACTUAL_AMOUNT and FEED_COMPLETE) are created automatically.

Tip: If control strategies are configured for the phase class, the Control Strategy list displays at the top of the
Reports tab. Only reports associated with the control strategy selected from the Control Strategy list are
displayed. If <All> is selected and the Type is Real, String, or Integer, then the Enum/E.U. box cannot be
edited. This must be set for each control strategy.
The material-enabled phase reports are added to each control strategy created. Edit the Enum/E.U. value
for each configured control strategy.

The Reports tab contains:

Name Purpose
Control Strategy A list of configured control strategies used to filter the displayed phase class reports.
Separate control strategies can be selected from the list or all control strategies can be
viewed at the same time. This list is only available if Control Strategy has been
enabled on the General tab.
Name The name of the phase class reports.
Tip: The name of the material phase class reports ACTUAL_AMOUNT and
FEED_COMPLETE cannot be edited.
ID The identification number of the phase class reports.
For material-enabled phase classes, parameter ID fills in the first available integer
greater than zero. The ACTUAL_AMOUNT report is the first of the Material Based
Recipe reports to be assigned an ID (view-only).
Type The report data type: Real, Integer, String, and Enumeration.
Tip: The data type for material-enabled phase reports ACTUAL_AMOUNT = REAL and
FEED_COMPLETE = ENUM cannot be modified.

Enum/E.U. If Enumeration Type is selected, shows the name of the enumeration set. Otherwise,
shows the engineering units for the report parameter.
Tip: The Enum/E.U. for the FEED_COMPLETE material-enabled phase class report
cannot be modified.

186 Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017
Phase class overview Chapter 15

Name Purpose
Accumulate Defines the phase class report parameter to add the value of uploaded values to its
current value instead of just storing it.
Changing the Accumulate setting also changes the UL on Terminal State setting:
• If the Accumulate value is set to None (Default), then the UL on Terminal State
value is on and enabled.
• If the Accumulate value is set to PHASE, then the UL on Terminal State value is
off and disabled.
• If the Accumulate value is set to BATCH, then the UL on Terminal State value is
off and disabled.
UL on Terminal State If selected, the reports are uploaded by the FactoryTalk Batch Server in these situations:
• When the phase logic requests the upload.
• When the phase is configured to automatically upload when the step changes to
COMPLETE, STOPPED, or ABORTED. (See Create a phase for more information.)
UL on TOC If selected, the report can be uploaded when a transfer of control takes place on the
phase, if the proper phase logic request is issued.
Material-enabled phase classes do not support transfer of control.
Reporting Contexts Reporting context IDs allows defining of associations between a phase report and a set
of context IDs. The defined context IDs are recorded by the FactoryTalk Batch Server in
the Context ID box of the batch event journal records, whenever a report event logs.
Select browse ( ) to open the Reporting Contexts dialog box, select one or more
context strings to be used for the particular report.
ERP Alias Used in conjunction with RSBizWare BatchERP only. The ERP alias is the SAP name for
that report. The ERP alias maps the report from FactoryTalk Batch Server to SAP.
Verification Method The part of the verification policy that defines the set of acceptable limits for a
parameter or report. The phase class parameter or report type must be Real or
Integer.
No Limits: Allows configuration of a verification policy to enact when the parameter or
report value is within the verification limits. Also select this option to not use
verification policies.
High/Low: Allows configuration of up to two verification policies. In addition to the No
Limits policy, specify a High and Low limit and a separate verification policy to use
when the parameter or report value exceeds the High limit or falls short of the Low
limit.
High-High/Low-Low: Allows configuration of up to three verification policies. In
addition to the No Limits policy and the High/Low policy, specify a second higher
limit, a second lower limit, and a separate verification policy to use when the
parameter or report value exceeds this second High limit or falls short of this second
Low limit.
High-High-High/Low-Low-Low: Allows configuration of up to four verification
policies. In addition to the No Limits policy, the High/Low policy, and the
High-High/Low-Low policy, specify a third higher limit, a third lower limit, and a
separate verification policy to use when the parameter or report value exceeds this
third High limit or falls short of this third Low limit.
Add Report Adds a new report to the phase class.
Delete Report Removes the selected report from the phase class.

See also

Create and configure phase classes on page 175

Configure phase class reports on page 184

Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017 187
Chapter 15 Phase class overview

Select context IDs Context IDs, or descriptors, can be associated with each phase class report or
parameter so that events recorded in the event journal may be more easily queried
and sorted. This association makes report generation and analysis easier.

To assign a context ID to phase class parameters or reports, select one or more

context IDs in the Create Phase Class dialog box.

Important: Context IDs are only assigned to recipe parameters and report parameters configured on
a phase class. Thus, only phase class parameters may have Context IDs and they may not
be changed within recipes.

To select context IDs:

1. With the Create Phase Class dialog box open, select the Parameters or
Reports tab. A list of phase class parameters or reports associated with the
phase class is shown.

2. Under Reporting Contexts, select browse ( ).

3. Select one or more context IDs by single-clicking on each, and then select
OK.

The selected reporting contexts are added to the report.

See also

Configure phase class parameters on page 179

Configure phase class reports on page 184

Phase overview on page 173

188 Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017
Phase class overview Chapter 15

Configure phase class messages Use these instructions to add new messages, edit existing messages, and delete
phase class messages from the list in the Create Phase Class dialog box Messages
tab.

To configure phase class messages:

1. Select Start, point to All Programs > Rockwell Software > FactoryTalk
Batch Suite > FactoryTalk Batch, and then select Equipment Editor.

2. With the Create Phase Class dialog box open, select the Messages tab. A
list of messages associated with the phase class is shown.

3. Select Add Message to add a new phase class message. A new default
message is added.

4. In the Name box, type the appropriate message.

5. In the ID box, type a message ID.

6. To delete a message, select the message row header, and then select Delete
Message. Select Yes to confirm the deletion.

7. Select Apply to save changes, or select OK to save changes and return to the
Classes View area.

See also

Create Phase Class dialog box - Message tab overview on page 190

Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017 189
Chapter 15 Phase class overview

Create Phase Class dialog box - Phase class messages are typically used for journal entry purposes and for
Messages tab troubleshooting phase logic problems. In some instances, the message displays to
the operator. A phase class message has two pieces of data associated with it: the
name and the message ID. Phase class message requests must be generated from
within the phase logic (a 30NN or 130NN request) and a corresponding phase
class message must be created in the area model for each phase class message
request.

The Messages tab contains:

Name Purpose
Name The name of the message. This text also serves as the actual phase class message.
ID The identification number of the report message.
Add Message Adds a new phase class message to the phase class.
Delete Message Removes the selected phase class message from the phase class.

See also

Configure phase class messages on page 189

Configure phase class control Use these instructions to edit the default control strategy, create new control
strategies, and delete control strategies. To remove all of the control strategies,
strategies
disable the Control Strategy option on the Create Phase Class dialog box
General tab.

Tip: The Control Strategy tab is not visible unless the Control Strategy check box is
selected in the Create Phase Class dialog box General tab.

Tip: Disabling control strategies for a phase class results in a warning message indicating the parameter
information that is lost if control strategies are disabled. Confirmation is required to complete the process.

To configure phase class control strategies:

1. Select Start, point to All Programs > Rockwell Software > FactoryTalk
Batch Suite > FactoryTalk Batch, and then select Equipment Editor.

2. With the Create Phase Class dialog box open, select the Control Strategy
tab. A list displays of control strategies associated with the phase class.

3. Select Add Control Strategy to add a new control strategy.

4. On the Create Enumeration dialog box, in the Enumeration box, type a

name for the new control strategy.

190 Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017
Phase class overview Chapter 15

5. In the Ordinal box, type the ordinal identification value for the control
strategy, or accept the default value and select OK.

The new control strategy is added.

6. For each parameter in the Parameters table, select or clear the parameter’s
check box within the column for the new control strategy.

Important: If the target parameter is removed from the same control strategy as the report, the verification
method for the report is automatically reset to No Limits.

7. For each report in the Reports table, select or clear the corresponding check
box in the column for the new control strategy.

8. From the Set Default Control Strategy list, select the appropriate control
strategy to configure that control strategy as the default for the phase class.

9. To edit or delete a control strategy, select the control strategy column and
select Edit Control Strategy or Delete Control Strategy.

10. Select Apply to save changes, or select OK to save changes and return to the
Classes View area.

See also

Create Phase Class dialog box - Control Strategy tab overview on page 192

Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017 191
Chapter 15 Phase class overview

Create Phase Class dialog box - A control strategy identifies a subset of the phase class and report parameters
Control Strategy tab configured on a phase class to be used at runtime. A control strategy value is
assigned to the phase class and only the parameters and reports of that control
strategy are available for use. A phase class can be configured to have one or more
control strategies.

Individually configure each control strategy with a subset of the defined phase class
parameters and reports. Define the value, range, and engineering unit for each
parameter, and the engineering unit for each report independently for each
control strategy. When creating master recipes using FactoryTalk Batch Recipe
Editor, specify which control strategy to use for each instance of the phase class
within the recipe.

If Material Based Recipes and Add Optional Material Parameters are enabled,
the material parameters and reports for a material-enabled phase class are added to
every control strategy created and cannot be deleted.

When the control strategy function is enabled, a default control strategy is created.

The Control Strategy tab contains:

Name Purpose
Set Default Control Strategy A list of configured control strategies for the phase class. The selected
control strategy is the default control strategy for any recipes based on the
phase class.
Parameters A table used to assign parameters to control strategies. Each row of the
table represents an associated parameter, and each column of the table
represents a different control strategy, as identified by the column header.
Parameters can be assigned or unassigned to a control strategy by selecting
or clearing the check box for the parameter in the appropriate control
strategy column. A single parameter can be assigned to multiple control
strategies.
Reports A table used to assign reports to control strategies. Each row of the table
represents an associated report, and each column of the table represents a
different control strategy, as identified by the column header. Reports can
be assigned to or removed from a control strategy by selecting or clearing
the check box for the report in the appropriate control strategy column. A
single report may be assigned to multiple control strategies.
Add Control Strategy Adds a new control strategy to the phase class.
Edit Control Strategy Edits the selected control strategy. Select the column header to select a
control strategy.
Delete Control Strategy Removes the selected control strategy from the phase class.

See also

Configure control strategies on page 190

192 Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017
Phase class overview Chapter 15

Verification policies Configure a separate verification policy for each parameter and report designated
as a Real or Integer type.

Tip: A verification policy for String or Enumeration parameters or reports cannot be

configured. The Verification Policies dialog box still displays for Strings and
Enumerations, but all boxes are view-only.

The Verification Method consists of four verification levels:

• No Limits: The selected policy is enacted when the parameter or report

value is within the deviation limits.
• High/Low: The options selected in this area describe the actions to be
taken when the parameter or report value is outside the calculated high-low
deviation limits.
• High-High/Low-Low: The options selected in this area describe the
actions to be taken when the parameter or report value is outside the
calculated high-high/low-low deviation limits.
• High-High-High/Low-Low-Low: The options selected in this area
describe the actions to be taken when the parameter or report value is
outside the defined high-high-high/low-low-low limits.

See also

How verification policies work on page 194

Configure the verification policy for parameters and reports on page 195

How verification policies work with control strategies on page 200

How editing target parameters affects report verification policies

on page 200

Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017 193
Chapter 15 Phase class overview

How verification policies work When choosing a verification method, specify a calculation method used in
determining the deviation limits. For each verification level, select a verification
policy option:

Tip: To use the signature template policy, first configure signature templates.

• None: A deviation event writes to the FactoryTalk Batch event journal

when the parameter or report value is outside the calculated deviation
limits, but no signature is required.
• Signature Template: Requires selection of a pre-configured signature
template that describes the number of signoffs required and the user and
groups permitted to enter an electronic signature.
• Not Allowed: If the parameter or report value is outside the calculated
range, stops the batch from continuing its processing.

The verification method selected, along with the options selected within an area,
affect the options available in the subsequently higher verification level areas. For
example, the No Limits verification method is selected, any options for the
High/Low, High-High/Low-Low or High-High-High/Low-Low-Low
verification methods cannot be configured.

194 Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017
Phase class overview Chapter 15

Verification options cannot be defined in a higher verification level less stringent

than those defined in a lower verification level. For example, if the
High-High/Low-Low verification method is selected, and the Signature
Template option for the policy when the value is within limits is selected, the
None option is disabled for the policy when the value exceeds the high/low level.

Tip: For recipe parameters, the highest and lowest limits must be within the minimum and maximum values
specified for the parameter in the Edit Phase dialog box Parameters tab. This does not apply to reports.
The default parameter value specified on the Parameters tab must be within the range of the low and
high limits.

The sets of high and low limits must conform to this relationship:

Maximum >= HHH > HH > H = Default = L > LL > LLL >= Minimum

See also

Signature template on page 67

Configure the verification policy for parameters and reports on page 195

Configure the verification policy Use the Edit Phase Class dialog box to configure the verification policies for
parameters and reports.
for parameters and reports
Before you begin:

• Verify set up of the electronic signature templates.

Tip: The phase class parameter or report type must be Real or Integer. A Verification Method for String or
Enumeration parameters or reports cannot be configured.

Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017 195
Chapter 15 Phase class overview

To configure the verification policy for parameters and reports:

1. Select Start, point to All Programs > Rockwell Software > FactoryTalk
Batch Suite > FactoryTalk Batch, and then select Equipment Editor.

2. In the Edit Phase Class dialog box, select the Parameters or Reports tab to
configure a verification policy for either a parameter or report, respectively.

3. In the parameter or report row header, select the Verification Method

browse to open the Verification Policies dialog box.

4. From the Verification Method list, select the verification method used for
the parameter or report. The selected method determines which boxes in
the dialog box become enabled.

• If the High/Low, High-High/Low-Low, or the

High-High-High/Low-Low-Low verification method is selected,
specify a calculation method. From the Calculation list, select the
calculation method that is used to determine the deviation limits.
(Absolute is the only available selection for parameters. If selected the
No Limits verification method, the Calculation list is disabled.
Continue with Step 5.)
• If the Absolute calculation method is selected, there is an option of
selecting the Scale check box. The Scale option scales the absolute
verification limits the same percentage as the Batch Scale value
specified on the Batch Creation dialog box in the FactoryTalk Batch
View.
• If the Percent or Relative calculation method is selected, select a
parameter from the Percent/Relative Target Parameter list. The
parameter value selected is used in the percentage or relative calculation
that determines the report verification limit. The list only displays real
or integer recipe parameters assigned to the same control strategy as the
report on the phase class being edited.
Important: Changes to the target parameter could automatically alter the verification policy of all
referencing reports.

5. In the Policy when value is within limits area, select one of the policy
options.

196 Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017
Phase class overview Chapter 15

• If Signature Template is selected, select browse ( ) next to the

Signature Template.
• From the Select Template list, select the signature template that
defines the signature policy to use for this parameter or report
verification limit.
• Select OK. The Select Signature dialog box closes, and the signature
template chosen displays in the box next to the Signature Template
option.

6. Repeat step 4 for each policy area enabled. In addition to these steps, for
each enabled policy, enter values in each respective set of Low and High
boxes that are used in calculating the verification limit.

Important: If a parameter or report type is changed from Real to Integer, and the calculation method for the
verification policy is Absolute or Relative, the values in each set of Low and High limits are
automatically rounded to the nearest integer.

7. Select OK to save changes and return to the Edit Phase Class dialog box.

8. To download the verification limits to the phase logic, enable or define a set
of limit tags. After setting up verification policies, enable or define these
limit tags when configuring each phase for automatic (non-instruction
based) phase classes.

See also

Signature template on page 67

How editing target parameters affects report verification policies

on page 200

Verification Policies dialog box on page 198

Parameter limit tags on page 223

Report limit tags on page 226

Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017 197
Chapter 15 Phase class overview

Verification Policies dialog box The Verification Policies dialog box contains:

Name Purpose
Verification Method A list that allows selection of Verification Methods:
No Limits: Define the actions taken when the parameter or report value is
within the verification limits. To not use verification policies, select this
option.
High/Low: Define two verification policies. Specify a High and Low limit
and a separate verification policy to use when the parameter or report value
exceeds the High limit or falls short of the Low limit.
High-High/Low-Low: Configure up to three verification policies. Specify a
second higher limit, a second lower limit, and a separate verification policy to
use when the parameter or report value exceeds this second High limit or
falls short of this second Low limit.
High-High-High/Low-Low-Low: Configure up to four verification policies.
Specify a third higher limit, a third lower limit, and a separate verification
policy to use when the parameter or report value exceeds this third High
limit or falls short of this third Low limit.
Calculation Verification limit calculation. Only enabled for reports. Select the type of
equation used to calculate the verification limit for reports. The FactoryTalk
Batch Server calculates the limits when the batch is added to the batch list or
when the target parameter changes.
Example configuration settings:
Target Parameter = 120
High Limit = 10
Low Limit = -10
Absolute: The deviation limit is the specified value defined in the recipe. The
absolute values entered in the three sets of Low and High boxes are
displayed as the default values for the LLL, LL, L, H, HH, HHH boxes in the
FactoryTalk Batch Recipe Editor Parameter Value Entry/Report Limit
Entry dialog box. This is the default and only type of limit calculation for
recipe parameters.
At runtime, the Server calculates:
High limit = 10
Low limit = -10
Percentage: The Target Parameter value is multiplied by the percentage
specified in the Low and High boxes. Only available for reports.
For example:
At runtime, the FactoryTalk Batch Server calculates:
High Limit = 120 + (.10)(120) = 132
Low Limit = 120 + (-.10)(120) = 108
Relative: The Target Parameter value plus the value specified in the Low
and High boxes. Only available for reports. For example:
At runtime, the Server calculates:
High Limit = 120 + (10) = 130
Low Limit = 120 + (-10) = 110
Scale Enabled only when the Calculation is Absolute. Indicates whether the
absolute verification limits are scaled the same percentage as the Batch
Scale value specified in the FactoryTalk Batch View Batch Creation dialog
box.

198 Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017
Phase class overview Chapter 15

Name Purpose
Percent/Relative Target Parameter Enabled when the calculation is Percentage and Relative of report limits.
Select the parameter whose value is to be used in the percentage or relative
calculation that determines the report verification limit.
The list only displays real or integer recipe parameters assigned to the same
control strategy as the report on the phase class being edited.
None A deviation event is recorded in the FactoryTalk Batch event journal, but no
other action occurs (default).
Signature Template Indicates that a signature verification is required when parameter or report
values fall outside of the specified range.
If selecting this option, select browse ( ) to open the Select Signature
Template dialog box. Select the signature template that contains the Signoff
groups who have the security privileges to enter signature verifications at this
verification level.
Not Allowed Indicates the recipe cannot proceed when the values for the parameter or
report are outside the defined limits. No event is recorded in the event
journal.
Low/High These boxes are used in calculating the default parameter deviation limits.
Low-Low/High-High These values can be changed in the recipe, but if no values are provided in the
Low-Low-Low/ recipe parameters, the values entered here are used.
High-High-High The definition of this box differs depending on the Calculation method
selected.
• Absolute calculation: The actual values entered are the Low and High
deviation limits. Deviation Limit = Absolute value.
• Percent calculation: These values define the percentage of the Target
Parameter used in calculating the Low and High deviation limits. These
values are the Percentage in this equation: Deviation Limit = Target
Parameter + (Target Parameter * Percentage). Enter positive and
negative values. To define the Low limit as lower than the Target
Parameter value, enter a negative value in the Low box.
• Relative calculation: The actual value entered is added to the Target
Parameter value to determine the deviation limit. These values are the
Relative value in this equation: Deviation Limit = Target Parameter +
(Target Parameter + Relative value). Enter positive and negative values.
To define the Low limit as lower than the Target Parameter value, enter
a negative value in the Low box.
The selected policy is enacted when the parameter or report values are
outside of the calculated deviation limits.

See also

Configure the verification policy for parameters and reports on page 195

Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017 199
Chapter 15 Phase class overview

How verification policies work If implementing control strategies, set up a different verification policy for each
with control strategies parameter and report in each control strategy.

If selected Percent or Relative as the calculation method for a report’s verification

policy, select a different target parameter for each control strategy. The target
parameter must be assigned to the same control strategy as the report. When
enabled control strategies, the target parameter list only displays integer and real
parameters assigned to the same control strategy as the report.

Important: If a report's target parameters are removed from the same control strategy as the
report, the verification method automatically resets to No Limits.

See also

How editing target parameters affects report verification policies

on page 200

How editing target parameters If any of these changes are made to a parameter, the verification method
automatically resets to No Limits for all reports that reference that parameter as
affects report verification
the target parameter:
policies
• Parameter name changes.
• Parameter type changes from Integer or Real to String or Enumeration.
• Removed Parameter from the same control strategy as a report.
• Deleted Parameter.
Important: If a report verification policy is set up with the Percent or Relative calculation method,
changes to the target parameter could automatically alter the verification policy of the
referencing report.

See also

How verification policies work with control strategies on page 200

200 Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017
Phase class overview Chapter 15

Material-enabled phases If using FactoryTalk Batch Material Manager in conjunction with FactoryTalk
Batch, two parameters (MATERIAL and AMOUNT) and two reports
(ACTUAL_AMOUNT and FEED_COMPLETE) are automatically added to
each material-enabled phase class.

Add optional parameters for material-enabled phase classes:

• CONTAINER
• LOT
• MATERIAL_CLASS
• LABEL

These optional parameters make data available to the phase class and to the client
programs as the batch runs.

Tip: The optional material parameter values within FactoryTalk Batch Equipment
Editor cannot be edited.

Because material-enabled phase classes are different from standard phase classes, be
aware of these issues when configuring a phase class to be material-enabled:

• What to do with existing parameters and report parameters.

• What to do about the number of tags configured on the phase class.

If a standard phase class does not have matching parameter and report names
reserved for materials, making this phase class material-enabled is quite simple.
Once the Material Based Recipes check box is enabled, the two reserved
parameters and two reserved report parameters are added. The same applies to
Add Optional Material Parameters.

If disabled Parameter/Tag Locking, add the appropriate number of tags.

See also

Phase class overview on page 173

Verification policies on page 193

Disable material on a material-enabled phase on page 202

Duplicate a phase on page 203

Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017 201
Chapter 15 Phase class overview

Standard phase class with If a standard phase class uses any of the reserved material parameter or material
report names, they must be of the correct data type for a material-enabled phase
matching parameter and report
class. In addition, if the MATERIAL parameter exists, it must also have the
names correct enumeration set selected.

Tip: The exceptions to this are the optional Material Parameters. The four parameters, CONTAINER, LOT,
MATERIAL_CLASS, and LABEL, cannot already exist as non-system parameters. If the system finds
parameters matching the reserved names, delete or rename the parameters before enabling the Add
Optional Material Parameters.

If the data types of the existing parameters are not exactly what the material-based
recipes subsystem expects, enabling a phase class to support materials could result
in issues. The system checks for correct data types and displays a message to correct
those with an invalid data type.

The parameter and report IDs previously configured remain unchanged. The
other material-based recipe parameters and reports that have not been configured
are added and assigned IDs using the first-available integer greater than zero.

See also

Standard phase class with control strategies configured on page 202

Standard phase class with If a standard phase class has control strategies configured and Material Based
Recipes is enabled, the material parameters (including optional parameters, if
control strategies configured
enabled) and reports are added to every control strategy. If disabled
Parameter/Tag Locking, add the appropriate number of tags.

See also

Material-enabled phase classes on page 201

Disable material on a Disabling Material Based Recipes on a material-enabled phase class automatically
deletes the two reserved parameters (and the optional parameters, if enabled) and
material-enabled phase the two reports. If Parameter/Tag Locking is enabled, remove the appropriate
class number of tags.

If multiple phases are created using the material-enabled phase classes, delete the
extra phases in each unit. Then, disable the Material Based Recipes on the phase
class.

See also

Material-enabled phase classes on page 201

202 Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017
Phase class overview Chapter 15

Duplicate a phase class Phase classes can be cut, copied, or pasted within the Classes View area using the
FactoryTalk Batch Equipment Editor toolbar. Duplicate phase classes within an
area model, including all of the phase parameters, reports, and messages. Use this
feature to cut or copy a phase class from one area model to another.

See also

Copy a phase class on page 203

Cut and paste a phase class on page 204

Copy a phase class Use these instructions to copy a phase class.

To copy a phase class:

1. Select Start, point to All Programs > Rockwell Software > FactoryTalk
Batch Suite > FactoryTalk Batch, and then select Equipment Editor.

2. From the Classes View area, select the phase class to be copied.

3. Select Edit > Copy Phase Class.

4. Select Edit > Paste Phase Class. A new phase class creates with the default
name PHASE CLASS NAME#, where # is an integer (beginning with 1)
that increments each pasted phase class.

See also

Cut and paste a phase class on page 204

Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017 203
Chapter 15 Phase class overview

Cut and paste a phase class Use these instructions to cut and paste a phase class.

To cut and paste a phase class:

Tip: To cut and paste between area models, open the first area model, cut or copy the appropriate phase
class, and then open the second area model and paste the phase class into the Classes View area.

1. Select Start, point to All Programs > Rockwell Software > FactoryTalk
Batch Suite > FactoryTalk Batch, and then select Equipment Editor.

2. From the Class View area, select the phase class to be cut.

3. From the Edit > Cut Phase Class. The phase class is removed from the
Classes View area and held in memory.

4. Select any phase class within the Classes View area and, select Edit > Paste
Phase Class.

See also

Copy a phase class on page 203

204 Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017
 Chapter 16

Configure phases

A phase is an instance of a specific phase class. Only one instance of a specific

phase class can be added to each unit, unless the phase class is material-enabled.
Once a phase class instance is added to a unit instance, the phase must be
configured.

A phase maps to the phase class in the engineered logic via tag addresses. If a single
instance of this phase class is required by multiple units, it may be shared between
the units. At a minimum, each tag in OPC or RSLinx Enterprise FactoryTalk Live
Data phases must be configured to indicate the tag’s address location in the
process-connected device.

Tip: For PhaseManager phases assigned to a Logix5000 CIP data server, it is not necessary to configure tag data.

Phase tags represent data associated with a specific phase during the execution of a
recipe. The number of tags associated with a phase depends on the phase class
configuration. Each phase has a minimum of ten pre-defined tags with which it is
associated. Additional tags may be configured. There are three types of additional
tags:

• Parameter
• Report
• Request

If the phase class is configured to require any of these additional tags, a

corresponding tag creates in the phase.

When using material-enabled phase classes, add multiple instances of the same
phase class to a single unit instance. Even though these phases are created from the
same phase class, they are distinguished from each other by the unique material
containers with which they are associated. Phases mapping to the same phase class
have independent resource IDs.

Tip: When a phase is selected in the Design View, the phase class on which it is based is highlighted. If the
phase class on which they are based is modified, phases are automatically updated. Phases created prior to
modifying the phase class are also updated.

Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017 205
Chapter 16 Configure phases

When the same phase is required by multiple units, it can be shared between the
units. However, a phase can only be owned by one unit at a time.

See also

Create a phase on page 206

Create a phase Use these instructions to create a phase.

Tip: If using eProcedure, allow plenty of space between phase icons in the Design
View area, as the eProcedure Equipment View displays the icons in the same
location. In the eProcedure Equipment View, each equipment icon displays
run-time data and up to five custom hyperlinks. If the icons are spaced too
closely together, this information may overlap, making it difficult to see the
data.

To create a phase:

1. Select Start, point to All Programs > Rockwell Software > FactoryTalk
Batch Suite > FactoryTalk Batch, and then select Equipment Editor.

2. Navigate to the phase class level of the area model (select Go Down ( ) to
the lowest level).

3. Select the desired phase class icon in the Classes View area.

4. Place the cursor in the Design View area where the phase is to be located
and select.

The Edit Phase dialog box opens. The Edit Phase dialog box contains these
tabs:
• General • Hyperlink (eProcedure only)
• Arbitration • Containers (Material Manager only)
• Cross Invocation • Parameter Limit Tags
• Tags • Report Limit Tags

5. To add multiple instances of the same phase to the same unit instance, select
again. Only material-enabled phase classes can be used for multiple phases.

See also

Configure the general data for a phase on page 207

206 Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017
Configure phases Chapter 16

Configure the general data for a Use these instructions to configure the Edit Phase dialog box General tab.
phase
To configure the general data for a phase:

1. Select Start, point to All Programs > Rockwell Software > FactoryTalk
Batch Suite > FactoryTalk Batch, and then select Equipment Editor.

2. Select the Edit Phase dialog box General tab.

3. In the Name box, type the phase name.

4. (For use with RSBizWare BatchERP only) In ERP Alias, type the SAP R/3
phase name.

5. In Equipment ID, type the equipment ID, or accept the default value.

6. In Data Server, confirm that the correct data server that corresponds to the
phase displays. If it does not, select the list to locate the appropriate server.

Tip: If the data server does not correspond to the phase, a message displays stating that continuing resets the
assignment to <None>.

7. (For use with FactoryTalk eProcedure only) Select browse ( ) next to the
Instruction File box. The Instruction Selection dialog box opens.

8. Select the instruction file that applies to the phase. The instructions display
in the Instructions area.

Important: Define an instruction file for each instruction-based phase. If an instruction-based

phase has no instruction file associated with its configuration, the eProcedure Server
will not start.

9. Select OK to return to the Edit Phase dialog box.

Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017 207
Chapter 16 Configure phases

10. To automatically download the appropriate parameters on a START

command, enable the Automatically Download Parameters Upon
START check box.

Tip: Automatic upload/download are configurable on a phase only when the associated phase class
parameters and reports have at least one member of the upload/download parameter subsets.
These features are disabled when an Instruction Based Server is selected.

11. To automatically upload the appropriate report values when the batch
transitions to a terminal state (COMPLETE, STOPPED, or ABORTED),
enable all or individual Automatically Upload Parameters Upon check
boxes.

12. Select Apply to save changes.

See also

Edit Phase dialog box - General tab on page 209

Automatic Upload/Download on page 61

208 Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017
Configure phases Chapter 16

Edit Phase dialog box - General tab The Edit Phase dialog box General tab contains:

Name Purpose
Name The name of the phase.
Phase The name of the phase class from which this phase was created (view-only). The icon
associated with the phase class is displayed next to the Name and Phase Class.
ERP Alias (RSBizWare BatchERP only) The SAP name for the phase. The ERP alias maps the
equipment module from FactoryTalk Batch to SAP.
Equipment ID A unique number identifies this phase. It must be the same ID used in the phase logic to
request this phase.
When Dynamic Unit Allocation is enabled and the First Available method is
selected, the FactoryTalk Batch Server performs a final ascending sort on this box and
chooses equipment with the smallest ID number that meets the required criteria.
Data Server Displays the currently assigned server. When the list opens, configured servers display.
Instruction File Use this feature in conjunction with eProcedure only. Disables if the data server is not
an Instruction Based Server. This maps to the instruction file associated with the phase.

Automatically Download When a START command issues, the FactoryTalk Batch Server downloads the
Parameters Upon START parameters configured with the Download on Start option on the phase. Enable this
function by selecting the check box. If no parameters exist on the phase, this option is
dimmed.
• If an OPC or RSLinx Enterprise FactoryTalk Live Data server is assigned to the phase,
this option is enabled when the number of parameter tags on the phase classis
equal or greater than the number of parameters.
• If a Logix5000 CIP data server is assigned to the phase, this option enables when DL
on Start is selected for at least one parameter on the phase class.
• If the Instruction Based Server is assigned to the phase, this function disables.
Automatically Upload When the batch transitions to a terminal state (COMPLETE, STOPPED, or ABORTED) the
Parameters Upon COMPLETE FactoryTalk Batch Server uploads the report values configured with the Upload on
STOPPED Terminal State option on the phase class. Enable this function so that it occurs for any
ABORTED or all of these terminal states by selecting the check box. If no reports exist on the phase
class, these options are dimmed.
• If an OPC or RSLinx Enterprise FactoryTalk Live Data server is assigned to the phase,
this option enables when the number of report tags on the phase class is equal or
greater than the number of reports.
• If a Logix5000 CIP data server is assigned to the phase, this option enables when UL
on Terminal State is selected for at least one report on the phase class.
• If the Instruction Based Server is assigned to the phase, this function disables.

See also

Configure the general data for a phase on page 207

Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017 209
Chapter 16 Configure phases

Configure the tag data for a Configure the tag data for the phase. These instructions only apply to phases
phase assigned to an OPC or RSLinx Enterprise FactoryTalk Live Data server.

Tip: For PhaseManager phases assigned to a Logix5000 CIP data server, it is not necessary to configure tag data.

To configure the tag data for a phase:

1. Select Start, point to All Programs > Rockwell Software > FactoryTalk
Batch Suite > FactoryTalk Batch, and then select Equipment Editor.

2. In the Edit Phase dialog box, select the Tags tab.

3. In the On Control and Off Control boxes, type the On Control and Off
Control scan rates for the phase.

If the data server associated with the phase is an OPC or RSLinx Enterprise
FactoryTalk Live Data server that allows for configurable scan rates, the
default scan rates for the phase can be modified. If the values cannot be
modified, the boxes disable.

4. Select Apply to save changes.

See also

Edit Phase dialog box - Tag tab on page 211

210 Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017
Configure phases Chapter 16

Edit Phase dialog box - Tag tab In the Edit Phase dialog box Tags tab, these boxes are available for phases
assigned an OPC or RSLinx Enterprise FactoryTalk Live Data server:

Name Purpose
Name The name of the phase (view-only).
Phase Class The name of the phase class from which this phase was created (view-only). The icon
associated with the phase class is displayed next to the Name and Phase Class.
Phase Tags A list of all tags that must be defined for the phase.
Defaults Returns all tag items associated with this phase to their default item names and the
default access path that is configured on the data server that is assigned to the phase.
The default tag item names include the name of the phase. (See Set tag items to the
default addresses for more information.)
Name The name of the highlighted tag (view-only).
Type The phase tag data type (view only). The box below the Type box displays comments
associated with the default tags. There are no comments associated with the report,
parameter, or additional request tags (view-only).
Class Description Displays a description of the currently selected tag class.
On Control Scan Rate Displays the on control scan rate for the OPC or RSLinx Enterprise FactoryTalk Live Data
server associated with the phase (view-only). The scan rate can be modified only within
specific data server definition (DSDF) files. Typically, these values do not need to be
modified.
The valid range of the on control scan rate is 250 to 30,000 milliseconds.
Off Control Scan Rate Displays the off control scan rate for the OPC or RSLinx Enterprise FactoryTalk Live Data
server associated with the phase (view-only). The scan rate can be modified only within
specific data server definition (DSDF) files. Typically, these values do not need to be
modified.
The valid range of the off control scan rate is 250 to 60,000 milliseconds.

See also

Set tag items to the default addresses on page 216

Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017 211
Chapter 16 Configure phases

Phase tag Phase tags automatically name and cannot be directly modified. If the phase name
changes, the tag name changes. There are ten default tags created for each OPC or
RSLinx Enterprise FactoryTalk Live Data phase. Additional tags create based on
the number of report, parameter, and request tags specified.

After the phase creates, all phase tags must be configured to include the correct tag
item. An item references the address location in which the tag data is stored. The
data type for the ten default tags is integer and cannot be modified.

The default data type for any additional tags that have been configured is real.
Change the data types for parameter and report tags when they are defined for the
phase class. Change the data types for the additional request tags when the phase is
edited.

When a phase is added to the area model, select the data server for assignment to
each tag. Change the data server assigned to the tags when the phase is edited.

Tip: The data server for a limit tag must be the same as the data server for its associated parameter tag. If
the data server for a parameter tag is changed, the data server for the associated limit tags is also
automatically changed.
The data server for a limit tag cannot be changed. To change the data server for a limit tag, change the
data server for its associated parameter tag.

See also

Phase tag naming conventions on page 213

Configure a phase tag on page 214

212 Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017
Configure phases Chapter 16

Phase tag naming conventions These naming conventions used for phase tags are based on a phase called
CHARGE1. The ## is a sequentially-assigned number for each user-defined
parameter, report, and additional request tag, beginning with 01. This example has
only a single parameter, report, and additional request configured on the phase
class. Replace the ## with 01.

Class Name Tag Name Example

Parameter Tags
PARMTR## [Phase_Name]P## CHARGE1P01
Parameter Limit Tags
PARMTR##M [Phase_Name]P##M CHARGE1P01M
PARMTR##L [Phase_Name]P##L CHARGE1P01L
PARMTR##H [Phase_Name]P##H CHARGE1P01H
PARMTR##LL [Phase_Name]P##LL CHARGE1P01LL
PARMTR##HH [Phase_Name]P##HH CHARGE1P01HH
PARMTR##LLL [Phase_Name]P##LLL CHARGE1P01LLL
PARMTR##HHH [Phase_Name]P##HHH CHARGE1P01HHH
Report Tags
REPORT## [Phase_Name]R## CHARGE1R01
Report Limit Tags
REPORT##M [Phase_Name]R##M CHARGE1R01M
REPORT##L [Phase_Name]R##L CHARGE1R01L
REPORT##H [Phase_Name]R##H CHARGE1R01H
REPORT##LL [Phase_Name]R##LL CHARGE1R01LL
REPORT##HH [Phase_Name]R##HH CHARGE1R01HH
REPORT##LLL [Phase_Name]R##LLL CHARGE1R01LLL
REPORT##HHH [Phase_Name]R##HHH CHARGE1R01HHH
Request Tags
REQUEST## [Phase_Name]Q## CHARGE1Q01
Default Tags
COMMAND [Phase_Name]_OC CHARGE1_OC
FAILURE [Phase_Name]_F CHARGE1_F
OWNER [Phase_Name]_W CHARGE1_W
PAUSE [Phase_Name]_P CHARGE1_P
PAUSED [Phase_Name]_PD CHARGE1_PD
REQUEST [Phase_Name]_RQ CHARGE1_RQ
SINGLE_STEP [Phase_Name]_SS CHARGE1_SS
STATUS [Phase_Name]_ST CHARGE1_ST
STEP_INDEX [Phase_Name]_SI CHARGE1_SI
UNIT [Phase_Name]_UN CHARGE1_UN

Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017 213
Chapter 16 Configure phases

Configure a phase tag Use these instructions to configure a phase tag.

To configure a phase tag:

1. Select Start, point to All Programs > Rockwell Software > FactoryTalk
Batch Suite > FactoryTalk Batch, and then select Equipment Editor.

2. From the Edit Tags dialog box, double-click the desired phase tag in the
Tags list box.

The Edit Phase Tag dialog box opens.

3. Select an appropriate data type from the Type list. OPC or RSLinx
Enterprise FactoryTalk Live Data servers do not accept Enumeration data
types. Use Integer instead. If the phase class has enabled Parameter/Tag
Locking, the type cannot be modified.

4. In Access Path, type the appropriate access path.

5. In Item Name, type the appropriate item name.

6. If the data server requires separate read and write items, type the write access
path in the Write Access Path box.

7. If the data server requires separate read and write items, type the write item
name in the Write Item Name box.

8. From the Data Server list, if the default is not correct, select the appropriate
data server.

9. Select OK to return to the Edit Tags dialog box.

10. Select OK to close the Edit Tags dialog box.

See also

Edit Phase Tag dialog box on page 215

214 Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017
Configure phases Chapter 16

Edit Phase Tag dialog box Phase tags are configured using the Edit Phase Tag dialog box, which contains:

Name Purpose
Name The automatically assigned name of the phase tag (view-only).
Tag Class The phase tag class (view only).
Type The phase tag data type. Parameters and reports defined as enumerations default to
Integer as the tag type. Type should never be set to Enumeration because an OPC or
RSLinx Enterprise FactoryTalk Live Data server does not recognize this tag type.
Parameters and reports defined as enumerations should use Integer as the tag type. If
the phase Parameter/Tag Locking is enabled (selected), the Type cannot be
modified.
Enumeration This should not be used. OPC or RSLinx Enterprise FactoryTalk Live Data servers do not
recognize enumeration tag types. Parameters and reports defined as enumerations
must use Integer as the tag type. If the phase Parameter/Tag Locking is enabled
(checked), the Enumeration cannot be modified.
Access Path The OPC access path used with the read item when the data server attempts to
subscribe to the tag’s value, or when performing read operations. This box changes to
Read Item Access Path when the associated OPC data server requires separate read
and write items.
Item Name The name of the item used when subscribing to the value of the tag or when
performing read operations. This box changes to Read Item Name when the
associated OPC data server requires separate read and write items.
Write Access Path The OPC access path for the write item. This disables if the data server does not require
separate read and write items.
Write Item Name The OPC item name for the write item. This disables if the data server does not require
separate read and write items or does not require an access path.
Data Server The user-defined data server name used by the phase tag. (This box disables for
request, control, and limit tags.)
Type The data server as defined in the DSDF file (view-only).

See also

Configure a phase tag on page 214

Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017 215
Chapter 16 Configure phases

Set tag items to the default When creating a phase from a phase class in the area model, the default phase
addresses name is <phasename>1. For example, if the phase is AGITATE, the phase creates
from this phase class with the default name of AGITATE1.

The phase's tag items the default name is: <Equipment Module Name>< Tag
Separator><Tag Extension>

For example, if the tag separator is a period (.), the Request tag (RQ) for phase
AGITATE1 would be: AGITATE1.RQ

If the phase name changes, the tag item names do not automatically change to
reflect the new phase name. For example, if the phase name changes from
AGITATE1 to AGITATE_U2, the tag Names reflect the new name
(AGITATE_U2), but the tag Item Names still reflect the original name of the
phases (AGITATE1). The example request tag for the AGITATE_U2 phase
would still be AGITATE1.RQ.

Re-establish the default address information for a phase by using the Defaults
button. The Item, Read Access Path, Read Item Name, Write Item Path, and
Write Item Name are returned to the appropriate default values specified for the
data server assigned to the phase. The phase tag names are changed to reflect the
current name of the phase.

This is an irreversible action! Once Defaults is selected, all tag item names and access paths are
automatically changed. (See Set all tag items to default name and access path for more
information.)

To set tag to the default address:

1. Select Start, point to All Programs > Rockwell Software > FactoryTalk
Batch Suite > FactoryTalk Batch, and then select Equipment Editor.

2. In the Edit Phase dialog box Tags tab, select Defaults.

3. Select Yes to set the defaults and return to the Edit Phase dialog box.

See also

Set all tag items to default name and access path on page 167

216 Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017
Configure phases Chapter 16

Configure the arbitration data Use these instructions to configure the arbitration data.
for a phase To configure the arbitration data for a phase:

1. Select Start, point to All Programs > Rockwell Software > FactoryTalk
Batch Suite > FactoryTalk Batch, and then select Equipment Editor.

2. Select the Edit Phase dialog box Arbitration tab.

3. Browse the area models equipment hierarchy to specify the equipment

acquired by the equipment phase. The lack of a plus or minus sign to the left
of an equipment type indicates no defined equipment. It can also indicate
that the equipment type cannot be used as a needed equipment item at this
level.

• To add equipment, under the Equipment Allocation by Resource

area, select the equipment needed by the phase and select Add. The
selected equipment displays in the right pane.
• To remove equipment, in the right pane, select the equipment to delete
and select Remove. The selected equipment is removed from the list.

4. Select Apply to save changes.

Tip: Phases do not have a Max Owners box to define because a phase can only execute one recipe phase class at a
time. For that reason, all phases can have only one owner.

See also

Edit Phase dialog box - Arbitration tab on page 218

Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017 217
Chapter 16 Configure phases

Edit Phase dialog box - Arbitration The Edit Phase dialog box on the Arbitration tab contains:
tab
Name Purpose
Name The name of the phase (view-only). The icon associated with the phase class
displays next to the Name and Phase Class.
Phase Class The name of the phase class from which this phase was created (view-only).
Equipment Allocation by A list of the equipment for which ownership is required by this phase in order for
Resource any procedural element linked to the phase to begin execution.
The left pane is a hierarchical display showing the current equipment configuration
of the area model. The hierarchy has two roots:
• Process Cells: Displays all the process cells within the area model. From here,
organization is hierarchical: process cells contain units and units contain phases
and operations sequences.
• Resources: Displays a list of all the configured resources within the area model.
The right pane is the list of equipment this phase is dependent upon. Any
equipment in this list must be acquired by the phase before the phase can begin
execution.
Add Add the selected equipment requirement to the Equipment Needed list.
Remove Remove the selected equipment requirement from the Equipment Needed list.

See also

Configure the arbitration data for a phase on page 217

Configure cross invocation data Use these instructions to configure cross invocation data.
for a phase Tip: Cross invocation is not supported in FactoryTalk eProcedure.

To configure cross invocation data for a phase:

1. Select Start, point to All Programs > Rockwell Software > FactoryTalk
Batch Suite > FactoryTalk Batch, and then select Equipment Editor.

2. Select the Edit Phase dialog box Cross Invocation tab.

3. In Cross Invocation Configuration, type the cross invocation string

information.

4. Select Apply to save changes.

See also

Edit Phase dialog box - Cross Invocation tab on page 219

218 Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017
Configure phases Chapter 16

Edit Phase dialog box - Cross The Edit Phase dialog box Cross Invocation tab contains:
Invocation tab
Name Purpose
Name The name of the phase (view-only).
Phase Class The name of the phase class from which this phase was created (view-only). The icon
associated with the phase class is displayed next to the Name and Phase Class.
Cross Invocation The cross invocation strings indicate the addition of an item to FactoryTalk Batch View
Configuration and the ActiveX control shortcut menus. This includes the caption for each menu item
and the data to be passed to the specified automation server when the menu item is
selected.
The default labels associated with each of the five fields are Cross Invocation Label #
(where # is 1 through 5). These labels can be modified in the Server Options dialog
box, and are seen in the Edit Process Cell dialog box.

See also

Configure cross invocation data for a phase on page 218

Configure hyperlink data for a This feature is used in conjunction with eProcedure only. Use these instructions
phase to configure hyperlink data.

To configure hyperlink data for a phase:

1. Select Start, point to All Programs > Rockwell Software > FactoryTalk
Batch Suite > FactoryTalk Batch, and then select Equipment Editor.

2. In the Edit Phase dialog box, select the Hyperlink tab.

3. In the Hyperlink Configuration boxes, type a valid URL string.

4. Select Apply to save changes.

See also

Edit Phase dialog box - Hyperlink tab on page 220

Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017 219
Chapter 16 Configure phases

Edit Phase dialog box - Hyperlink tab This feature is used in conjunction with eProcedure only.

The Edit Phase dialog box on the Hyperlink tab contains:

Name Purpose
Name The name of the phase (view-only).
Phase Class The name of the phase class from which this phase was created (view-only).
The icon associated with the phase class is displayed next to the Name and
Phase Class.
Hyperlink The URL associated with each hyperlink label.
Configuration The default labels associated with each of the five fields are Hyperlink Label
# English (where # is 1 through 5). These labels can be modified in the
Server Options dialog box. The labels are used in the eProcedure Client
Equipment view.

See also

Configure hyperlink data for a phase on page 219

Configure container data The Containers tab is visible with material-enabled phase classes only.

Configure the set of containers from which this phase can select material, or into
which it can distribute material, or both.

Tip If the Material Server is unavailable, the Container and Storage Location Associations area contains
an error message stating the container data is unavailable. The CONTAINER column is unavailable but
contains the associations previously configured.

To configure container data:

1. Select Start, point to All Programs > Rockwell Software > FactoryTalk
Batch Suite > FactoryTalk Batch, and then select Equipment Editor.

2. Select the Edit Phase dialog box Containers tab.

3. Browse the container and storage location trees to specify associations with
the phase. The lack of a plus or minus sign to the left of Containers or
Storage Locations indicates no containers or storage locations have been
defined. Define these in the Material Editor.

Select the container or storage location needed by the phase under the
Container and Storage Location Associations area and select Add. The
item selected displays in the right pane under the Container/Storage
Location column. Adding a container that already exists in the
Container/Storage Location column is not allowed.

220 Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017
Configure phases Chapter 16

To remove a container or storage location, in the right pane, select the item
to delete and select Remove. The selected item is removed from the list.

4. Select the appropriate check box to indicate if the container is a source of

material (material is drawn from this container), a material destination
(material enters this container), or both.

Tip: At least one check box, addition, or distribution, must be selected for the configuration to be accepted, and
it must agree with the container behavior. The High and Low values configured in the phase class
parameters specify the container behavior, whether the phase class is a material addition, distribution, or
both.
Addition - Low = 0, High = positive number
Distribution - Low = negative number, High = 0
Both - Low = negative number, High = positive number

5. Select Apply to save changes.

6. Select OK to close the Edit Phase dialog box.

See also

Edit Phase dialog box - Containers tab on page 222

Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017 221
Chapter 16 Configure phases

Edit Phase dialog box - Containers The Edit Phase dialog box Containers tab contains:
tab
Name Purpose
Name The name of the phase (view-only).
Phase Class The phase class name from which this phase was created (view-only). The icon
associated with the phase class displays next to the Name and Phase Class.
Container and Storage Location A list of containers and storage locations to which this phase connects. The two
Associations columns in the right pane indicate whether the container is a source or a destination
for material. Icons are used to represent a material source (container with a plus sign),
and a material destination (container with a minus sign).
The left pane is a hierarchical display of the set of containers and storage locations
currently configured in the material database. The hierarchy has two roots:
• Containers: Displays all the containers within the material database not
associated with a storage location. Containers within storage locations are not
displayed because the phase makes an association only with independent
containers or storage locations, never with containers within storage locations.
• Storage Locations: Displays a list of all the storage locations configured within
the Material Editor.
Add Add a selected container or storage location to the Container/Storage Location
column.
Remove Remove the selected container or storage location from the Container/Storage
Location column.

See also

Configure container data on page 220

222 Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017
Configure phases Chapter 16

Parameter limit tags If enabled, Parameter/Tag Locking enables FactoryTalk Batch Equipment
Editor to determine and build the tags required for downloading all the parameter
limits and verification configuration details to the phase logic. If Parameter/Tag
Locking is disabled, have all the limits information downloaded to the parameters
chosen by selecting the appropriate set of parameter limit tags for those
parameters. The Parameter Limit Tags tab is not displayed for instruction-based
phases.

See also

Enable parameter limit tags on page 223

Edit Phase dialog box - Parameter Limit Tags tab on page 224

Map parameter tags to parameter limit tags on page 225

Enable parameter limit tags Use the Edit Phase dialog box Parameter Limit Tags tab to enable parameter
limit tags. The Parameter/Tag Locking option must be enabled in the Edit
Phase dialog box General tab.

When parameter limit tags are enabled, the required verification limit tags for the
parameters that have signature verification policies defined are created.

To enable parameter limit tags:

1. Select Start, point to All Programs > Rockwell Software > FactoryTalk
Batch Suite > FactoryTalk Batch, and then select Equipment Editor.

2. In the Edit Phase dialog box, select the Parameter Limit Tags tab.

3. Select the Enable Limit Tags check box.

The limit tags required for all parameters with signature verification policies
in this phase are automatically created and displayed in the Limit Tags area.

4. Select OK to close the Edit Phase dialog box or Apply to keep the dialog
box open.

See also

Edit Phase dialog box - Parameter Limit Tags tab on page 224

Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017 223
Chapter 16 Configure phases

Edit Phase dialog box - Parameter Automatically create and maintain the necessary phase parameter tags for the
Limit Tags tab parameters defined in the phase class.

If the Parameter/Tag Locking option is enabled on the phase class from which
the phase was created, the system automatically creates the required verification
limit tags for the parameters that have signature verification policies defined.

The Parameter Limit Tags tab contains:

Name Purpose
Name Name of the phase.
Phase Class Name of the phase class from which the phase was created.
Enable Limit Tags Creates the necessary parameter limit tags for the verification policies configured on the
phase class. This option is only available if the Parameter/Tag Locking option was
selected in the Edit Phase Class dialog box General tab.
If the Parameter/Tag Locking option was not selected, define the limit tag sets and map
the parameter tags to the limit tags.
Tip: These areas are enabled only if Parameter/Tag Locking is disabled.
Parameter Tag to Limit Tag Mapping area
Parameter Tag Displays the tag name for the user-defined parameter that was created in the phase class
(view only). (See Phase tags for information on phase tag naming conventions.)

Type Displays the data type for the parameter (view only).
Limit Tag Set Creates the necessary set of verification limit tags for the parameter. Select the same
verification method that is configured in the Edit Phase Class dialog box Parameters
tab.

Limit Tags area

Limit Tags scroll box Lists the set of phase tag classes created for the selected Limit Tag Set.
Name Displays the phase tag defined for the selected tag class (view only).
Type Displays the phase tag data type. The area below the Type box describes the phase tag (view
only).

See also

Enable parameter limit tags on page 223

224 Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017
Configure phases Chapter 16

Map parameter tags to Use the Edit Phase dialog box Parameter Limit Tags tab to map parameter tags
parameter limit tags to parameter limit tags, if Parameter/Tag Locking is not enabled on the phase
class and parameter tags are created manually. These instructions only apply to
OPC or RSLinx Enterprise FactoryTalk Live Data phases.

If the Parameter/Tag Locking option is disabled on the phase class, manually

select the appropriate limit tag set for each parameter tag.

To map parameter tags to parameter limit tags:

1. Select Start, point to All Programs > Rockwell Software > FactoryTalk
Batch Suite > FactoryTalk Batch, and then select Equipment Editor.

2. In the Edit Phase dialog box, select the Parameter Limit Tags tab.

3. Place the cursor in the Limit Tag Set box that is in the same row as the
parameter to map.

Tip: Remember to update the Number of Tags boxes in the Edit Phase Class dialog box General tab before
mapping parameter tags to limit tags. Even if parameters are added to the phase class and verification
methods are configured for them, parameter tags do not display in the Parameter Tag to Limit Tag
Mapping area if the number of tags entered on the phase class is too low.

4. From the Limit Tag Set list, select the option that matches the verification
method defined for the parameter on the phase class.

Tip: If the phase class on which the phase is based uses control strategies, select the verification method of the
control strategy that has the largest number of limits.
For example, if a phase class has two control strategies, and Strategy 1 has a verification method of H/L,
and Strategy 2 has a verification method of HHH/LLL, choose the HHH/LLL limit tag set.

All limit tags required for the selected Limit Tag Set are created and
displayed in the Limit Tags area.

5. Repeat steps 2 and 3 for each parameter that has a verification policy with
parameter verification limits specified.

6. Select OK to close the Edit Phase dialog box or Apply to keep the dialog
box open.

See also

Parameter limit tags on page 223

Edit Phase dialog box - Parameter Limit Tags tab on page 224

Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017 225
Chapter 16 Configure phases

Report limit tags If Parameter/Tag Locking is enabled, it allows FactoryTalk Batch Equipment
Editor to determine and build the tags required for downloading the report limits
and verification configuration details to the phase logic. If Parameter/Tag
Locking is disabled, have all the limits information downloaded to the reports
chosen by selecting the appropriate set of report limit tags for those parameters.
The Report Limit Tags tab is not displayed for instruction-based phases.

See also

Edit Phase dialog box - Report Limit Tags tab on page 226

Edit Phase dialog box - Report When the Enable Limit Tags check box is enabled, the necessary phase parameter
and report tags are created and maintained for the parameters and reports defined
Limit Tags tab
in the phase.

The Report Limit Tags tab contains:

Name Purpose
Name Name of the phase.
Phase Class Name of the phase class from which the phase was created.
Enable Limit Tags Creates the necessary parameter limit tags for the verification policies configured on the
phase class. This option is only available if the Parameter/Tag Locking option was
selected in the Edit Phase Class dialog box General tab.
If the Parameter/Tag Locking option was not selected, define the limit tag sets and map
the parameter tags to the limit tags.
Tip: These areas are enabled only if Parameter/Tag Locking is disabled.
Report Tag to Limit Tag Mapping area
Report Tag Displays the tag name for the user-defined report that was created in the phase class (view
only). (See Configure a phase tag for information on phase tag naming conventions.)
Type Displays the report data type (view only).
Limit Tag Set Creates the necessary set of verification limit tags for the report. Select the same
verification method configured in the Edit Phase Class dialog box Reports tab.

Limit Tags area

Limit Tags scroll box Lists the set of phase tag classes created for the selected Limit Tag Set.
Name Displays the phase tag defined for the selected tag class (view only).
Type Displays the phase tag data type. The area below the Type box describes the phase tag (view
only).

See also

Report limit tags on page 226

Configure a phase tag on page 214

226 Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017
Configure phases Chapter 16

Enable report limit tags Use the Edit Phase dialog box Report Limit Tags tab to enable limit tags. The
Parameter/Tag Locking option must be enabled on the Edit Phase dialog box
General tab to enable limit tags.

When the Enable Limit Tags check box is enabled, the necessary phase parameter
and report tags are created and maintained for the parameters and reports defined
in the phase.

To enable report limit tags:

1. Select Start, point to All Programs > Rockwell Software > FactoryTalk
Batch Suite > FactoryTalk Batch, and then select Equipment Editor.

2. In the Edit Phase dialog box, select the Report Limit Tags tab.

3. Select the Enable Limit Tags check box.

The limit tags required for all reports with signature verification policies in
this phase are automatically created and displayed in the Limit Tags area.

4. Select OK to close the Edit Phase dialog box or Apply to keep the dialog
box open.

See also

Map report tags to report limit tags on page 228

Edit Phase dialog box - Report Limit Tags tab on page 226

Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017 227
Chapter 16 Configure phases

Map report tags to report limit If Parameter/Tag Locking is disabled and parameter tags are created manually,
tags follow this procedure to create parameter limit tags. These instructions only apply
to OPC or RSLinx Enterprise FactoryTalk Live Data phases.

If Parameter/Tag Locking is disabled, manually select the appropriate Limit Tag

Set for each Report tag.

To map report tags to report limit tags:

1. Select Start, point to All Programs > Rockwell Software > FactoryTalk
Batch Suite > FactoryTalk Batch, and then select Equipment Editor.

2. In the Edit Phase dialog box, select Report Limit Tags tab.

3. Place the cursor in the Limit Tag Set box that is in the same row as the
parameter that to map.

Tip: Remember to update the Number of Tags boxes in the Edit Phase dialog box General tab before
mapping report tags to limit tags. Even if reports to the phase and configured verification methods for
them are added, report tags do not display in the Report Tag to Limit Tag mapping area if the number
of tags entered on the phase is too low.

4. From the Limit Tag Set list, select the option that matches the verification
method defined for the report on the phase class.

228 Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017
Configure phases Chapter 16

Tip: If the phase class on which the phase is based uses control strategies, select the verification method of the
control strategy that has the largest number of limits. For example, if a phase class has two control
strategies, and Strategy 1 has a verification method of H/L, and Strategy 2 has a verification method of
HHH/LLL, choose the HHH/LLL limit tag set.

All limit tags required for the selected Limit Tag Set are created and
displayed in the Limit Tags area.

5. Select OK to close the Edit Phase dialog box or Apply to keep the dialog
box open.

See also

Enable report limit tags on page 227

Configure parameter and After enabling or mapping the parameter and report limit tags, configure the
Access Path and Item Name for each limit tag. These are configured in the same
report limit tags Edit Phase Tag dialog box where other phase tags are configured.

Tip: The data server cannot be changed for limit tags. The data server for a limit tag
must be the same as the data server for the parameter or mapped report tag.
When changing the data server for a parameter or report, the data server for its
corresponding limit tags automatically changes to match.

See also

Phase tags on page 164

Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017 229
Chapter 16 Configure phases

How edits to parameters, After limit tags are enabled or mapped, if the verification method of the parameter
reports, and phase classes or report changed, the limit tags are automatically adjusted to match the new
verification method. New tags are automatically created or deleted. There is no
affect limit tags need to alter the number of limit tags that exist.

Important After limit tags are enabled or mapped, if the data server changed for the phase to the
instruction server, all limit tags are automatically deleted. Limit tags are not needed for
instruction-based phases.

If the Parameter/Tag Locking option is enabled:

• When the phase class contains control strategies, the number of limit tags
for the parameter is the largest limit set for any of the control strategies to
which the parameter is assigned. When a control strategy is deleted, the
system automatically recalculates the limit tag set required for each
parameter and adjusts the number of limit tags accordingly. If the control
strategy that defined the largest set of limits for the parameter is deleted, the
number of limit tags are automatically decreased.
• If Parameter/Tag Locking was enabled when limit tags were created for
the phase, and then Parameter/Tag Locking is disabled, the existing tags
are preserved and not modified.
• If a parameter or report is deleted, the corresponding set of limit tags are
automatically deleted. The parameter tag to limit tag set is maintained for
the other remaining parameters or reports, and the item names assigned to
each tag remain the same.
Important If Parameter/Tag Locking is not enabled and a parameter or report is deleted from the phase
class and the number of tags in the Edit Phase dialog box General tab is decreased, re-map the
remaining parameter tags to limit tag sets. The parameter tag names and limit tag associations
are shifted; they are not maintained.

See also

Configure parameter and report limit tags on page 229

230 Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017
Configure phases Chapter 16

Overview of sharing phases When a single phase or operation sequence is required by more than one unit, it
must be shared by all units that require it. Do not create a new instance of the
and operation sequences same phase or operation sequence in the other unit(s). Prior to sharing a phase or
between units operation sequence, verify the phase or operation sequence is physically able to be
shared.

A phase or operation sequence may have only one owner at a time. Sharing a single
phase or operation sequence allows any shared unit to gain ownership of it during
batch execution. A phase or operation sequence cannot be owned by more than
one unit at the same time.

When a phase or operation sequence is shared, any changes made to it are reflected
in each unit that contains the shared phase or operation sequence, including its
physical placement in the Design View area. When an instance of a shared phase
or operation sequence is deleted from one unit, the phase or operation sequence is
removed from the selected unit but it is still present in any other units to which it
belongs.

See also

Share a phase or operation sequence on page 232

Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017 231
Chapter 16 Configure phases

Share a phase or operation Use these instructions to share a phase or operation sequence.
sequence
To share a phase or operation sequence:

1. Select Start, point to All Programs > Rockwell Software > FactoryTalk
Batch Suite > FactoryTalk Batch, and then select Equipment Editor.

2. Open the area model.

3. Navigate to the phase or operation sequence level of the unit in the area
model that does not contain the phase or operation sequence to be shared.

4. Select Share.

The Share Phases and Operation Sequences Between Units dialog box
displays. Navigate to the phases and operation sequences by selecting the
plus (+) sign next to the unit names.

5. Select the phase or operation sequence to share with the current unit, then
select OK.

The icon of the selected phase or operation sequence displays in the Design
View area. A small hand is at the bottom left corner, in both the active unit
and the unit in which the phase or operation sequence was originally
defined.

See also

Overview of sharing phases and operation sequences between units

on page 231

232 Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017
 Chapter 17

Operation sequence configuration

An operation sequence is an instance of a specific operation sequence class. Only

one instance of a specific operation sequence can be added to each unit. Once an
operation sequence instance is added to a unit instance, the operation sequence
must be configured.

Tip: It is not necessary to configure tag data, as SequenceManager Equipment

Operation Sequences are assigned to a Logix5000 CIP data server.

When an operation sequence is selected in the Design View, the operation

sequence class on which it is based is highlighted. If the operation sequence class
on which they are based is modified, operation sequences are automatically
updated. Operation sequences created prior to modifying the operation sequence
class are also updated.

See also

Configure the general data for an operation sequence on page 235

Configure the arbitration data for operation sequences on page 237

Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017 233
Chapter 17 Operation sequence configuration

Create an operation Use these instructions to create an operation sequence.

sequence To create an operation sequence:

1. Select Start, point to All Programs > Rockwell Software > FactoryTalk
Batch Suite > FactoryTalk Batch, and then select Equipment Editor.

2. Open the area model.

3. Navigate to the operation sequence level of the area model (select Go Down
( ) to the lowest level).

4. In the Classes area, select the operation sequence and place it in the Design
View area where you want the instance to reside.

5. Use the Edit Operation Sequence dialog box to view and configure the
properties in the General, Arbitration, and Tags tabs.

See also

Configure the general data for an operation sequence on page 235

Configure the arbitration data for operation sequences on page 237

Edit Operation Sequence dialog The operation sequence general attributes include the operation sequence class
name, equipment ID, and the current assigned data server.
box - General tab
The Edit Operation Sequence dialog box General tab contains:

Name Purpose
Name The name of the operation sequence.
Operation Class The name of the operation sequence class from which this operation sequence was
created (view-only).
Equipment ID A unique number, greater than zero, that identifies this operation sequence. It must be
the same equipment ID used in the phase logic to request this operation sequence.
Data Server Displays the currently assigned server. When the list opens, configured servers are
shown.

See also

Configure the general data for an operation sequence on page 235

234 Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017
Operation sequence configuration Chapter 17

Configure the general data for an Use these instructions to configure general data for an operation sequence, using
operation sequence the Edit Operation Sequence dialog box General tab.

To configure the general data for an operation sequence:

1. Select Start, point to All Programs > Rockwell Software > FactoryTalk
Batch Suite > FactoryTalk Batch, and then select Equipment Editor.

2. With the Edit Operation Sequence dialog box open, select the General
tab.

3. In Name, type the operation sequence name.

4. In Equipment ID, enter the equipment ID, or accept the default value.

5. In Data Server, confirm that the correct data server is shown. If it does not,
select the list to locate the appropriate server.

6. Select Apply to save changes.

See also

Edit Operation Sequence dialog box - General tab on page 234

Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017 235
Chapter 17 Operation sequence configuration

Edit Operation Sequence dialog The Edit Operation Sequence dialog box Arbitration tab configures resources
box - Arbitration tab the operation sequence instance must acquire to be run.

The Arbitration tab contains:

Name Purpose
Name The name of the operation sequence (view-only).
Operation Class The name of the operation sequence class from which this operation sequence was
created (view-only).
Equipment Allocation by A list of the equipment for which ownership is required by this operation sequence
Resource in order for any procedural element linked to the operation sequence to begin
execution.
The left pane is a hierarchical display showing the current equipment configuration
of the area model. The hierarchy has two roots:
• Process Cells: Displays all the process cells within the area model. From here,
organization is hierarchical: process cells contain units and units contain phases
and operations sequences.
• Resources: Displays a list of all the configured resources within the area model.
The right pane is the list of equipment this operation sequence is dependent upon.
Any equipment in this list must be acquired by the operation sequence before the
operation sequence can begin execution.
Add Add the selected equipment requirement.
Remove Remove the selected equipment requirement.

See also

Configure the arbitration data for operation sequences on page 237

236 Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017
Operation sequence configuration Chapter 17

Configure the arbitration data for an Use the Edit Operation Sequence dialog box Arbitration tab to configure
operation sequence arbitration data for an operation sequence.

To configure the arbitration data for an operation sequence:

1. Select Start, point to All Programs > Rockwell Software > FactoryTalk
Batch Suite > FactoryTalk Batch, and then select Equipment Editor.

2. With the Edit Operation Sequence dialog box open, select the
Arbitration tab.

3. Browse the area model's equipment hierarchy to specify the equipment

acquired by the operation sequence. The equipment hierarchy can be
navigated by opening equipment to view the contained resources.

• To add equipment, under the Equipment Allocation by Resource

area, select the equipment needed by the operation sequence and select
Add. The selected equipment displays in the right pane.
• To remove equipment, in the right pane, select the equipment to delete
and select Remove. The selected equipment is removed from the list.

4. Select Apply to save changes.

See also

Edit Operation Sequence dialog box - Arbitration tab on page 236

Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017 237
Chapter 17 Operation sequence configuration

Edit Operation Sequence dialog The Edit Operation Sequence dialog box Tags tab displays the configuration of
box - Tags tab CIP communication data for the operation sequence.

The Tags tab contains:

Name Purpose
Name The name of the operation sequence (view-only).
Operation Class The name of the operation sequence class from which this operation sequence was
created (view-only).
Operation sequence tags A list of all the tags that are defined for the operation sequence (view-only). The tags
shown are configured in the Operation Sequence Class dialog box in the Reports tab
and Parameters tab.
Name The name of the highlighted tag (view-only).
Usage The type of parameter (view-only), either Input or Output.
Type The operation sequence tag data type (view only).
Tip: Parameters and reports that use the ENUM type are shown as the INTEGER
type for the Logix5000 controller.

See also

Configure operation sequence class reports on page 240

Configure operation sequence class parameters on page 238

Configure operation sequence class Use the Create Operation Sequence Class dialog box Parameters tab to
parameters configure operation sequence class parameters.

Tip: Use the keyboard to move around in the grid. Press the Tab key to move
focus to the grid. Press Ctrl+Alt+Home to highlight the first editable cell
in the grid.

To configure operation sequence class parameters:

1. Select Start, point to All Programs > Rockwell Software > FactoryTalk
Batch Suite > FactoryTalk Batch, and then select Equipment Editor.

2. With the Create Operation Sequence Class dialog box open, select the
Parameters tab. A list of parameters associated with the operation sequence
class displays.

3. Select Add Parameter to add a new operation sequence class parameter. A

new parameter displays with default values.

4. In Name, type a unique name for the operation sequence class parameter.

238 Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017
Operation sequence configuration Chapter 17

Important: The parameter name must match the name of the sequencing
input parameter belonging to the equipment sequence in the
controller.

5. From the Type list, select the appropriate parameter type. The parameter
type is equivalent to the sequencing input parameter type belonging to the
equipment sequence in the controller. See Create Operation Sequence
Class dialog box - Parameters tab for sequencing input parameter type
information.

• If the Type is Real or Integer, add the Max value, Min value, and
Default value, and then optionally type the engineering units in the
Enum/E.U. box.
• If the Type is Enumeration, choose the appropriate enumeration set
from the Enum/E.U. list and select the appropriate default
enumeration from the Default list.
• If the Type is String, type the engineering units in the Enum/E.U. box
and the default string in the Default box.

6. If the parameter must scale within a recipe when a batch scales, select the
Scale check box. (See Scale parameters for more information.)

7. To assign a context or descriptor to the recipe operation sequence class

parameter, select one or more Context IDs from the Reporting Contexts
column.

8. To delete a parameter, do the following:

a. Select the parameter row header, then select Delete Parameter.

b. Select Yes to confirm the deletion.

9. To save changes, select Apply.

10. To save changes and return to the Class View area, select OK.

See also

Scale parameters on page 53

Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017 239
Chapter 17 Operation sequence configuration

Configure operation sequence class Use the Create Operation Sequence Class dialog box Reports tab to configure
reports operation sequence class reports. An operation sequence class report is defined for
the operation sequence class, while the corresponding report tag is automatically
built for the operation sequence instance.

To configure operation sequence class reports:

1. Select Start, point to All Programs > Rockwell Software > FactoryTalk
Batch Suite > FactoryTalk Batch, and then select Equipment Editor.

2. With the Create Operation Sequence Class dialog box open, select the
Reports tab. A list of operation sequence reports associated with the
operation sequence is shown.

Tip: Use the keyboard to move around in the grid. Press the Tab key to move the focus
in the grid. Press Control+Alt+Home to highlight the first editable cell in the
grid.

3. Select Add Report to add a new operation sequence report.

A new report displays with default values.

a. In Name, type a unique name for the report parameter.

Important: The report name must match the name of the sequencing output
parameters belonging to the equipment sequence in the controller.

b. From the Type list, select the appropriate parameter type. The report
type is equivalent to the sequencing output parameter type belonging to
the equipment sequence in the controller. See Create Operation
Sequence Class dialog box - Reports tab for sequencing output
parameter type information.

• If Type is REAL, STRING, or INTEGER, type the engineering

units in the Enum/E.U. box. If control strategies are enabled, edit
the Enum/E.U. value for each configured control strategy.
• If Type is ENUM, select the appropriate enumeration set from the
Enum/E.U. box.

240 Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017
Operation sequence configuration Chapter 17

c. To assign a context or descriptor to the report parameter, from the

Reporting Contexts column, select one or more Context IDs.

4. To delete a report, do the following:

a. Select the report row header, and then select Delete Report.

b. Select Yes to confirm the deletion.

5. To save changes, select Apply.

6. To save changes and return to the Class View area, select OK.

See also

Configure the verification policy for parameters and reports on page 195

Select context IDs on page 188

Overview of sharing phases When a single phase or operation sequence is required by more than one unit, it
must be shared by all units that require it. Do not create a new instance of the
and operation sequences same phase or operation sequence in the other unit(s). Prior to sharing a phase or
between units operation sequence, verify the phase or operation sequence is physically able to be
shared.

A phase or operation sequence may have only one owner at a time. Sharing a single
phase or operation sequence allows any shared unit to gain ownership of it during
batch execution. A phase or operation sequence cannot be owned by more than
one unit at the same time.

When a phase or operation sequence is shared, any changes made to it are reflected
in each unit that contains the shared phase or operation sequence, including its
physical placement in the Design View area. When an instance of a shared phase
or operation sequence is deleted from one unit, the phase or operation sequence is
removed from the selected unit but it is still present in any other units to which it
belongs.

See also

Share a phase or operation sequence on page 232

Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017 241
Chapter 17 Operation sequence configuration

Share a phase or operation Use these instructions to share a phase or operation sequence.
sequence
To share a phase or operation sequence:

1. Select Start, point to All Programs > Rockwell Software > FactoryTalk
Batch Suite > FactoryTalk Batch, and then select Equipment Editor.

2. Open the area model.

3. Navigate to the phase or operation sequence level of the unit in the area
model that does not contain the phase or operation sequence to be shared.

4. Select Share.

The Share Phases and Operation Sequences Between Units dialog box
displays. Navigate to the phases and operation sequences by selecting the
plus (+) sign next to the unit names.

5. Select the phase or operation sequence to share with the current unit, then
select OK.

The icon of the selected phase or operation sequence displays in the Design
View area. A small hand is at the bottom left corner, in both the active unit
and the unit in which the phase or operation sequence was originally
defined.

See also

Overview of sharing phases and operation sequences between units

on page 231

242 Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017
 Appendix A

Supported area model changes

This section lists properties of an area model that can be edited without affecting a
Warm or Warm-All restart of the FactoryTalk Batch Server.

Important If an option or parameter is not listed in this section, it is not

considered safe to modify (create, edit, or delete) that object in order
to ensure a successful Warm or Warm-All restart of the FactoryTalk
Batch Server.

See also

Area model object warm restart support on page 243

Resource classes warm restart support on page 244

Resources warm restart support on page 244

Unit attributes warm restart support on page 245

Unit attribute tags warm restart support on page 245

Area model object warm A FactoryTalk Batch area model configuration file (.CFG file) always contains a
single area object by definition.
restart support
To edit, select Edit > Area.

Area Model Object Warm Restart Supported

Version Yes

See also

Supported area model changes on page 243

Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017 243
Appendix A Supported area model changes

Resource classes warm Select Edit > Resources to created or edited resource classes.

restart support Warm restart support for adding resource classes within an area model setting:

Resource Class Action Warm Restart Support

Create new resource class Yes

Warm restart support for modifying resource class properties setting:

Resource Class Property Warm Restart Support

Resource class name Yes

See also

Supported area model changes on page 243

Resources warm restart Select Edit > Resources to create and edit resources.

support Warm restart support for adding resources defined within an area model:

Resource Action Warm Restart Support

Creation Yes

Warm restart support for modifying resource properties:

Resource Property Warm Restart Support

Name Yes
Max Owners The value of this property can be increased without affecting warm
restart functionality.
Dependent Resources Resources can be removed from a resource’s list of dependent
resources without affecting warm restart functionality.
Cross Invocation Labels Yes
Hyperlink Labels Yes

See also

Supported area model changes on page 243

244 Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017
Supported area model changes Appendix A

Unit attributes warm Select Edit > Tags to create and edit unit attributes.

restart support Warm restart support for adding unit attributes defined within an area model:

Unit Attribute Action Warm Restart Support

Create tag classes Yes

Existing warm restart support for modifying unit attribute properties:

Unit Attribute Property Warm Restart Support

Engineering Unit Yes
Description Yes

See also

Supported area model changes on page 243

Unit attribute tags warm Create, delete, and edit unit attribute tags using the properties dialog of a unit
object.
restart support
Warm restart support for editing unit attribute tags within an area model:

Unit Attribute Tag Action Warm Restart Support

Creation Yes

Warm restart support for modifying the properties of a unit attribute tag:

Unit Attribute Tag Property Warm Restart Support

Engineering Unit Yes
Data Source Yes
Access Path Yes
Item Name Yes
Write Access Path Yes
Write Item Name Yes
Server Yes

See also

Units warm restart support on page 249

Unit overview on page 137

Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017 245
Appendix A Supported area model changes

Equipment phase tags Equipment phase tags are automatically created by FactoryTalk Batch Recipe
Editor when equipment phases are created.
warm restart support
Warm restart support for modifying the properties of an equipment phase tag:

Unit Attribute Tag Property Warm Restart Support

Access Path Yes
Item Name Yes
Write Access Path Yes
Write Item Name Yes

See also

Supported area model changes on page 243

Enumeration sets warm Select Edit > Enumeration Sets to create and edit enumeration sets.

restart support Warm restart support for adding enumeration sets defined within an area model.

• Enumeration Set Action: Creation

• Warm Restart Support: Yes

See also

Supported area model changes on page 243

246 Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017
Supported area model changes Appendix A

Data servers warm restart Select Edit > Server to create and edit data servers.

support Warm restart functionality for adding data servers to an area model:

Server Action Warm Restart Support

Creation Yes

Warm restart support for modifying data server properties:

Server Property Warm Restart Support

Data Server Type Yes
Watchdog Protocol Yes
Watchdog Item Access Path Yes
Watchdog Item Name Yes
Watchdog Write Item Access Path Yes
Watchdog Write Item Name Yes
Server Location Yes
On Control Scan Rate Yes
Off Control Scan Rate Yes

See also

Supported area model changes on page 243

Process cell classes warm Process cell classes are created within the main window of FactoryTalk Batch
Equipment Editor. Properties of a process cell class can be edited by right-clicking
restart support on the icon that represents a process cell class.

Warm restart support for adding process cell classes.

Process Cell Class Action Warm Restart Support

Creation Yes

Warm restart support for modifying the properties of a process cell class:

Process Cell Class Property Warm Restart Support

Name Yes
Icon Yes

See also

Supported area model changes on page 243

Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017 247
Appendix A Supported area model changes

Process cells warm restart Process cells are created and deleted using the main window of FactoryTalk Batch
Equipment Editor. Properties of a process cell can be edited by right-clicking on
support the icon that represents a process cell.

Warm restart support for adding process cells:

Process Cell Action Warm Restart Support

Creation Process cells can be added to an area model.

This table describes warm restart support for modifying the properties of a process
cell:

Process Cell Property Warm Restart Support

ERP Alias Yes
Max Owners The value of this property can be increased without
affecting warm restart functionality.
Dependent Resources Resources can be removed from a process cell's list of
dependent resources without affecting warm restart
functionality.
Cross Invocation Labels Yes
Hyperlink Labels Yes

See also

Area models on page 21

Process cell overview on page 125

248 Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017
Supported area model changes Appendix A

Unit classes warm restart Unit classes are created within the main window of FactoryTalk Batch Equipment
Editor. Properties of a unit class can be edited by right-clicking on the icon that
support represents a unit class.

Warm restart support for adding unit classes:

Unit Class Action Warm Restart Support

Creation Unit classes can be added to an area model.

This table describes warm restart support for modifying the properties of a unit
class:

Unit Class Property Warm Restart Support

Icon Yes
Assigned Unit Attributes Unit attributes can be added to the assigned set of the unit class.

See also

Supported area model changes on page 243

Units warm restart support Create units within the main window of FactoryTalk Batch Equipment Editor.
Right-click the icon representing a unit to edit the unit properties.

Warm restart support for adding units:

Unit Action Warm Restart Support

Creation Yes

This table describes warm restart support for modifying unit properties:

Unit Property Warm Restart Support

ERP Alias Yes
Unit Attribute Tags (See Unit attribute tags for information on which properties can
be modified.)
Dependent Resources Removing resources from the units list of dependent resources can
be done without affecting warm restart functionality.
Cross Invocation Labels Yes
Hyperlink Labels Yes

See also

Unit attribute tags warm restart support on page 245

Unit overview on page 137

Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017 249
Appendix A Supported area model changes

Parameters warm restart Right-click on a Phase icon to create Parameters for a phase in the Edit Phase
dialog box Parameters tab.
support
Warm restart support for adding parameters to a phase setting:

Parameter Action Warm Restart Support

Creation Parameters can be added to a recipe phase without affecting warm restart
functionality, with the exception of material parameters.

Important: If the Edit Phase dialog box General tab Material Based Recipes option is selected, the
optional material parameters, MATERIAL and AMOUNT, are added to the Parameters tab.
The warm restart functionality does NOT support these material parameters. Adding these
material parameters and then performing a warm restart causes running batches to be
removed from the Batch List.

Warm restart support for modifying the properties of a parameter associated with
a phase settings:

Parameter Property Warm Restart Support

High Raise the value of this property.
Low Lower the value of this property without affecting warm restart
functionality.
Default Yes
Engineering Units Yes

See also

Added parameters warm restart support on page 251

250 Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017
Supported area model changes Appendix A

Added parameters warm restart When building a unit operation level recipe, specify a value for each parameter in
support the recipe phases added as steps to the unit operation. The value can be:

• Actual value
• Operator Prompt
• Deferral to a higher level parameter

If the FactoryTalk Batch Server detects that a new parameter has been added to
the recipe phase (during the restoration of batches to the batch list during a warm
restart), then there is no value for the parameter that can be found in the loaded
recipe structure.

When no value is found, the server sets the value on the parameter for the step to
Operator Prompt.

See also

Supported area model changes on page 243

Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017 251
Appendix A Supported area model changes

Report warm restart Right-click on a phase class icon to create phase reports in the Edit Phase Class
dialog box Reports tab.
support
Warm restart support for adding reports to a phase class setting:

Report Action Warm Restart Support

Creation Reports can be added to a phase class without affecting warm restart
functionality, with the exception of material reports.

Important: When the Material Based Recipes option is selected in the Edit
Phase dialog box General tab, the optional material reports
ACTUAL_AMOUNT and FEED_COMPLETE are added to the Reports
tab. The warm restart functionality does not support these material
reports. Adding these material reports and then performing a warm
restart causes running batches to be removed from the batch list.

Warm restart support for modifying report properties associated with phase class
settings:

Report Property Warm Restart Support

Engineering Units Yes
Verification Method Yes
ERP Alias Yes

See also

Added reports warm restart support on page 252

Added reports warm restart When a unit operation level recipe is loaded into the FactoryTalk Batch Server,
the value of each report for each recipe phase step is set to Bad Value. As the
support
phase logic uploads report values, the Bad Value is replaced with the actual value
reported by the phase logic.

If the FactoryTalk Batch Server detects that a new report has been added to the
recipe phase (while restoring batches to the batch list during a warm restart), then
the report is treated as if it was never uploaded and assigned a current value of Bad
Value.

See also

Report warm restart support on page 252

252 Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017
Supported area model changes Appendix A

Configured messages warm Right-click on a recipe phase class icon to create phase class messages in the Edit
Phase Class dialog box, Messages tab.
restart support
Existing warm restart support for adding configured messages to a phase class
settings:

• Message Action: Creation

• Warm Restart Support: Messages can be added to a phase class without
affecting warm restart functionality.

See also

Supported area model changes on page 243

Recipe phases warm restart Right-click on a Recipe Phase icon to create and delete Recipe phases.

support Warm restart support for the adding of recipe phases setting:

Recipe Phase Action Warm Restart Support

Creation Recipe Phases can be added to an area model without
affecting warm restart functionality.

Warm restart support for modifying the properties of a recipe phase settings:

Recipe Phase Property Warm Restart Support

Number of Parameter Tags An increase in this value is safe for warm restart
functionality.
Number of Report Tags An increase in this value is safe for warm restart
functionality.
Parameters (See Parameters for information on which properties
can be modified.)
Reports (See Reports for information on which properties can
be modified.)
Messages (See Configured messages for information on which
properties can be modified.)

See also

Parameters warm restart support on page 250

Report warm restart support on page 252

Configured messages warm restart support on page 253

Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017 253
Appendix A Supported area model changes

Equipment phases warm From the main window in FactoryTalk Batch Equipment Editor, right-click on an
equipment phase icon to create equipment phases.
restart support
Warm restart support for adding equipment phases setting:

Equipment Phase Action Warm Restart Support

Creation Equipment phases can be added to an area model without
affecting warm restart functionality.

Warm restart support for modifying properties of an equipment phase settings:

Equipment Phase Property Warm Restart Support

ERP Alias This property can be changed without affecting warm restart
functionality.
Automatic Download on Start Yes
Automatic Upload on Complete Yes
Automatic Upload on Stopped Yes
Automatic Upload on Aborted Yes
Server Yes
Tags (See Equipment phase tags for information on which
properties can be modified.)
Dependent Resources Removing resources from a list of dependent resources can
be done without affecting warm restart functionality.
Cross Invocation Labels Yes
Hyperlink Labels Yes

See also

Equipment phase tags warm restart support on page 246

254 Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017
 Appendix B

Troubleshoot issues

Issues that may occur include:

• Import/export area model errors

• COM-related exception errors
• Signature template errors

See also

Unable to access instruction file on page 255

Illegal characters encountered in writing instruction file on page 256

Unable to access Material Server for material support per container

on page 256

COM-related exception errors on page 257

Invalid signoff on page 260

Unable to access instruction The XML schema requires that the contents of any instruction files must be
included in the XML file. FactoryTalk Batch Equipment Editor must access the
file instruction file at the time of the export. If the instruction files cannot be accessed,
this error message displays and the export does not occur.

See also

Troubleshoot issues on page 255

Illegal characters encountered in writing instruction file on page 256

Unable to access Material Server for material support per container

on page 256

Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017 255
Appendix B Troubleshoot issues

Illegal characters Because the contents of instruction files are included (that is, putting them into a
CDATA section), it is possible that the particular character sequence ]]>, which is
encountered in writing illegal in CDATA sections, might be encountered.
instruction file
If this character sequence is encountered, this error message displays and the
export does not occur.

See also

Troubleshoot issues on page 255

Unable to access Material Server for material support per container

on page 256

Unable to access Material There is a requirement that material support per container must be included in
the XML file. FactoryTalk Batch Equipment Editor must make a call to the
Server for material support Material Server at the time of the export. It is possible that the Material Server
per container cannot be accessed at that time.

If the Material Server cannot be accessed, this error message displays and the
export does not occur.

See also

Troubleshoot issues on page 255

256 Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017
Troubleshoot issues Appendix B

COM-related exception General COM-related system or program errors can occur for any number of
reasons in processing the import or export request. A generic error handling
errors displays the routine that encountered the error and the reason for the error as
supplied by the originator (function) of the error.

If this occurs, an error message displays and the import or export does not occur.
Examples include:

See also

XML parser error messages on page 257

Material-specific errors on page 258

XML parser error messages The Microsoft XML parser returns different error messages for different error
conditions. Examples of error conditions and error messages:

Error Condition Error Message

Invalid Data The element: <Element Name> has an invalid value according to its data type.
Invalid Element Content The element content is invalid according to its Schema. Expecting: <Element
Name>.
Undefined Key Reference Undefined values for KeyRef identity constraint: <Reference Constraint Name>.
Uniqueness Violation Duplicated values for unique/key identity constraint: <Uniqueness Constraint
Name>.

See also

Troubleshoot issues on page 255

COM-related exception errors on page 257

Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017 257
Appendix B Troubleshoot issues

Material-specific errors When the referenced material, material class, or container does not exist in the
material database, a dialog box similar to the one shown here opens with a list of
the missing phase class parameter values:

Select:

• Continue: Change the missing material, material class, or container with

NULL_MATERIAL, NULL_CLASS, or NULL_CONTAINER,
respectively, and continue the process.
• Ignore: Continue the process without any changes. A prompt displays to fix
the problem.
• Cancel: Quit the process.

If the Material Server is installed, but not accessible, or if the material system
enumeration sets (MATERIALS, MATERIAL_CLASSES, and CONTAINERS)
are included in a material-enabled recipe phase class and are not configured as
NULL, the import occurs without generating an error message.

A material-enabled recipe phase class must contain:

• $MATERIAL
• $AMOUNT

A material-enabled recipe phase class must contain:

• $ACTUAL_AMOUNT
• $FEED_COMPLETE

258 Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017
Troubleshoot issues Appendix B

A material-enabled recipe phase class may, as an option, contains four recipe

parameters. They must be included together or not at all:

• $CONTAINER
• $LOT
• $LABEL
• $MATERIAL_CLASS

See also

COM-related exception errors on page 257

Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017 259
Appendix B Troubleshoot issues

Invalid signoff If required signoff information for a signature template is unknown or missing,
the Invalid Signoffs dialog box opens when starting or using FactoryTalk Batch
Equipment Editor:

This error notification can occur:

• When FactoryTalk Batch Equipment Editor starts after a group or user

account used in signature template(s) is deleted.
• In FactoryTalk Batch Equipment Editor, Edit Signature Templates dialog
box was exited without configuring all required signature information.

See also

Resolve invalid signoff caused by deleted group or user on page 261

Resolve invalid signoff when required information is omitted on page 262

260 Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017
Troubleshoot issues Appendix B

Resolve invalid signoff caused Use these instructions to troubleshoot the Invalid Signoff dialog box triggered
by deleted group or user by:

• Signature templates are created in FactoryTalk Batch Equipment Editor

and then saved to the area model.
• FactoryTalk Batch Equipment Editor is closed.
• A group or user account used in one or more signature templates is deleted
in the FactoryTalk Administration Console.
• FactoryTalk Batch Equipment Editor is re-started.
• The Invalid Signoff dialog box opens.

To resolve invalid signoff caused by deleted group or user:

• To delete the account from the signature template(s), select OK, save the
area model and restart FactoryTalk Batch Equipment Editor. The error
message no longer opens.
• To not delete the account from the signature template(s), select OK, and
exit FactoryTalk Batch Equipment Editor without saving the area model.
Determine the deleted group or user account in the Event Viewer
(Start>Administrative Tools>Event Viewer> Applications and Services
Logs> FactoryTalk Diagnostics). Then re-add the account using the
FactoryTalk Administration Console.

See also

Invalid signoff on page 260

Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017 261
Appendix B Troubleshoot issues

Resolve invalid signoff when Use this information to troubleshoot the Invalid Signoff dialog box triggered by
these sequence of events:
required information is omitted
1. Signature templates are created in the Edit Signature Templates dialog
box in FactoryTalk Batch Equipment Editor.

2. Required information for a valid signoff is omitted or forgotten (for

example, multiple signoffs are configured but security permissions are not
specified for all signoffs).

3. Selected OK or Apply.

4. The Invalid Signoffs dialog box opens.

To resolve invalid signoff:

1. Examine the information presented in the Invalid Signoffs dialog box.

Listed beneath the Signature Template column is the name of the template
or templates not fully configured.

2. Select OK and then make the necessary change(s) in the Edit Signature
Templates dialog box. For example, configure security permissions for all
signoffs, select OK to save the signature template configuration, then use
the File > Save command to save the signature templates in the area model.

See also

Invalid signoff on page 260

No Signature templates If no signature templates have been configured in the area model, attempted use of
Signature Template Selection Browse produces this error message:
configured within the Area
Model

Define templates in Edit > Signature Templates and retry the operation.

See also

Troubleshoot issues on page 255

262 Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017
Troubleshoot issues Appendix B

Equipment Editor: Area If applied security authority to the area model, and there is a security mismatch
between the security authority identifier (SAI) in the area model and the
model is secured to a FactoryTalk Network Directory SAI, this error message opens in FTB_EE>:
different FactoryTalk
Network Directory

Make note of the FactoryTalk Network Directory and host computer

information, then select OK to close the error message.

If there is a backup of the FactoryTalk Network Directory SAI, or of the area

model in an unsecured form, these options are available:

• Restore the FactoryTalk Network Directory SAI to which the area model is
secured. The name of the computer that hosts that SAI is provided in the
dialog box. Use the FactoryTalk Administration Console to restore a saved
backup of the SAI. The Restore command is available by right-clicking on
the top node in the Explorer pane. When the SAI restores, use File > Open
in FactoryTalk Batch Equipment Editor to open the secured area model.
• Open an unsecured copy of the area model.

See also

Troubleshoot issues on page 255

Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017 263
Appendix B Troubleshoot issues

Recipe Editor: Area model is When attempting to open FactoryTalk Batch Recipe Editor, and an SAI
mismatch exists between the area model and the FactoryTalk Network Directory,
secured to a different this error message opens:
FactoryTalk Network
Directory

Make note of the FactoryTalk Network Directory and host computer

information, then select OK to close the error message and FactoryTalk Batch
Recipe Editor.

To recover, backup of the FactoryTalk Network Directory SAI, or of the area

model in unsecured form.

• Restore the FactoryTalk Network Directory SAI to which secures the area
model. The name of the computer that hosts that SAI is provided in the
dialog box. Use the FactoryTalk Administration Console to restore a saved
backup of the SAI. The Restore command is available by right-clicking on
the top node in the Explorer pane. When the SAI with which the area
model is associated is restored, open FactoryTalk Batch Recipe Editor.
• Open an unsecured copy of the area model in FactoryTalk Batch
Equipment Editor, then select File > Save. Then, open FactoryTalk Batch
Recipe Editor.

See also

Troubleshoot issues on page 255

264 Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017
 Legal Notices

Legal Notices Copyright notice

© 2017 Rockwell Automation Technologies, Inc. All rights reserved. Printed in

USA.

This document and any accompanying Rockwell Software products are

copyrighted by Rockwell Automation Technologies, Inc. Any reproduction
and/or distribution without prior written consent from Rockwell Automation
Technologies, Inc. is strictly prohibited. Please refer to the license agreement for
details.

End User License Agreement (EULA)

You can view the Rockwell Automation End-User License Agreement ("EULA")
by opening the License.rtf file located in your product's install folder on your hard
drive.

Trademark Notices

Allen-Bradley, CompactLogix, ControlLogix, Connected Components

Workbench, eProcedure, FactoryTalk, GuardLogix, GuardPLC, Micro800,
MicroLogix, MobileView, MobileView Guard, PanelBuilder, PanelView,
PhaseManager, PlantLink, PlantPAx, PLC-2, PLC-3, PLC-5, PowerMonitor,
RSBizWare, RSBizWare BatchHistorian, RSBizWare Historian, RSBizWare
MaterialTrack, RSLinx, Rockwell Automation, Rockwell Software, SLC,
SoftLogix, Studio 5000, and XMare trademarks of Rockwell Automation, Inc.

Any Rockwell Automation software or hardware not mentioned here is also a

trademark, registered or otherwise, of Rockwell Automation, Inc.

For a complete list of products and their respective trademarks, go to:

http://www.rockwellautomation.com/rockwellautomation/legal-notices/overvie
w.page?#tab4

Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017 265
Legal Notices

Warranty

This product is warranted in accordance with the product license. The product’s
performance may be affected by system configuration, the application being
performed, operator control, maintenance, and other related factors. Rockwell
Automation is not responsible for these intervening factors. The instructions in
this document do not cover all the details or variations in the equipment,
procedure, or process described, nor do they provide directions for meeting every
possible contingency during installation, operation, or maintenance. This
product’s implementation may vary among users.

This document is current as of the time of release of the product; however, the
accompanying software may have changed since the release. Rockwell Automation,
Inc. reserves the right to change any information contained in this document or
the software at any time without prior notice. It is your responsibility to obtain the
most current information available from Rockwell when installing or using this
product.

Environmental compliance

Rockwell Automation maintains current product environmental information on

its website at
http://www.rockwellautomation.com/rockwellautomation/about-us/sustainabili
ty-ethics/product-environmental-compliance.page

Contact Rockwell Automation

Customer Support Telephone — 1.440.646.3434

Online Support — http://www.rockwellautomation.com/support/

266 Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017
 Index
command verification policy
A change 80
add configure 78
data servers 247 remove 81
enumeration sets 246 configure 117
OPC data server 100 unit attribute tag information 145
process cell classes 247 configure a recipe approval 85
process cells 248 container information
resource classes 244 equipment module 220
resources 244 control strategies
unit attribute tags 245 and verification policies 200
unit attributes 245 example 55
unit classes 249 implement 56
units 249 overview 54
arbitration information with upload/download parameter subsets 62
process cell 130 copy a phase 203
shared resources 113 create
unit 146 global unit attribute 169
area model create area model 22
create 22 create phase classes 175
edit 243 create process cell class 126
import XML file 30, 31 cross invocation
migration 24 definition of 149
name 22 cross invocation strings
open 23 equipment modules 218
secure 93 process cells 149
automatic upload/download 61 shared resources 115
unit 149
cut and paste a phase 204
B
batch commands, configure verification policies 78
binding expressions
data types 119
operators 119
binding requirements 117
example 117

C
calculation method 194
classes, unit 249
command verification policies dialog box, field descriptions 80

Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017 267
Index

electronic signature template 67

add 69
D configure signoffs 71
data server delete 76
add 97, 247 modify 77
default item access path 99 electronic signatures
delete 106 how they work 65
edit 105 sequence of tasks 65
location 99 types 64
name 99 use 63
OPC 99 enable
RSLinx Enterprise Live 102 parameter limit tags 223
scan rates 99 report limit tags 227
types 99 enhanced phase logic request 57, 61
watchdog item access path 99 enumeration sets 37
watchdog item name 99 add 246
watchdog protocol 99 delete 43
watchdog write item access path 99 description 37
watchdog write item name 99 example 37
data server definition files 96 negative ordinal values 37
data server properties work with 40
modify 247 enumerations
data server protocols material database unavailable 39
CIP 97 equipment dependencies
FTD 97 process cells 130
OPC 97 unit 146
data servers Equipment Editor
assign 107 interface 18
data types open 16
binding expressions 119 security 16
enumeration 119 equipment module
examples 119 container information 220
integer 119 cross invocation strings 218
real 119 hyperlink strings 219
string 119 OPC tags 212
default tags tag naming conventions 213
naming conventions 212 tags 164, 212
delete equipment phase tag properties
unit instance 152 modify 246
deviation limits 194 equipment phases
DSDF 96 modify 254
duplicate a phase 203 example
unit attribute binding 117
expression builder
E unit binding 118
edit command verification policies dialog box, field descriptions 80 validation-Recipe Editor 120
edit signature templates dialog box, field descriptions 68
268 Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017
 Index

expressions L
operands-Equipment Editor 120
operators-Equipment Editor 119 limit tags
validation-Equipment Editor 120 map to parameter tags 225
map to report tags 228
name conventions 212
F tag locking disabled 225, 228
FactoryTalk Live Data 101 tag locking enabled 223, 227
link
units 153
G
general information
M
process cells 209
shared resources 112 material database
global binding requirements 117 area model 25
global unit attribute enumerations 39
create 169 material-enabled phases
groups, configure for electronic signatures 71 configure 201
disable 202
material-specific errors 258
H menu bar 19
High/Low 193 message partners 178
High-High/Low-Low 193 messages
High-High-High/Low-Low-Low 193 modify 253
hyperlink strings modify
equipment module 219 area object 243
shared resources 116 data server properties 247
unit 151 equipment phase tag properties 246
equipment phases 254
messages 253
I process cell class 247
icons process cell properties 248
create 136 recipe parameter properties 250
path verification 135 recipe phases 253
import report parameter properties 252
enumerations (XML) 30 resource class properties 244
system phases (XML) 31 resource properties 244
XML area model 30, 31 unit attribute properties 245
import errors unit attribute tag properties 245
material-specific 258 unit attribute tags 245
XML parser 257 unit class properties 249
unit properties 249

Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017 269
Index

process cell
add 248
N arbitration information 130
No Limits 193 class
none, verification policy 194 create 126
not allowed 194 edit 127
create 127
cross invocation strings 149
O definition 248
operands general information 209
binding expression-Equipment Editor 120 process cell classes
operators, expressions-Equipment Editor 119 add 247
modify 247
process cell properties
P
modify 248
parameter deviations, select verification method 53
parameter limits 53
parameter tags R
map to limit tags 225 recipe approval 85
naming conventions 212 recipe parameter properties
parameters modify 250
overview 45 recipe parameters
phase 49 warm restart 251
report 50 recipe phases
scale 53 modify 253
target 200 report parameter properties
permissions, configure for electronic signatures 71 modify 252
phase report parameters
configuring to material-enabled 201 warm restart 252
copy 203 report tags
cut 204 map to limit tags 228
disable material-enabled 202 name conventions 212
parameters reports
definition 49, 250 phase 50
paste 204 request tags, name conventions 212
phase commands, configure verification policies 78 resource class properties
phase link group 178 modify 244
phase logic resource classes
enhanced request 57, 61 add 244
phase parameters resource properties
definition 250 modify 244
policy resources
change for a command 80 add 244
remove for a command 81
verification 78

270 Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017
 Index

re-verify recipes 22 create 164

RSLinx Enterprise 101 map to limit tags 225, 228
RSLinx Enterprise Live Data server 102 naming conventions 212
RSLinx Enterprise Live Data tags 46 RSLinx Enterprise Live Data 46
RSLinx Enterprise Server Path 99, 104 set to default addresses 216
set to default names 167
unit attribute 161
S unit attribute tags 158
save area model 22 information 145
scale parameters 53 work with 157
scan rates target parameters, and report verification policies 200
data server 99 template
security permissions, configure for electronic signatures 71 add 69
server options 19 configure signoffs 71
share delete 76
units 153 modify 77
shared resources signature 67
define 111 toolbar-Equipment Editor 19
description 110 transitions
signature requirement, remove for a command 81 data types-Equipment Editor 119
signature template
add 69
configure signoffs 71
U
create 67 unique icons 136
delete 76 unit
modify 77 arbitration information 146
verification policy 194 configure arbitration 146
signature templates dialog box, field descriptions 68 configure cross invocation 149
signatures configure hyperlinks 151
electronic 63 configure tag information 145
how they work 65 create a unit class 139
sequence of tasks 65 create a unit instance 141
types 64 create tags 161
signoff policies, configure for commands 78 cross invocation strings 149
signoffs, configure 71 definition 249
Single Sign-On Equipment Editor 16 delete 152
edit a unit class 140
equipment dependencies 146
T hyperlink strings 151
tags link 153
delete tag class 171 remove a unit instance 152
description 157 share 153
edit 165 tags information 145
edit from menu 165 work with 137
edit tag class 171
equipment module information 210
equipment module tags
Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017 271
Index

unit attribute binding

example 117
unit attribute properties
modify 245 W
unit attribute tag properties watchdog
modify 245 item access path 99
unit attribute tags 145 item name 99
add 245 protocol 99
create 161 Windows-linked user 16
modify 245
unit attributes
add 245 X
unit binding expression builder-Equipment Editor 118 XML
unit class properties import enumerations 30, 31
modify 249 XML parser errors 257
unit classes
add 249
unit instance
create 141
remove 152
unit properties
modify 249
unit tag class
See 158
units
add 249
upload/download parameter subsets 57
use with control strategies 62
user groups, configure for electronic signatures 71

V
validation
binding expressions-Equipment Editor 120
verification method, select 53
verification policies 194
and control strategies 200
change for a command 80
configure 193
configure for commands 78
configure for parameters and reports 195
dialog box fields 198
remove for a command 81

272 Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017
Rockwell Automation support
Rockwell Automation provides technical information on the web to assist you in using its products. At
http://www.rockwellautomation.com/support you can find technical and application notes, sample code, and links to software service packs. You
can also visit our Support Center at https://rockwellautomation.custhelp.com for software updates, support chats and forums, technical
information, FAQs, and to sign up for product notification updates.

In addition, we offer multiple support programs for installation, configuration, and troubleshooting. For more information, contact your local
distributor or Rockwell Automation representative, or visit http://www.rockwellautomation.com/services/online-phone .

Installation assistance
If you experience a problem within the first 24 hours of installation, review the information that is contained in this manual. You can contact
Customer Support for initial help in getting your product up and running.

United States or Canada 1.440.646.3434

Outside United States or Canada Use the Worldwide Locator available at http://www.rockwellautomation.com/locations , or contact your local Rockwell
Automation representative.

New product satisfaction return

Rockwell Automation tests all of its products to ensure that they are fully operational when shipped from the manufacturing facility. However, if
your product is not functioning and needs to be returned, follow these procedures.

United States Contact your distributor. You must provide a Customer Support case number (call the phone number above to obtain one) to
your distributor to complete the return process.
Outside United States Please contact your local Rockwell Automation representative for the return procedure.

Documentation feedback
Your comments will help us serve your documentation needs better. If you have any suggestions on how to improve this document, complete the
feedback form, publication RA-DU002.

Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017

Copyright © 2017 Rockwell Automation Technologies, Inc. All rights reserved. Printed in the U.S.A.