FactoryTalk Batch User Guide - Literature Library

FactoryTalk Batch User Guide - Literature Library
User Guide
FactoryTalk Batch
Administrator Guide
FactoryTalk® Batch
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
components
Document organization .................................................................................................... 11
FactoryTalk Batch regional settings ............................................................................... 12
Chapter 2
FactoryTalk Batch
communications
Create a shared directory .................................................................................................. 13
Use OLE for Process Control (OPC)............................................................................ 14
OPC group support ................................................................................................... 14
Chapter 3
FactoryTalk Batch security
FactoryTalk Batch Server user account configuration requirements ...................... 16
FactoryTalk Batch system configuration....................................................................... 17
System-wide COM security limit settings............................................................. 18
FactoryTalk Batch Server install configuration ................................................... 19
FactoryTalk Batch Client installation configuration ......................................... 20
FactoryTalk Batch Windows Firewall exceptions ............................................... 21
Add the Batch COM service.................................................................................... 22
Set security on folders or files........................................................................................... 24
Add users and user groups ........................................................................................ 25
FactoryTalk Security for the Batch Clients .................................................................. 25
Tighten security for FactoryTalk Batch Clients .................................................. 26
FactoryTalk Batch View security .................................................................................... 28
Configure security for the FactoryTalk Batch View windows .......................... 28
Security for FactoryTalk Batch commands........................................................... 29
Configure security for FactoryTalk Batch commands................................ 30
Enable the FactoryTalk Batch View confirm settings................................. 31
Set the automatic logoff time period ...................................................................... 33
Change the logged-on user with your HMI .......................................................... 34
External security devices ........................................................................................... 36
Enable an external security device ................................................................... 37
FactoryTalk Batch Equipment Editor and FactoryTalk Batch Recipe Editor
security.................................................................................................................................. 37
Configure access mode security ............................................................................... 39
Configure feature security ........................................................................................ 40
Modify FactoryTalk Batch Equipment Editor configuration options ............ 41
FactoryTalk Batch default policy settings ..................................................................... 41
Product policies in the local and network directories ......................................... 42
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
3
Table of contents
Chapter 4
FactoryTalk Batch electronic
signatures
Command verification policies ....................................................................................... 48
Command signature requests .................................................................................. 49
Set parameter signature request ............................................................................... 51
FactoryTalk Batch Parameter Prompt Acknowledge Signature request ........ 52
Unit Bind Prompt Acknowledge Signature request ........................................... 53
Phase Bind Prompt Acknowledge Signature request .......................................... 54
Unit Bind Signature request .................................................................................... 55
Remove Batch Signature request ............................................................................. 56
Add Event Signature request.................................................................................... 57
Active Step Change Signature request ................................................................... 58
Parameter deviation verification policies....................................................................... 59
Parameter deviation signature requests.................................................................. 60
Report parameter deviation signature requests .................................................... 61
General usage phase logic requests .................................................................................. 61
General usage signature requests ............................................................................. 62
Electronic signature security ............................................................................................ 63
Configure the ESignature network directory policy setting .............................. 64
Chapter 5
FactoryTalk Batch audit trail
4
Enable auditing for FactoryTalk Batch Equipment Editor or FactoryTalk Batch
Recipe Editor....................................................................................................................... 67
Audited FactoryTalk Batch Equipment Editor events............................................... 68
Audited FactoryTalk Batch Recipe Editor events ....................................................... 71
Audit messages .................................................................................................................... 73
FactoryTalk Diagnostics Viewer ............................................................................. 74
Standard viewer message fields in FactoryTalk Diagnostics Viewer ........ 75
Extended viewer message fields in FactoryTalk Diagnostics Viewer ....... 76
FactoryTalk AssetCentre Client ............................................................................. 78
Viewer message fields ................................................................................................. 79
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
Table of contents
Chapter 6
The FactoryTalk Batch Service
Manager
Windows services ............................................................................................................... 82
FactoryTalk Batch Service Manager interface .............................................................. 82
Connection.................................................................................................................. 83
Service state.................................................................................................................. 83
Server............................................................................................................................. 84
Batch Server Statistics dialog box .................................................................................... 85
Batch Server Statistics dialog box - General tab ................................................... 86
Batch Server Statistics dialog box - Messages tab ................................................. 87
Batch Server Statistics dialog box - PCD Communications tab ....................... 88
Batch Server Statistics dialog box - View Communications tab ....................... 89
Start the FactoryTalk Batch Server service ................................................................... 90
Grace periods in FactoryTalk Batch Server........................................................... 92
Enable a grace period ................................................................................................. 93
Add a custom service ......................................................................................................... 94
Chapter 7
The FactoryTalk Batch Server
FactoryTalk Batch Server service configuration .......................................................... 95
Specify the startup type ............................................................................................. 96
FactoryTalk Batch Server option configuration .......................................................... 97
Server Options dialog box - Project Settings tab .................................................. 98
Set project directories ........................................................................................ 99
Recipe storage .................................................................................................... 100
Recipe versioning .............................................................................................. 101
Server Options dialog box - Restart Control tab ............................................... 101
Redundant servers ............................................................................................ 102
Server Options dialog box - Batch Reporting tab .............................................. 103
Report Editor .................................................................................................... 104
Perform end of batch archiving ..................................................................... 105
Perform incremental archiving ...................................................................... 106
Perform user-defined end of batch................................................................ 107
None.................................................................................................................... 107
Never ................................................................................................................... 107
Archiver Event Filters tab ....................................................................................... 108
Batch Server tab ........................................................................................................ 109
Hold propagation ............................................................................................. 110
Communications timeout .............................................................................. 111
Miscellaneous .................................................................................................... 112
Cross Invocation Descriptors and Defaults tab ................................................. 113
Resource types ................................................................................................... 113
Descriptors......................................................................................................... 113
Default values .................................................................................................... 114
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
5
Table of contents
Hyperlink Descriptors and Defaults tab ............................................................. 114
Material Policies tab................................................................................................. 115
Modify the .NET registry key ........................................................................................ 116
Use automatic restart control to restart the FactoryTalk Batch Server ................ 117
Restart the FactoryTalk Batch Server .................................................................. 117
Perform a manual failover............................................................................................... 118
Configure the FactoryTalk Batch Server for manual failover ......................... 119
Configure the material-enabled FactoryTalk Batch Server for manual failover
...................................................................................................................................... 120
Command handshake timeout ...................................................................................... 122
Chapter 8
View event log entry properties ..................................................................................... 123
Modify event log settings ................................................................................................ 127
Windows event log
Chapter 9
Cross invocation overview.............................................................................................. 130
Cross invocation string configuration ......................................................................... 132
Cross invocation string escape sequences .................................................................... 134
Cross invocation string example ........................................................................... 136
FactoryTalk Batch View and ActiveX Controls configuration for cross
invocation .......................................................................................................... 137
Cross invocation
Chapter 10
The FactoryTalk Batch Phase
Simulator
6
Start the FactoryTalk Batch Phase Simulator ............................................................ 140
FactoryTalk Batch Phase Simulator interface .................................................... 141
Phase Configuration dialog box ................................................................................ 142
Change the dwell time............................................................................................. 143
Change the sequence of requests ........................................................................... 144
Indicate a continuous phase ................................................................................... 145
Phase Status dialog box ................................................................................................... 146
View phase parameter tag values ........................................................................... 147
View and update report parameter tag values ..................................................... 148
View request data tag values ................................................................................... 149
Change ownership of a phase ................................................................................. 150
Command a phase .................................................................................................... 151
Phase commands............................................................................................... 152
Acknowledge and clear a request........................................................................... 153
Restore and clear requests ....................................................................................... 154
Unit Tag Status dialog box ............................................................................................. 155
Change the value of a unit tag................................................................................ 156
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
Table of contents
Chapter 11
Network Editor
Open the Network Editor .............................................................................................. 157
Network Editor interface ............................................................................................... 158
Hierarchy pane.......................................................................................................... 159
Detail pane ................................................................................................................. 159
Results pane ............................................................................................................... 160
Menu bar .................................................................................................................... 161
Network Editor toolbar .......................................................................................... 161
Status bar .................................................................................................................... 162
Configure your network ................................................................................................. 162
Select a network model............................................................................................ 163
Add a server ............................................................................................................... 164
Remove a server......................................................................................................... 164
Synchronize network models ................................................................................. 165
User Preferences dialog box............................................................................................ 165
User Preferences dialog box - General tab ........................................................... 166
Edit colors .......................................................................................................... 167
Edit the application font ................................................................................. 168
Edit information tips ....................................................................................... 169
User Preferences dialog box - Views tab............................................................... 170
List View properties ......................................................................................... 171
User Preferences dialog box - Reports tab ........................................................... 172
Set report preferences ...................................................................................... 173
Change margins ................................................................................................ 174
Set the report fonts and colors ....................................................................... 175
Column and row preferences in reports ...................................................... 178
Report printing formats .................................................................................................. 179
Preview reports ......................................................................................................... 180
Print reports .............................................................................................................. 181
Print a range of reports ............................................................................................ 181
Chapter 12
Server
Abnormal FactoryTalk Batch termination ................................................................. 183
Copied log file filename .......................................................................................... 184
Abnormal termination batch record entries ....................................................... 185
Tag verification log information ................................................................................... 186
Tag verification log file ............................................................................................ 187
Windows Event Log ................................................................................................ 188
FactoryTalk Batch performance chart ......................................................................... 188
Open the FactoryTalk Batch performance chart ............................................... 189
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
7
Table of contents
Chapter 13
Enable editing of batch IDs ............................................................................................ 191
Disable editing of batch IDs........................................................................................... 192
Define a custom default batch ID ................................................................................. 193
Create a custom batchidcreation.dll ............................................................................. 194
Batch identification
Chapter 14
Change the FactoryTalk Batch
Server user account
New user account requirements for the FactoryTalk Batch Server ....................... 197
Configure your FactoryTalk Batch system ................................................................. 198
Server account password change locations .......................................................... 200
Change the server user account for the FactoryTalk Batch Server service.... 201
Change the server user account in FactoryTalk Batch COM+ applications202
Change the server user account in My Computer properties.......................... 203
Chapter 15
Run multiple instances of
FactoryTalk Batch View
8
Enable multiple FactoryTalk Batch View instances .................................................. 206
Custom configuration files ..................................................................................... 207
Copy and rename a default configuration file ............................................ 208
Create configuration files when launching FactoryTalk Batch View .... 209
Configuration file log location .............................................................................. 210
Start FactoryTalk Batch View from the command line ........................................... 211
Start FactoryTalk Batch View with a configuration file................................... 212
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
Table of contents
Appendix A
General troubleshooting
errors
Legal Notices
Index
Automatic repair of batch component installation fails. .......................... 213
FactoryTalk Batch Server does not start. ..................................................... 213
FactoryTalk Batch Server runs for a specific period of time and then
stops, and consistently stops at the same time interval. ............................ 214
FactoryTalk Batch Service Manager does not display the FactoryTalk
Batch Server or FactoryTalk Event Archiver. ............................................. 214
FactoryTalk Batch Service Manager displays Batch.Server Class instead of
Batch Server. ....................................................................................................... 214
The FactoryTalk Batch View/Client is properly configured, but cannot
view the Event Journals. .................................................................................. 214
The text in FactoryTalk Batch dialog boxes does not display properly. 214
Unable to locate files. ....................................................................................... 215
An Application Log error is generated. ........................................................ 215
A Licensing error message is generated in Visual Basic. ............................ 215
Recipes not visible from FactoryTalk Batch View program. ................... 216
List of available SQL server databases not displayed in the Server Options
dialog box. .......................................................................................................... 216
Event Journal files are not being created...................................................... 216
Legal Notices ..................................................................................................................... 217
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
9
Chapter 1
FactoryTalk Batch components
This guide contains instructions for tasks specific to FactoryTalk® Batch, such as
configuring security and services. Instructions are also provided on the
implementation and use of components not normally accessed or used by batch
operators, such as the FactoryTalk Batch Server, Simulator, and performance
chart.
See also
Document organization on page 11
FactoryTalk Batch regional settings on page 12
Document organization
The information in this document is presented in an order that should minimize
the effort required for the configuration and administration of a FactoryTalk
Batch system.
The following subjects are included:
•
Configuring Regional Settings, Communications, Security, Electronic
Signatures, and Batch Auditing
•
Using the FactoryTalk Batch Service Manager, Windows Event Log, Phase
Simulator, and Server
•
Configuring Batch IDs, the Server user account, and multiple instances of
FactoryTalk Batch View
•
General troubleshooting
See also
FactoryTalk Batch Communications on page 13
FactoryTalk Batch security on page 15
The FactoryTalk Batch Server on page 95
Batch identification on page 191
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
11
Chapter 1
FactoryTalk Batch components
FactoryTalk Batch regional
settings
FactoryTalk Batch components are supported in U.S. English only. Install the
English language version of Windows Server, Windows 7, or Windows 8.1 to
ensure proper operation of FactoryTalk Batch, FactoryTalk eProcedure, or
FactoryTalk Batch Material Manager.
Important:
Modifying regional settings is not supported.
See also
FactoryTalk Batch security on page 15
FactoryTalk Batch communications on page 13
12
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
Chapter 2
FactoryTalk Batch communications
The FactoryTalk Batch Server uses the Component Object Model (COM) to
access data from project directories and to communicate with other programs such
as FactoryTalk Batch View, and data servers. All project directories accessed by the
FactoryTalk Batch Server must be shared, and the server user account must have
permission to access that shared directory.
See also
Create a shared directory on page 13
Use OLE for Process Control (OPC) on page 14
Create a shared directory
A shared directory allows computers on the network to read from and write to a
common recipe, area model, or data file. The FactoryTalk Batch installation
creates a shared directory named BATCHCTL where the FactoryTalk Batch
software is installed (the default is C:\Program Files (x86)\Rockwell
Software\Batch). If you installed your project files in a different directory,
configure that directory as a shared directory. To configure a shared directory,
administrative privileges are required.
To create a shared directory:
1. Navigate to the project file directory, then right-click the folder, and select
the sharing option.
2. Use the File Sharing dialog box to add each user or user group name that
requires access to the project file directory.
3. Repeat for each user or user group, including the user accounts used by the
FactoryTalk Batch Server and FactoryTalk Event Archiver.
4. Select Share.
See also
Use OLE for Process Control on page 14
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
13
Chapter 2
FactoryTalk Batch communications
Use OLE for Process Control
(OPC)
The FactoryTalk Batch Server supports the use of the OLE for Process Control
(OPC) communications protocol. OPC provides a defined set of COM interfaces
for data access functions.
The OPC communications protocol is used by the FactoryTalk Batch Server to
communicate with process-connected devices via a data server and to
communicate with FactoryTalk Batch View, SignatureList ActiveX control and
PC-Based phases. COM is used to communicate with ActiveX controls or other
high-level applications such as FactoryTalk Batch Material Manager.
See also
OPC group support on page 14
OPC group support
Within the OPC protocol, data is accessed through collections of data items
referred to as groups. Different data servers have varying levels of OPC support,
including maximum numbers of groups, maximum numbers of items per group
and performance issues, and so on. Because of this, FactoryTalk Batch support of
OPC is flexible in order to achieve successful communication with as many
different data servers as possible. To achieve this, the FactoryTalk Batch Server is
flexible in its definition of Groups, and allows for different OPC grouping
configurations to communicate with the data server(s).
The manner in which the FactoryTalk Batch Server organizes the area model tags
into groups is defined by data server definition files (DSDF). These files are
located in the Batch\Dataservers directory. FactoryTalk Batch comes with a
predefined set of DSDF files. If you need to communicate with a data server for
which there is no predefined DSDF file, contact Rockwell Automation
Application Support.
See also
Use OLE for Process Control (OPC) on page 14
14
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
Chapter 3
FactoryTalk Batch security
The following information explains administering security for the FactoryTalk
Batch Server using Windows security and implementing FactoryTalk Security for
the FactoryTalk Batch Client components. For information on the administration
of your FactoryTalk Security system as a whole, see FactoryTalk Help.
To open FactoryTalk Help, click Start, point to All Programs > Rockwell
Software > FactoryTalk Tools, and then click FactoryTalk Help.
See also
FactoryTalk Batch Server user account configuration requirements
on page 16
FactoryTalk Batch system configuration on page 17
FactoryTalk Security for the Batch clients on page 25
FactoryTalk Batch default policy settings on page 41
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
15
Chapter 3
FactoryTalk Batch security
FactoryTalk Batch Server
user account configuration
requirements
Create a Windows user account for the FactoryTalk Batch Server prior to
installing FactoryTalk Batch applications. When installing FactoryTalk Batch and
FactoryTalk eProcedure applications, you are prompted to enter this user account.
When creating the server user account, the following configuration requirements
must be met.
•
The password must be configured to never expire.
If the password expired, the batch server service would fail to log on.
•
The server user account must never be disabled or deleted.
If this account is ever disabled or deleted, the batch server service would fail
to log on.
•
The domain user account must have a unique name.
If the server user account is a domain account, remove any local user
accounts with the same name.
•
The Server user account or user group must exist on all workgroup
computers.
If you are using a local account and expect that account to have access to
resources on other computers in a workgroup environment, you must create
accounts with the same name and password on each computer in the
workgroup.
See also
FactoryTalk Batch system configuration on page 17
FactoryTalk Batch security on page 15
16
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
FactoryTalk Batch security
Chapter 3
FactoryTalk Batch system
configuration
The FactoryTalk Batch and FactoryTalk eProcedure installation programs
configure the local computer with the necessary COM Security settings to allow
remote communication between the FactoryTalk Batch Server and client
applications.
The configuration of the local computer during installation depends on whether
you are installing a server or client application, a FactoryTalk Batch or eProcedure
application and whether the Windows Firewall is enabled or disabled.
See also
System-wide COM security limit settings on page 18
FactoryTalk Batch Server install configuration on page 19
FactoryTalk Batch Client installation configuration on page 20
FactoryTalk Batch Windows Firewall exceptions on page 21
Add the Batch COM service on page 22
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
17
Chapter 3
FactoryTalk Batch security
System-wide COM security limit
settings
To support DCOM client-server communication, configure the local computer’s
COM Security Limits with these access, launch, and activation permissions.
Access Permissions
Security Limits for ANONYMOUS LOGON:
•
Local Access Permissions
•
Remote Access Permissions
Launch and Activation Permissions
Security Limits for ANONYMOUS LOGON:
•
Local Launch Permissions
•
Local Activation Permissions
•
Remote Activation Permissions
See also
FactoryTalk Batch Server install configuration on page 19
FactoryTalk Batch Client installation configuration on page 20
FactoryTalk Batch Windows Firewall exceptions on page 21
Add the Batch COM service on page 22
FactoryTalk Batch system configuration on page 17
18
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
FactoryTalk Batch security
Chapter 3
FactoryTalk Batch Server install
configuration
During the FactoryTalk Batch Server installation, the Windows user group
batchsvr_group is created on the FactoryTalk Batch Server. This group is
automatically assigned all the user rights and default access permissions required
for the FactoryTalk Batch Server to function correctly.
The installation programs for the FactoryTalk Batch Server and FactoryTalk
eProcedure Server applications require you to enter the FactoryTalk Batch Server
user account name and password to configure the server computer. The
installation adds the FactoryTalk Batch Server user account to these groups and
services:
•
Administrators group
•
batchsvr_group
•
Batch COM+ Application
•
FactoryTalk Batch Server service
•
FactoryTalk Event Archiver service
•
eProcedure Server service (eProcedure Server installation)
The services for the FactoryTalk Batch Server, FactoryTalk Event Archiver,
eProcedure Server, and the Batch COM+ Application require identical user
accounts to support the FactoryTalk Batch Server functionality.
Important:
If an invalid FactoryTalk Batch Server user account is entered during
installation, the Batch COM+ Application fails to install.
If you change the FactoryTalk Batch Server user account once the installation is
complete, you must configure your FactoryTalk Batch system to use the new
server user name and password.
See also
FactoryTalk Batch system configuration on page 17
FactoryTalk Batch Client installation configuration on page 20
FactoryTalk Batch Windows Firewall exceptions on page 21
Add the Batch COM service on page 22
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
19
Chapter 3
FactoryTalk Batch security
FactoryTalk Batch Client
installation configuration
When you install the FactoryTalk Batch and FactoryTalk eProcedure Client
applications, you are prompted for the FactoryTalk Batch Server user account
name.
If you change the FactoryTalk Batch Server user account after the installation is
complete, you must configure your FactoryTalk Batch system to use the new
server user name and password.
If the FactoryTalk Batch Server user account is a workgroup account or if the
server computer needs to access files on the FactoryTalk Batch Client computer,
add the server user account to each client computer.
If a FactoryTalk Batch Client is running on Windows XP and connecting to a
remote FactoryTalk Batch Server, change the Local Security Policy on the client
computer.
See also
FactoryTalk Batch system configuration on page 17
FactoryTalk Batch Server install configuration on page 19
FactoryTalk Batch Windows Firewall exceptions on page 21
Change the FactoryTalk Batch Server user account on page 197
20
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
FactoryTalk Batch security
Chapter 3
FactoryTalk Batch Windows
Firewall exceptions
If the Windows Firewall is enabled when you install FactoryTalk Batch or
FactoryTalk eProcedure applications, the installation program adds the following
exceptions to the local computer:
Windows Firewall Exceptions
• batchsvr.exe (Batch server installs)
• Port 135 TCP
• batchvew.exe (Batch client installs)
• Port 80 TCP (eProcedure Client installs)
• DaClient.exe
• RnaDiagnosticsSrv.exe
• EventClientMultiplexer.exe
• RnaDiagReceiver.exe
• EventServer.exe
• RnaDirServer.exe
• iexplore.exe
• RsvcHost.exe
• OPCEnum.exe
• VStudio.exe
If the Windows Firewall is enabled after you install the applications, run the
FactoryTalk Windows Firewall Configuration Utility on each computer in your
FactoryTalk Batch system to add the exceptions.
To run the FactoryTalk Windows Firewall Configuration Utility, click Start > All
Programs > Rockwell Software > FactoryTalk Tools > Windows Firewall
Configuration Utility.
See also
FactoryTalk Batch system configuration on page 17
System-wide COM security limit settings on page 18
FactoryTalk Batch Server install configuration on page 19
FactoryTalk Batch Client installation configuration on page 20
Add the Batch COM service on page 22
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
21
Chapter 3
FactoryTalk Batch security
Add the Batch COM service
To add the COM service, run the BatchIDCreationCOMPlusInstall script and
then add the server user account to the FactoryTalk Batch Server service,
FactoryTalk Event Archiver service, and the Batch COM+ Application. If
FactoryTalk eProcedure is part of your system, add the server user account to the
eProcedure Server service.
To add the Batch COM service:
1. In Windows Explorer, expand Program Files > Rockwell Software >
Batch > Scripts.
2. Double-click BatchIDCreationCOMPlusInstall.vbs to add the
FactoryTalk Batch COM service to the computer.
3. Click Start > Administrative Tools > Component Services > Computers
> My Computer > COM+ Applications.
4. Right-click Batch > Properties.
5. Click the Identity tab, select This user, and enter the user name and
password for the FactoryTalk Batch Server.
6. Click OK and then close Component Services.
7. Click Start > Administrative Tools > Services.
8. Right-click FactoryTalk Batch Server > Properties.
9. Click the Log On tab and then select This Account.
10. Enter the user account name and password for the server.
11. Click OK.
22
•
Add the server user account to FactoryTalk Event Archiver service if
you are using FactoryTalk Event Archiver in incremental mode.
•
Add the server user account to the eProcedure Server service if
eProcedure is part of your FactoryTalk Batch system.
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
FactoryTalk Batch security
Chapter 3
12. Close Services.
13. Restart the computer.
See also
FactoryTalk Batch Server install configuration on page 19
FactoryTalk Batch Client installation configuration on page 20
FactoryTalk Batch Windows Firewall exceptions on page 21
FactoryTalk Batch system configuration on page 17
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
23
Chapter 3
FactoryTalk Batch security
Set security on folders or
files
Limit log file and event journal (.evt) access to prevent data from being lost.
Setting security on the folders or files is one suggested method. Set the security
according to company requirements.
Use Notepad to open log files. If a log file is opened with a program other than
Notepad, the FactoryTalk Batch Server may not run due to an access error.
Important:
FactoryTalk Batch Server continues writing information to log files and event journals (.evt) even
when they are open. If a file is opened and then saved, data that may have been written to the
event journal or log file while the file is open is lost.
To set security on folders or files:
1. In Windows Explorer, locate the folder or file.
2. Right-click the folder or file, and then select Properties.
3. Select the Security tab, select Edit, and then select Add.
4. From the Select Users, Computers, Service Accounts, or Groups dialog
box, select Advanced and then select Find Now.
5. Select a user or group from the Search results list, and then select OK.
6. Repeat for each user or group that requires access to the folder or file.
Tip:
Be sure to add the FactoryTalk Batch Server user account and then configure the
account with Full Control permissions.
7. Select OK to return to the Properties dialog box.
8. From the Group or user name list, select a user or group, and then select
the permissions in the Permissions area. Repeat for each user or group.
9. Select OK.
See also
FactoryTalk Batch Server user account configuration requirements
on page 16
24
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
FactoryTalk Batch security
Chapter 3
Add users and user groups
Set security on folders and files to limit log file and event journal (.evt) access.
To add users and user groups:
1. In Windows Explorer, locate the folder or file.
2. Right-click the folder or file, and then select Properties.
3. Select the Security tab, select Edit, and then select Add.
4. From the Select Users, Computers, Service Accounts, or Groups dialog
box, select Advanced and then click Find Now.
5. Select a user or group from the Search results list, and then select OK.
6. Repeat for each user or group that requires access to the folder or file.
Tip:
Be sure to add the FactoryTalk Batch Server user account and then configure the account with Full Control
permissions.
7. Select OK to return to the Properties dialog box.
8. From the Group or user name list, select a user or group, and then select
the permissions in the Permissions area. Repeat for each user or group.
9. Select OK.
See also
Set security on folders or files on page 24
FactoryTalk Security for the
Batch Clients
Security settings are shared among FactoryTalk enabled products across a network
or on the same computer using FactoryTalk Security in FactoryTalk Batch View,
ActiveX controls, FactoryTalk Batch Equipment Editor, and FactoryTalk Batch
Recipe Editor. FactoryTalk Directory is the infrastructure which contains the
policies defined for products and resources.
FactoryTalk Batch product policies are created in both the Local Directory and
the Network Directory when the FactoryTalk Services Platform is installed. The
FactoryTalk Batch product polices are used to restrict access to the FactoryTalk
Batch Client components and their features. For a complete list of FactoryTalk
Batch secured resources and their default product policy settings, see FactoryTalk
Batch default policy settings.
The following information is specific to configuring FactoryTalk Security for the
FactoryTalk Batch Clients. For information on securing your FactoryTalk system
as a whole, see FactoryTalk Help.
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
25
Chapter 3
FactoryTalk Batch security
To open FactoryTalk Help, click Start > All Programs > Rockwell Software >
FactoryTalk Tools > FactoryTalk Help.
The FactoryTalk Services Platform installation process:
•
Creates a FactoryTalk Local Directory and a FactoryTalk Network
Directory on the computer. When the install process finishes, both
directories are fully configured and ready for use.
Tip:
Security settings in the Network Directory are completely separate from the security settings in the Local
Directory. For example, changes made to the security settings in the Network Directory do not change
security settings in the Local Directory.
•
Allows any Windows Administrator user account to log on to either
directory. The installation process automatically adds the local Windows
Administrators group to the FactoryTalk Administrators group in each
FactoryTalk Directory.
•
Allows any authenticated Windows user to log on to the FactoryTalk
Local Directory. The installation process automatically adds all members
of the local Windows Authenticated Users group to the FactoryTalk Local
Directory.
•
Allows all new user accounts full access permissions. The installation
process automatically sets system policies to allow all new user accounts
added to either directory full access to that directory by default.
See also
FactoryTalk Batch default policy settings on page 41
Tighten security for FactoryTalk Batch Clients on page 26
Tighten security for FactoryTalk
Batch Clients
Restrict access to specific features of your individual FactoryTalk products. Only
users with access can use secured product features.
For example, when you set up product policies for FactoryTalk Batch, restrict use
of the Abort command to specific users. This prevents automated batch processes
from going down during run time.
To configure security for multiple features in FactoryTalk, use the Feature
Security for Product Policies dialog box.
26
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
FactoryTalk Batch security
Chapter 3
To configure security for the FactoryTalk Batch features, refer to the secured
product policies defined for the FactoryTalk Batch Clients.
To tighten security for FactoryTalk Batch Clients:
•
Delete the Windows Authenticated Users group from the Local
Directory. Secure the FactoryTalk Batch Configuration Options
product policies in the Local Directory to avoid tampering or unauthorized
changes.
•
Create new FactoryTalk user accounts and groups in the FactoryTalk
Directory. Create user accounts or groups to secure the FactoryTalk Batch
Clients.
•
Add user accounts and groups created in Windows to the FactoryTalk
Directory. Windows accounts added to the FactoryTalk Directory are
called Windows-linked user accounts and groups.
Windows Workgroup User Accounts are not supported in FactoryTalk.
If you use Windows workgroups, you cannot administer user accounts centrally for
FactoryTalk Batch Client applications. FactoryTalk Directory does not allow multiple user
accounts to have the same name and password.
•
Remove the All Users group from the FactoryTalk Batch product policies.
The FactoryTalk Services Platform installation process adds the All Users
group to all FactoryTalk product policies. To secure FactoryTalk Batch,
remove or restrict the All Users group for FactoryTalk Batch product
policies. For example, to restrict access to FactoryTalk Batch View windows,
remove the All Users group from the associated product policies and then
add the necessary user accounts.
•
Add user accounts and groups to the FactoryTalk Batch product policies.
To secure FactoryTalk Batch resources, add only the necessary user
accounts and groups to the corresponding product policies. For a complete
list of FactoryTalk Batch product policies, see FactoryTalk Batch default
policy settings.
See also
Security for FactoryTalk Batch commands on page 29
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
27
Chapter 3
FactoryTalk Batch security
FactoryTalk Batch View
security
Configure FactoryTalk security to specify which FactoryTalk Batch View toolbar
buttons and windows are available to each logged on user. Removing a user group
from a security policy disables the corresponding toolbar button for all users who
are members of that user group. When a button is disabled, it no longer appears
on the toolbar.
Restrict access to resources based on where a user is physically located, such as a
computer used to perform actions. (For more information, see FactoryTalk Help.)
To open FactoryTalk Help, click Start, point to All Programs > Rockwell
Software > FactoryTalk Tools, and then click FactoryTalk Help.
See also
Security for FactoryTalk Batch commands on page 29
Configure security for the
FactoryTalk Batch View
windows
To tighten security for a FactoryTalk Batch View window, remove the All Users
group from the corresponding product policy and then add the necessary user
accounts.
To configure security for the FactoryTalk Batch View windows:
1. Open the FactoryTalk Administration Console and log on to the
appropriate FactoryTalk Directory.
2. Expand System > Policies > Product Policies > Batch > BatchView &
ActiveX.
3. Right-click View and then select Properties.
4. Select the policy setting you want to configure and then click the
corresponding browse button.
5. In the Configure Securable Action dialog box:
•
Select a user or group and then click Remove.
•
Allow/deny a user or group access to the feature by selecting or clearing
the corresponding check box and then clicking OK.
Tip:
•
28
Product policies do not inherit security settings. When specifying permissions for product policies, clearing
both the Allow and Deny check boxes denies access to the product feature.
Add a user account or user group by clicking Add. This option displays
the Select User and Computer dialog box.
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
FactoryTalk Batch security
Chapter 3
6. In the Select User and Computer dialog box you can:
•
Select a user, user group or computer and then click OK.
•
Click Create New to create and then add a new user, user group or
computer group.
7. Click OK to close the View Properties dialog box.
Tip:
Restart FactoryTalk Batch components to update changes made in the FactoryTalk Directory.
See also
FactoryTalk Batch View security on page 28
Security for FactoryTalk Batch
commands
Configure FactoryTalk Security to require user confirmation for batch commands
and phase commands. A command that has the confirm feature enabled does not
execute until the user account is validated in the Log on to Confirm User dialog
box.
To enable the Confirm feature, configure the FactoryTalk Batch product policy
for the command and then set the associated <Command> Confirm policy setting
to True. These policy settings are defined in FactoryTalk Directory for each
command button within FactoryTalk Batch View and every phase command
issued from the Phase Control window.
Tip:
When the Confirm feature is enabled for a command, only active user accounts
assigned to the Command are allowed to execute the command. Users validated in
the Log on to Confirm User dialog box are not logged on to FactoryTalk Batch
View.
The <Command> Confirm policy settings are found in the following locations:
•
FactoryTalk Directory\Local | Network\
System\Policies\Product Policies\Batch\BatchView and
ActiveX\Commands
•
FactoryTalk Directory\Local | Network\
System\Policies\Product Policies\Batch\BatchView and
ActiveX\Phase Commands
See also
FactoryTalk Batch View security on page 28
Configure security for FactoryTalk Batch commands on page 30
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
29
Chapter 3
FactoryTalk Batch security
Configure security for FactoryTalk
Batch commands
To allow only specified users to issue commands against a batch or a phase, add
the appropriate users or user groups to the Command or Phase Command policy
setting. Then remove or restrict the All Users group.
To configure security for FactoryTalk Batch commands:
1. Open the FactoryTalk Administration Console and log on to the
appropriate FactoryTalk Directory.
2. Expand System > Policies > Product Policies > Batch > BatchView &
ActiveX.
3. Right-click Commands and then select Properties.
4. Select the policy setting to configure and then select the corresponding
browse button.
5. (optional) In the Configure Securable Action dialog box:
30
•
Select a user or group and then select Remove.
•
Allow or deny a user or group access to the feature by selecting or
clearing the corresponding check box and then selecting OK.
•
Add a user account or user group by selecting Add. This option displays
the Select User and Computer dialog box.
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
FactoryTalk Batch security
Chapter 3
6. (optional) In the Select User or Group dialog box:
•
Select a user, user group, computer, or computer group and then select
OK.
•
Select Create New to create and then add a new user, user group,
computer, or computer group.
7. Select OK to close the View Properties dialog box.
Tip:
Restart all FactoryTalk Batch components to update security changes made in the FactoryTalk Directory.
See also
FactoryTalk Batch View security on page 28
Security for FactoryTalk Batch commands on page 29
Enable the FactoryTalk Batch View
confirm settings
If specific users and/or groups are assigned to a batch command or phase
command and the corresponding Confirm policy setting is enabled, only the
specified users are allowed to issue the command. All commands in FactoryTalk
Batch View have a command confirmation option. If confirm is enabled for a
command, that command is not issued until a user with the appropriate
permissions is validated using the Log on to Confirm User dialog box. Users
validated in the Log on to Confirm User dialog box are not logged in to the
FactoryTalk Batch View.
To enable the FactoryTalk Batch View confirm settings:
1. Open the FactoryTalk Administration Console and log on to the
appropriate FactoryTalk Directory.
2. Expand System > Policies > Product Policies > Batch > BatchView &
ActiveX.
3. Right-click Phase Commands (or Commands) and then select Properties.
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
31
Chapter 3
FactoryTalk Batch security
4. Scroll to the BatchView and ActiveX - Phase Commands (or
Commands) - Confirmations policy settings. Select the policy setting and
then click the corresponding drop-down list box.
5. Select True to require a user log on each time the command button is
clicked. Select False if no log on is required.
6. Click OK.
Tip:
Restart all FactoryTalk Batch components to update changes made in the FactoryTalk Directory.
See also
Security for FactoryTalk Batch commands on page 29
Set the automatic logoff time period on page 33
Change the logged-on user with your HMI on page 34
External security devices on page 36
32
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
FactoryTalk Batch security
Chapter 3
Set the automatic logoff time
period
Configure a specified period of inactivity before logging off a user using
FactoryTalk Batch View security. FactoryTalk Batch View uses the Windows
screen saver activation to send a log off message. If the Batch List window of
FactoryTalk Batch View is the top window in your system when the screen saver
activates, FactoryTalk Batch View logs off the current user, the status bar displays
No authenticated User, and FactoryTalk Batch View continues to run.
To set the automatic logoff time period:
1. Right-click the Windows desktop.
2. From the shortcut menu, select Properties.
3. From the Display Properties dialog box, click the Screen Saver tab.
4. Select a screen saver from the list, and then enter the automatic log off time
period in the Wait box.
5. Click OK to return to the desktop.
See also
Security for FactoryTalk Batch commands on page 29
Change the logged-on user with your HMI on page 34
External security devices on page 36
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
33
Chapter 3
FactoryTalk Batch security
Change the logged-on user with
your HMI
Configure your human-machine interface (HMI) to notify FactoryTalk Batch
View to change the logged on user. The HMI sends a user name and password so
the FactoryTalk Batch View can attempt to log on the specified user.
A Component Object Model (COM) component was created to log on and off of
FactoryTalk Batch either programmatically, or by using an HMI. The following
example, created in Visual Basic, is one way to implement external log-ons using
the COM component.
To change the logged-on user with your HMI:
1. In Visual Basic, create a new project and add a reference to the
BatchViewUser 1.0 Type Library.
2. Create a Visual Basic form that allows a user to enter a user name and a
password.
3. Add two Command buttons, one for user log-ons and another to log off.
Here is an example of a Visual Basic form:
34
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
FactoryTalk Batch security
Chapter 3
4. Create a new COM object and add code to support the log on functionality.
The following code sample demonstrates how to create a COM object in
Visual Basic that is used for logging on and off of FactoryTalk Batch View.
5. Save the project and make an executable file.
6. Run the executable to log users on and off of FactoryTalk Batch View.
Tip:
DDE is not a supported communication protocol with the FactoryTalk Batch suite of products.
See also
Security for FactoryTalk Batch commands on page 29
Set the automatic logoff time period on page 33
External security devices on page 36
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
35
Chapter 3
FactoryTalk Batch security
External security devices
Use an external security device, such as a retinal scanner, with the FactoryTalk
Batch View. You must use a .dll with a function that collects the user name and
password. When the FactoryTalk Batch View security prompts the user for user
name and password, your .dll is called. Your function is expected to copy the user
name to <USERNAME> and the password to <PASSWORD>. The size limit on
each of these is 1023 bytes.
The following is an example of a function that would return the user name and
password to the FactoryTalk Batch View:
int <func>(char username, char password)
return code of 0 == SUCCESS
Any value other than 0 is an error and an entry is recorded in the Batchvew.log file.
If the .dll fails to load, the function is not found in the .dll, or the function causes
an exception, the log on mechanism is disabled. The standard logon dialog box
must then be used.
The FactoryTalk Batch Equipment Editor and FactoryTalk Batch Recipe Editor
also support an external security device. The product policies used to configure an
external security device for the FactoryTalk Batch Equipment Editor and
FactoryTalk Batch Recipe Editor are created in the following FactoryTalk Local
Directory locations.
•
System > Policies > Product Policies > Batch > Equipment Editor >
Configuration > Options - External Login
•
System > Policies > Product Policies > Batch > Recipe Editor >
Configuration > Options - External Login
See also
Enable an external security device on page 37
Security for FactoryTalk Batch commands on page 29
Change the logged-on user with your HMI on page 34
36
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
FactoryTalk Batch security
Chapter 3
Enable an external security device
Use the FactoryTalk Administration Console to modify the required security
policy settings for enabling an external security device. These policy settings are
located in the FactoryTalk Local Directory.
To enable an external security device:
1. Run the FactoryTalk Administration Console and log on to the Local
Directory.
2. Expand System > Policies > Product Policies > Batch > BatchView &
ActiveX > Configuration.
3. Right-click Options and then select Properties.
4. Edit the following policy settings:
Enabled = True
Name of DLL=<YourDLLNameWithPath>
Name of Function=<FunctionNameInDLL>
Tip:
Restart all FactoryTalk Batch components to update changes made in the FactoryTalk Directory.
See also
External security devices on page 36
Security for FactoryTalk Batch commands on page 29
Change the logged-on user with your HMI on page 34
FactoryTalk Batch
Equipment Editor and
FactoryTalk Batch Recipe
Editor security
Security for FactoryTalk Batch Equipment Editor and FactoryTalk Batch Recipe
Editor is implemented using the FactoryTalk Security product policies defined in
the FactoryTalk Network Directory. There are two product policy options
available:
•
Access Modes governs access to the editors (only FactoryTalk users can be
granted access). There are two levels of working access to area models in
FactoryTalk Batch Equipment Editor, and recipes in FactoryTalk Batch
Recipe Editor.
•
View Only provides full viewing privileges, but no changes can be
saved.
•
Full Edit provides full editing privileges.
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
37
Chapter 3
FactoryTalk Batch security
•
Feature Security governs which FactoryTalk users can secure area models
and recipes to the FactoryTalk Network Directory Security Authority
Identifier (SAI).
•
The Area Model: Secure policy governs which users can secure an area
model to a particular SAI in FactoryTalk Batch Equipment Editor.
•
The Recipe: Secure policy governs which users can secure a recipe to a
particular SAI in FactoryTalk Batch Recipe Editor.
Additionally, there are other Configuration Options product policies created in
the FactoryTalk Local Directory for the editors.
•
To tighten security, remove the All Users group from FactoryTalk Batch
Equipment Editor and FactoryTalk Batch Recipe Editor product policies in
the FactoryTalk Directory.
•
FactoryTalk Batch Equipment Editor and FactoryTalk Batch Recipe Editor
support the use of an external security device, such as a retinal scanner.
•
In addition to FactoryTalk Security, configure Windows security on
FactoryTalk Batch Equipment Editor and FactoryTalk Batch Recipe Editor
files and folders in Windows Explorer.
•
RDB security can also be configured when using RDB recipes that are
stored in SQL Server.
See also
Configure access mode security on page 39
Configure feature security on page 40
Product policies in the local and network directories on page 42
Modify FactoryTalk Batch Equipment Editor configuration options
on page 41
38
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
FactoryTalk Batch security
Chapter 3
Configure access mode security
Configure the two levels of working access to area models in FactoryTalk Batch
Equipment Editor, and recipes in FactoryTalk Batch Recipe Editor.
To configure the access mode security:
1. Open the FactoryTalk Administration Console and log on to the
appropriate FactoryTalk Directory.
2. Expand System > Policies > Product Policies > Batch > Equipment
Editor (or Recipe Editor).
3. Right-click Access Modes and then select Properties.
4. Select the policy setting you want to configure and then click the browse
button.
5. In the Configure Securable Action dialog box:
•
Select a user or group and then click Remove.
•
Allow or deny a user or group access to the feature by selecting or
clearing the corresponding check box and then clicking OK.
•
Add a user account or user group by clicking Add. This option displays
the Select User and Computer dialog box.
6. In the Select User or Group dialog box:
•
Select a user, user group, computer or computer group and then click
OK.
•
Click Create New to create and then add a new user, user group or
computer group.
7. Click OK to close the Access Modes Properties dialog box.
8. Restart all FactoryTalk Batch components to update changes made in the
FactoryTalk Directory.
See also
FactoryTalk Batch Equipment Editor and FactoryTalk Batch Recipe Editor
security on page 37
Configure feature security on page 40
Modify FactoryTalk Batch Equipment Editor configuration options
on page 41
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
39
Chapter 3
FactoryTalk Batch security
Configure feature security
Configure which users can secure area models and recipes to the FactoryTalk
Network Directory Security Authority Identifier (SAI).
To configure feature security:
1. Open the FactoryTalk Administration Console and log on to the
appropriate FactoryTalk Network Directory.
2. Expand System > Policies > Product Policies > Batch > Equipment
Editor (or Recipe Editor).
3. Right-click Feature Security and then select Properties. The Feature
Security Properties dialog box opens.
4. Select Area Model: Secure and then click browse (
Batch Recipe Editor, the policy is Recipe: Secure.
). For FactoryTalk
5. In the Configure Securable Action dialog box you can:
•
Click Add to add a user account or user group using the Select User
and Computer dialog box:
•
Select a user, user group, computer or computer group and then
click OK.
•
Click Create New to create and then add a new user, user group, or
computer group.
•
Allow or deny a user or group access to the feature by selecting or
clearing the corresponding check box and then clicking OK.
•
Select a user or group and then click Remove.
6. Click OK to close the Feature Security Properties dialog box.
Tip:
Restart all FactoryTalk Batch components to update changes made in the FactoryTalk Network Directory.
See also
FactoryTalk Batch Equipment Editor and FactoryTalk Batch Recipe Editor
security on page 37
Configure access mode security on page 39
Modify FactoryTalk Batch Equipment Editor configuration options
on page 41
40
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
FactoryTalk Batch security
Chapter 3
Modify FactoryTalk Batch
Equipment Editor configuration
options
Modify the configuration options in product policies created in the FactoryTalk
Local Directory for the editors.
The following example is specific to FactoryTalk Batch Equipment Editor.
FactoryTalk Batch Recipe Editor configuration options are configured similarly.
To modify FactoryTalk Batch Equipment Editor configuration options:
1. Open the FactoryTalk Administration Console and then log on to the
FactoryTalk Local Directory.
2. Expand System > Policies > Product Policies > Batch > Equipment
Editor > Configuration.
3. Right-click Options and then select Properties.
4. From the Options Properties dialog box, configure the policy settings and
then click OK.
Tip:
Restart all FactoryTalk Batch components to update changes made in the FactoryTalk Directory.
See also
Configure access mode security on page 39
Configure FactoryTalk Batch Equipment Editor and FactoryTalk Batch
Recipe Editor security on page 37
Configure feature security on page 40
Product policies in the local and network directories on page 42
FactoryTalk Batch default
policy settings
When the FactoryTalk Services Platform is installed, FactoryTalk Security
product policies are created in the FactoryTalk Directory for FactoryTalk Batch
View clients.
The product policies for FactoryTalk Batch Clients are created in both the Local
and Network Directories, except for the Configuration Options which are only
created in the Local Directory.
See also
Product policies in the local and network directories on page 42
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
41
Chapter 3
FactoryTalk Batch security
Product policies in the local and
network directories
The following product policy configurations are created in the FactoryTalk Local
and Network Directories for FactoryTalk Batch.
\\System\Policies\Product Policies\Batch\BatchView and ActiveX
Security Objects
Product Policy Descriptions
These policy settings are used to secure the FactoryTalk Batch
View
• Alarm Summary — Access the Alarm Summary View windows and the Exit, Configuration, and Help
buttons.
window
• Arbitration — Access the Arbitration window Users must have Allow permissions to access the View
windows and buttons.
• Batch List — Access the Batch List window
Default = All Users have access.
• Configuration — Configure the Batch View
To tighten security, remove or restrict the All Users group
• Event Journals — Access the Event Journal
and then add the necessary user accounts to the policy
window
settings.
• Exit — Exit the FactoryTalk Batch View
• Help — Activate help file
• Phase Control — Access the Phase Control
window
• Phase Summary — Access the Phase Summary
window
• Procedure as SFC — Access the SFC View
window
• Procedure as Table — Access the Table View
window
• Prompts — Access the Unacknowledged
Prompts window
• Signatures — Access the Signature List window
\\System\Policies\Product Policies\Batch\BatchView and ActiveX
42
Security Objects
Product Policy Descriptions
View — Confirmations
• Configuration — Confirm
This policy setting is used to secure access to the System
Configuration and Defaults dialog box in the FactoryTalk
Batch View.
If the Configuration-Confirm policy is True, then only the
users defined in the Configuration policy setting are
allowed access to System Configuration and Defaults
dialog box. Users are validated using the Log On to
FactoryTalk dialog box.
Default = False.
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
FactoryTalk Batch security
Chapter 3
Phase Commands
• Abort — Abort a phase
• Ack — Acknowledge a phase prompt
• Acquire — Acquire a phase
• ClearFail — Clear all failures
• Disconnect — Disconnect a phase
• Hold — Hold a phase
Phase commands are secured objects that can be configured
to require user validation prior to execution.
To require user validation for a phase command, set the
associated Confirm policy setting to True.
To tighten security, remove or restrict the All Users group
and then add the necessary user accounts to the policy
setting.
Default = All Users have access.
• Pause — Pause a phase
• Phase Auto Mode — Place phase in auto mode
• Phase Semi-Auto Mode — Place phase in
semi-auto
• Release — Release phase
• Reset — Reset phase
• Restart — Restart phase
• Resume — Resume phase
• Start — Start phase
• Stop — Stop phase
\\System\Policies\Product Policies\Batch\BatchView and ActiveX
Security Objects
Product Policy Descriptions
Phase Commands — Confirmations
• Abort — Confirm
If a Phase Command — Confirm policy is True, then only
the users defined in the associated Phase Command policy
setting are allowed to execute the phase command. Users are
validated using the Log On to Confirm User dialog box.
Phase commands are issued from the Manual Phase
Control window in FactoryTalk Batch View. Confirm settings
are configured separately for each phase command.
Users validated in the Log on to Confirm User dialog box
are not logged on to FactoryTalk Batch View.
Default = False.
• Ack — Confirm
• Acquire — Confirm
• ClearFail — Confirm
• Disconnect — Confirm
• Hold — Confirm
• Pause — Confirm
• PhaseAuto Mode — Confirm
• PhaseSemi-AutoMode — Confirm
• Release — Confirm
• Reset — Confirm
• Restart — Confirm
• Resume — Confirm
• Start — Confirm
• Stop — Confirm
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
43
Chapter 3
FactoryTalk Batch security
\\System\Policies\Product Policies\Batch\BatchView and ActiveX
Security Objects
Product Policy Descriptions
Commands
• Abort — Abort batch
Batch commands are secured objects that can be configured
to require user validation prior to execution.
To require user validation for a batch command, set the
associated Confirm policy setting to True.
To tighten security, remove or restrict the All Users group
and then add the necessary user accounts to the policy
setting.
Default = All Users have access.
• Ack — Acknowledge a prompt
• Acquire — Acquire a resource
• Add Batch — Add a Batch
• Auto — Place batch in auto mode
• Bind — Bind step to unit
• BindAck — Acknowledge a bind prompt
• ClearFail — Clear all failures
• Comment — Operator comment to Event
Journal
• Disconnect — Disconnect a phase
• Hold — Place batch on hold
• Manual — Place batch in manual mode
• MatSvrControl — Control the Material Server
• ParamChange — Change parameter value
• ReactivateStep — Change the active
eProcedure step
• Release — Release a resource
• Remove — Remove a batch
• Reorder — Reprioritize needed resources list
• Restart — Restart batch
• Resume — Resume batch
• Semi-Auto — Place batch in semi-auto mode
• Start — Start batch
• Step — Change the active step
• Stop — Stop the batch
44
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
FactoryTalk Batch security
Chapter 3
\\System\Policies\Product Policies\Batch\BatchView and ActiveX
Security Objects
Product Policy Descriptions
Commands — Confirmations
• Abort — Confirm
If a Command — Confirm policy is True, then only the
users defined in the associated Command policy setting are
allowed to execute the batch command. Users are validated
using the Log On to Confirm User dialog box.
Users validated in the Log on to Confirm User dialog box
are not logged on to FactoryTalk Batch View.
Default = False.
• Ack — Confirm
• Acquire — Confirm
• Add Batch — Confirm
• Auto — Confirm
• Bind — Confirm
• BindAck — Confirm
• ClearFail — Confirm
• Comment — Confirm
• Disconnect — Confirm
• Hold — Confirm
• Manual — Confirm
• MatSvrControl — Confirm
• ParamChange — Confirm
• ReactivateStep — Confirm
• Release — Confirm
• Remove — Confirm
• Reorder — Confirm
• Restart — Confirm
• Resume — Confirm
• Semi-Auto — Confirm
• Start — Confirm
• Step — Confirm
• Stop — Confirm
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
45
Chapter 3
FactoryTalk Batch security
\\System\Policies\Product Policies\Batch
Security Objects
Product Policy Descriptions
Equipment Editor — Access Modes
• Full Edit
Once logged on, the user can edit and save changes to the
area model.
To tighten security, remove or restrict the All Users group
and then add the necessary user accounts.
Default = All Users have access.
• ViewOnly
Once logged on, the user can view and edit the Area Model
but cannot save changes.
Default = All Users have access.
Equipment Editor -- Feature Security
• Area Model: Secure
Once logged on, Full Edit users can enable Security Authority
for an area model. The secured area model contains the same
Security Authority Identifier (SAI) as stored in the FactoryTalk
Network Directory. Thereafter, the area model can only be
opened and worked on in FactoryTalk Batch Equipment
Editor under the same SAI. Attempting to open the area
model under another SAI results in a security error.
\\System\Policies\Product Policies\Batch
Security Objects
Product Policy Descriptions
Recipe Editor — Access Modes
• Full Edit
Once logged on, the user can edit and save changes to
recipes.
To tighten security, remove or restrict the All Users group
and then add the necessary user accounts.
Default = All Users have access.
• ViewOnly
Once logged on, the user can view recipes, but cannot make
changes or save the recipe with a new name using the
Save As function.
Default = All Users have access.
Recipe Editor -- Feature Security
• Recipe: Secure
Once logged on, Full Edit users can enable Security
Authority for a recipe. The secured recipe contains the same
Security Authority Identifier (SAI) as stored in the
FactoryTalk Network Directory. Thereafter, the recipe can
only be opened and worked on in FactoryTalk Batch Recipe
Editor if the current FactoryTalk Network Directory has the
same SAI. Attempting to open the recipe under another SAI
results in a security error.
See also
FactoryTalk Batch default policy settings on page 41
46
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
Chapter 4
FactoryTalk Batch electronic signatures
FactoryTalk Batch electronic signatures are electronically recorded representations
of a signature and their associated data. Signature data includes timestamps,
security permissions, meanings for signoffs, and comments. When a signature
request is created, an entry is recorded in the Event Journal. If the signature
request is user generated, a Signature dialog box is displayed. Additional journal
entries are recorded when a signature request is completed, user canceled, system
canceled, or when a signoff is successful or unsuccessful. These electronic
signatures include all the components necessary for compliance with 21 CFR Part
11.
A Signature dialog box displays context information to the user based on the
signature request type. For example, a Command Signature dialog box displays
Time Generated, Batch ID, Procedure ID, and Command.
There are several steps involved in configuring and executing electronic signatures.
Important:
The FactoryTalk Batch Server responds differently when electronic signatures are configured in
the area model. Be aware of the behavior changes before a decision is made to implement
electronic signatures.
The requested user information in a Signature dialog box is defined by the
signature template configured in the area model. Signature templates determine
the number of signoffs required to complete a signature request. Each signoff has
associated security permissions, meaning, and may require a comment. Signature
templates are used with:
•
Command Verification Policies
•
Parameter Deviation Verification Policies
•
General Usage Phase Logic Requests
•
eProcedure Step Verifications
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
47
Chapter 4
FactoryTalk Batch electronic signatures
Signature templates are used to generate signature requests displayed in
FactoryTalk Batch View, ActiveX controls, and eProcedure.
Signature templates determine the credentials and number of signoffs required for
steps defined as part of a Recipe Approval process.
See the FactoryTalk Batch Equipment Editor User Guide for information on
configuring signature templates.
See also
Command verification policies on page 48
Parameter deviation verification policies on page 59
General usage phase logic requests on page 61
Electronic signature security on page 63
Command verification
policies
The area model supports several types of command verification policies that can
generate signature requests prior to, during, or when batch execution is complete.
Actions initiated in FactoryTalk Batch View, ActiveX Controls, eProcedure or
through the FactoryTalk Batch Server API, generate signature requests. For
information on executes, see the FactoryTalk Batch Server API Communication
Language Reference Guide.
See also
Command signature requests on page 49
FactoryTalk Batch Parameter Prompt Acknowledge Signature request
on page 52
Unit Bind Signature request on page 55
Active Step Change Signature request on page 58
48
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
FactoryTalk Batch electronic signatures
Chapter 4
Command signature requests
If a command verification policy is associated with a signature template, and a
command is issued against a batch, a Command Signature request is generated
and a dialog box is displayed.
For example: If a HOLD command requires a signature, then when a HOLD
command is issued against a batch, an electronic signature request is generated and
a dialog box is displayed. For information on command signatures, see
Acknowledge a Command Signature in the FactoryTalk Batch View User Guide.
The following is an explanation of the modifications made to support FactoryTalk
Batch electronic signatures:
Command Execute
Batch Server
When a legal command execute is received, the FactoryTalk Batch Server checks the area
model configuration to determine if a signature request is required. If yes, then the command
action is queued and a signature request is generated.
Exception: ABORT Command is not queued.
Response
An ActionID is returned by the execute used to locate the generated signature.
Completion
When all signature signoffs generated by the queued command are complete, the command is
issued to the target procedure.
Exception: ABORT command is issued regardless of Signature state.
Cancellation
When any signature is user canceled, then the queued command is terminated and all other
signature requests associated with the same command action are system canceled.
Exception: ABORT command cannot be canceled by the user.
Overlap
If a command execute is received by a procedure that has incomplete signature requests for a
prior command execute action, then the new command execute fails. A failed execute’s
response item contains an appropriate error message.
Exception: ABORT Command creating a command overlap terminates the original command
action causing a system cancel instead of a failure. If ABORT overlaps with an ABORT
command, then any incomplete signatures for the first command are system canceled and a
new signature request is generated for the second command.
Automatic Cancellation
When a procedure transitions to a state in which a queued command action is not legal, the
command execute action is terminated, and its associated incomplete signature requests are
system canceled.
Cmd
Commands used with command verification policies are:
START
STOP
AUTO-MODE
PAUSE
HOLD
RESTART
MAN-MODE RESUME ABORT
RESET
CLEAR_FAILURES
DISCONNECT
SEMIAUTO-MODE
When a Command Verification Policy is configured for a command, and the same
Command is issued in Manual Phase Control against a Phase, a Command
Signature request is generated.
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
49
Chapter 4
FactoryTalk Batch electronic signatures
The following is an explanation of the modifications made to support FactoryTalk
Batch electronic signatures:
Phase, Phase2, Phase3 Executes
Batch Server
When a legal command execute is received, the FactoryTalk Batch Server checks the area model
to determine if a signature request is required. If yes, then the command is queued and a
signature request is generated.
Exceptions:
• Phase Reset and Phase Disconnect.
• Batch is created regardless of whether a Signature is required, or if the Signature is canceled.
• ABORT Command is not queued.
Response
An ActionID is returned by the Execute used to locate the generated signature.
Completion
When all Signature Signoffs generated by the queued command are complete, then the
Command is issued to the target procedure.
Exception: ABORT Command issued regardless of Signature state.
Cancellation
When any Signature is user canceled, then the queued Command is terminated and all other
Signature Requests associated with the same command action are System Canceled.
Exception: ABORT Command cannot be canceled by the user.
Overlap
If a Phase Execute is received by a procedure that has incomplete Signature Requests for a prior
Phase Execute Action, then the new Phase Execute fails. If a Command Execute is received by a
phase that has incomplete Signature Requests for a prior Phase Reset or Phase Disconnect, then
the new Command Execute fails. The failed Execute’s response item contains an appropriate
error message.
Exception: ABORT Command creating a Command overlap terminates the original Command
Action causing a System Cancel instead of a failure. If ABORT overlaps with an ABORT Command,
then any incomplete Signatures for the first command are System Canceled and a new Signature
Request is generated for the second command.
Automatic Cancellation
When a procedure transitions to a state in which a queued Action would not be legal, the
Execute is terminated, and its associated incomplete Signature Requests are System Canceled.
Warm Reboot
Signature Requests generated in response to a Phase Execute Action are System Canceled in the
event of a FactoryTalk Batch Server warm boot.
See also
Command verification policies on page 48
Set parameter signature request on page 51
50
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
FactoryTalk Batch electronic signatures
Set parameter signature
request
Chapter 4
If a Parameter Change command verification policy is configured in the area
model and associated with a signature template, then a Set Parameter Signature
request is generated when a user attempts to change a recipe parameter value or a
formula parameter value.
The following is an explanation of the modifications made to support FactoryTalk
Batch electronic signatures:
SetParm Execute
Batch Server
If the target is a recipe phase parameter, the FactoryTalk Batch Server checks the area model to
determine if a Signature Request is required for SetParm Execute confirmation. If yes, then a
Signature Request is generated. The server also checks for deviations on the recipe phase
parameter. If the SetParm Execute target is a formula parameter, then the server checks all
recipe phase parameters that reference the formula parameter. If deviations are detected,
then the appropriate Signature Request(s) are generated. If one or more signatures are
generated, then storing the specified value to the parameter is deferred until all Signature
Requests are complete.
Response
An ActionID is returned by the execute that is used to locate the generated signature(s).
Completion
When all generated Signature Requests associated with the SetParm Execute are complete,
then the value passed in the SetParm Execute Action is stored into the specific parameter.
Cancellation
When any incomplete Signature associated with the SetParm Execute is cancelled, then the
entire SetParm Execute Action is terminated and all Signature Requests associated with the
same SetParm Execute Action are System Cancelled.
Overlap
If a SetParm Execute is received targeting a parameter that has incomplete Signature Requests
for a prior SetParm Execute Action, then the new SetParm Execute fails. The failed Execute’s
response item contains an appropriate error message. The specified value is not stored in the
specified parameter.
Automatic Cancellation
If any incomplete Signature Requests associated with a SetParm Execute is user cancelled,
then the Execute Action is terminated and it’s remaining incomplete Signature Requests are
System Cancelled.
Warm Reboot
Signature Requests generated in response to a SetParm Execute Action are restored in the
event of a FactoryTalk Batch Server warm boot.
See also
Command verification policies on page 48
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
51
Chapter 4
FactoryTalk Batch electronic signatures
FactoryTalk Batch Parameter
Prompt Acknowledge Signature
request
If an Ack Command Verification policy is configured in the area model and
associated with a signature template, then a Recipe Parameter Prompt Signature
request is generated when a prompt is used to retrieve a Recipe Parameter Phase
value.
The following is an explanation of the modifications made to support FactoryTalk
Batch electronic signatures:
Parameter Value Ack Execute
Batch Server
If an Ack execute is received in response to an UnacknowledgedEvent generated to retrieve a
Recipe Parameter Phase value, then the FactoryTalk Batch Server generates a confirmation
Signature prompt if so configured in the area model. The server also performs configured
deviation checks on the value that is to be stored in the Recipe Parameter. If deviations are
detected then a signature request(s) is generated. If one or more signatures is generated, then
storing the specified value is delayed until the signature requests are complete.
Response
An ActionID is returned by the Execute used to locate the generated signature(s).
Completion
When all Signature Signoffs generated by the Execute are completed, then the parameter
value is stored.
Cancellation
When any signature generated by a Parameter Value Ack execute is canceled, then the
Parameter Value Ack Action is terminated and its associated incomplete Signature Requests
are System Cancelled.
Overlap
If an Ack execute response to a parameter value prompt is received while there are existing
incomplete Signature Requests generated by a prior Ack to the same prompt, or the Batch has
a Remove Action pending, then the new execute fails. The failed execute is populated with an
appropriate error message.
Automatic Cancellation
A Signature generated for confirmation of a Parameter Ack Value Action may be System
Canceled if any other signature associated with the same Action is user canceled, or if the
Batch System UnacknowledgedEvent targeted is terminated by the Ack.
Warm Reboot
Signature Requests generated in response to a Parameter Ack Execute Action are System
Cancelled in the event of a FactoryTalk Batch Server warm boot.
See also
Command verification policies on page 48
52
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
FactoryTalk Batch electronic signatures
Chapter 4
Unit Bind Prompt Acknowledge
Signature request
If a Bind Ack Command Verification policy is configured in the area model and it
is associated with a Signature Template, then a Unit Bind Prompt Acknowledge
Signature request is generated when binding a Unit to a step after a prompt has
been generated or prompting bind’s a Unit to a step.
The following is an explanation of the modifications made to support FactoryTalk
Batch electronic signatures:
Unit Bind Execute
Batch Server
When the FactoryTalk Batch Server receives a legal Ack execute in response to a Unit Bind
Unacknowledged Event, it may queue the bind selection delivery pending a Signature Request
if such behavior is configured in the area model.
Response
An ActionID is returned by the Execute used to locate the generated signature.
Completion
When all Signature Signoffs generated by an Ack received in response to a Unit Bind
UnacknowledgedEvent are completed, then the Unit Requirement binds to the Ack execute
response Unit specified if the bind action is still legal.
Cancellation
When any Signature generated by a Unit Bind Ack execute is cancelled, then the Unit Bind Ack
Action is terminated and its associated incomplete Signature Requests are System Cancelled.
Overlap
If a Unit Bind Ack execute response to a Unit Bind Prompt is received while there are existing
incomplete Signature Requests generated by a prior Unit Bind Ack Action targeting the same
prompt, or the Batch has a Remove Action pending, then the new execute fails. The failed
execute’s response item is populated with an appropriate error message string.
Automatic Cancellation
If the batch system cancels an UnacknowledgedEvent targeted by a Unit Bind Ack Action, then
the queued Execute Action is terminated and all incomplete Signature Requests associated
with the Action are System Cancelled.
Warm Reboot
Signature Requests generated in response to a Unit Bind Ack Execute Action are System
Cancelled in the event of a FactoryTalk Batch Server warm boot.
See also
Command verification policies on page 48
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
53
Chapter 4
FactoryTalk Batch electronic signatures
Phase Bind Prompt
Acknowledge Signature request
If a Bind Ack Command Verification policy is configured in the area model and it
is associated with a Signature Template, then a Phase Bind Signature request is
generated when binding a phase to a material after a prompt is generated or
prompting binds a phase to a material.
The following is an explanation of the modifications made to support FactoryTalk
Batch electronic signatures:
Recipe Phase Bind Ack Execute
Batch Server
When the FactoryTalk Batch Server receives a legal Ack execute in response to a Recipe Phase
Bind UnacknowledgedEvent, it may queue the bind selection delivery pending a Signature
Request if such behavior is configured in the area model.
Response
An ActionID is returned by the Execute used to locate the generated signature.
Completion
When all Signature Signoffs generated by an Ack received in response to a Recipe Phase Bind
UnacknowledgedEvent are completed, then the Recipe Phase is bound using the Ack execute
response data specified if the bind action is still legal.
Cancellation
When any Signature generated by a Recipe Phase Bind Ack Execute is cancelled, then the Recipe
Phase Bind Ack Action is terminated and its associated incomplete Signature Requests are
System Cancelled.
Overlap
If an Ack execute response to a recipe Phase Bind Prompt is received while there are existing
incomplete Signature Requests generated by a prior Ack to the same prompt, or the Batch has a
Remove Action pending, then the new execute fails. The failed execute’s response item is
populated with an appropriate error message string.
Automatic Cancellation
If the batch system cancels an UnacknowledgedEvent targeted by a Recipe Phase Bind Ack
Action, then the queued Execute Action is terminated and all incomplete Signature Requests
associated with the Action are System Cancelled.
Warm Reboot
Signature Requests generated in response to a Recipe Phase Bind Ack Execute Action are System
Cancelled in the event of a FactoryTalk Batch Server warm boot.
See also
Command verification policies on page 48
54
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
FactoryTalk Batch electronic signatures
Chapter 4
Unit Bind Signature request
If a Bind Command Verification policy is configured in the area model and it is
associated with a Signature Template, then a Unit Bind Signature request is
generated when a user attempts to bind a Unit to a step.
The following is an explanation of the modifications made to support FactoryTalk
Batch electronic signature:
Bind Execute
Batch Server
When the FactoryTalk Batch Server receives a legal Bind execute, the Area Model configuration
is checked to determine if a confirmation signature is required for the Bind request. If one is
required, then a Signature Request is generated using the specified Signature Template and
the Bind action is queued pending Signature completion.
Response
An ActionID is returned by the Execute used to locate the generated signature.
Completion
When all Signature Signoffs associated with a Bind Execute Action are completed, then the
Unit Requirement targeted by the Bind Execute Action is bound to the specified Unit if the bind
action is still legal.
Cancellation
When any Signature generated by a Bind Execute Action is cancelled, then the Bind Action is
terminated and its associated incomplete Signature Requests are System Cancelled.
Overlap
If a Bind Execute is received while a previous Bind Execute Action is pending for the same
target Unit Requirement, then the new Bind Execute fails. The failed execute’s response item is
populated with an appropriate response string. For purposes of determining the legality of
overlapping executes, Command, Step, Remove, and BindPhase Executes are treated as being
Bind Executes. This means, for example, that if a Step Execute Action is pending Signature
completion on a procedure, then a Bind Execute to the same procedure fails because of the
overlap with the Step execute.
Automatic Cancellation
If any step associated with the Unit Requirement being targeted by a queued Bind Execute
Action becomes an active recipe element, then the Bind Execute Action is terminated and its
associated incomplete Signature Requests are System Cancelled. This happens because the
Bind action is not legal for a Unit Requirement associated with any active steps.
Warm Reboot
Signature Requests generated in response to a Bind Execute Action are restored in the event of
a FactoryTalk Batch Server warm boot.
See also
Command verification policies on page 48
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
55
Chapter 4
FactoryTalk Batch electronic signatures
Remove Batch Signature
request
If a Remove/Reset Command Verification policy is configured in the area model
and it is associated with a Signature Template, then a Remove Batch Signature
Request is generated when a user attempts to remove a batch from the Batch List
or reset a phase run under Manual Phase Control.
The following is an explanation of the modifications made to support FactoryTalk
Batch electronic signatures:
Remove Execute
56
Batch Server
When the FactoryTalk Batch Server receives a legal Remove execute, the area model configuration
is checked to determine if a confirmation Signature is required for the batch removal request. If
one is required, then a Signature Request is generated using the specified Signature Template and
the batch removal action is queued pending completion of the Signature Request.
Manual Phase Control - When the server receives a legal Phase Reset Execute, it checks the area
model configuration to determine if a confirmation signature is required. If so, then a Signature
Request is generated using the specified Signature Template and the phase reset action is queued
pending of the Signature Request completion.
Response
An ActionID is returned by the Execute used to locate the generated signature.
Completion
When all Signature Signoffs associated with a Remove Execute are completed, then the batch
specified in the Remove execute is removed from the batch list if the Remove instruction is still
legal.
When all Signatures associated with a Phase Reset are complete, then the Manual Phase Control
batch specified in the Phase Reset Execute is removed from the Batch List if the Phase Reset
instruction is still legal.
Overlap
If a Remove Execute is received targeting a batch for which a queued Remove Execution Action
already exists pending Signature completion(s), then the new Remove Execute fails. The failed
execute’s response item is populated with an appropriate response string.
If a Phase Reset Execute is received targeting a batch for which a queued Phase Reset Execution
Action already exists pending Signature completion(s), then the new Phase Reset Execute fails.
For purposes of determining the legality of overlapping of executes, Remove Executes are treated
as Phase Reset Executes. This means that if a Remove Execute action is pending Signature
completion on a Manual Phase Control batch, then a Phase Reset issued via a Phase Execute to the
same batch fails because of the Remove Execute overlap.
Cancellation
When an incomplete Signature associated with a Remove Execute Action is cancelled, then the
queued Remove Execute Action is terminated and its associated incomplete Signature Requests
are System Cancelled.
When an incomplete Signature associated with a Phase Reset Execute Action is cancelled, then the
queued Phase Reset Execute Action is terminated and its associated incomplete Signature
Requests are System Cancelled.
Automatic
Cancellation
A Remove Execute Action that is queued pending Signature Completion(s) is terminated if the
target batch changes to an illegal state for Batch Removal, resulting in System Cancellation of its
incomplete Signature Request(s).
A Phase Reset Execute Action that is queued pending Signature Completion(s) is terminated if the
target batch changes to an illegal state for Batch Removal, resulting in System Cancellation of its
incomplete Signature Request(s).
Warm Reboot
Signature Requests generated in response to a Phase Reset or a Remove Execute Action are System
Cancelled in the event of a FactoryTalk Batch Server warm boot.
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
FactoryTalk Batch electronic signatures
Chapter 4
Add Event Signature request
If a Comment Command Verification policy is configured in the area model and
it is associated with a Signature Template, then an Add Event Signature Request
is generated when a user attempts adding a comment to a batch. For information
on the AddEvent execute, see the FactoryTalk Batch Server API Communication
Language Reference Guide.
The following is an explanation of the modifications made to support FactoryTalk
Batch electronic signatures:
AddEvent Execute
Batch Server
When the FactoryTalk Batch Server receives a legal AddEvent, AddEvent_Phase, or
AddEvent_CI execute, it checks the Area Model configuration to determine if a confirmation
Signature is required for the AddEvent action. If one is required, then a Signature Request is
generated using the specified Signature Template and the AddEvent action is queued pending
completion of the Signature Request.
An AddEvent is not generated when all batches are selected.
Response
An ActionID is returned by the execute used to locate the generated signature.
Completion
When all Signature Signoffs associated with an AddEvent execute are completed, then the
AddEvent action is handled if it is still legal.
Cancellation
When any Signature generated by an AddEvent execute action is cancelled, then the AddEvent
execute action is terminated and its associated incomplete Signature Requests are System
Cancelled.
Overlap
AddEvent executes targeted at the same batch are permitted to overlap. If the batch has a
Remove Action pending, then AddEvent execute fails.
Warm Reboot
Signature Requests generated in response to a AddEvent execute action are restored in the
event of a FactoryTalk Batch Server warm boot.
See also
Command verification policies on page 48
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
57
Chapter 4
FactoryTalk Batch electronic signatures
Active Step Change Signature
request
If a Step Command Verification policy is configured in the area model and
associated with a signature template, then an Active Step Change Signature
request is generated when performing an active step change.
The following is an explanation of the modifications made to support FactoryTalk
Batch electronic signatures:
Step Execute
Batch Server
When the FactoryTalk Batch Server receives a legal Step execute, the Area Model configuration
is checked to determine if a confirmation signature is required for the Active Step Change
action. If one is required, then a signature request is generated using the specified signature
template and the Active Step Change action is queued pending signature request completion.
Response
An ActionID is returned by the execute used to locate the generated signature.
Completion
When all signatures associated with a Step execute action are completed, then the queued
Step execute action is performed if it is still legal.
Cancellation
When any signature generated by a Step execute action is cancelled, then the Active Step
Change action is terminated and its associated incomplete Signature Requests are System
Cancelled.
Overlap
When a Step execute is received targeting a procedure that already has a pending Step
execute action, then the new Step execute fails. The failed execute’s response item is
populated with an appropriate error message.
For purposes of determining overlapping legality executes, Command and Remove execute
actions are treated as being Step execute actions. This means, for example, that if a Step
execute action is pending signature completion, then an AUTO command issued via a
Command execute to the same procedure fails because of the overlap with the Step execute
action.
Warm Reboot
Signature requests generated in response to a Step execute action are not restored in the
event of a FactoryTalk Batch Server warm boot.
See also
Command verification policies on page 48
58
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
FactoryTalk Batch electronic signatures
Parameter deviation
verification policies
Chapter 4
FactoryTalk Batch parameter deviations provide automatic detection of
deviations for recipe and report parameters, automatic prompting for electronic
signatures, and automatic recording of these events in the FactoryTalk Batch
Event Journal.
If a phase class parameter or report parameter is configured with a Verification
method and associated with a signature template, then a Signature Request is
generated. If the signature is user generated, then a Signature dialog box opens to
the user when the defined parameter limit values are exceeded. If the Signature
Request is not user generated, then the Signature prompt begins to flash and the
Signature Request displays in the Signature List. For information on enabling
parameter limit tags, see the FactoryTalk Batch Equipment Editor User Guide.
Tip:
The FactoryTalk Batch Server does not allow batch creation if the Verification configuration in the recipe is
different from the area model Verification configuration.
See also
Parameter deviation signature requests on page 60
Report parameter deviation signature requests on page 61
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
59
Chapter 4
FactoryTalk Batch electronic signatures
Parameter deviation signature
requests
The following is an explanation of modifications made to support parameter
deviation signature requests:
Parameter Deviations
Batch Server
When an attempt is made to change a recipe parameter value, the FactoryTalk Batch Server
validates the new value against the correct limits and then executes the correct verification
policy. There are two ways a recipe parameter can be changed, SETPARM and ACK executes.
After checking for deviations, the server carries out the parameter’s configured verification
policy. A verification policy of "None" has no action, meaning that no electronic signatures or
failures are generated even if a deviation exists. When the verification policy is "Signature
Template", the server initiates an action as defined by the signature template. When the
verification policy is "Not Allowed", the server fails the parameter change. The SETPARM or ACK
execute response will be: "FAIL: Value is outside the permitted limits."
If a parameter value is changed on a recipe parameter, the limit values must remain within the
high and low range defined in the area model. The server will not allow a batch to be created
containing a recipe parameter that violates the limit values defined area model.
When a phase is run in Manual Phase Control, the server reads the recipe and report parameter
limits from the area model phase class configuration. If a phase is executing within a recipe, then
the server reads the recipe and report parameter limits from the recipe step configuration.
Response
An ActionID is returned by the execute used to locate the generated signature(s).
Completion
The server does not change the parameter value sent in the ACK or SETPARM execute until all
required signatures are complete. Completion of a signature generated for Parameter Deviation
acknowledgment results in execution of a queued SetParm or ParamValueAck execute action if
the signature was the last remaining incomplete signature associated with the action.
Cancellation
Cancellation of a signature generated for acknowledgment of a Parameter Deviation results in
termination of its associated SetParm or ParamValueAck execute action and termination of any
incomplete signature requests associated with the same action.
Overlap
If a SetParm execute is received targeting a parameter that has incomplete signature requests
for a prior SetParm execute action, then the new SetParm execute fails. A failed execute’s
response item contains an appropriate error message.
If an Ack execute response to a recipe phase bind prompt is received while there are existing
incomplete signature requests generated by a prior Ack to the same prompt, or the batch has a
Remove action pending, then the new execute fails. The failed execute’s response item is
populated with an appropriate error message string.
Automatic Cancellation
Parameter deviation signature requests are system cancelled if any other incomplete signatures
associated with the same Action ID are cancelled. The server does not change the parameter
value sent in the ACK or SETPARM if any of the required signatures are cancelled.
Warm Reboot
A FactoryTalk Batch Server warm boot restores parameter deviation signature requests
generated by a SetParm execute action, but not those generated by an Ack execute action.
See also
Parameter deviation verification policies on page 59
Report parameter deviation signature requests on page 61
60
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
FactoryTalk Batch electronic signatures
Chapter 4
Report parameter deviation
signature requests
The following is an explanation of how report parameter deviation signature
requests are handled by the FactoryTalk Batch Server:
Report Parameter Deviations
Batch Server
The FactoryTalk Batch Server validates all real and integer report parameters according to the
report parameter’s verification method as part of the upload process. In all cases, except one,
the upload is completed and recorded in the event journal regardless of whether a deviation is
detected. The exception occurs for a verification policy of "Not Allowed". In this case, the
request fails and the value is not uploaded.
When the verification policy is "None", no electronic signatures or failures are generated, even
if a deviation exists.
When the verification policy is "Signature Template", the server initiates any required
signature prompts as defined by the signature template. The report upload is completed
without failure – even if a signature is pending.
If a report limit value is not known, the server processes all the other report parameters,
recording deviations, and report values then fails the upload request.
Response
An ActionID is returned by the execute used to locate the generated signature.
Completion
Completion of a signature generated for report deviation acknowledgment does not result in
any additional action.
Cancellation
Report deviation signature requests cannot be cancelled.
Automatic Cancellation
There is no scenario under which a report deviation signature request is system cancelled.
Warm Reboot
A FactoryTalk Batch Server warm boot restores report parameter deviation signature requests.
See also
FactoryTalk Batch electronic signatures on page 47
Parameter deviation verification policies on page 59
Parameter deviation signature requests on page 60
General usage phase logic
requests
A General Usage Signature request is created when a General Usage Phase Logic
request is sent to the FactoryTalk Batch Server during the execution of an
automated phase. Each signature template configured in FactoryTalk Batch
Equipment Editor has a unique template index. To generate a signature the Phase
Logic request specifies the signature template index.
For information on configuring general usage phase logic requests, see Download
Batch Parameters in the FactoryTalk Batch PCD Programmer Reference Guide.
See also
General usage signature requests on page 62
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
61
Chapter 4
FactoryTalk Batch electronic signatures
General usage signature
requests
The following is an explanation of how general usage signature requests are
handled by the FactoryTalk Batch Server:
General Usage Signatures
Batch Server
General usage signatures are generated by Phase Logic requests received from Equipment
Phases. The equipment phase specifies the Signature Template ID from which the Signature is
generated, and the Phase Logic Request is considered complete when the Signature Request is
complete.
Response
If a Phase Logic Request for a General Usage Signature specifies an invalid Signature Template
ID, then the Phase Logic Request is handled according to standard Phase Logic Request failure
protocols. If the request is successful in generating the Signature, then no response is made
until the Signature is either complete or cancelled.
Completion
When the Signature for a General Usage Signature generated by a Phase Logic Request is
complete, then the Phase Logic Request is considered complete. The Phase Logic Request
completion is handled via the standard Phase Logic Request communication protocol.
Cancellation
When the Signature for a General Usage Signature generated by a Phase Logic request is
cancelled, the Phase Logic request is considered failed. The Phase Logic request failure is
handled via the standard Phase Logic request communication protocol.
Overlap
The Phase Logic Request protocol does not support overlapped Phase Logic requests; hence,
overlapped general usage signatures are not an issue. Note that parallel recipe phases can
create parallel requests, but no parallelism is possible from within the scope of a single
equipment phase.
Automatic Cancellation
If the Phase Logic request from which a general usage signature is generated is aborted, then
the general usage signature is System Cancelled if it is in the incomplete state.
Warm Reboot
Signature requests generated in response to a General Usage Signature Phase Logic request are
System Cancelled in the event of a FactoryTalk Batch Server warm boot.
See also
General usage phase logic requests on page 61
62
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
FactoryTalk Batch electronic signatures
Electronic signature
security
Chapter 4
FactoryTalk Security is used to support FactoryTalk Batch Electronic Signature
Signoffs. The ESignature Network Directory policy setting is created in the
FactoryTalk Local Directory during FactoryTalk Batch installation with a default
value of True. The value of the ESignature Network Directory policy setting
determines whether the users and groups defined in the FactoryTalk Local
Directory or the users and groups defined in the FactoryTalk Network Directory
are used to assign Security Permissions to Electronic Signature Templates and
validate Electronic Signature Request Signoffs.
Security Permissions for Signature Signoffs are specified when the Signature
Template is created in FactoryTalk Batch Equipment Editor. The Security
Permissions defined in the Signature Template are required to complete the
Signoff(s) generated in the associated Signature Request. Each Signoff requires a
UserID and a password. When a signature requires multiple signoffs, each signoff
must be made using a unique UserID and password.
Signature templates are also used for Recipe Approval process signoffs, and must
be configured before recipe approvals can be enabled, configured, and executed.
For more information on configuring signature templates, see the FactoryTalk
Batch Equipment Editor User Guide.
See also
FactoryTalk Batch electronic signatures on page 47
Configure the ESignature network directory policy setting on page 64
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
63
Chapter 4
FactoryTalk Batch electronic signatures
Configure the ESignature
network directory policy setting
The ESignature Network Directory policy setting must be set to True to enable
signature signoff permission validations across a network. For stand alone
computers, set the ESignature Network Directory policy setting to False.
Important:
Changing the FactoryTalk Directory Server after creating Signature
Templates causes Signoffs to fail unless the FactoryTalk System folder is
backed up and restored on the new FactoryTalk Directory Server.
To configure the ESignature Network Directory policy setting:
1. Open the FactoryTalk Administration Console.
2. Log on to the FactoryTalk Local Directory.
3. Point to System > Policies > Product Policies > Batch > Equipment
Editor > Configuration > Options.
4. Right-click Options, and then click Properties. The Option Properties
dialog box opens.
5. Select the ESignature Network Directory policy setting. If you are using
Network security select True, to use Electronic Signatures on a stand alone
computer, select False.
6. Click OK.
7. Restart the server and client applications.
See also
FactoryTalk Batch electronic signatures on page 47
Electronic signature security on page 63
FactoryTalk Batch default policy settings on page 41
64
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
Chapter 5
FactoryTalk Batch audit trail
FactoryTalk Batch auditing provides a detailed audit trail of user-initiated changes
from FactoryTalk Batch Equipment Editor and FactoryTalk Batch Recipe Editor.
FactoryTalk Batch Equipment Editor and FactoryTalk Batch Recipe Editor track
all changes in the current editing session for each user-initiated action. When
changes are saved, each entry in the list generates an audit message. If changes are
made but are not saved, no audit message is generated.
Audit messages are forwarded from FactoryTalk Batch Equipment Editor and
FactoryTalk Batch Recipe Editor to FactoryTalk Diagnostics, a Rockwell Software
product that enables application logging and auditing, or to FactoryTalk
AssetCentre (if installed).
The FactoryTalk Directory System folder contains Audit settings that apply to
all FactoryTalk-enabled products in a system. The FactoryTalk Audit Policy
Setting, Audit changes to configuration and control system, must be enabled to
display audit messages in either the FactoryTalk Diagnostics viewer or the
FactoryTalk AssetCentre viewer. This FactoryTalk policy setting overrides the
registry settings used to enable and disable auditing in FactoryTalk Batch
Equipment Editor and FactoryTalk Batch Recipe Editor. (For more information
see FactoryTalk Help, located in the FactoryTalk Administration Console.)
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
65
Chapter 5
FactoryTalk Batch audit trail
In version 6.02, FactoryTalk Batch Equipment Editor and FactoryTalk Batch
Recipe Editor began storing audit messages to FactoryTalk Diagnostics. The audit
messages were viewed with the FactoryTalk Diagnostics viewer. In version 9.00
and higher, if FactoryTalk AssetCentre is installed (and auditing is enabled), the
audit messages are routed to FactoryTalk AssetCentre. The audit messages are
then viewable through FactoryTalk AssetCentre’s Audit View.
Tip:
FactoryTalk Diagnostics looks to see if FactoryTalk AssetCentre is installed. If it is, audit messages are routed
there. If FactoryTalk AssetCentre is not installed, audit messages are routed to the FactoryTalk Diagnostics
native store.
See also
Enable auditing for FactoryTalk Batch Equipment Editor or FactoryTalk
Batch Recipe Editor on page 67
Audited FactoryTalk Batch Equipment Editor events on page 68
Audited FactoryTalk Batch Recipe Editor events on page 71
Audit messages on page 73
66
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
FactoryTalk Batch audit trail
Chapter 5
Enable auditing for
FactoryTalk Batch
Equipment Editor or
FactoryTalk Batch Recipe
Editor
Perform the following steps to enable auditing. The default setting is disabled.
Use the FactoryTalk Administration Console to modify the policy settings for
auditing. These policy settings are located in both the FactoryTalk Network
Directory and Local Directory. The Local Directory audit policy overrides the
Network Directory audit policies.
Tip:
The FactoryTalk Audit Policy Setting, Audit changes to configuration and control system, must be enabled
to display audit messages in FactoryTalk Diagnostics or FactoryTalk AssetCentre.
To enable auditing for FactoryTalk Batch Equipment Editor or FactoryTalk
Batch Recipe Editor:
1. Open the FactoryTalk Administration Console and log on to the Network
Directory or Local Directory.
2. Point to System > Policies > System Policies.
3. Right-click Audit Policy, and then click Properties.
4. Select Audit changes to configuration and control system and set it to
Enabled. Auditing is enabled the next time you run FactoryTalk Batch
Equipment Editor or FactoryTalk Batch Recipe Editor.
Tip:
Restart all FactoryTalk Batch components to update changes made in the FactoryTalk Diagnostics.
See also
FactoryTalk Batch audit trail on page 65
Audited Equipment Editor events on page 68
Audited Recipe Editor events on page 71
Audit messages on page 73
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
67
Chapter 5
FactoryTalk Batch audit trail
Audited FactoryTalk Batch
Equipment Editor events
68
This section describes the set of audit messages generated by FactoryTalk Batch
Equipment Editor. Not all user actions are audited; for example, View menu
changes and Options menu changes do not generate audit messages. The
following events are audited when the area model is saved.
Message Type
Event
Area Model
Invoke FactoryTalk Batch Equipment Editor
Open an existing area model
Create a new area model
Save an area model
Edit/update an area model property
Delete an area model
Add a signature template
Delete a signature template
Update a signature template
Enable/disable recipe approvals
Enable/disable recipe versioning
Update a command verification policy
Area Model Security
Security authority is configured for an area model
Security authority identifier (SAI) is set or removed
Security authority configuration change is accepted by user
Security authority changes are saved to the area model
Data Server
Add an OPC server
Delete an OPC server
Edit/update an OPC server property
Add a Logix5000 CIP server
Delete a Logix5000 CIP server
Edit a Logix5000 CIP server
Add an FTD server
Delete an FTD server
Edit/update an FTD server property
Enumeration Set
Create an enumeration set
Delete an enumeration set
Edit/update an enumeration set property
Enumeration
Add an enumeration
Delete an enumeration
Edit/update an enumeration property
Resource Class
Add a resource class
Delete a resource class
Edit/update a resource class property
Resource
Add a resource
Delete a resource
Edit/update a resource property
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
FactoryTalk Batch audit trail
Chapter 5
Message Type
Event
Process Cell Class
Add a process cell class
Copy a process cell class
Delete a process cell class
Edit/update a process cell class property
Process Cell
Add a process cell
Copy a process cell
Delete a process cell
Edit/update a process cell property
Unit Attribute
Add a unit attribute
Delete a unit attribute
Edit/update a unit attribute property
Unit
Add a unit
Copy a unit
Edit a unit
Delete a unit
Edit/update a unit property
Global Unit Binding
Requirements
Add global unit attribute
Edit global unit attribute
Delete global unit attribute
Unit Flow Path
Link units with a flow path
Unlink units with a flow path
Equipment Phase Class (Recipe
Phase)
Add an equipment phase class
Copy an equipment phase class
Delete an equipment phase class
Edit/update an equipment phase class property
Edit/update an equipment phase class control strategy set of parameters
Edit/update an equipment phase class optional material parameters
property
Edit/update an equipment phase class control strategy set of reports
Edit/update an equipment phase class control strategy
Equipment Phase
Add an equipment phase
Copy an equipment phase
Delete an equipment phase
Edit/update an equipment phase property
Edit/update an equipment phase’s server property
Reset an equipment phase’s tags to default values
Share an equipment phase between units
Recipe Parameter
Add a recipe parameter
Delete a recipe parameter
Edit/update a recipe parameter property
Recipe Approval Step
Add a recipe approval step
Delete a recipe approval step
Edit/update a recipe approval step
Report Parameter
Add a report parameter
Delete a recipe parameter
Edit/update a recipe parameter property
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
69
Chapter 5
FactoryTalk Batch audit trail
Message Type
Event
Phase Message
Add a phase message
Delete a phase message
Edit/update a phase message property
Synchronize
Synchronize a phase
Tag Class
Add a tag class
Delete a tag class
Edit/update a tag class property
Unit Attribute Tag
Add a unit attribute tag
Delete a unit attribute tag
Edit/update a unit attribute tag property
Container Association
Add a container association
Delete a container association
Edit/update a container association property
Instruction Configuration
Edit/update an instruction configuration property
Phase Tag
Edit/update a phase tag property
See also
Enable auditing for FactoryTalk Batch Equipment Editor or FactoryTalk
Batch Recipe Editor on page 67
Audit messages on page 73
70
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
FactoryTalk Batch audit trail
Chapter 5
Audited FactoryTalk Batch
Recipe Editor events
This section describes the set of audit messages generated by FactoryTalk Batch
Recipe Editor in response to recipe modifications and operations.
Message Type
Event
Recipe Object
Open an existing recipe
Create a new recipe
Save a recipe
Save all recipes
Remove a recipe (User-supplied comment when deleting)
Import a recipe (User-supplied comment when importing)
Export a recipe (User-supplied comment when exporting)
Rebuild the recipe directory (User-supplied comment when rebuilding recipe)
Delete an existing recipe
Recipe Print
Print a Procedure, Unit Procedure, or Operation
Recipe Header
Edit/update recipe header properties (except Recipe Name)
Recipe Step
Add a recipe step, insert step, or parallel recipe step
Delete a recipe step
Edit/update a recipe step
Recipe Approval Step
Signoff on an approval step
Revert an approval step
Recipe Versioning
Check in a recipe (create a new version of a recipe)
Check out a recipe (create a work-in-progress (WIP) recipe)
A recipe is obsoleted
An obsolete recipe is saved
An obsolete recipe is reinstated
A reinstated recipe is saved
Version conflict on recipe import
Version conflict on recipe directory rebuild (including auto-rebuild of the directory when
FactoryTalk Batch Recipe Editor opens)
A recipe is deleted due to version conflict resolution (during import or recipe directory
rebuild)
Signoff(s) removed due to verification failure (for versioned and non-versioned recipes)
Recipe Security
Change a recipe security state
Edit/modify a security authority identifier (SAI)
Change a FactoryTalk Services Platform SAI host computer
Recipe Text Box
Add a text box
Edit a text box (only if comment actually changes)
Delete a text box
Associate a text box
Disassociate a text box
Recipe Formula Parameter
Add a recipe formula parameter to a step
Delete a recipe formula parameter from a step
Edit/update a recipe formula parameter of a step
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
71
Chapter 5
FactoryTalk Batch audit trail
Message Type
Event
Formula Value
Edit/update a formula value’s non-origin properties
Edit/update a formula value’s origin property
Edit/update a formula value’s value property for deferred parameters
Report Limit
Add a report limit
Delete a report limit
Edit/update a report limit
Bind Requirement
Add/update a bind requirement
Delete a bind requirement*
Bind Preference
Add/update bind preference
Delete bind preference
Recipe Transition
Add a transition to a recipe
Delete a transition to a recipe
Edit/update a recipe transition
Link Group
Add a recipe link group
Delete a recipe link group
Edit/update a recipe link group
Equipment Requirement
Add an equipment requirement to a recipe
Delete an equipment requirement of a recipe
Edit/update procedure-only equipment requirement properties (except downstream
units)
Edit/update procedure-only equipment requirement’s downstream units property
Edit/update operation and unit procedure equipment requirements
Recipe Verification
Verify a single recipe
Verify all recipes
Material Loop
Add a material loop to a recipe
Undo a material loop
Recipe Link
Add a recipe link
Delete a recipe link
See also
Enable auditing for FactoryTalk Batch Equipment Editor or FactoryTalk
Batch Recipe Editor on page 67
Audit messages on page 73
72
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
FactoryTalk Batch audit trail
Audit messages
Chapter 5
When auditing is enabled for FactoryTalk Batch Equipment Editor and
FactoryTalk Batch Recipe Editor, view the audit messages through the
FactoryTalk Diagnostics Viewer or the FactoryTalk AssetCentre client.
Tip:
FactoryTalk Diagnostics looks to see if FactoryTalk AssetCentre is installed. If it is,
audit messages are routed there. If FactoryTalk AssetCentre is not installed, audit
message are routed to FactoryTalk Diagnostics.
See also
FactoryTalk Diagnostic Viewer on page 74
FactoryTalk AssetCentre Client on page 78
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
73
Chapter 5
FactoryTalk Batch audit trail
FactoryTalk Diagnostics Viewer
For information about using or customizing the FactoryTalk Diagnostics Viewer,
refer to FactoryTalk Diagnostics Viewer online help.
The illustration shows a FactoryTalk Batch audit record in the FactoryTalk
Diagnostics Viewer. The audit record was generated by the creation of a new
operation.
See also
FactoryTalk Batch audit trail on page 65
Standard viewer message fields in FactoryTalk Diagnostics Viewer
on page 75
Extended viewer message fields in FactoryTalk Diagnostics Viewer
on page 76
74
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
FactoryTalk Batch audit trail
Chapter 5
Standard viewer message fields in
FactoryTalk Diagnostics Viewer
The following is a detailed list of the default FactoryTalk Diagnostic Viewer
standard message parameters.
Field
Data Type
Description
Used In
Message
Variant
Application and event-specific message
associated with the event being reported.
If provided by the user, applies to all
FactoryTalk Batch Recipe Editor and
FactoryTalk Batch Equipment Editor
audit messages.
Severity
Enum
This field specifies the severity of the audit
message. This value, along with the
Audience parameter, defines where this
message is routed.
This is RNADiagSeverity_Info. This is not
configurable.
Audience
Enum
This field specifies the audience for the audit This is RNADiagAudience_Op. This is not
message. This value, in conjunction with the configurable.
Severity parameter, defines where this
message is routed.
Time
Date
Date and time, specified as (GMT/UTC)
Represented in the TimeStamp field of
the audit message.
Location
BSTR
Name of the host computer.
Represented in the MachineName field
in the audit message.
Provider
BSTR
Name of the client application or
component.
Not used.
User
BSTR
Name of the person logged into the editor.
Represented in the UserName field of
the audit message.
User Description
BSTR
Fully resolved user name.
Represented in the UserDescription
field of the audit message.
Args
Variant
Used for Visual Basic Compatibility.
Not used.
See also
FactoryTalk Diagnostics Viewer on page 74
Extended viewer message fields in FactoryTalk Diagnostics Viewer
on page 76
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
75
Chapter 5
FactoryTalk Batch audit trail
Extended viewer message fields in
FactoryTalk Diagnostics Viewer
Extended fields are provided in the FactoryTalk Diagnostics Viewer.
Field
Data Type
Description
Used In
Verbosity
Long
This value field is arbitrary; values from 1 through Not used.
100 are valid. Use to further define or filter
messages.
Action
BSTR
The updating/editing action made by the user.
All audit messages.
Area
BSTR
For Equipment objects, the area name the object
belongs to. This field is used when needed.
Some Equipment audit
messages.
ContainingObject
BSTR
The object type that contains the EditedObject.
This is used to help define exactly what object is
being edited/updated.
Some Equipment audit
messages.
ContainingObjectID
BSTR
The sub-property or object property field of the
Some Equipment and Recipe
equipment or recipe object affected by the action. audit messages.
EditedObject
BSTR
The Equipment or Recipe object affected by the
action.
All audit messages.
EditedObjectID
BSTR
The most common way to identify the
EditedObject.
All audit messages.
EditedProperty
BSTR
The property affected by the action.
Some Recipe, Equipment and
Area audit messages.
EditedProperty1
BSTR
EditedProperty2
BSTR
Preference priority
EquipmentPhase
BSTR
For Equipment objects, the equipment phase
name the object belongs to. This field is used
when needed.
Some Equipment audit
messages.
NewValue
BSTR
The value of a property after it was changed.
Updating audit events only.
NewValue1
BSTR
The value of a property after it was changed:
• Phase Name
• Attribute Name
• Expression text
NewValue2
BSTR
Priority number
OldValue
BSTR
The value of a property before it was changed.
Updating audit events only.
OldValue1
BSTR
The value of a property before it was changed:
• Phase Name
Updating audit events only.
• Attribute Name
• Expression text
76
OldValue2
BSTR
Priority number
Operation
BSTR
For Recipe objects, the operation name the object Some Recipe audit messages.
belongs to. This field is used when needed.
Procedure
BSTR
For Recipe objects, the procedure name the object Some Recipe audit messages.
belongs to. This field is used when needed.
ProcessCell
BSTR
For Equipment objects, the process cell name the Some Equipment audit
object belongs to. This field is used when needed. messages.
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
Updating audit events only.
FactoryTalk Batch audit trail
Chapter 5
Field
Data Type
Description
Used In
SubAction
BSTR
An updating/editing action to a list that is a
property of the EditedObject. This can be Add or
Delete.
Updating audit events for
properties that are lists only.
SubObject
BSTR
The object type referenced by the EditedObject.
Updating audit events for
properties that are lists only.
SubObjectID
BSTR
The value of a property after it was changed.
Updating audit events for
properties that are lists only.
Unit
BSTR
For Equipment objects, the unit name the object
belongs to. This field is used when needed.
Some Equipment audit
messages.
UnitProcedure
BSTR
For Recipe objects, the unit procedure name the Some Recipe audit messages.
object belongs to. This field is used when needed.
Working Set
BSTR
For Recipe objects, the computer name and
database where the recipes are stored.
Some Recipe audit messages.
See also
FactoryTalk Diagnostics Viewer on page 74
Standard viewer message fields in FactoryTalk Diagnostics Viewer
on page 75
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
77
Chapter 5
FactoryTalk Batch audit trail
FactoryTalk AssetCentre Client
When FactoryTalk AssetCentre is installed, and auditing is enabled for
FactoryTalk Batch Equipment Editor and FactoryTalk Batch Recipe Editor, view
the audit messages through the FactoryTalk AssetCentre client.
Tip:
To use FactoryTalk AssetCentre for auditing, Change Management (FactoryTalk
AssetCentre add-on solution) must be installed.
The graphic illustrates an audit log as viewed with the FactoryTalk AssetCentre
client. The FactoryTalk Batch audit message (the nineteen fields written to
FactoryTalk Diagnostics and forwarded to FactoryTalk AssetCentre) are written
to the Message Summary field. Only the first 100 characters of the Message
Summary field are displayed on a line. The entire message is displayed in the
Details window. The EditedObject audit message field is used to populate the
Resource field in the Viewer.
See also
FactoryTalk Batch audit trail on page 65
Viewer message fields on page 79
78
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
FactoryTalk Batch audit trail
Viewer message fields
Chapter 5
The audit messages for FactoryTalk AssetCentre are formatted as closely as
possible as those used in FactoryTalk Diagnostics Viewer messages. The Resource
field for audit messages contains the value of the Edited Object field of a
diagnostics message.
The Message field contains these fields:
•
User comment
•
Action
•
Area
•
ContainingObject
•
ContainingObjectID
•
EditedObject
•
EditedObjectID
•
EditedProperty
•
EquipmentPhase
•
NewValue
•
OldValue
•
Operation
•
Procedure
•
ProcessCell
•
SubAction
•
SubObject
•
SubObjectID
•
Unit
•
UnitProcedure
•
WorkingSet
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
79
Chapter 5
FactoryTalk Batch audit trail
Each entry consists of a Label and its associated data. Each entry also contains tab
characters to line up the data for readability, and is followed by a new line
character.
See also
FactoryTalk AssetCentre Client on page 78
Enable auditing for FactoryTalk Batch Equipment Editor or FactoryTalk
Batch Recipe Editor on page 67
80
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
Chapter 6
The FactoryTalk Batch Service Manager
The FactoryTalk Batch Service Manager is used with the FactoryTalk Batch
Server, eProcedure Server, and FactoryTalk Event Archiver, when FactoryTalk
Event Archiver is configured as a Windows service. The Service Manager manually
starts and stops the FactoryTalk Batch Server and manually starts, pauses,
continues or stops FactoryTalk Event Archiver services. The Service Manager
accesses the Batch Server Statistics dialog box, which gives access to COM server
information, COM client status, error information, and other FactoryTalk Batch
Server information.
Tip:
To command the FactoryTalk Batch Server or FactoryTalk Event Archiver services,
you must have local administrator privileges on the computer where the server
and/or FactoryTalk Event Archiver services are installed. If you do not have local
administrator privileges, you will have view-only privileges.
See also
Windows services on page 82
FactoryTalk Batch Service Manager interface on page 82
Batch Server Statistics dialog box on page 85
Start the batch server service on page 90
Add a custom service on page 94
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
81
Chapter 6
The FactoryTalk Batch Service Manager
Windows services
The FactoryTalk Batch Server and FactoryTalk Event Archiver operate as
Windows services. During FactoryTalk Batch installation, the user account
specified during the installation is assigned to the Log On As: This Account:
option, found in the (Administrative Tools) Services dialog box.
Running as a Windows service allows the FactoryTalk Batch Server to run in the
absence of an interactive Windows logon. Logging on or logging off Windows
during operation does not disrupt the server execution.
Configure the FactoryTalk Batch Server to start automatically, giving server
control to Windows Services, or control the FactoryTalk Batch Server manually
using the FactoryTalk Batch Service Manager. The Service Manager also controls
the type of boot method that the server uses, and runs the server in demo mode.
Tip:
Specifying the boot method or demo mode in the FactoryTalk Batch Service
Manager does not alter the Batchsvr.ini file and has no effect on the server when
automatically starting.
See also
The FactoryTalk Batch Service Manager on page 81
FactoryTalk Batch Service
Manager interface
The FactoryTalk Batch Service Manager interface is organized into three areas:
•
Connection
•
Service state
•
Server
See also
Connection on page 83
Service state on page 83
Server on page 84
82
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
The FactoryTalk Batch Service Manager
Connection
Chapter 6
The Connection area contains:
Item
Definition
Computer
Displays the selected computer.
Select Computer
Selects the computer where the service is located.
Service
Allows you to select a service from a list of batch services for the selected
computer.
See also
The FactoryTalk Batch Service Manager on page 81
Service state on page 83
Server on page 84
Service state
The Service State area contains buttons, text and a graphic traffic light service
state representation.
The following possible states and corresponding colors are displayed:
STARTING
None
RUNNING
Green
STOPPED
Red
PAUSED
Yellow
NOT CONNECTED
None
START PENDING
None
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
83
Chapter 6
The FactoryTalk Batch Service Manager
The Service State area contains the following buttons:
Item
Definition
Stop
Stops the selected service.
Pause
Pauses the selected service. This button is not enabled for the batch server.
Start/
Continue
Starts the selected service or continues a service that has been paused.
Tip:
The state of the FactoryTalk Batch Service Manager (information from the
Connection and Server groups) is stored from the last time the Service Manager
was run. These values are written when the FactoryTalk Batch Server is closed.
See also
The FactoryTalk Batch Service Manager on page 81
Connection on page 83
Server on page 84
Server
The Server area contains:
Item
Definition
Allow Demo Mode
The FactoryTalk Batch Server runs with full functionality without a license for a
two-hour period. After two hours, the server stops running.
Allow Grace Period
The FactoryTalk Batch Server starts when a valid activation is not found. The grace
period is seven days, after which a valid FactoryTalk Activation license is required.
Cold Boot
The FactoryTalk Batch Server starts in a completely initialized condition. All restart
data is erased and all recipe content is removed from the Batch List.
Warm Boot
The FactoryTalk Batch Server starts and attempts to restore the set of batches that
were on the batch list when the server previously terminated. The restart files are
altered so only one warm restart may be attempted.
Warm All Boot
Restarts the FactoryTalk Batch Server only if it is able to restore all of the batches
to the batch list. Restart does not alter the restart files so another warm-all or
warm restart may be attempted. This is the default setting for automatic restarts.
Server Statistics
This button opens the Batch Server Statistics dialog box.
See also
The FactoryTalk Batch Service Manager on page 81
Service state on page 83
Connection on page 83
84
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
The FactoryTalk Batch Service Manager
Batch Server Statistics
dialog box
Chapter 6
The Batch Server Statistics dialog box displays an overview of the current
system’s status. The data is view-only and cannot be modified. The COM server
and area model file referenced are specified in the Server Options dialog box
accessed from FactoryTalk Batch Equipment Editor. The Batch Server Statistics
dialog box is organized into four tabs.
See also
Batch Server Statistics dialog box - General tab on page 86
Batch Server Statistics dialog box - Messages tab on page 87
Batch Server Statistics dialog box - PCD Communications tab on page 88
Batch Server Statistics dialog box - View Communications tab on page 89
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
85
Chapter 6
The FactoryTalk Batch Service Manager
Batch Server Statistics dialog
box - General tab
The General tab lists various data on the number of batches and prompts being
currently handled by the FactoryTalk Batch Server, as well as the Windows time
on the server, the time the batch server was started, and the name and creation
date of the current area model.
The General tab contains the following:
Field
Definition
Batch Count
The number of batches loaded in the FactoryTalk Batch Server.
Prompts Count
The number of prompts currently existing within all batches.
Version
The version number of the FactoryTalk Batch Server.
Time
The time as specified by Windows on the FactoryTalk Batch Server.
Started at
The time the FactoryTalk Batch Server was started.
Area Model File Name
The name of the currently active area model.
Area Model Date
The creation date of the currently active area model.
See also
The FactoryTalk Batch Service Manager on page 81
Batch Server Statistics dialog box on page 85
86
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
The FactoryTalk Batch Service Manager
Chapter 6
Batch Server Statistics dialog
box - Messages tab
The Messages tab is used to monitor FactoryTalk Batch Server log information.
The messages displayed in the three sections are the most recent messages written
to the server log by the server.
The Messages tab consists of the following:
Field
Definition
Info
The most recent Info-type entry in the log file. Info entries are log entries
recorded as a part of the normal execution.
Warning
The most recent Warning-type entry in the log file. Warning entries indicate
that a minor irregularity was detected in the system. The irregularity was
handled by the system or the system is not sure of the occurrence’s implications.
Severe
The most recent Severe-type entry in the log file. Severe entries indicate that a
severe error condition was encountered. The system handled the situation as
best it could.
See also
The FactoryTalk Batch Service Manager on page 81
Batch Server Statistics dialog box on page 85
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
87
Chapter 6
The FactoryTalk Batch Service Manager
Batch Server Statistics dialog
box - PCD Communications tab
The PCD Communications tab is used to monitor the FactoryTalk Batch Server
communication status and any data servers that are communicating with the
server. Verification of all tags, phases, and equipment operation sequences
associated with the current area model is also performed.
The PCD Communications tab consists of the following components:
Field
Definition
Data Server Status
Lists of all configured data servers in the area model and the communication status
between FactoryTalk Batch and these data server(s).
Tag Verify Status
Indicates if the verification function is READY, IN PROGRESS, or COMPLETED.
Tag Verify Verified
Indicates the number of tags, phases, and equipment operation sequences that the
server has processed during tag verification.
Tag Verify Bad
Indicates the number of tags, phases, and equipment operation sequences that the
server was unable to verify. Bad tags, phases, and equipment operation sequences
indicate either the data server is unable to supply the data requested by the
FactoryTalk Batch Server or the data was not of the expected type.
Tag Verify Total
Indicates the total number of tags, phases, and equipment operation sequences.
Start
Starts the verification process.
Stop
Stops the verification process.
See also
The FactoryTalk Batch Service Manager on page 81
Batch Server Statistics dialog box on page 85
88
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
The FactoryTalk Batch Service Manager
Chapter 6
Batch Server Statistics dialog
box - View Communications tab
The View Communications tab is used to monitor the number of Dynamic Data
Exchange (DDE), Component Object Model (COM) and Ole for Process
Control (OPC) conversations taking place between the FactoryTalk Batch Server
and Client software, such as FactoryTalk Batch View and ActiveX Controls.
The View Communications tab consists of the following:
Item
Definition
DDE Connections
The number of DDE communications attached to the FactoryTalk Batch Server.
COM Connections
The number of COM communications attached to the server.
OPC Connections
The number of OPC communications attached to the server.
Items
The number of communication items the server is currently supporting.
See also
The FactoryTalk Batch Service Manager on page 81
Batch Server Statistics dialog box on page 85
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
89
Chapter 6
The FactoryTalk Batch Service Manager
Start the FactoryTalk Batch
Server service
The FactoryTalk Batch Service Manager communicates with the Windows
Services of the selected computer to determine available services. There may be a
noticeable delay as communications are established, marked by the cursor
displayed as an hourglass. If the FactoryTalk Batch Service Manager cannot
communicate with the selected computer’s Windows Services, a message box is
displayed stating that the FactoryTalk Batch Service Manager failed to connect to
the specified computer.
The FactoryTalk Batch Phase Simulator must be running to test FactoryTalk
Batch in a demo environment. For more information, see The FactoryTalk Batch
Phase Simulator in the FactoryTalk Batch Administrator Guide.
Important:
The FactoryTalk Batch Server cannot start if Security Authority is
enabled and there is a mismatch between the Security Authority
Identifiers (SAIs) in the area model and the FactoryTalk Network Directory.
For information on your recovery options, see Troubleshooting in the
FactoryTalk Batch Equipment Editor User Guide.
To start the FactoryTalk Batch Server service:
1. Select the Start button, point to All Programs > Rockwell Software >
FactoryTalk Batch Suite > FactoryTalk Batch, and then select Batch
Service Manager. The Batch Service Manager opens.
Tip:
If running on Windows 7 or Windows Server 2008, run the FactoryTalk Batch Service Manager as an
administrator.
2. Select Select Computer. The Select Computer dialog box opens.
3. In the Enter the object name to select area, enter the name of the
computer where the FactoryTalk Batch Server is installed (or select the
Advanced button to search for a computer).
4. Select OK to close the Select Computer dialog box.
5. From the Service list, select FactoryTalk Batch Server.
6. (optional) Select Allow Demo Mode if you want to run FactoryTalk Batch
in demo mode. If you run FactoryTalk Batch in the demo mode, be aware
that the Server stops after two hours of operation.
90
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
The FactoryTalk Batch Service Manager
Chapter 6
7. Select the method to use for restarting the server after a service halt.
•
Cold Boot: Restarts the server in a cold state. All journal data or recipe
content is erased upon startup. If Security Authority is enabled, SAIs in
a secured area model and any secured recipes must match the current
Network FactoryTalk Directory SAI.
•
Warm Boot: Restarts the server, restoring the set of batches that were
on the batch list when the server previously terminated. No validation
for Security Authority is performed.
•
Warm All Boot: Restarts the server only if it is able to restore all of the
batches to the batch list. No validation for Security Authority is
performed.
8. Select the Start/Continue button to start the service. Wait for the status to
change to RUNNING and the light is green.
9. Select the Server Statistics button. The Batch Server Statistics dialog box
opens.
10. Select the PCD Communications tab. The Data Server Status box
displays the status of the conversation. Make sure that conversation is
GOOD.
11. Select Start. The tag verification process begins. When tag verification is
COMPLETED, select OK, or select Stop to end the verification process
and then select OK.
Tip:
If the number of COM servers exceeds the viewable area within the Data Server Status box, a scroll bar
displays, enabling you to scroll through the list.
12. Select Close. The Batch Service Manager dialog box closes.
Tip:
If software component conversation becomes LOST while running in Demo mode, make sure that the
simulator is running and try starting the server(s) again. For more information, see Start the FactoryTalk
Batch phase simulator.
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
91
Chapter 6
The FactoryTalk Batch Service Manager
Grace periods in FactoryTalk
Batch Server
When the FactoryTalk Batch Server starts, it performs a license check. If a valid
activation is found, a successful license check is returned to the server. As a result
of the license check, the server determines which applications have a license.
If its normal license check process fails, the server requests grace period activation
from FactoryTalk Activation. The manner in which the grace period activation is
requested depends on the area model and why the license check process failed. The
server will log the request for, and receipt of, the grace period license.
When grace period activation is requested for multiple activations by one process,
the grace period is ended and the timer reset when any of the multiple activations
can be successfully obtained.
Every four hours the FactoryTalk Activation software attempts to check out each
activation requested as a grace period activation by the FactoryTalk Batch Server.
If any one of these activations is successfully checked out, the grace period for the
server ends.
Tip:
If the FactoryTalk Batch Server is started in the Demo mode, an exception is made
to the license and unit checks. Even if no licenses are found, the server will run for
two hours and then shut down.
See also
Enable a grace period on page 93
92
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
The FactoryTalk Batch Service Manager
Enable a grace period
Chapter 6
Use the Allow Grace Period option on the Batch Service Manager dialog box to
start the FactoryTalk Batch Server in the event that it cannot find a valid
activation license. The grace period is seven days.
To enable a grace period:
1. Select Start > All Programs > Rockwell Software > FactoryTalk Batch
Suite > FactoryTalk Batch, and then select Batch Service Manager. The
Batch Service Manager opens.
2. Select Select Computer. The Select Computer dialog box opens.
3. In the Enter the object name to select area, enter the computer name
where the batch server is installed (or click the Advanced button to search
for a computer).
4. Click OK to close the Select Computer dialog box.
5. From the Service list, select FactoryTalk Batch Server.
6. Select Allow Grace Period enable grace period activation.
7. Click the Start/Continue button to start the service. Wait for the status to
change to RUNNING.
The FactoryTalk Batch Server searches for valid activations first. If the
appropriate activation is not found, the server will start under a grace period
activation. The FactoryTalk Batch Server checks for valid activation licenses
every four hours until it either finds one or the grace period expires.
8. Click Close. The Batch Service Manager dialog box closes.
See also
Grace periods in FactoryTalk Batch Server on page 92
Start the batch server service on page 90
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
93
Chapter 6
The FactoryTalk Batch Service Manager
Add a custom service
Define a custom service to command the FactoryTalk Batch Server and
FactoryTalk Event Archiver services using the FactoryTalk Batch Service
Manager. To make a service available to the Service Manager, you must enter the
file name of the executable for the service in a service registry key. This key is
located at:
HKEY_LOCAL_MACHINE\SOFTWARE\BATCHCTL\Services
To add a custom service:
1. In the Registry Editor, select the
HKEY_LOCAL_MACHINE\SOFTWARE\BATCHCTL\Services
subkey.
2. From the Edit menu, select New > Key. A new key folder is added.
3. Enter the Key Name without the file extension.
See also
The FactoryTalk Batch Service Manager on page 81
94
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
Chapter 7
The FactoryTalk Batch Server
The FactoryTalk Batch Server is the FactoryTalk Batch component that controls
and coordinates system information, phases, and recipes. The FactoryTalk Batch
Server allows integration with process-connected devices and third-party software
packages. The FactoryTalk Batch Server must be started and remain active during
all batch functions.
See also
FactoryTalk Batch Server service configuration on page 95
FactoryTalk Batch Server option configuration on page 97
Modify the .NET registry key on page 116
FactoryTalk Batch Server
service configuration
FactoryTalk Batch Server configuration can be verified and customized as needed.
Configuration includes specifying the startup method (Automatic or Manual),
specifying the restart type (Warm, Warm All, or Cold), and setting the server
options.
Tip:
The FactoryTalk Batch Server service is configured to run as a Windows Server 2008 user.
Changing the user account in which the server runs is done through Services.
See also
The FactoryTalk Batch Server on page 95
Specify the startup type on page 96
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
95
Chapter 7
The FactoryTalk Batch Server
Specify the startup type
Verify the FactoryTalk Batch Server startup and account types using the Services
Administrative Tool. You must be logged on with local administrative privileges
to configure the server.
To specify the startup type:
1. Select Administrative Tools > Services.
2. From the list of services, double-click Batch Server.
3. In the Startup type area, select Automatic to allow the batch server to start
automatically upon system startup.
4. Select the Log On tab.
5. From the Log On As area, select This account.
6. Select Browse. The Select Users dialog box opens.
7. Select the User to be used for the batch server, and then select OK.
8. In the Password box, enter the password for the batch server account.
9. In the Confirm password box, enter the password.
10. Select OK to close the Batch Server Properties dialog box.
11. Close the Services dialog box.
See also
FactoryTalk Batch Server service configuration on page 95
96
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
The FactoryTalk Batch Server
Chapter 7
FactoryTalk Batch Server
option configuration
Configure the FactoryTalk Batch Server and FactoryTalk Event Archiver using
the Server Options dialog box in FactoryTalk Batch Equipment Editor. The
configuration information for the server indicates how it communicates with
FactoryTalk Batch View and the data server(s). Configure FactoryTalk Event
Archiver to specify if and how electronic batch record files (.evt) are inserted into
the ODBC-compliant database.
Changing items such as FactoryTalk Batch Server information, area model, and
the error logging directory take effect when the server is restarted. Changing items
such as the recipe directory and batch journal directory take effect the next time
the server accesses these items. None of the items in FactoryTalk Event Archiver
configuration require the server to be restarted. These changes take effect the next
time the server needs that configuration item.
Important:
FactoryTalk Batch does not support the use of mapped drives. Do not use
mapped drives for project directories.
See also
Server Options dialog box - Project Settings tab on page 98
Server Options dialog box - Restart Control tab on page 101
Server Options dialog box - Batch Reporting tab on page 103
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
97
Chapter 7
The FactoryTalk Batch Server
Server Options dialog box Project Settings tab
The default project settings for a computer on which the FactoryTalk Batch
Server is installed are universal naming convention (UNC) names for all except
the Initialization File Name. If the server is installed on another computer, then
the Initialization File Name would use UNC names.
See also
Set project directories on page 99
Recipe storage on page 100
Recipe versioning on page 101
98
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
The FactoryTalk Batch Server
Set project directories
Chapter 7
Set directories for the following: Primary Journal, Secondary Journal, Error
Logging, Instructions (if you are using FactoryTalk eProcedure), and Equipment
Database.
Important:
The Primary Journal path must be defined or the FactoryTalk Batch Server will not start. The
Primary Journal path must be on the server computer in the BATCHCTL share. In addition, if
the Primary Journal or Secondary Journal path is invalid, the server will not start. If an
invalid path is used, an error message indicating the invalid path is written to the
batchsvr.log file.
To set project directories:
1. In FactoryTalk Batch Equipment Editor, select Options > Server Options.
2. Select the Project Settings tab.
3. Select Browse to open the Select Directory dialog box.
4. Select the appropriate directory, and then select OK to return to the Server
Options dialog box. The selected UNC directory path name is inserted into
the appropriate box.
See also
Server Options dialog box - Project Settings tab on page 98
FactoryTalk Batch Server option configuration on page 97
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
99
Chapter 7
Recipe storage
The FactoryTalk Batch Server
In the FactoryTalk Batch Equipment Editor, Server Options dialog box, the
Store Recipes Using section is used to specify the format for storing recipes:
•
Binary Files
•
Microsoft SQL Server Database
•
XML Files
The default format is Binary Files. When the Binary Files option is selected,
recipes are stored in separate files according to recipe level. Procedures are stored as
.bpc files, Unit Procedures are stored as .upc files, and Operations are stored as
.uop files. Specify the appropriate directory.
When the Microsoft SQL Server Database option is selected, recipes are stored
in a SQL server database.
When the XML Files option is selected, recipes are stored in separate .xml files.
Procedures are stored as .pxml files, Unit procedures as .uxml files and Operations
as .oxml files.
Tip:
If using SQL Server for recipe storage: If SQL Server is not installed on the
same computer as the Batch Client, to see a list of available SQL Server databases
in the Server Options dialog box, install SQL Server’s Client Tools Connectivity
option. Do a custom install of SQL Server to install the Client Tools Connectivity
option.
See also
Server Options dialog box - Project Settings tab on page 98
FactoryTalk Batch Server option configuration on page 97
100
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
The FactoryTalk Batch Server
Recipe versioning
Chapter 7
Below the Store Recipes Using area is the Enable Recipe Versioning check box.
Check this box to enable Recipe Versioning, a system-enforced naming
convention that stores and protects recipe revisions. By default the box is
unchecked and recipe versioning is disabled.
Important:
FactoryTalk Full Edit access to FactoryTalk Batch Equipment Editor is
required to enable and disable recipe versioning.
See also
Recipe storage on page 100
Set project directories on page 99
Server Options dialog box Restart Control tab
The Restart Control tab allows you to specify a restart method to initiate in the
event of a server computer failure. Selecting Cold Restart will restart the
FactoryTalk Batch Server in an uninitialized state and all recipe content is erased.
Selecting Warm Restart (the default) forces the server (or backup server) to
restart in the same state it was in prior to the failure, without any loss of journal
data or recipe content. Selecting Warm All Restart allows the server to restart
only if it is able to restore all of the batches to the batch list. Warm All Restart is
the default setting used by the automatic restart function.
The Restart Control tab also allows you to specify primary and secondary path
names for the storage of files containing restart information. (See Specify the
startup type for more information.)
Important:
You must define a valid Primary Restart path or the FactoryTalk Batch Server will not
start, and the following error message is logged in the Windows Server event log file:
Unable to start because RestartDirectoryPath key not specified in Batchsvr.ini.
In addition, if the Primary Restart or Secondary Restart path is invalid, the server
will not start.
See also
Redundant servers on page 102
Define redundant servers on page 102
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
101
Chapter 7
The FactoryTalk Batch Server
Redundant servers
FactoryTalk Batch can be configured to store batch journals and batch restart
information in two separate locations. If there is a hardware failure on the primary
FactoryTalk Batch Server computer, secondary server performs a manual failover.
The second computer must be capable of running the server. Define redundant
servers by specifying the primary and secondary restart path names. These path
names indicate where system files are written to should the system experience a
failure. If the secondary path name is not specified, FactoryTalk Batch does not
create secondary files.
Tip:
Archiver recovery — The eventdir.txt and the archque.txt are not updated
as secondary files. As part of the manual failover procedure, manually copy the
files from the primary directory to the secondary directory.
Install the area model file and all recipe files and, if using eProcedure, all
instruction files on both the primary server and the secondary server.
See also
Perform a manual failover on page 118
Define redundant servers
FactoryTalk Batch can be configured to store batch journals and batch restart
information in two separate locations.
To define redundant servers:
1. From the FactoryTalk Batch Equipment Editor Options menu, click
Server Options.
2. Select the Restart Control tab.
3. In the Restart Type area, click on a selection, or accept the default, Warm
Restart.
4. Click the Primary Path browse button. The Select Directory dialog box
opens.
5. Select the MyProject\restart folder located in the BATCHCTL share on
the primary server’s hard drive (the default is c:\Program Files
(x86)\Rockwell Software\Batch\MyProject\restart), and then click OK.
102
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
The FactoryTalk Batch Server
Chapter 7
6. Click the Secondary Path browse button. The Select Directory dialog box
opens.
7. Locate and select the MyProject\restart folder located in the
BATCHCTL share on the secondary server’s hard drive, and then click
OK.
8. Repeat steps 1 through 7 on the redundant server computer, selecting the
Batch\MyProject\restart folder on the redundant server as the Primary
Path. The Secondary Path can remain blank or point to another redundant
server. Additionally, you must configure a data server to communicate with
the process controller on the redundant server computer. The redundant
server computer needs to communicate with the process controller that is
running the phase logic.
Tip:
You must also verify that the primary and secondary journal project directories are defined.
See also
Redundant servers on page 102
Server Options dialog box - Restart Control tab on page 101
Set project directories on page 99
Server Options dialog box Batch Reporting tab
Use the Batch Reporting tab to select the reporting application for generating
batch reports and archiving Batch data. Never is the default reporting application.
To use the Server Options dialog box - Batch Reporting tab:
1. Select the Batch Reporting tab.
2. Select the appropriate option from the Reporting Application area. The
following sections define the available reporting application options.
See also
Report Editor on page 104
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
103
Chapter 7
Report Editor
The FactoryTalk Batch Server
As of version 10.00, the Report Editor functionality is no longer supported or
available. If you are currently using the Report Editor functionality, it is
recommended that you transition to the standard reporting that is available using
the Rockwell Automation Knowledgebase - Answer ID 62366.
See also
Server Options dialog box - Batch Reporting tab on page 103
104
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
The FactoryTalk Batch Server
Perform end of batch archiving
Chapter 7
Selecting Archiver (End of Batch) defers control of batch reporting to
FactoryTalk Event Archiver and only performs batch reporting upon removal of
the batch from the Batch List. The End of Batch runs in the security context of
the FactoryTalk Batch Server. When using End of Batch archiving, FactoryTalk
Event Archiver must be disabled as a Windows service and cannot be controlled
using the FactoryTalk Batch Service Manager. (See the FactoryTalk Event Archiver
User Guide for information on disabling FactoryTalk Event Archiver as a service.)
Tip:
If Event Journal Signatures are enabled, specify Archiver (End-of-Batch) archiving to ensure that all
event journal records are properly archived.
To perform end of batch archiving:
1. Select Archiver (End of Batch).
2. In the Archiver area, select Delete files after archive to allow for the
deletion of the .evt files after FactoryTalk Event Archiver has stored the
data in the ODBC database.
Important:
Deleting files after archiving is not a reversible action and is not recommended.
3. In Table Name, type the name of the table that contains the Batch data.
The default is BATCHHIS.
The Database Connect String box should contain, at a minimum,
ODBC;. It updates automatically when the data source is selected the first
time FactoryTalk Event Archiver is started after installation. However, if
you know the name of the data source, enter
ODBC;DSN=DataSourceName; and skip the FactoryTalk Event
Archiver setup function.
To change the default Table Name from BATCHHIS:
Create a new table.
Update the stored procedure named BHInsert to use the new table name. (See the
FactoryTalk Event Archiver User Guide for instructions on creating a new table.)
See also
Server Options dialog box - Batch Reporting tab on page 103
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
105
Chapter 7
The FactoryTalk Batch Server
Perform incremental archiving
Use Archiver (Incremental) to defer control of batch archiving to FactoryTalk
Event Archiver and to perform batch reporting at user-defined intervals during
batch execution. Specify the Incremental period between active archiving in
Minutes or Seconds. The minimum setting is 5 seconds. The maximum is 9999
minutes. Setting the value outside of this range causes FactoryTalk Event Archiver
to run in 5 minute incremental periods.
To update the incremental period after making changes, stop and restart the
Incremental Archiver.
Configure the Incremental Archiver with a Windows user account that has
administrative privileges to log on to the system. When using incremental
archiving, configure FactoryTalk Event Archiver to run as a Windows service with
an automatic startup type. Use the FactoryTalk Batch Service Manager to monitor
and control FactoryTalk Event Archiver service. (See the FactoryTalk Event
Archiver User Guide for information on enabling FactoryTalk Event Archiver as a
service.)
To perform incremental archiving:
1. Select Archiver (Incremental).
2. In the Archiver area, select Delete files after archive to enable the deletion
of the .evt files after FactoryTalk Event Archiver has stored the data in the
ODBC database.
Important:
Deleting files after archiving is not a reversible action and is not recommended.
3. In Table Name, type the name of the table that contains the batch data.
(The default is BATCHHIS.)
4. In Incremental Period, type a value and select Minutes or Seconds.
See also
Server Options dialog box - Batch Reporting tab on page 103
106
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
The FactoryTalk Batch Server
Chapter 7
Perform user-defined end of batch
Select User-Defined (End of Batch) to define a batch reporting application that
is not listed in the Reporting Application area. Specify paths and names of the
application’s .ini and .exe files.
To perform user-defined end of batch:
1. Select User-Defined (End of Batch).
2. Select the Executable File browse button to locate the application’s
executable file. The dialog box opens.
3. In the Select Archiver Executable File dialog box, select the appropriate
.exe file, and then select Open.
4. Select the Initialization File browse button to locate the application’s
initialization file.
5. In the Select Archiver Initialization File dialog box, select the appropriate
.ini file, and then select Open.
See also
Server Options dialog box - Batch Reporting tab on page 103
None
Select this option if no batch reporting or archiving application is to be used.
See also
Server Options dialog box - Batch Reporting tab on page 103
Never
Does not maintain a queue. This is the default selection.
Important:
The Never setting causes the archiver queue file to not get written to. For a custom archiver and
when writing to this queue file, use a setting other than Never and manually maintain the size
of the archive queue file.
See also
Server Options dialog box - Batch Reporting tab on page 103
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
107
Chapter 7
The FactoryTalk Batch Server
Archiver Event Filters tab
The options listed under the Archiver Event Filters tab determine what
electronic batch record data FactoryTalk Event Archiver inserts into the
BATCHHIS table. To enable an event filter, select the appropriate check box. To
disable an event filter, clear the appropriate check box.
To enable or disable an event filter:
1. Select the Archiver Event Filters tab.
2. Select the appropriate check boxes to indicate the event type data for the
FactoryTalk Event Archiver collection. Clear the check boxes for the data
that is not to be collected.
See also
FactoryTalk Batch Server option configuration on page 97
108
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
The FactoryTalk Batch Server
Batch Server tab
Chapter 7
The Batch Server tab allows you to select and/or configure FactoryTalk Batch
Server options (including the hold propagation type), watchdog communications
timeout settings, FactoryTalk Event Archiver log file size, minimum disk space
required to add a batch, default batch ID, and whether to enable/disable event
journal signatures.
See also
Hold propagation on page 110
Communications timeout on page 111
Miscellaneous on page 112
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
109
Chapter 7
The FactoryTalk Batch Server
Hold propagation
The Hold Propagation area allows you to indicate the hold propagation type to
use when the FactoryTalk Batch Server detects a failure caused by a watchdog
timeout, a handshake timeout, or a phase failure (PHASE_F > 0). A Hold
command associated with a failure propagates up through the recipe hierarchy as
high as the mode and selected option allows.
Hold Propagation Type
Description
Phase
Only the affected phase is held, allowing the balance of the phase’s unit and all
other units to continue running.
Operation
Only the affected phase and the related operation are held, allowing the
balance of the operation’s unit and all other units to continue running.
Unit
The phase and the related unit are held and all other units continue running.
Batch
(Default) Holds the entire batch when a failure is detected by the FactoryTalk
Batch Server.
The following diagram shows how a step’s mode can affect the hold propagation.
Depending on the step’s mode, the batch may be held at a lower level than the
selected hold propagation option.
See also
Batch Server tab on page 109
110
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
The FactoryTalk Batch Server
Communications timeout
Chapter 7
The Communications Timeout area allows you to configure the FactoryTalk
Batch Server’s watchdog timer.
The Period (msec) box allows you to set the watchdog timer setpoint in
milliseconds. When the timer expires, the FactoryTalk Batch Server checks
communication with the process-connected device’s data server and performs the
set/reset test on the data server watchdog timer. In the event of a failed
conversation, the server attempts to reconnect. The default is 10000.
The Allowable Failures box allows you to indicate how many Set/Reset retries
the FactoryTalk Batch Server should perform before it declares that conversation
with the server is BAD and issues a HOLD command. The default is 5.
Tip:
The recommended configuration for Batch watchdog and PCD watchdog is that the PLC watchdog
timer setpoint must be configured to have a value that is 5 % or less of the total value of the FactoryTalk
Batch Server watchdog timer’s period value and allowable failures value.
Example: If the server’s watchdog timeout period is set to 10000 milliseconds (10 seconds), and the
allowable failures is set to 5, then set the PLC watchdog timer setpoint to 47500 milliseconds (47.5
seconds):
.95 (5 x 10000) = 47500
Important:
When the watchdog times out in the PCD, the PLI should be designed to set the Phase Failure Tag
to a nonzero value that represents an understandable message in the Phase Failure Enumeration
Set such as PCD1 Batch Watchdog Timed Out.
(See the FactoryTalk Batch Equipment Editor User Guide for details on editing
enumerations and enumeration sets.)
See also
Batch Server tab on page 109
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
111
Chapter 7
Miscellaneous
The FactoryTalk Batch Server
The Miscellaneous area allows you to define options relating to the batchsvr.log
and the batchSvr.ini file.
The Maximum Log File Size box allows you to input the maximum size (in bytes)
for the log file. When the log file reaches the maximum specified size, all new data
is appended to the top of the log and old information is overwritten.
The Minimum Disk Space box allows you to input the minimum disk space (in
bytes) that must be available before a batch can be added to batch list. This helps
to avoid data loss due to inadequate disk space.
The Default Batch ID box allows you to specify a default batch ID; this batch ID
automatically populates the Batch ID box when each batch is created.
Enable Event Journals Signatures turns event journal signatures on or off. The
Event Journal Signature function is a tool for detecting any unauthorized changes
to electronic batch records (.evt files). (See the FactoryTalk Batch System Files
Reference Guide for more information about Event Journal Signatures.)
Tip:
Do not edit the batchsvr.log or batchsvr.ini files directly unless you are specifically
instructed to do so by Rockwell Automation Technical Support. The batchsvr.ini
file contains data items that determine the configuration of the FactoryTalk Batch
Server and how the server operates in relation to the other FactoryTalk Batch
components.
See also
Batch Server tab on page 109
Batch identification on page 191
112
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
The FactoryTalk Batch Server
Chapter 7
Cross Invocation Descriptors
and Defaults tab
The Cross Invocation Descriptors and Defaults tab allows you to specify cross
invocation labels and set default cross invocation strings for different resource
types. Use FactoryTalk Batch Equipment Editor to define up to five cross
invocation strings for each resource within the area model. Each time a selection
changes in FactoryTalk Batch View and ActiveX Controls, the cross invocation
strings associated with the equipment resource are retrieved from the FactoryTalk
Batch Server and evaluated. The contents of these strings can indicate a shortcut
menu item and subitems, the caption(s) for the shortcut menu item(s), and the
data that is passed to the automation server.
See also
Resource types on page 113
Cross invocation on page 129
Resource types
Use the Resource Types list to select a resource type for cross invocation labels
and strings. Select one of the following from the list: Equipment Modules,
Process Cells, Resources, or Units.
See also
Cross Invocation Descriptors and Defaults tab on page 113
Descriptors
The Descriptors area allows you to enter up to five cross invocation labels for
each resource type. These labels are used within the resource’s Edit dialog box.
See also
Cross Invocation Descriptors and Defaults tab on page 113
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
113
Chapter 7
The FactoryTalk Batch Server
Default values
Use the Default Values area to assign default URLs to each hyperlink label
defined for the selected resource type. Enter the URL address for the hyperlink in
the box that corresponds to the correct hyperlink label. The label in box 1 of the
Descriptors area corresponds to the URL address in box 1 of the Default Values
area. Default URLs can be overwritten when a specific resource type instance is
edited.
Tip:
If a hyperlink value is not defined, either as a default or when the specific resource type instance is created,
the hyperlink label is not visible in eProcedure.
See also
Hyperlink Descriptors and Defaults tab on page 114
Hyperlink Descriptors and
Defaults tab
This feature is used in conjunction with FactoryTalk eProcedure only.
The Hyperlink Descriptors and Defaults tab specifies the hyperlink labels and
default values used with different resource types. The labels and default values are
used in the resource’s Edit dialog box. You can define up to five hyperlink labels
and default values for each resource within the area model. (Refer to the
FactoryTalk eProcedure Administrator Guide for additional hyperlink
information.)
The Resource Types list allows you to select a resource type for the hyperlink
labels and URLs you define. Select one of the following from the list: Phases,
Process Cells, Resources, or Units.
The Descriptors area allows you to enter up to five hyperlink labels for each
resource type. These labels are used within the resource’s Edit dialog box.
The Default Values area allows you to assign default URLs to each hyperlink label
defined for the selected resource type. Enter the URL address for the hyperlink in
the box that corresponds to the correct hyperlink label. The label in box 1 of the
Descriptors area corresponds to the URL address in box 1 of the Default Values
area. Default URLs can be overwritten when a specific resource type instance is
edited.
Tip:
If a hyperlink value is not defined, either as a default or when the specific resource type instance is created,
the hyperlink label is not visible in eProcedure.
See also
FactoryTalk Batch Server option configuration on page 97
114
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
The FactoryTalk Batch Server
Material Policies tab
Chapter 7
These features are used in conjunction with FactoryTalk Batch Material Manager
only.
•
Option When Material Server Communication is lost
•
Hold on Split Feed
Option when Material Server Communication is lost
When communication with the Material server is lost, these two options are
available: Failure and Hold or Switch to Manual.
By default, the FactoryTalk Batch Server is configured to Failure and Hold. In
this case, batches are placed in the HELD state when communication with the
Material server is lost. The FactoryTalk Batch Server automatically resumes
communication with the Material server when it becomes available.
To run batches even when communication is lost, configure the FactoryTalk
Batch Server to Switch to Manual. In Manual mode, the server prompts the
operator for information normally supplied by the Material Server. Restore the
communication manually when the Material server becomes available. (For more
information on restoring communication manually, see the FactoryTalk Batch
Material Manager Administrator Guide.)
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
115
Chapter 7
The FactoryTalk Batch Server
Hold on split feed
Choose the Yes option to hold batches or the No option to continue to run
batches in the event of a split feed.
The Yes option is the default option and the batch is HELD when a split feed
occurs.
For the No option, create a loop in the recipe so that the binding process can select
another container for material additions when a split feed occurs. Add a material
loop to the recipe with the Create Material Loop button in FactoryTalk Batch
Recipe Editor. (For information regarding material loops, see the FactoryTalk
Batch Recipe Editor User Guide.)
See also
FactoryTalk Batch Server option configuration on page 97
Modify the .NET registry key
The .NET registry key contains the FactoryTalk Batch Server computer name and
is used by remote clients to locate the server computer. During a FactoryTalk
Batch Client computer installation, the setup program prompts you for the server
computer name and then places the name into the .NET key. In the event that you
change the server computer name, or if you are switching control to another
FactoryTalk Batch Server computer, you need to manually modify the .NET
registry key on all remote client computers to point to the server computer.
To modify the .NET registry key:
1. Open the Registry Editor.
2. Select the HKEY_LOCAL_MACHINE on Local Machine window.
Navigate to the SOFTWARE\BATCHCTL\Net subkey.
3. Double-click the Server registry value.
4. Modify the value data: Server = <MachineName>, where <MachineName>
is the computer name on which the FactoryTalk Batch Server is installed.
See also
The FactoryTalk Batch Server on page 95
116
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
The FactoryTalk Batch Server
Chapter 7
Use automatic restart
control to restart the
FactoryTalk Batch Server
The FactoryTalk Batch Server maintains a detailed record of every recipe’s state as
the recipe is running. If the server computer were to lose power or otherwise fail,
use the automatic restart control feature to restart the server. Upon restarting the
server on a failed server node, the following functions are placed into the state that
existed prior to termination of the server:
•
Control Recipes
•
Semi-Auto Phase Control
•
Arbitration
See also
Restart the FactoryTalk Batch Server on page 117
Restart the FactoryTalk Batch
Server
If the FactoryTalk Batch Server computer experiences a system failure, then
restarting the computer starts the server. However, if the FactoryTalk Batch
Server service fails, then you need to restart the service using the FactoryTalk
Batch Service Manager.
To restart the FactoryTalk Batch Server:
1. Open the FactoryTalk Batch View. Batches on the batch list prior to the
failure are still on the batch list. All batches that had phases in an active state
now have transitions in the HELD state, and are in MANUAL mode with a
failure.
2. Select the batch, and then click the Auto button to place a batch in
AUTOMATIC mode.
3. Click the Clear All Failures button to clear the failures.
4. Select the batch, and then click the Restart Batch button. The previously
active phases return to a RUNNING state and the batch completes.
See also
Use automatic restart control to restart the FactoryTalk Batch Server
on page 117
The FactoryTalk Batch Service Manager on page 81
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
117
Chapter 7
The FactoryTalk Batch Server
Perform a manual failover
FactoryTalk Batch can be configured to store batch journals and batch restart
information in two separate locations. The use of a secondary server allows you to
perform a manual failover if there is a hardware failure on the primary FactoryTalk
Batch Server. The second computer must be capable of running the server.
You must install your area model file and all recipe files (and all instruction files if
using eProcedure) on both the primary server and the secondary server.
Tip:
Archiver recovery - As part of the manual failover procedure you must manually copy the eventdir.txt
and the archque.txt from the primary directory to the secondary directory.
See also
The FactoryTalk Batch Server on page 95
Define redundant servers on page 102
118
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
The FactoryTalk Batch Server
Chapter 7
Configure the FactoryTalk Batch
Server for manual failover
When the FactoryTalk Batch Server fails, complete the following steps.
Tip:
If you are using FactoryTalk Batch Material Manager, refer to the procedure for
material-enabled configuration.
To configure the FactoryTalk Batch Server for manual failover:
1. Start the process-connected device communication software on the
secondary server. The secondary server computer needs to communicate
with the process controller that is running the phase logic.
2. Ensure that the secondary server’s project directories are assigned to local
directories in the Server Options dialog box located in FactoryTalk Batch
Equipment Editor.
3. Use the FactoryTalk Batch Service Manager to start the FactoryTalk Batch
Server on the secondary server computer, select Warm or Warm All as the
startup type. The secondary server allows the batches to be restarted based
upon information written by the primary server.
4. (optional) If you are also using eProcedure, use the FactoryTalk Batch
Service Manager to start the eProcedure Server on the secondary server
computer.
5. For each computer running FactoryTalk Batch View, enter the secondary
server’s computer name as the NET registry key value.
6. Stop and restart each FactoryTalk Batch View instance and any other
software that communicates directly with the FactoryTalk Batch Server.
This causes the instance to connect with the secondary server.
Tip:
The existing batches are placed in the MANUAL mode with transitions in the HELD state. Place the batches
in AUTOMATIC mode, clear the failures, and then restart the batch.
See also
Perform a manual failover on page 118
Modify the .NET registry key on page 116
Configure the material-enabled Batch server for manual failover
on page 120
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
119
Chapter 7
The FactoryTalk Batch Server
Configure the material-enabled
FactoryTalk Batch Server for
manual failover
Upon failure of the primary FactoryTalk Batch Server computer, if this is a
FactoryTalk Batch Material Manager system, complete the following steps:
To configure the material-enabled FactoryTalk Batch Server for manual
failover:
1. On the Material server computer, start the Network Editor.
2. Select the network model for the primary FactoryTalk Batch Server.
3. Right-click BATCHSERVER in the tree and select Remove Server.
4. From the File menu, click Synchronize.
5. Select the network model for the Material server.
6. Right-click any <Undefined> FactoryTalk Batch Server in the tree, and
then click Add Server.
7. Type a name in the Alias box.
8. Click the Computer Name box, and then select the computer to be used as
the secondary server.
9. From the File menu, click Synchronize.
10. Start the process-connected device communication software on the
secondary server. The secondary server computer needs to communicate
with the process controller running the phase logic.
11. Ensure that the project directories for the secondary server are assigned to
local directories. Use the Server Options dialog box in FactoryTalk Batch
Equipment Editor.
12. Use the FactoryTalk Batch Service Manager to start the FactoryTalk Batch
Server software on the secondary server computer, select Warm or Warm
All as the startup type. The secondary server allows the batches to be
restarted based upon information written by the primary server.
120
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
The FactoryTalk Batch Server
Chapter 7
13. If you are also using eProcedure, use the FactoryTalk Batch Service Manager
to start the eProcedure Server on the secondary server computer.
14. For each computer running the FactoryTalk Batch View, enter the
computer name of the secondary server as the NET registry key value.
15. Stop and restart each FactoryTalk Batch View instance and any other
software that communicates directly with the FactoryTalk Batch Server.
This causes the FactoryTalk Batch View instance to connect with the
secondary server.
Tip:
The existing batches are placed in the MANUAL mode with transitions in the HELD state. Place the batches
in AUTOMATIC mode, clear the failures, and then restart the batch.
See also
Modify the .NET registry key on page 116
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
121
Chapter 7
The FactoryTalk Batch Server
Command handshake
timeout
The FactoryTalk Batch Server uses a command handshake protocol ensuring that
commands issued to phases are handled in a serial manner and are not lost or
overwritten. The protocol has a configurable timeout period. When a command
handshake timeout condition occurs, an error is generated in the phase object that
represents the phase, and the batch is placed on HOLD based upon the configured
hold propagation settings. This allows the operator to disconnect the server from
the affected phase should the timeout period expire. Without this feature, the
server must be shut down and restarted if the phase stops responding.
When a command handshake timeout period occurs, the step representing the
troubled phase in the SFC display turns red and a failure is generated for the
phase. The message PHASE NOT RESPONDING is shown on the status bar
when the step is selected. It is also displayed in the Phase List Display area of the
Phase Control window when the phase is selected.
A System Message event type is logged into the electronic batch record. The
description includes the fact that a time-out occurred as well as the type and ID of
the command that timed out. In addition, the event is recorded in the FactoryTalk
Batch Server log file with a severity status of SEVERE and the description is the
type and ID of the timed-out command.
If a communication error is detected while the command handshake is in process,
the command handshake timer is stopped. The timer is reset and restarted if
communication is successfully restored. If the command handshake completes
after the timeout period, then the commands that are pending the handshake
completion are processed. However, the error must be cleared before the batch can
be restarted.
In order to restart a batch, you must issue the CLEAR_FAILURES command. If
the command handshake completes successfully, the error is cleared and the batch
can be restarted. Otherwise, the error is not cleared and the batch is not restarted.
The operator should check the execution status of the process-connected device.
The Batchsvr.ini file contains an item used to configure the length of time, in
seconds, that the FactoryTalk Batch Server waits for a command handshake before
issuing a timeout. If the item is not included in the Batchsvr.ini file, it defaults to
60. The valid range is 5 to 600.
[XMAN] CommandTimeOut=90
This value is read when the FactoryTalk Batch Server starts. If you change the
value, stop and restart the server.
See also
The FactoryTalk Batch Server on page 95
122
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
Chapter 8
Windows event log
The Windows Event Log service records application, system, and security
information. This information can be viewed using the Event Viewer.
Tip:
Supported Windows versions for FactoryTalk Batch are listed in the FactoryTalk
Batch Components Upgrade and Installation Guide.
See also
View event log entry properties on page 123
Modify event log settings on page 127
View event log entry
properties
From the Windows Event Viewer, you can double-click any log entry to display its
properties.
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
123
Chapter 8
Windows event log
There are 10 items for a Windows event log entry. Six of these are identical for all
FactoryTalk Batch Server events. These items, along with a description, are listed
below. The Category, Event ID, and Description are described in the table
following the list.
Item
Description
Date
Date that the event occurred.
Time
Time that the event occurred.
Type
Type of the event (i.e., Information, Error, etc.).
User
Configured domain user.
Computer
Computer on which the FactoryTalk Batch Server is running.
Source
BatchSvr
Category
Category of the event.
Event ID
ID of the event.
Description
Description of the event.
Data
File and line number within the FactoryTalk Batch Server source code that generated the entry.
Category
Event ID
Description
Start
1000
Server demand started successfully in demo mode.
Start
1001
Server demand started successfully in production mode.
Start
1002
Server auto started successfully.
Start
1003
Server failed to auto start. See the Batchsvr.log file for more information.
Start
1004
Server failed to demand start. See the Batchsvr.log file for more information.
Important: Do not edit the Batchsvr.log files.The Batchsvr.log contains critical information Technical Support needs to
determine the cause of a FactoryTalk Batch Server failure.
Start
1005
Command line arguments are inconsistent.
Start
1006
Unexpected command line argument [Descriptive String].
Start
1007
Service handler not installed.
Start
1008
Not running as a service or StartServiceCtrlDispatcher failed.
Start
1009
Log directory does not exist. Validate ErrorLogDirectory key value in Batchsvr.ini.
Important: Do not edit the Batchsvr.ini file unless specifically instructed by Technical Support.
124
Start
1010
Unable to start due to access permissions on log directory specified by ErrorLogDirectory
key value in Batchsvr.ini.
Start
1011
Batchsvr.log file could not be created/opened. Validate pathname in Batchsvr.ini.
Start
1012
Unable to start. Log file (Batchsvr.log or Verify.log) does not have write access permission.
Start
1013
Unable to start. Unable to access log file (Batchsvr.log or Verify.log).
Start
1014
Unable to start. Verify.log file does not have write access permission.
Start
1015
Unable to start due to missing Batchsvr.ini file.
Start
1016
Unable to start due to access permissions on Batchsvr.ini file.
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
Windows event log
Chapter 8
Category
Event ID
Description
Start
1017
Unable to start due to access problem with Batchsvr.ini file.
Start
1018
Access error on Batchsvr.ini detected prior to logging on as user
specified in Batchsvr.ini.
Start
1019
Access error on Batchsvr.ini detected while running as user specified in Batchsvr.ini.
Start
1020
Access error on log file detected while running as user specified in Batchsvr.ini.
Start
1021
Access error on event files detected while running as user specified in Batchsvr.ini.
Start
1022
Unable to start because primary event file directory specified by
EventDirectoryPath key in Batchsvr.ini is missing.
Start
1023
Unable to start because secondary event file directory specified by
EventDirectoryPathSecondary key in Batchsvr.ini is missing.
Start
1024
Unable to start because of access permissions on primary event file directory specified by
EventDirectoryPath key in Batchsvr.ini.
Start
1025
Unable to start because of access permissions on secondary event file directory specified
by EventDirectoryPathSecondary key in Batchsvr.ini.
Start
1026
Unable to start because of access permissions on Archque.txt file in primary event file
directory.
Start
1027
Unable to start because of access permissions on Archque.txt file in secondary event file
directory.
Start
1028
Unable to start because of access permissions on Eventdir.txt file in primary event file
directory.
Start
1029
Unable to start because of access permissions on Eventdir.txt file in secondary event file
directory.
Start
1030
Unable to start because RestartDirectoryPath key not specified in Batchsvr.ini.
Start
1031
Unable to start because RestartDirectoryPath specified in Batchsvr.ini missing.
Start
1032
Unable to start because of access permissions on RestartDirectoryPath specified in
Batchsvr.ini.
Start
1033
Unable to start because of access permissions (security?) on
RestartDirectoryPath specified in Batchsvr.ini.
Start
1034
Unable to start because RestartDirectoryPath2 specified in Batchsvr.ini missing.
Start
1035
Unable to start because of access permissions on RestartDirectoryPath2 specified in
Batchsvr.ini.
Start
1036
Unable to start because of access permissions (security) on RestartDirectoryPath2
specified in Batchsvr.ini.
Start
1037
Server started by an ActiveX client.
Start
1038
Domain user name is blank and must be initialized in the SECURITY section of the
Batchsvr.ini. The Server will not have any network
credentials, which means it cannot access anything off node (i.e., data servers, event
journal files, or recipes).
Start
1039
Internal Error. Call to CoInitializeSecurity failed.
Start
1040
Internal Error. Call to RegisterClassObjects failed.
Start
1041
The SQL Server database cannot be opened.
Boot
2000
Server warm booting.
Boot
2001
Server cold booting.
Boot
2002
Server started.
Boot
2003
Server warm all booting.
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
125
Chapter 8
Windows event log
Category
Event ID
Description
Boot
3000
Data Server: [Descriptive String] status changed to GOOD.
Boot
3001
Data Server: [Descriptive String] status changed to SUSPECT.
Boot
3002
Data Server: [Descriptive String] status changed to LOST.
Boot
3003
Data Server: [Descriptive String] status changed to BAD.
Boot
3004
Data Server: [Descriptive String] status changed to an unknown
conversation status.
Boot
3005
Data Server: [Descriptive String].
Shutdown
4000
Server shutting down.
Shutdown
4001
Server exception occurred. See the Batchsvr.log file for information.
Shutdown
4002
Server automatically shutting down from demo mode.
Tag_Verification
5000
Server tag verification process Started.
Tag_Verification
5001
Server tag verification process Aborted.
Tag_Verification
5002
Server tag verification completed, [Descriptive String1] of [Descriptive String2] tags
verified successfully.
Registration
6000
Server registered.
Registration
6001
Server unregistered.
Registration
6002
Server registered as a service.
Control
7000
Notify SCM: The service is stopping.
Control
7001
Notify SCM: Service stopped.
Control
7002
Notify SCM: The service is starting.
Control
7003
Notify SCM: The service is running.
Control
7004
SERVICE_CONTROL_STOP received from Service Control Manager.
Control
7005
Unexpected SERVICE_CONTROL_PAUSE received from Service Control Manager.
Control
7006
Unexpected SERVICE_CONTROL_CONTINUE received from
Service Control Manager.
Control
7007
SERVICE_CONTROL_INTERROGATE received from Service
Control Manager.
Control
7008
SERVICE_CONTROL_SHUTDOWN received from Service Control Manager.
Control
7009
Bad Service Request.
Category_Debug
8000
Command Line: [Descriptive String].
Category_Debug
8001
Argument received from SCM or BatchSCM: [Descriptive String].
Category_Debug
8002
HRESULT = [Descriptive String].
Category_Debug
8003
Thread [Descriptive String] started.
Category_Debug
8004
Exception in object [Descriptive String1] in method [Descriptive String2].
Category_Debug
8005
Service could not be marked for deletion by the SCM.
Category_Debug
8006
Debug: [Descriptive String].
See also
Windows event log on page 123
Modify event log settings on page 127
126
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
Windows event log
Chapter 8
Modify event log settings
In order to prevent the system event logs from exceeding the maximum allowable
size, configure the application and system log to overwrite events as needed.
To modify event log settings:
1. Open the Event Viewer:
Window Server 2008 SP1: Click the Start button, point to Control Panel
> Administrative Tools > Event Viewer.
Windows XP Professional SP3: Click the Start button, click Control Panel,
then Administrative Tools > Event Viewer.
2. Right-click Application, and then click Properties. The Application
Properties dialog box opens.
3. In the Log size area, select Overwrite events as needed, and then click OK.
4. Repeat steps 2 and 3 for the System.
5. Exit the Event Viewer.
See also
Windows event log on page 123
View event log entry properties on page 123
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
127
Chapter 9
Cross invocation
Cross Invocation is the means by which the FactoryTalk Batch View and ActiveX
Controls pass data to, and activate, an automation server such as an HMI or Visual
Basic program. The data passed is specific to an equipment resource selected from
the FactoryTalk Batch Client applications.
FactoryTalk Batch provides a procedure-centric view of the batches running in the
plant. The HMI provides an equipment-centric view of these batches. If the HMI
is an automation server that supports the Cross Invocation interface, cross
invocation can send equipment-specific information about a batch to your HMI.
The HMI can then act based on the data received. For example, it may invoke a
graphic specific to the selected equipment resource or information specific to an
Equipment Module’s running logic.
See also
Cross invocation overview on page 130
Cross invocation string configuration on page 132
Cross invocation string escape sequences on page 134
Cross invocation string example on page 136
FactoryTalk Batch View and ActiveX Controls configuration for cross
invocation on page 137
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
129
Chapter 9
Cross invocation
Cross invocation overview
Cross invocation is accomplished by way of user-defined and selectable cross
invocation menu items. If configured for a selected equipment resource, the cross
invocation menu items are visible and selectable from:
•
FactoryTalk Batch View when the Goto HMI button is selected.
•
The ActiveX Controls when the ActiveX control shortcut menus are
invoked by right-clicking on the running object.
If a recipe step is not bound to an equipment resource:
•
The FactoryTalk Batch ProcedureView ActiveX control does not display
the Cross Invocation menu when you right-click on the step.
•
FactoryTalk Batch View displays a message indicating the step is not bound
when you select the Goto HMI button.
Within the FactoryTalk Batch Client applications, there are a number of
selectable procedural elements. Each of these procedural elements relates to a
specific equipment resource. Each equipment resource may be configured to have
cross invocation strings (defined on the Cross Invocation tab of any configurable
equipment resource in the area model).
Procedural Element > Equipment Resource > Cross Invocation Strings
Each cross invocation string defines the following:
130
•
The text for displaying the Cross invocation menu item.
•
The data for passing to the automation server.
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
Cross invocation
Chapter 9
The following table shows the various FactoryTalk Batch View windows and the
equipment resource to which a selected procedural element is linked. For cross
invocation to be implemented, the cross invocation strings must be configured for
the equipment resource.
FactoryTalk Batch View window
Selectable elements
Corresponding equipment resource
Batch List
Batch
Process Cell (Procedure)
Procedure as SFC/Table
Batch
Unit (Unit Proc or Operation)
Process Cell (Procedure)
Unit (Unit Proc or Operation)
Unit Procedure
Unit
Operation
Unit
Recipe Phase
Phase
Event Journal
Batch
Process Cell (Procedure)
Unacknowledged Prompts
Unacknowledged Prompts
Phase
Phase Control
Process Cell
Process Cell
Unit
Unit
Phase
Phase
Recipe
Process Cell (Procedure)
Unit (Unit Proc or Operation)
Arbitration
Unit (Unit Proc or Operation)
Process Cell
Process Cell
Unit
Unit
Phase
Phase
Resource
Resource
Alarm Summary
N/A
N/A
Phase Summary
Phase
Phase
See also
Cross invocation on page 129
Cross invocation string configuration on page 132
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
131
Chapter 9
Cross invocation
Cross invocation string
configuration
Use FactoryTalk Batch Equipment Editor to define up to five cross invocation
strings for each resource defined within the area model. Each time a procedural
element is selected in FactoryTalk Batch View or from the ActiveX Controls, the
cross invocation strings associated with the equipment resource corresponding to
the selected element are retrieved from the FactoryTalk Batch Server and
evaluated. The contents of these strings become the caption(s) for the cross
invocation menu item(s) and optional sub-menu items as well as the context data
that is passed to the automation server. The context data is encapsulated in escape
sequences.
Cross invocation strings are defined according to the following syntax:
•
A cross invocation string must be enclosed entirely in square brackets [ ].
Anything outside of the square brackets is ignored by the Server.
•
Within the square brackets, the initial text (to the first semicolon) indicates
the menu item(s) caption(s).
•
All text within the square brackets after the first semicolon defines the
context data passed to the automation server when the menu item is
selected.
•
A single string can specify one cross invocation item with any number of
subitems. The first comma-delimited portion of the cross invocation string
identifies the menu item for the shortcut menu, and each subsequent
sub-string identifies a subitem.
•
The data passed in response to all subitems is identical. Subitems are
optional.
Example:
[Menu Item, Subitem 1, Subitem 2; %P, %S, %R]
132
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
Cross invocation
Chapter 9
The cross invocation string portion that specifies the data to pass to the
automation server when selecting a menu item is defined by escape sequences. The
escape sequences are replaced by the context data they represent before the string
is passed. The valid escape sequences are identified in the following table along
with their meaning.
Escape sequence
Replace by
%P
The path to the selected step. In some instances, this value can be empty. (See Context Data
Responses for more information.)
Examples:
CreateID
CreateID \t Procedure \t Unit Procedure \t Operation \t Phase
%N
Equipment resource name to which the selected control recipe corresponds.
%C
Class name from which the equipment resource corresponding to the step was created.
%T
Equipment resource type to which the selected control recipe corresponds.
%S
Computer on which the FactoryTalk Batch Server is executing.
%B
Batch ID of the selected control recipe.
%M
Menu item caption that was selected. If submenu items exist, they appear in the following order: the
caption of the menu item appended with a colon, then the index number of the submenu item
appended with a colon, and then the caption of the submenu item selected.
%R
Resource ID of the equipment resource to which the selected control recipe corresponds.
See also
Cross invocation overview on page 130
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
133
Chapter 9
Cross invocation
Cross invocation string
escape sequences
The escape sequences used in the cross invocation strings correspond to the
current selection in FactoryTalk Batch View or ActiveX Controls applications.
The context data passed to the automation server is relative to the current
selection. (See the FactoryTalk Batch View User Guide for information regarding
selectable elements.)
The following describes each escape sequence relative to the type of procedural
element selected:
Escape
Sequence
Procedure
Unit Procedure
Operation
Phase
%P
Path
Path
Path
Path
%N
Corresponding
Corresponding Unit name
Process Cell Name
Corresponding Unit
name
Corresponding Phase
name
%C
Corresponding
Process Cell class
name
Corresponding Unit Class
name
Corresponding Unit
Class name
Corresponding Phase Class
name
%T
1 (Process Cell)
2 (Unit)
2 (Unit)
3 (Phase)
%S
Node
Node
Node
Node
%B
Batch ID
Batch ID
Batch ID
Batch ID
%M
Menu caption
Menu caption
Menu caption
Menu caption
%R
Corresponding
Process Cell
resource ID
Corresponding Unit resource
ID
Corresponding Unit
resource ID
Corresponding Phase
resource ID
If the control recipe runs across multiple process cells, the context data replaced by %N and %C is the first process cell in the
process cells list of associated with the recipe.
134
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
Cross invocation
Chapter 9
The following describes each escape sequence relative to the element selected
within the FactoryTalk Batch View Phase Control window. (See the FactoryTalk
Batch View User Guide for information regarding selectable elements.)
Escape
Sequence
Process Cell
Unit
Phases
%P
Empty
Path (if exists).
The context data that replaces %P
(when selecting a unit) is the unit
procedure path or operation that owns
that unit, and blank otherwise.
Create ID (if exists).
The context data that replaces %P when
selecting an equipment phase is the
Create ID of the batch within which the
phase is executing. This only exists if that
equipment phase is currently executing
within the context of a batch.
%N
Name of process
cell
Name of unit
Name of phase
%C
Process Cell Class
name
Unit Class name
Phase Class name
%T
1 (process cell)
2 (unit)
3 (phase)
%S
Node
Node
Node
%B
Empty
Batch ID (if exists)
Batch ID (if exists)
%M
Menu caption
Menu caption
Menu caption
%R
Process cell
resource ID
Unit resource ID
Phase resource ID
See also
Cross invocation on page 129
Cross invocation string configuration on page 132
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
135
Chapter 9
Cross invocation
Cross invocation string example
This is an example of a cross invocation string configured in FactoryTalk Batch
Equipment Editor and the resulting cross invocation menu as seen from
FactoryTalk Batch View.
[DETAIL DISPLAY, VIEW MODE, EDIT MODE; %P, %N, %T, %C, %S, %B,
%R, %M]
This illustrates the type of data that could be passed to the automation server
when the Batch ID is selected in FactoryTalk Batch View and the batch is
running.
Tip:
The automation server must be configured for responding appropriately to the data.
See also
Cross invocation overview on page 130
Cross invocation string configuration on page 132
136
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
Cross invocation
Chapter 9
FactoryTalk Batch View and ActiveX
Controls configuration for cross
invocation
Once the cross invocation strings are defined, FactoryTalk Batch View and
ActiveX Controls must be configured to support cross invocation.
FactoryTalk Batch View is configured to support cross invocation under the
General tab of the System Configuration and Defaults window. On this tab,
cross invocation must be selected and the program identifier of the automation
server must be specified.
Once configured in FactoryTalk Batch View, the cross invocation menu items
become visible when a procedural element is selected (that corresponds to an
Equipment Resource with configured cross invocation strings) followed by
selecting the Goto HMI button.
The ActiveX Controls are configured to support cross invocation when the
following two properties are configured for the ActiveX object:
•
InvocationProgID
•
ShowCustomMenu
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
137
Chapter 9
Cross invocation
The InvocationProgID property must contain the program identifier of the
automation server. The ShowCustomMenu property must be set to True so that
the cross invocation strings are visible on the ActiveX object’s shortcut menu
during runtime as shown:
See also
Cross invocation string configuration on page 132
Cross invocation overview on page 130
138
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
Chapter 10
The FactoryTalk Batch Phase Simulator
FactoryTalk Batch comes with a phase logic simulation program that allows you to
run the FactoryTalk Batch software and simulate your batch process without
being connected to a PCD. The FactoryTalk Batch Phase Simulator imitates the
functionality of a data server and communicates with the FactoryTalk Batch
Server using the OPC communication protocol. This is a powerful tool for testing,
experimentation and demonstration purposes.
Tip:
The Simulator is automatically started by the FactoryTalk Batch Server if required
by the area model.
The Simulator allows you to save report parameter values.
Tip:
When running a material-enabled phase, RUNNING logic should not have any
configured requests. You must set the FEED_COMPLETE report parameter to 1 and
set a value for the ACTUAL_AMOUNT report parameter. Save the simulation file
after making these changes.
See also
Start the FactoryTalk Batch Phase Simulator on page 140
Phase Configuration dialog box on page 142
Phase Status dialog box on page 146
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
139
Chapter 10
The FactoryTalk Batch Phase Simulator
Start the FactoryTalk Batch
Phase Simulator
Start the FactoryTalk Batch Phase Simulator for the FactoryTalk Batch Server
and FactoryTalk Batch View to run in a simulated environment.
To start the FactoryTalk Batch Phase Simulator:
•
Select Start > All Programs > Rockwell Software > FactoryTalk Batch
Suite > FactoryTalk Batch > Simulator. The Phase Simulator opens.
See also
The FactoryTalk Batch Phase Simulator on page 139
FactoryTalk Batch Phase Simulator interface on page 141
140
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
The FactoryTalk Batch Phase Simulator
FactoryTalk Batch Phase
Simulator interface
Chapter 10
Upon startup, the FactoryTalk Batch Phase Simulator reads the area model that is
specified in the Batchsvr.ini file. The area model file name is displayed on the title
bar. By default, when you first install the software it is set up to read
ice_cream1.cfg, one of the sample area models shipped with FactoryTalk Batch.
This file contains the equipment required to run the Sampledemo1 recipe. The
Simulator simulates the RUNNING, STOPPING, HOLDING, ABORTING,
and RESTARTING states for all phases configured in the recipe.
Tip:
The Simulator simulates only phase states for area models that have no more than 50 parameters and 50
report parameters.
The Simulator menu bar consists of the following options:
Option
Definition
File
Open a simulator (.sim) file, save a file, or exit the Simulator.
Edit
Edit phase configuration, phase status, or unit tag status.
Protocols
Enable or disable the Watchdog and Command Handshake functions.
Help
Open the Simulator About box.
See also
The FactoryTalk Batch Phase Simulator on page 139
Start the FactoryTalk Batch Phase Simulator on page 140
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
141
Chapter 10
The FactoryTalk Batch Phase Simulator
Phase Configuration
dialog box
The FactoryTalk Batch Phase Simulator allows you to edit a phase’s
configuration. You can set the following items for each sequencing state of a
phase:
•
Dwell Time
Indicates the length of time, in seconds, that a specific state is active for the
selected phase.
•
Time of Request
Indicates the time, within the dwell period, at which a request is made.
•
Type of Request
Indicates the type of request to make. (Refer to the FactoryTalk Batch PCD
Programmer Technical Reference Guide for more information about
requests.)
•
Request Parameters
Each request can have up to three parameters that further describe the
request.
•
Continuous Phase Indication
A continuous phase is a phase whose phase logic does not transition to the
COMPLETE state. You can simulate continuous phase logic by selecting
Continuous Phase. When a transition that follows a step running
continuous phase logic evaluates to TRUE, and the step is not involved in
Transfer of Control, then the FactoryTalk Batch Server sends a STOP
command to the phase. If the phase with continuous phase logic is involved
in Transfer of Control, and the transition evaluates to TRUE, the Transfer
of Control procedure is executed, transferring ownership of the phase from
the step prior to the transition to the step following the transition. A
NEW_PARAMETERS command is issued to the phase’s phase logic when
the Transfer of Control occurs, notifying the phase logic that new recipe
parameter values associated with the new recipe step are available for
download if the phase logic requests a download.
Tip:
To use a continuous phase in an actual batch, write appropriate phase logic to
define non-terminating behavior.
Refer to the NEW_PARAMETERS Command section in the FactoryTalk Batch PCD
Programmer Technical Reference Guide for more information.
See also
Change the dwell time on page 143
Change the sequence of requests on page 144
Indicate a continuous phase on page 145
142
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
The FactoryTalk Batch Phase Simulator
Change the dwell time
Chapter 10
Change the length of time that a specific state is active for the selected phase.
To change the dwell time:
1. Start the FactoryTalk Batch Phase Simulator.
2. Select Edit > Phase Configuration. The Phase Configuration dialog box
opens.
3. From the Select Phase list, select the appropriate phase.
4. From the Select State list, select the state to change the dwell time.
5. In Dwell Time, type the desired dwell time for the selected state.
6. Select Update Phase.
See also
Phase Configuration dialog box on page 142
Change the sequence of requests on page 144
Indicate a continuous phase on page 145
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
143
Chapter 10
The FactoryTalk Batch Phase Simulator
Change the sequence of
requests
Change the time, type, and parameters of the request in a phase.
To change the sequence of requests:
1. Start the FactoryTalk Batch Phase Simulator.
2. Select Edit > Phase Configuration.
3. In the Phase Configuration dialog box, from the Select Phase list, select
the appropriate phase.
4. Type an appropriate value in @Time (time is in seconds). This value
determines when the request is processed. This value must not be greater
than the Dwell Time.
For example, if the Dwell Time is 30 seconds, and the @Time value is 20
seconds, then this request will be processed after the selected state has been
active for 20 seconds.
5. Type an appropriate request number in _RQ. (Refer to the FactoryTalk
Batch PCD Programmer Technical Reference Guide for information on
request numbers.)
6. Type any required request parameter data in Q01, Q02, and Q03. These
parameters are used to further define the request.
7. Select the Update Phase button.
8. Select Close.
See also
Phase Configuration dialog box on page 142
Change the dwell time on page 143
Indicate a continuous phase on page 145
144
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
The FactoryTalk Batch Phase Simulator
Chapter 10
Indicate a continuous phase
Simulate continuous phase logic by selecting Continuous Phase.
To indicate a continuous phase:
1. Start the FactoryTalk Batch Phase Simulator.
2. Select Edit > Phase Configuration. The Phase Configuration dialog box
opens.
3. From the Select Phase list, select the appropriate phase.
4. If this is a continuous phase, select Continuous Phase.
5. Select Update Phase.
6. Select Close.
See also
Phase Configuration dialog box on page 142
Change the dwell time on page 143
Change the sequence of requests on page 144
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
145
Chapter 10
The FactoryTalk Batch Phase Simulator
Phase Status dialog box
The status of a phase can be changed during run time to test phase logic prior to
implementation.
•
View parameter tag values and associated parameter names
•
View request tag values
•
Set owner of phase to External
•
Change the phase’s state for phases under External Control
•
Restore active requests for HELD/RESTARTED phases
•
Change report parameter tag values
•
Change value of the Failure bit
•
Set phase to COMPLETE
•
Acknowledge/Clear requests of phases under External control
See also
View phase parameter tag values on page 147
View and update report parameter tag values on page 148
Change ownership of a phase on page 150
Command a phase on page 151
Acknowledge and clear a request on page 153
146
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
The FactoryTalk Batch Phase Simulator
View phase parameter tag
values
Chapter 10
The phase parameter tag values are read-only and cannot be modified in the
Simulator. The FactoryTalk Batch Server writes these tags when a download
request is processed.
To view phase parameter tag values:
1. Start the FactoryTalk Batch Phase Simulator.
2. Select Edit > Phase Status.
3. Select the appropriate phase from the Select Phase list.
4. In the Arrays list, select Phase Parameter Tags. Each parameter tag
associated with this phase is displayed, along with its current value and type.
See also
View and update report parameter tag values on page 148
Change the value of a unit tag on page 156
View request data tag values on page 149
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
147
Chapter 10
The FactoryTalk Batch Phase Simulator
View and update report
parameter tag values
The report parameter tag values can be modified and uploaded to the FactoryTalk
Batch Server. The uploaded value(s) are reflected in the electronic batch record
(.evt files).
To view and update report parameter tag values:
1. Start the FactoryTalk Batch Phase Simulator.
2. Select Edit > Phase Status.
3. In the Select Phase list, select the appropriate phase.
4. In the Arrays list, select Report Parameter Tags. Each report parameter tag
associated with this phase displays, along with its current value and type.
5. Enter a new value for the appropriate Report Parameter Tag.
6. Select Update Report Data to update the tag value. The report tag values
are uploaded to the Batch Server when an upload request is processed.
See also
View request data tag values on page 149
Change ownership of a phase on page 150
Command a phase on page 151
Acknowledge and clear a request on page 153
Restore and clear requests on page 154
148
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
The FactoryTalk Batch Phase Simulator
Chapter 10
View request data tag values
The request data tag values are read-only. These may be set by the FactoryTalk
Batch Phase Simulator when making a configured request or may be written to
the FactoryTalk Batch Server when processing a phase logic Receive Message
request.
To view request data tag values:
1. Start the FactoryTalk Batch Phase Simulator.
2. Select Edit >Phase Status.
3. Select the appropriate phase from the Select Phase list.
4. From the Arrays list, select Request Data Tags. Each request data tag
associated with this phase is listed, along with its current value and type.
See also
View and update report parameter tag values on page 148
Change ownership of a phase on page 150
Command a phase on page 151
Acknowledge and clear a request on page 153
Restore and clear requests on page 154
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
149
Chapter 10
The FactoryTalk Batch Phase Simulator
Change ownership of a phase
The Owner button acts as a toggle, switching the value in the Owner register
between zero and one. A zero represents Batch as the owner and a one represents
an external owner.
To change ownership of a phase:
1. Start the FactoryTalk Batch Phase Simulator.
2. Select Edit > Phase Status.
3. From the Select Phase list, select the appropriate phase.
4. To set ownership to External, select Owner when the value in the Owner
register is 0.
To set ownership to Batch, select Owner when the value in the Owner
register is 1.
See also
View and update report parameter tag values on page 148
View request data tag values on page 149
Command a phase on page 151
Acknowledge and clear a request on page 153
Restore and clear requests on page 154
150
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
The FactoryTalk Batch Phase Simulator
Command a phase
Chapter 10
The FactoryTalk Batch Phase Simulator allows you to change the state of a phase.
To command a phase:
1. Start the FactoryTalk Batch Phase Simulator.
2. In the Edit menu, click Phase Status.
3. In the Select Phase list, select the phase to command.
4. To set the phase to COMPLETE, click the Set Complete button.
5. For all other state change commands, set the Owner of the phase to
External.
6. Click the appropriate state change command button (Start/Stop,
Abort/Reset, or Hold/Restart).
If the requested state change is legal, the server sends the command to
FactoryTalk Batch View and the phase transitions to the appropriate state.
The new state value is displayed in the Status register in the Phase Status
dialog box.
•
If the phase is running and the Abort/Reset button is selected, the
phase goes to ABORTING. To transition the phase to the ABORTED
state, select the Set Complete button.
If a phase is running and the Hold/Restart button is selected, the phase goes to
HOLDING. To transition the phase to the HELD state, select the Set Complete
button.
See also
View and update report parameter tag values on page 148
View request data tag values on page 149
Phase commands on page 152
Acknowledge and clear a request on page 153
Restore and clear requests on page 154
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
151
Chapter 10
The FactoryTalk Batch Phase Simulator
Phase commands
The FactoryTalk Batch Phase Simulator allows you to change the state of a phase.
An active phase can be commanded to COMPLETE without gaining phase
ownership. All other state change commands require the phase be under external
control. The Start/Stop, Abort/Reset and Hold/Restart buttons are modal, in
that the command issued is determined based on the phase’s active state at the
time the button is clicked. Only legal state change commands are executed. For
example, if a phase is RUNNING and the Start/Stop button is clicked, the STOP
command is issued. START is not a legal command to a phase in the RUNNING
state. (Refer to the FactoryTalk Batch PCD Programmer Technical Reference Guide
for additional information on legal state transitions.)
The following table shows the phase’s transition when the state change command
is received, along with the associated state value (##).
COMMAND
INITIAL STATE
FINAL STATE
COMPLETE
COMPLETE (70)
START
RUNNING (50)
STOP
STOPPING (30)
STOPPED (80)
ABORT
ABORTING (10)
ABORTED (90)
RESET
IDLE (100)
HOLD
HOLDING (20)
HELD (60)
RESTART
RESTARTING (40)
RUNNING (50)
See also
Phase Status dialog box on page 146
The FactoryTalk Batch Phase Simulator on page 139
Command a phase on page 151
152
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
The FactoryTalk Batch Phase Simulator
Acknowledge and clear a
request
Chapter 10
Requests must be acknowledged and then cleared to allow a phase to continue
processing when running under External control. The Ack/Clear Request
button must be clicked twice, first to acknowledge the request, then to clear the
request.
To acknowledge and clear a request:
1. Start the FactoryTalk Batch Phase Simulator.
2. Select Edit > Phase Status.
3. In the Select Phase list, select the phase to be commanded.
4. If the Request register contains a request, select Ack/Clear Request to
acknowledge the request. The value in the Request register changes to 10,
indicating that the request confirmation was received from the Batch
Server.
5. Select Ack/Clear Request to clear the request. Upon clearing the request,
the value in the Request register changes to 0, indicating that the request
was cleared. The phase continues to process.
See also
View and update report parameter tag values on page 148
View request data tag values on page 149
Command a phase on page 151
Restore and clear requests on page 154
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
153
Chapter 10
The FactoryTalk Batch Phase Simulator
Restore and clear requests
Requests generated by a phase can be stored in the request buffer registers should
the phase receive a Hold command. The requests can then be copied back to the
request registers when the phase receives a Restart command. The Restore Req
and Clear Req registers must both contain a 1 (one) to allow for the saving and
restoring of requests for a HELD/RESTARTED phase.
To restore and clear requests:
1. Start the FactoryTalk Batch Phase Simulator.
2. Select Edit > Phase Status.
3. In the Select Phase list, select the phase to be commanded.
4. In the Restore Req register, type a 1.
5. In the Clear Req register, type a 1.
See also
View and update report parameter tag values on page 148
View request data tag values on page 149
Command a phase on page 151
Acknowledge and clear a request on page 153
154
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
The FactoryTalk Batch Phase Simulator
Chapter 10
Unit Tag Status dialog box
Values of unit tags configured in the area model can be changed during run time
in the Unit Tag Status dialog box.
The Unit Tag Status dialog box consists of the following:
Item
Definition
Tagname
A list of all configured unit tags for the active area model.
Class
The class associated with the unit tag.
Type
The type value associated with the unit tag.
Item
The item (addressable location) associated with the unit tag.
Value
The current value for the unit tag. This value can be modified and sent to the FactoryTalk Batch
Server.
Update Values
Updates the tag values in the Simulator.
See also
Change the value of a unit tag on page 156
The FactoryTalk Batch Phase Simulator on page 139
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
155
Chapter 10
The FactoryTalk Batch Phase Simulator
Change the value of a unit tag
Change the value of a unit tag using FactoryTalk Batch Phase Simulator.
To change the value of a unit tag:
1. Start the FactoryTalk Batch Phase Simulator.
2. Select Edit > Unit Tag Status.
3. Make any required modifications to the Unit Tag Values, and select
Update Values. The new values are written into the FactoryTalk Batch
Phase Simulator unit tags.
4. Select OK to return to the FactoryTalk Batch Phase Simulator window.
See also
Phase Status dialog box on page 146
View request data tag values on page 149
Acknowledge and clear a request on page 153
156
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
Chapter 11
Network Editor
The Network Editor is a utility that allows you to indicate where other
FactoryTalk® Batch and/or FactoryTalk Batch Material Manager Servers are
located on the network. This network configuration information simplifies
integration with other FactoryTalk products and the process of reconfiguring a
multi-computer system.
During installation, the network configuration information is completed based on
your responses. If you have multiple servers in your network, use the Network
Editor to update the location of all your servers.
The Network Editor is installed automatically with the FactoryTalk Batch and
Material Servers.
See also
Network Editor interface on page 158
Configure your network on page 162
User Preferences dialog box on page 165
Report printing formats on page 179
Open the Network Editor
Open the Network Editor to configure your network.
Tip:
If running on Windows Server 2008 or Windows 7, you must run the Network
Editor as administrator. Right-click Network Editor and select Run as
administrator.
To open the Network Editor:
•
Click the Start button, point to All Programs > Rockwell Software >
FactoryTalk Batch Suite > FactoryTalk Batch, and then select Network
Editor. The Network Editor window opens.
See also
Network Editor on page 157
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
157
Chapter 11
Network Editor
Network Editor interface
The Network Editor interface has the following areas:
•
Hierarchy pane
•
Detail pane
•
Results pane
•
Toolbar
•
Status bar.
See also
Hierarchy pane on page 159
Detail pane on page 159
Results pane on page 160
Network Editor toolbar on page 161
Status bar on page 162
158
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
Network Editor
Hierarchy pane
Chapter 11
The Hierarchy pane provides a hierarchical view of the application servers in your
FactoryTalk Batch system. The Network Model is the parent item in the
hierarchy list, with the following application servers listed as Network Model
members: Material Server, BatchERP Server, and FactoryTalk Batch Server 1
through Batch Server 10. The following indicators appear next to each server
listed:
Indicates the server is recognized on the network
Indicates the server is not defined or recognized
Indicates there is a problem with the server or the server’s configuration
See also
Network Editor interface on page 158
Detail pane
The Detail pane provides information specific to the item selected in the
Hierarchy pane.
Network model information
The following items are available when Network Model is selected in the
Hierarchy pane.
Item
Description
System Name
Allows you to name your FactoryTalk Batch system. The default is Network Model.
Network Model from
Displays the name of the computer from which the FactoryTalk Batch system was last
synchronized.
Time Stamp
Displays the time of the last synchronization.
User Name
Displays the Windows user ID of the person who performed the last synchronization.
Apply Changes
Saves changes made to the FactoryTalk Batch system information.
Undo Changes
Undoes changes made to the FactoryTalk Batch system information that are not
applied.
Synchronize All Application Servers
Initiates the synchronization of the application servers.
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
159
Chapter 11
Network Editor
Application server information
The following items are available when a server or Undefined is selected in the
Hierarchy pane.
Item
Description
Alias
Displays a user-defined alias for the selected application server.
Computer Name
Displays the computer name for the selected server.
Configure
Allows you to specify the name of the material database when using
FactoryTalk Batch Material Manager. The default database is
MaterialBasedRecipe.
Important:
The Network Editor does not verify database names. Changes made to the database name are
immediate for the clients and servers. If the database name is invalid, the Material Editor will not
open. Before changing the database name, check the spelling and synchronize the Network
Editor. After changing the database name, confirm that the Material Editor opens and can read
the database.
See also
Network Editor interface on page 158
Results pane
The Results pane provides information messages regarding the results of the last
synchronization. Included in the list is an icon indicating the type of message
listed, the name of the computer that performed the synchronization, and the
message generated by the synchronization process.
The table below shows icons used in the messages and explains what types of
messages they represent.
Information
Represents an information message.
Error
Indicates an error message.
Warning
Indicates a warning message.
See also
Network Editor interface on page 158
160
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
Network Editor
Menu bar
Chapter 11
The menu bar contains the menus for File, Edit, View, and Help.
•
File menu
From the File menu, you can select a Network Model, synchronize all
servers, print, and exit the Network Editor application.
•
Edit menu
From the Edit menu, you can add or remove a server from the Network
Editor.
•
View menu
From the View menu, you can show or hide the toolbar/status bar, and
refresh the Network Editor. You can also specify how data is viewed in the
panes as well as setting other user preferences.
See also
Network Editor interface on page 158
Network Editor toolbar
The Network Editor includes a toolbar which allows you to perform various
functions. The buttons are enabled based on the item currently selected in the
Network Editor. As you move your cursor over a button, a tool tip displays the
button name and a detailed functional description displays in the status bar.
The Network Editor Toolbar buttons are:
Select Network Model: Allows you to select a network model from another computer.
Synchronize: Allows you to synchronize your application servers.
Add Server: Allows you to add a previously undefined server.
Remove Server: Allows you to remove a server.
Up One Level: Moves you up one level in the Hierarchy pane.
Print: Prints a report for the selected item.
Print Preview: Allows you to view a report on the selected item.
Help: Opens the Network Editor help.
See also
Network Editor interface on page 158
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
161
Chapter 11
Network Editor
The status bar at the bottom of the window displays text messages on the left side.
In addition, the status bar displays one or more icons on the right side,
representing the status of the application and data.
Status bar
The list of states that can be displayed in the status bar:
Database: The Network Editor is accessing data.
Server: The Network Editor is accessing other servers.
Printing: A report is being printed or previewed.
Processing: The Network Editor is processing data.
Waiting: The Network Editor is busy.
See also
Network Editor interface on page 158
Configure your network
The Network Editor allows you to configure your FactoryTalk Batch system. You
can add or remove application servers, print reports, and synchronize your
network model with another computer.
This section provides instructions for performing each of these functions.
See also
Select a network model on page 163
Add a server on page 164
Remove a server on page 164
Synchronize network models on page 165
162
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
Network Editor
Select a network model
Chapter 11
When you select a network model, you are retrieving an existing network model
from another computer and using it as the network model for the local computer.
You must do this if you add, remove, or rename a server in your system and need
to update your network model with your existing system, or if you want to use the
network model from another computer.
To select a network model:
1. Open the Network Editor.
2. In the Network Editor toolbar, click the Select Network Model button.
3. Type the computer name in the "Enter the object name to select" area, or
click the Advanced button to search for a computer.
4. Click OK.
5. Click the Synchronize button.
See also
Configure your network on page 162
Remove a server on page 164
Add a server on page 164
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
163
Chapter 11
Network Editor
Add a server
Use the Network Editor to add a previously undefined server.
To add a server:
1. Open the Network Editor.
2. In the Hierarchy pane, select the type of server to add.
3. Click Add Server.
4. In the Alias box, type an alias name. This is the name that displays in the
Network Editor.
5. In the Computer Name box, type the computer name, or use the browse
button to locate and select the computer from the list of computers on your
domain.
6. Click OK.
See also
Remove a server on page 164
Configure your network on page 162
Network Editor on page 157
Select a network model on page 163
Remove a server
Use the Network Editor to remove a server.
To remove a server:
1. Open the Network Editor.
2. In the Hierarchy pane, select the server to remove.
3. Click the Remove Server button.
See also
Add a server on page 164
Select a network model on page 163
Configure your network on page 162
164
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
Network Editor
Chapter 11
Synchronize network models
The synchronization process copies the network model data from your computer
to each of the computers included in your FactoryTalk Batch system.
Click the Synchronize button. The Network Editor refreshes and the results of
the synchronization process display in the Results pane.
Tip:
It is a good idea to synchronize after adding or removing a server from the
network model.
See also
Select a network model on page 163
Add a server on page 164
Remove a server on page 164
User Preferences dialog box
The User Preferences function allows you to customize the behavior and
appearance of the various panes and views within the Network Editor.
You can turn on information tips, change the application text/background colors,
configure the various views, and set up reports used for printing.
See also
Edit colors on page 167
Edit the application font on page 168
Edit information tips on page 169
Set report preferences on page 173
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
165
Chapter 11
Network Editor
User Preferences dialog box General tab
The General tab is used to configure the basic behavior and appearance of the
Network Editor views and dialog boxes. The selections on the General tab are
used in conjunction with other sections of the User Preferences dialog box.
In the Options area, you have the following selections:
•
Use application colors: Select to assign colors, other than the current
Windows colors, to the background and text in the views.
•
Use application font: Select to change the font, font style, and size from
the default Windows style.
•
Information tips: Select to enable single line tips that appear when you
move the cursor over a button or field.
•
Animate dialogs: Select to have dialog boxes fly out from the location from
which they are opened.
•
Confirm deletion: Select to display an "Are you sure?" message when you
delete an item. Leave disabled to delete an item immediately without
confirmation.
•
Confirm exit: Select to have the application ask if you want to exit. Leave
disabled to exit without a confirmation message.
See also
User Preferences dialog box on page 165
166
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
Network Editor
Edit colors
Chapter 11
The Network Editor defaults to the current Microsoft Windows color scheme.
You can change the color of the text and background.
To edit colors:
1. Open the Network Editor.
2. From the View menu, select User Preferences.
3. On the General tab in the User Preferences dialog box, select Use
application colors.
4. Select the Colors tab.
5. Disable Use Windows colors to enable the Background color and Text
color lists.
6. Select the desired colors from the appropriate list, and then click Apply.
See also
User Preferences dialog box on page 165
Network Editor interface on page 158
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
167
Chapter 11
Network Editor
Edit the application font
The Network Editor defaults to the current Windows fonts. You can change the
display font.
To edit the application font:
1. Open the Network Editor.
2. From the View menu, select User Preferences.
3. On the General tab in the User Preferences dialog box, select Use
application font.
4. Select the Font tab.
5. Select the desired font, style, and size from the appropriate lists, and then
click OK.
6. Click Apply.
7. Click OK.
See also
User Preferences dialog box on page 165
Network Editor interface on page 158
168
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
Network Editor
Edit information tips
Chapter 11
Information tips appear when you move the cursor over a button or field. You can
change the font and colors of tips, and set tip timing, which determines how soon
a tip displays.
To edit information tips:
1. Open the Network Editor.
2. From the View menu, select User Preferences.
3. On the General tab in the User Preferences dialog box, select
Information tips.
4. Select the Tips tab.
5. To enable the Background color and Text color lists, disable Use
Windows colors.
6. To change the tip color, select the text and background colors from the
appropriate lists, and then click OK.
7. To change the tip font, click the Change Font button. The Font dialog box
opens. Select the desired font, style, and size from the appropriate list, and
then click OK.
8. To change the timing of information tips, use the Up and Down arrows to
change the settings in the Timing area.
•
Delay determines how soon a tip displays when the cursor stops on an
area with a tip.
•
Visible duration determines how long the tip is visible before closing.
9. Click Apply.
10. Click OK.
See also
User Preferences dialog box on page 165
Network Editor interface on page 158
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
169
Chapter 11
Network Editor
User Preferences dialog box Views tab
If you want to configure properties that are specific to each view and list in the
Network Editor, use the Views tab. For all list views, you can enable information
tips, alter the behavior of drag and drop, change the appearance of scroll bars, and
set selection options. On selected views, you can change the font style and color, as
well as the background color.
See also
User Preferences dialog box on page 165
Network Editor interface on page 158
170
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
Network Editor
List View properties
Chapter 11
The List View Properties area contains the following options to change the
appearance and behavior of items seen in a list view.
•
"Hot" list selection – If selected, an item is automatically highlighted and
selected when the cursor remains over the item for a certain period of time.
•
List information tips – If selected, single-line tips appear when you move
the cursor over a button or field.
•
Flat scroll bars – If selected, scroll bars appear 2-dimensional. If disabled,
scroll bars have a 3-dimensional appearance (Windows default). The
following figure illustrates both the default (on the left) and flat (on the
right) scroll bars:
•
Header drag and drop – If selected, users can click and drag a header from
one location to another in order to rearrange the columns.
•
Header "hot" tracking – If selected, an item is automatically highlighted
but not selected when the cursor moves over a header item. You must still
click the item at least once to activate it.
•
Subitem images – Not currently enabled.
See also
User Preferences dialog box on page 165
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
171
Chapter 11
Network Editor
User Preferences dialog box Reports tab
Use the User Preferences dialog box - Reports tab to configure the layout and
appearance of reports.
The Reports tab contains the following items:
Item
Description
Report
Lists the report templates available for the item or view that is currently active in the Network
Editor.
List
Enables the list report style, if available for the associated report.
Formatted
Enables the formatted report style, which is the default format for most reports.
Include Related Data
Adds any additional data associated with the selected item to the printed report.
Footer Text
Prints the word or phrase entered at the bottom of each report page.
List Reports
Formatted Reports
Graphical Reports
Opens the Report Page Configuration dialog box where you can set the margins, font, and
text color for a specific report template.
See also
Set report preferences on page 173
Change margins on page 174
Set the report fonts and colors on page 175
Column and row preferences in reports on page 178
172
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
Network Editor
Set report preferences
Chapter 11
You can define a footer to print on each report page and select the font and color
(if your printer supports color printing) for the various report sections.
To set report preferences:
1. From the View menu, select User Preferences. The User Preferences
dialog box opens to the General tab.
2. Select the Reports tab. The default report style for most views is
Formatted.
3. To change the type of printed report, select either List or Formatted to the
right of the appropriate report.
Tip:
If you select the List format, set the page orientation to landscape. From the File
menu, select Print Setup, select Landscape in the Orientation area, and then
click OK.
4. Where available, you can select Include Related Data, and any additional
data associated with the selected item (single items only – not lists or
groups) also prints on the report.
5. In the Footer Text box, type a word or phrase to appear centered at the
bottom of each page.
6. Click Apply.
See also
User Preferences dialog box on page 165
Network Editor interface on page 158
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
173
Chapter 11
Change margins
Network Editor
Use the Report Page Configuration dialog box to change margins.
To change margins:
1. To change the margins, fonts, and colors of a printed report, click the
desired Report button (List, Formatted, or Graphical). The Report Page
Configuration dialog box opens.
2. Change the margin widths of the printed report if desired. Type the desired
amounts in each box for the Left, Right, Top, and Bottom margins. A
visual representation of each margin change displays in the Report page
preview area. Note that this is not to scale.
3. If you want to use inches instead of metric measurements, disable Metric
Measurements.
4. Click OK to close the Report Page Configuration dialog box.
5. Click Apply.
See also
User Preferences dialog box on page 165
174
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
Network Editor
Set the report fonts and colors
Chapter 11
There are four areas in a report for which you can edit the fonts and colors:
•
Heading – Prints across the top of each page, generally in a larger, bolder
font than the rest of the report.
•
Sub Heading – Refers to the field names on the report, such as Server. In
formatted reports, subheadings print to the left of the actual report data.
•
Body – Refers to the actual report data. Body text is usually smaller and
lighter than the headings.
•
Footing – Prints the page number, date and time that the report is printed
across the bottom of each page, generally in a smaller font than the rest of
the report.
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
175
Chapter 11
Network Editor
To set the report fonts and colors:
1. To change the font type, style, and size of each section in the report
template (heading, subheading, body, or footer), select the Fonts tab.
2. Click the button for the report section you want to edit. The Font dialog
box opens.
3. Select the desired font, font style/size, and then click OK.
176
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
Network Editor
Chapter 11
4. If your printer supports color printing, you can add color to the report.
Select the Colors tab.
5. Click the color selection button corresponding to the report section to
which you want to add color. The Color dialog box opens.
6. Select a color from the Color dialog box, and then click OK. You will see a
visual representation of each color change in the Report page preview area
of the dialog box.
7. Repeat for the other sections of the report, as desired. When you are
finished changing fonts and colors, click OK to close the Report Page
Configuration dialog box.
8. Click Apply.
See also
Report printing formats on page 179
Set report preferences on page 173
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
177
Chapter 11
Network Editor
Column and row preferences in
reports
The Results pane contains data items in columnar format. The data items cannot
be edited directly.
If you select List in the User Preferences dialog box, you can manipulate the
columns in the Results pane as follows:
Action
How to Perform
Sorting columns
Click a column header to sort the items in the column alphabetically or numerically.
Sizing columns
Automatically: To make the column width fit the contents, double-click the boundary to
the right of the column heading.
Manually: Drag the boundary on the right side of the column heading until the column is
the desired width.
Editing the item name
Click once on a row to highlight it, and then click again. The item name is encased in an
editing box so that you can rename the item.
Double-click on a row to open the Properties dialog box, allowing you to edit the item
name.
Right-click on a row to display the shortcut menu; select Rename.
Editing a row
Double-click on a row to open the Properties dialog box to edit the row’s information.
Right-click on a row to display the shortcut menu; select Properties or other editing
operations.
Copy, delete, or move rows
178
Right-click on a row to display the shortcut menu; select Cut, Copy, Paste, or Delete.
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
Network Editor
Chapter 11
Report printing formats
The Network Editor report printing feature allows you to print network, server,
or result pane information, in a report formatted with headers, footers and
column headings (in list reports). There are two report formats available:
formatted and list. The header (at the top of the page) consists of the report name,
while the footer (at the bottom of the page) contains the printing date/time and
the page count.
A formatted report presents the information down the page, with bold field names
as shown in this figure.
A list report presents the data in a columnar, spreadsheet format, with one line per
data item. The field names become column headings as shown in this figure.
You can customize the reports by setting margins, changing font styles, and
selecting text colors. In addition, you can enter custom text that is also included in
the footer. (See "Set report preferences" for more information.)
See also
Set report preferences on page 173
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
179
Chapter 11
Network Editor
Preview reports
The Print Preview function of the Network Editor allows you to see how a
printed report looks before you send it to the printer.
To preview reports:
1. Click the Print Preview button. The Print Preview window opens,
displaying the report as it will look when printed. The following options are
available from the Print Preview window:
•
Next Page – If there is more than one page in the report, click Next
Page to view the next page of the report.
•
Prev Page – Click to view the previous report pages (if there is more
than one page in the report).
•
Two Page – Allows you to view two pages of a report in the same
window.
•
One Page – Returns to the default preview setting of one page per
window.
•
Zoom In/Out – Click Zoom In to magnify the preview page. Click
Zoom Out to reduce the size of the page in the preview window.
•
Close – Closes the preview window.
2. Click Close to return to the Network Editor. You can either print the
report or make additional report configuration changes.
See also
Report printing formats on page 179
Print reports on page 181
Set report preferences on page 173
180
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
Network Editor
Print reports
Chapter 11
The Network Editor report printing feature allows you to print network, server,
or result pane information, in a report formatted with headers, footers and
column headings (in list reports).
To print reports:
1. In the Network Editor’s Hierarchy pane, select the list or item(s) that you
want to print.
2. From the File menu, click Print. You could also click the Print button or
press ctrl+p to display the Print dialog box.
3. Ensure that the correct printer is selected, and click OK.
Tip:
To configure heading and footer fonts and add a custom footer to your reports, see
Set report preferences for instructions.
See also
Set report preferences on page 173
Preview reports on page 180
Report printing formats on page 179
Print a range of reports
You may want to print just certain pages of the report. You can do so by entering
the starting and ending page numbers of the section you want printed.
To print a range of reports:
1. In the Network Editor’s Hierarchy pane, select the list or item(s) that you
want to print.
2. Click Print.
3. In the Page Range area, click Pages. Type the page numbers to print in the
From and To boxes.
4. Ensure that the correct printer is selected and click OK.
See also
Report printing formats on page 179
Preview reports on page 180
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
181
Chapter 11
182
Network Editor
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
Chapter 12
Server
This section contains information on abnormal FactoryTalk Batch Server
termination, error log and tag verification log generation, and how the logs are
used to troubleshoot system problems.
See also
Abnormal FactoryTalk Batch termination on page 183
Tag verification log information on page 186
Abnormal FactoryTalk
Batch termination
After a FactoryTalk Batch Server failure, FactoryTalk Batch restarts your batches
where they were before the failure. If the reason for the FactoryTalk Batch Server
failure is not obvious, like a power failure, the FactoryTalk Batch Server writes this
critical information to a log file. The log file contains the information the
Application Support group needs when determining the cause of a server failure.
The log file is a circular file, and eventually overwrites itself. To eliminate the
possibility of losing this critical information, the FactoryTalk Batch Server reads
the value of AbnormalTermination within the Batchsvr.ini file upon startup. If
the field value is NO, or the field is not present, then no action is taken. If the field
value is YES, then the current Batchsvr.log file is copied to the path specified by
the ErrorLogDirectory entry in the Batchsvr.ini file. The name of the copied log
file is determined based on CopyFileID.
After determining whether or not to make a copy of the current log file, the
FactoryTalk Batch Server writes a value of YES into the field. At completion of a
normal shutdown, the server writes a value of NO into the field.
See also
Copied log file filename on page 184
Abnormal termination batch record entries on page 185
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
183
Chapter 12
Server
Copied log file filename
If the FactoryTalk Batch Server generates a name for a copied log file, and the file
name already exists in the directory where the copy is to be stored, the server
attempts to create a new name for the copied log file. The server generates new log
file names by incrementing the CopyFileID value until an unused file name is
found. The integer used to generate this file name is incremented one last time and
this value stored into the CopyFileID field in the Batchsvr.ini file. If no unused
file names are found, then the server is forced to overwrite the file name generated
with the CopyFileID field’s original value.
The value of the CopyFileID field is an integer from which a file name of the
following format is generated:
<nnn>.LOG
Where <nnn> is the value of the CopyFileID field obtained from the
Batchsvr.ini file, with leading zeros. The leading zeros help sort the files when
viewed from Windows Explorer or a similar program. Every time the FactoryTalk
Batch Server uses this value to generate a name for a copied log file, it increments
the integer value stored in the field. An attempt to increment the integer beyond a
value of 999 results in a wrapping of the value back to one.
If this value is not present or is invalid, then a current value of one (1) is assumed.
This results in the creation of a log file copy with the name 001.log and the
updating of the field to a value of two (2).
See also
Abnormal FactoryTalk Batch termination on page 183
184
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
Server
Chapter 12
Abnormal termination batch
record entries
The electronic batch record (.evt file) will contain three entries if the batch is
terminated by a FactoryTalk Batch Server cold boot or the batch is terminated
due to an error when attempting to restore the batch from a server warm restart.
The first entry repeats the Event File Name event field. The second entry is a
System Message event field indicating the reason the batch was terminated. The
last entry is a System Message event field indicating the end of the batch.
Example: Termination of FactoryTalk Batch Due to Cold Boot
Description
Event
PValue
Event File Name
MachineName\Program Files (x86)\Rockwell
Software\Batch\YourProject\JOURNALS\4123.evt
YourBatchDescription
System Message
Batch terminated by COLD boot of FactoryTalk Batch server
YourBatchDescription
System Message
End Of BATCH
Example: Termination of FactoryTalk Batch During Warm Restart
Description
Event
PValue
Event File Name
MachineName\Program Files (x86)\Rockwell
Software\Batch\YourProject\ JOURNALS\4125.evt
YourBatchDescription
System Message
Batch terminated due to error attempting to restore batch
during WARM restart
YourBatchDescription
System Message
End Of BATCH
See also
Abnormal FactoryTalk Batch termination on page 183
Copied log file filename on page 184
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
185
Chapter 12
Server
Tag verification log
information
Tag verification is an operator-initiated process that causes the FactoryTalk Batch
Server to attempt to read the current value of most tags defined in the area model.
The tags are read up to 30 at a time, based on the value specified in the
Batchsvr.ini file, and as reads are completed, new reads are initiated.
A dedicated log file, Verify.log, records the most recent verification results. This
file is replaced with a new copy each time a verification begins. The Verify.log file
writes to the same directory as the Batchsvr.log file.
Verification start, completion, and abort records in the standard FactoryTalk
Batch Server log file, Batchsvr.log. Individual tag results record in the verification
log file, Verify.log.
See also
Abnormal FactoryTalk Batch termination on page 183
Tag verification log file on page 187
Windows Event Log on page 188
186
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
Server
Tag verification log file
Chapter 12
The record structure in the tag verification log file (Verify.log) is identical to the
record structure used in the Batchsvr.log file. The tag verification log file
structure reserves the first record for field labels. The installation program installs
a default file into the directory specified by the ErrorLogDirectory value in the
Batchsvr.ini file.
The default file contains the following records:
•
The first record is the standard header record that labels the fields.
•
The second record indicates whether the verify function was performed.
The format of this record is depicted below:
Field #
Name
Value
1
Time
This field is left blank.
2
Severity
INFO
3
File
This field is left blank.
4
Line
This field is left blank.
5
RC_ID
This field is left blank.
6
Batch ID
This field is left blank.
7
Path
This field is left blank.
8
Element ID
This field is left blank.
9
Element Name
This field is left blank.
10
Message
Tag Verify Has Not Been Run.
The Verify.log file is limited to 9,000,000 bytes and wraps if that limit is
exceeded. This provides enough space to verify roughly 50,000 tags before the
output wraps.
The FactoryTalk Batch Server only keeps the verification log file open during the
verification process. When a program has a file open, the file cannot be deleted or
renamed. The server overwrites any existing verification log file each time a
verification begins. If the server encounters a verification log file that is read only,
the server changes the protection on the file to allow it to be overwritten.
See also
Tag verification log information on page 186
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
187
Chapter 12
Server
Windows Event Log
The following events regarding tag verification are recorded in the Windows
Event Log.
Event
Generate Windows Event Log
Start
"Batch Server Tag Verification Process Started"
Abort
"Batch Server Tag Verification Process Aborted"
Completion
"Batch Server Tag Verification Completed, <xxx> of <yyy> tags verified successfully" where
<xxx> is the number of tags that were successfully verified, and <yyy> is the total number of
tags on which verification was attempted.
See also
Tag verification log information on page 186
FactoryTalk Batch
performance chart
The FactoryTalk Batch performance chart is a pre-defined set of charts for use
with the Windows System Monitor.
Tip:
The predefined performance monitor charts are in English only. Non-English
customers must configure the charts manually. (Refer to your Windows
documentation for more information on performance charts.)
The Windows System Monitor can examine the use of computer resources by
FactoryTalk Batch components, as well as other processes and applications, and
help determine if a process or application is using too much CPU time or memory.
The performance chart charts specific processes that can affect the performance of
FactoryTalk Batch, and is an important tool in identifying and troubleshooting
system problems.
Tip:
The performance chart is intended to be used primarily as a debugging and
diagnostic tool by FactoryTalk Batch product support personnel.
The Windows System Monitor is used to view chart data, alerts, logs and reports.
Additionally, charts can be saved for future review. To view the FactoryTalk Batch
performance chart, make sure that the System Monitor is set to chart view mode.
See also
General troubleshooting errors on page 213
188
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
Server
Chapter 12
Open the FactoryTalk Batch
performance chart
The performance chart automatically opens the Windows System Monitor with
the pre-defined charts loaded.
To open the FactoryTalk Batch performance chart:
1. Click the Start button.
2. Point to All Programs > Rockwell Software > FactoryTalk Batch Suite >
FactoryTalk Batch.
3. Click Performance Chart. The Performance dialog box opens with the
pre-defined charts listed.
See also
Using the performance chart on page 188
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
189
Chapter 13
Batch identification
For purposes of batch identification, you can create custom default batch IDs, and
allow or prevent editing of batch IDs. You can also automatically generate custom
batch IDs. In order to implement this option, you must perform steps in
FactoryTalk Batch View and FactoryTalk Batch Equipment Editor, edit some
Visual Basic code and compile it into a new DLL. If you are using the FactoryTalk
Batch ActiveX controls, you can use the BatchID editable property to enable or
disable editing of batch IDs. For more information, see the FactoryTalk Batch
ActiveX Controls Library Reference.
See also
Enable editing of batch IDs on page 191
Disable editing of batch IDs on page 192
Define a custom default batch ID on page 193
Create a custom batchidcreation.dll on page 194
Enable editing of batch IDs
The batch ID is shown on the Batch Creation dialog box when a batch is created,
and by default, is editable. However, if editing of batch IDs has been disabled,
follow these steps to enable this option.
To enable editing of batch IDs:
1. Open FactoryTalk Batch View.
2. Select Configuration and Defaults.
3. Enter your system configuration password, and then select OK.
4. Select the General tab, and in the BatchID Editing area, select the Allow
Editing of Batch ID check box.
See also
Batch identification on page 191
Disable editing of batch IDs on page 192
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
191
Chapter 13
Batch identification
Disable editing of batch IDs
If you create a custom batch ID, we recommend that you prevent editing of batch
IDs. This ensures that the custom batch ID you specified appears when you add a
batch to the batch list, and that it cannot be changed by the operator.
The following steps disable editing of the batch ID. In this case, the box on the
Batch Creation dialog, which displays when a batch is added to the batch list, is
grayed out.
Tip:
If a failure occurs in the generation of a custom batch ID, the batch ID is editable regardless of the setting.
To disable editing of batch IDs:
1. Open FactoryTalk Batch View.
2. Select Configuration and Defaults.
3. Enter your system configuration password, and then select OK.
4. Click the General tab, and then in the BatchID Editing section, deselect
the Allow Editing of Batch ID check box.
See also
Batch identification on page 191
Enable editing of batch IDs on page 191
192
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
Batch identification
Chapter 13
Define a custom default
batch ID
If you define a custom default batch ID, when a new batch is added to the batch
list, the box on the Batch Creation dialog is automatically populated with the
custom default batch ID. If you want to create a custom default batch ID, follow
these steps.
To define a custom default batch ID:
1. Open FactoryTalk Batch Equipment Editor.
2. From the Options menu, select Server Options.
3. Select the Batch Server tab.
4. In the Miscellaneous section, type a default batch ID in the Default Batch
ID box.
5. Click OK.
See also
Batch identification on page 191
Disable editing of batch IDs on page 192
Enable editing of batch IDs on page 191
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
193
Chapter 13
Batch identification
Create a custom
batchidcreation.dll
Automatically generate custom batch IDs in any values or increments. If this
option is chosen, modify some Visual Basic code, compile it into a new Dynamic
Link Library (DLL) file, and then place it in the BATCHCTL\Bin folder.
We recommend that you make a backup copy of the original BatchIDCreation.dll
before making any changes. Supported versions of Visual Basic are shown in the
System Requirements of the FactoryTalk Batch Getting Results Guide.
Tip:
The FactoryTalk Batch Server and the Visual Basic development environment must be installed on the same
computer.
Tip:
If the AutoBatchID execute fails or the generated batch ID contains invalid characters, the Batch ID box in
FactoryTalk Batch View becomes editable, even if the Allow Editing of Batch ID check box in the
View/Configuration or Defaults/General is disabled. If you created a default batch ID, it populates the
Batch ID box and is editable. You can also enter the batch ID manually in the event of a failure.
To customize batchidcreation.dll:
1. Copy the Custom folder from the FactoryTalk Batch CD, including all
subdirectories, to the local hard drive, leaving the structure intact.
2. Double-click BatchIDCreation.vbp. The Visual Basic project opens. If you
see error messages about references that are not yet in the Visual Basic
project, click Yes until you see the message that Visual Basic is unable to set
the version compatible component. Click OK.
194
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
Batch identification
Chapter 13
3. From the Project menu, select References. The References dialog box
opens.
There are several files that are required for references used in the Visual
Basic project. These references must be set manually within the Visual Basic
IDE.
4. From the Available References list, select the following references:
•
COM+ Services Type Library
The COM+ Runtime library, COMSVCS.dll, that is needed for
COM+ functionality. If this file is not on your system, use
MTXAS.dll.
•
OLE Automation
The OLE Automation support DLL, STDOLE32.tlb, which is usually
a standard Visual Basic reference.
•
batchidcreationinsertion 1.0 Type Library
The AutoBatchID type library, batchidcreationinsertion.tlb, required
to create your customized version of the BatchIDCreation.dll.
5. Click OK.
6. From the Project menu, select BatchIDCreation Properties. The Project
Properties dialog box opens.
7. Select the Component tab, and then select Binary Compatibility.
8. Click the browse button, locate C:\Program Files (x86)\Rockwell
Software\Bin\BatchID\-Creation.dll, and then click Open.
9. Click OK.
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
195
Chapter 13
Batch identification
10. Modify the source code located between the Begin - Code Modifications
heading and the End - Code Modifications heading within
[GenerateBatch] to define the BatchID value.
Tip:
The batch ID can contain a maximum of 255 characters with no spaces or invalid characters. The batch ID
can be comprised of any characters except the following: The defined list separator, single or double
quotes, brackets, parentheses, the percent sign (%), the tab character ( \t ), the carriage return character
( \r ), or the new line character ( \n ).
11. From the File menu, click Make BatchIDCreation.dll. The Make Project
dialog box opens. Compile the project into a .dll named BatchIDCreation
dll.
12. Click OK.
13. Replace the default BatchIDCreation.dll
14. Restart your computer.
See also
Batch identification on page 191
Define a custom default batch ID on page 193
196
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
Chapter 14
Change the FactoryTalk Batch Server user
account
Depending on the facility's security requirements, there may be a requirement to
periodically change the FactoryTalk Batch Server user name or password, or both.
If you change the server’s user account after installing the FactoryTalk Batch
components, configure the FactoryTalk Batch system to use the new server user
account.
Important:
The user account for the FactoryTalk Batch Server, Batch Archiver,
eProcedure Server services and the Batch COM+ Application must be
identical.
See also
FactoryTalk Batch system configuration on page 17
System-wide COM security limit settings on page 18
FactoryTalk Batch Server install configuration on page 19
FactoryTalk Batch Client installation configuration on page 20
Add the Batch COM service on page 22
New user account
requirements for the
FactoryTalk Batch Server
When creating a new user account for the FactoryTalk Batch Server, the following
requirements must be met.
•
The password must be configured never to expire--if the password ever
expires, the service eventually fails to log on.
•
The user account must never be disabled or deleted--if this account is ever
disabled/deleted, the service eventually fails to log on.
•
The domain user account must have a unique name--if the user account is a
domain account, remove any local user accounts with the same name.
•
The user account/user group must exist on all workgroup computers--if you
want a local account to have access to resources on other computers in a
workgroup environment, you must create accounts with the same name and
password on each computer in the workgroup.
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
197
Chapter 14
Change the FactoryTalk Batch Server user account
Configure your FactoryTalk
Batch system
After you create a new user account for the FactoryTalk Batch Server, configure
your FactoryTalk Batch system.
To configure your FactoryTalk Batch system:
1. Configure the FactoryTalk Batch Server computer:
•
Add the new server user account to the batchsvr_group and
administrators group. By adding the new account to the
batchsvr_group it inherits all the required user rights and access
permissions.
If FactoryTalk Batch Material Manager is part of your system, add the new
FactoryTalk Batch Server user account to the MTBatchServer group on the
Material Server computer.
Add the new FactoryTalk Batch Server user account to the FactoryTalk Batch
Server service.
If you are running FactoryTalk Event Archiver in incremental mode, add the new
FactoryTalk Batch Server user account in the Batch Archiver service.
If FactoryTalk eProcedure is part of your system, add the new FactoryTalk Batch
Server user account to the eProcedure Server service.
Add the new FactoryTalk Batch Server user account to the Batch COM object in
Component Services > My Computer > COM+ Applications.
198
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
Change the FactoryTalk Batch Server user account
Chapter 14
2. Configure the FactoryTalk Batch Client computer(s):
•
If you are using workgroup security, create the new FactoryTalk Batch
Server user account on all FactoryTalk Batch Client computers in the
workgroup.
Add the new FactoryTalk Batch Server user account to Component Services >
My Computer > Properties > COM Security on all remote FactoryTalk Batch
View computers. Configure the account with Access Permissions: Local Access
and Remote Access.
If eProcedure is part of your system, add the new FactoryTalk Batch Server user
account to Component Services > My Computer > Properties > COM Security
on all remote eProcedure Client computers. Configure the account with Access
Permissions: Local Access and Remote Access.
See also
Server account password change locations on page 200
Change the server user account for the FactoryTalk Batch Server service
on page 201
Change the server user account in FactoryTalk Batch COM+ applications
on page 202
Change the server user account in My Computer properties on page 203
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
199
Chapter 14
Change the FactoryTalk Batch Server user account
Server account password
change locations
If you change the password for the existing FactoryTalk Batch Server user
account, change the password in these locations:
•
If you are using Workgroup security, change the password for the
FactoryTalk Batch Server user account on all FactoryTalk Batch computers
in the workgroup.
•
Change the password for the FactoryTalk Batch Server user account in the
FactoryTalk Batch server service.
•
•
If you are running FactoryTalk Event Archiver in incremental mode,
change the password for the FactoryTalk Batch Server user account to
the Batch Archiver service.
•
If eProcedure is part of your system, change the password for the
FactoryTalk Batch Server user account in the eProcedure Server
service.
Change the password for the FactoryTalk Batch Server account in the
Batch COM object in Component Services > My Computer > COM+
Applications.
See also
Configure your FactoryTalk Batch system on page 198
200
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
Change the FactoryTalk Batch Server user account
Change the server user account
for the FactoryTalk Batch Server
service
Chapter 14
To change the user account for the FactoryTalk Batch Server service, complete
these steps on the server computer.
To change the server user account for the FactoryTalk Batch Server service:
1. Point to Administrative Tools > Services, and then click Services. The
Services dialog box opens.
2. Right-click Batch Server, and then click Properties. The FactoryTalk
Batch Server Properties dialog box opens.
3. On the Log On tab, select This Account and type the new user and/or
password.
4. Click OK.
•
If you are using FactoryTalk Event Archiver in incremental mode,
change the user account name and/or password for the Batch Archiver
service.
•
If eProcedure is part of your system, change the user account name
and/or password for the eProcedure Server service.
5. Close Services.
See also
Configure your FactoryTalk Batch system on page 198
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
201
Chapter 14
Change the FactoryTalk Batch Server user account
Change the server user account
in FactoryTalk Batch COM+
applications
To change the FactoryTalk Batch Server user account in Batch COM+
applications, complete these steps on the FactoryTalk Batch Server computer.
To change the server user account in FactoryTalk Batch COM+ applications:
1. Point to Administrative Tools > Component Services.
2. Expand Component Services, Computers, My Computer and COM+
Applications.
3. Right-click Batch, and then select Properties. The Batch Properties dialog
box opens.
4. On the Identity tab, select This user and type the new FactoryTalk Batch
Server user name and/or password.
5. Click OK.
Tip:
The new permissions are applied the next time the FactoryTalk Batch Server is started on the computer.
See also
Server account password change locations on page 200
202
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
Change the FactoryTalk Batch Server user account
Change the server user account
in My Computer properties
Chapter 14
To change the FactoryTalk Batch Server user account in My Computer
properties, complete these steps on the FactoryTalk Batch Client computers.
To change the server user account in My Computer properties:
1. Point to Administrative Tools > Component Services.
2. Expand Component Services and Computers.
3. Right-click My Computer, and then click Properties. The My Computer
Properties dialog box opens.
4. On the COM Security tab, click the Edit Default button in the Access
Permissions area. The Access Permission dialog box opens.
5. Click the Add button to open the Select Users, Computers, or Groups
dialog box.
6. Type the new FactoryTalk Batch Server user account name and then click
OK.
7. In the Access Permission dialog box, select the new FactoryTalk Batch
Server account. In the Permissions list, select Allow for Local Access and
Remote Access.
8. Click OK twice.
9. Close Component Services.
10. Restart the computer.
See also
Server account password change locations on page 200
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
203
Chapter 15
Run multiple instances of FactoryTalk Batch View
Batch allows multiple instances of the Batch View, running locally on one
computer, to view batches running on one FactoryTalk Batch Server. One or more
people can open an instance of FactoryTalk Batch View on the same computer
running the FactoryTalk Batch Client software. Each instance of the FactoryTalk
Batch View is fully functional and can be used to initiate and control the batch
process and view running batches.
See also
Enable multiple FactoryTalk Batch View instances on page 206
Custom configuration files on page 207
Configuration file log location on page 210
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
205
Chapter 15
Run multiple instances of FactoryTalk Batch View
Enable multiple FactoryTalk
Batch View instances
When FactoryTalk Batch is installed, the SupportMultipleDisplays function is
disabled by default. Before running multiple instances of FactoryTalk Batch View,
enable it in the Windows Registry and create individual configuration files for
each instance. When the registry variable SupportMultipleDisplays is absent or
its value is FALSE in the FactoryTalk Batch Server computer, only one instance of
FactoryTalk Batch View is allowed on each computer in the FactoryTalk Batch
system. When SupportMultipleDisplays is set to TRUE in the FactoryTalk
Batch Server computer, multiple instances ofFactoryTalk Batch View are allowed
on each computer in the FactoryTalk Batch system.
Important:
The SupportMultipleDisplays functionality must be enabled on the computer where the
FactoryTalk Batch Server is installed and running.
To enable multiple FactoryTalk Batch View instances:
1. On the computer where the FactoryTalk Batch Server is installed, open the
Registry Editor.
•
From the Start menu, select Run, type regedit or regedt32 in the
Open box, and then select OK.
2. Navigate to HKEY_LOCAL_MACHINE > SOFTWARE >
BATCHCTL > Setup.
206
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
Run multiple instances of FactoryTalk Batch View
Chapter 15
3. In the right pane, double-click SupportMultipleDisplays. The Edit String
dialog box opens.
4. Enter TRUE in the Value data box, and then click OK.
5. Close the Registry Editor.
See also
Run multiple instances of FactoryTalk Batch View on page 205
Custom configuration files
Each running instance of the Batch View requires a unique configuration file. The
configuration file contains the application settings and the user preference
settings. The default configuration file is BatchVEW.ini. More configuration files
can be created using the file name of BatchVEW_description.ini. All
configuration file names must start with BatchVEW and end with .ini.
Example: A configuration file for a user named John is labelled
BatchVEW_John.ini.
All configuration files are located in the \bin folder where FactoryTalk Batch View
is installed. The default location for FactoryTalk Batch Clients is C:\Program
Path\Rockwell Software\Batch; the location of the configuration files would be
C:\Program Path\Rockwell Software\Batch\bin.
There are two ways to create configuration files: Copy and rename
BatchVEW.ini or create a configuration file when Batch View opens.
See also
Copy and rename default configuration file on page 208
Create configuration files when launching Batch View on page 209
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
207
Chapter 15
Run multiple instances of FactoryTalk Batch View
Copy and rename a default
configuration file
Copy the default BatchVEW.ini configuration file and rename it for the user.
Configuration files are created using the file name of
BatchVEW_description.ini. All configuration file names must start with
BatchVEW and end with .ini.
To copy and rename a default configuration file:
1. On the Batch client computer, using Windows Explorer, navigate to the
folder containing BatchVEW.ini.
2. Select BatchVEW.ini and copy it by pressing Ctrl+C.
3. Paste (Ctrl+V) the copy of the file.
4. Right-click the copied file (labelled Copy of BatchVEW.ini), and then
select Rename from the popup menu.
5. Type the desired name for the new configuration file in the format of
BatchVEW_description.ini, where _description is the user name.
6. From the Start menu, select All Programs > Rockwell Software >
FactoryTalk Batch Suite > FactoryTalk Batch > View. The Display
Configuration dialog box opens.
7. Click Start to launch the Batch View with the default BatchVEW.ini file,
or select a configuration file from the Available Configurations list, and
then click Start. The Batch View opens. The title bar displays the name of
the configuration file used to start the program.
See also
Custom configuration files on page 207
Create configuration files when launching Batch View on page 209
208
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
Run multiple instances of FactoryTalk Batch View
Create configuration files when
launching FactoryTalk Batch View
Chapter 15
Create unique configuration files for each instance of the Batch View when the
Display Configuration dialog box opens.
To create configuration files when launching FactoryTalk Batch View:
1. From the Start menu, select All Programs > Rockwell Software >
FactoryTalk Batch Suite > FactoryTalk Batch > View. The Display
Configuration dialog box opens.
2. Select the Start View with a New Configuration option.
3. Select a configuration on which to base the new configuration from the
Base Configuration list, for example, BatchVEW_John.ini.
4. Enter a new user name in the New Configuration Description box.
The new configuration file name displays in the New Configuration File
box.
5. Click Start. The Batch View opens with the name of the configuration file
used to start the program displayed in the title bar.
See also
Custom configuration files on page 207
Copy and rename default configuration file on page 208
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
209
Chapter 15
Run multiple instances of FactoryTalk Batch View
Configuration file log location
Each running instance of the Batch View generates its own log file. The Batch
View automatically generates the log files based on the configuration files. The log
file has the same file name as the configuration file name with the extension of .log.
For example, the configuration file BatchVEW_John.ini would be associated
with a log file called BatchVEW_john.log.
All log files are located in the \bin folder where FactoryTalk Batch is installed. The
default location for FactoryTalk Batch, for example, is C:\Program Files
(x86)\Rockwell Software\Batch;the location of the log files would be C:\Program
Files (x86)\Rockwell Software\Batch\Bin.
See also
Run multiple instances of FactoryTalk Batch View on page 205
210
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
Run multiple instances of FactoryTalk Batch View
Start FactoryTalk Batch
View from the command
line
Chapter 15
Instances of the FactoryTalk Batch View can be launched from the command line,
with or without a configuration file. If a custom configuration file is specified
from the command line, it must already exist or you will get an error message.
Run a customized instance of the Batch View from the command line regardless
of whether or not the SupportMultipleDisplays value is set to TRUE or FALSE,
or the value exists in the registry.
To start FactoryTalk Batch View from the command line:
1. From the Start menu, select Run, then enter cmd.
2. Navigate to C:\Program Files (x86)\Rockwell Software\Batch\Bin.
3. Enter BatchVEW.exe.
Tip:
If the BatchVEW.ini file does not exist, the Batch View displays an error message and then terminates.
See also
Enable multiple FactoryTalk Batch View instances on page 206
Run multiple instances of FactoryTalk Batch View on page 205
Start FactoryTalk Batch View with a configuration file on page 212
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
211
Chapter 15
Run multiple instances of FactoryTalk Batch View
Start FactoryTalk Batch View
with a configuration file
You can specify the configuration file name in the command prompt when
starting FactoryTalk Batch View from the command line.
If the SupportMultipleDisplays option is set to TRUE on the FactoryTalk Batch
Server computer and no configuration file is specified in the command prompt,
the Display Configuration dialog box opens. You can select an existing
configuration file or create a new one.
If the SupportMultipleDisplays is set to TRUE on the FactoryTalk Batch Server
computer and the specified configuration file does not exist, FactoryTalk Batch
View displays an error message and then terminates.
To start FactoryTalk Batch View with a configuration file:
1. From the Start menu, select Run, then enter cmd.
2. Navigate to C:\Program Files (x86)\Rockwell Software\Batch\Bin.
3. Enter BatchVEW.exe BatchVEW_description.ini
Tip:
If the BatchVEW_description.ini file does not exist, FactoryTalk Batch View displays an error message
and then terminates.
See also
Enable multiple FactoryTalk Batch View instances on page 206
Run multiple instances of FactoryTalk Batch View on page 205
212
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
Appendix A
General troubleshooting errors
This section outlines errors that may occur while installing and running
FactoryTalk Batch and possible solutions.
Automatic repair of batch component
installation fails.
This can happen if one or more folders were moved in Windows explorer. For
example, if the Schema folder gets moved away from its original directory, the
installation package starts up automatically and tries to repair the problem. This
may clear out the Model and Server keys in the registry, which will prevent the
batch client editors from finding the Network Model.
The solution is to completely uninstall the application and then reinstall it.
FactoryTalk Batch Server does not start.
Error Message: (none)
This can happen if:
•
Journal path has not been defined in FactoryTalk Batch Server options.
Modify the FactoryTalk Batch Server options to include a valid Primary
Journal path. Verify that the Secondary Journal path, if defined, is valid.
•
Restart path has not been defined in FactoryTalk Batch Server options.
Modify the FactoryTalk Batch Server options to include a valid Primary
Restart path. Verify that the Secondary Restart path, if defined, is valid.
•
Incorrect Net registry key value.
The FactoryTalk Batch Server is always installed with the default user and
password.
The FactoryTalk Batch Server’s logon and password settings are not
migrated from the server .ini file during an upgrade. After a new
installation, to run the server as a different user, you must change the logon
and password settings, using the Control Panel Services dialog box.
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
213
Appendix A
General troubleshooting errors
FactoryTalk Batch Server runs for a specific Error Message: (none)
period of time and then stops, and
Check the FactoryTalk Batch Service Manager. If the Allow Demo Mode
consistently stops at the same time
interval.
check box is selected, clear the check box.
FactoryTalk Batch Service Manager does Error Message: (none)
not display the FactoryTalk Batch Server or
FactoryTalk Event Archiver.
• The computer where the services are located is not selected.
Click the Select Computer button and select the appropriate computer.
•
The FactoryTalk Batch Server or FactoryTalk Event Archiver services are
not registered with the Windows Registry.
To register a service, click the Start button, point to All Programs, and
then select Command Prompt. Navigate to the Program Files
(x86)\Rockwell Software\Batch\bin directory. To register the
FactoryTalk Batch Server type batchsrv /service at the command prompt,
and press Enter. To register FactoryTalk Event Archiver, type batcharc
/service at the command prompt, and press Enter.
FactoryTalk Batch Service Manager
displays Batch.Server Class instead of
Batch Server.
Error Message: (none)
The service displays the class name instead of the display name.
This is caused by DCOMCNFG configuring the FactoryTalk Batch Server
service to display the class name of the service instead of the display name.
When this occurs, the server no longer supports its COM interface and
must be reinstalled.
The FactoryTalk Batch View/Client is
properly configured, but cannot view the
Event Journals.
Error Message: (none)
There may be a version conflict in one or more of the required files.
The text in FactoryTalk Batch dialog boxes Error Message: (none)
does not display properly.
FactoryTalk Batch does not support the use of large system fonts.
Use the Display Properties dialog box to change the default system font
size to Small Fonts.
214
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
General troubleshooting errors
Appendix A
Unable to locate files.
Error Message: The Recipe directory file could not be found.
The server options for the FactoryTalk Batch Server are not configured to
point to the folder that contains the Recipe.dir file. (See Edit the
FactoryTalk Batch server options for more information.)
An Application Log error is generated.
Error Message: The Application log file is full.
The Application log is not set for wrapping.
Use the Event Viewer to change the Application Event Log Wrapping setting to
Overwrite Events as Needed:
1. Click the Start button, point to All Programs > Administrative Tools,
and then select Event Viewer. The Event Viewer opens.
2. Right-click Application Log, and select Properties. The Application Log
Properties dialog box opens.
3. In the Log size section, select Overwrite events as needed.
4. Click OK.
5. Exit the Event Viewer.
A Licensing error message is generated in Error Message: License information for this component not found. You do not have
Visual Basic.
an appropriate license to use this functionality in the design environment.
The ActiveX controls did not install correctly.
Visual Basic should be installed before FactoryTalk Batch is installed. If you have
already installed FactoryTalk Batch:
1. Uninstall the FactoryTalk Batch Client to remove the ActiveX controls.
(Refer to the FactoryTalk Batch Components Upgrade and Installation Guide
for information on uninstalling the client).
2. Re-install Visual Basic.
3. Re-install the FactoryTalk Batch Client using the FactoryTalk Batch Setup
program.
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
215
Appendix A
General troubleshooting errors
Recipes not visible from FactoryTalk Batch Error Message: (none)
View program.
When you click Create a Batch, no recipes display in the Select a Recipe
dialog box.
The Release Recipe to Production check box is not selected in the recipe
header data. Or, if recipe approvals are enabled, the Release Recipe to
Production step is not approved.
Recipe approvals disabled: For each recipe that should appear in the
Select a Recipe dialog box, ensure that the Release Recipe to Production
check box is selected. This can be done by selecting the Header Data menu
option from the Recipe Editor Recipe menu for the recipe and selecting
the Release Recipe to Production check box.
Recipe approvals enabled: For each recipe that should appear in the Select
a Recipe dialog box, ensure that the Release Recipe to Production step is
approved. This can be done by signing off on the Release Recipe to
Production approval step as part of the approval process defined in the area
model for the recipe.
List of available SQL server databases not
displayed in the Server Options dialog
box.
Error Message: (none)
When the browse button for SQL server databases is clicked, no databases
are displayed in the Database Selection dialog box.
Install the SQL Server Client Tools Connectivity option. Do a custom
install of SQL server to install the SQL Server Client Tools Connectivity
option.
Event Journal files are not being created.
Error Message: (none)
If the Primary Journals directory is located on a computer other than the
server computer, or not within the BATCHCTL share, and that computer
becomes inaccessible, the server continues executing batches but is unable to
create event journals for those batches. You will not receive a notification of
the problem. The primary journal directory must be located on the
FactoryTalk Batch Server computer in the BATCHCTL share.
See also
FactoryTalk Batch performance chart on page 188
216
Rockwell Automation Publication FactoryTalk Batch Administrator 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 Administrator Guide - February 2017
217
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/
218
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
Index
.
.evt file 185
.NET registry key 116
A
ActiveX controls
troubleshoot 213
administrative Tools 82
allowable failures 109
Archiver
(Incremental) 103
event filters 108
service 198
audit
Equipment Editor 67
message generation 65
Recipe Editor 67
AutoBatchID
execute failure 194
automatic
restart control 117
B
Batch
audit 65
Batch COM+ Application 19
Batch IDs
customize 191
Batch Server
cold boot 84, 185
computer name 116
demo mode 82, 84
does not start 213
end of batch 185
failure 183
grace period 84
options 97
performance chart 188
restart 183
user group 19
warm all boot 84
warm boot 84
warm restart 185
Batch Server Service
start 90
startup type 96
Batch Server Statistics
COM information 81
dialog box 86
Batch Service Manager
interface 82
BATCHHIS table
select 103
BatchIDCreation.dll 194
Batchsvr.ini 186
batchsvr_group 19
BatchVEW.ini 207
boot methods
cold boot 84
warm all boot 84
warm boot 84
C
change
colors 167, 170
fonts 170
list view properties 170
report margins 173
view properties 170
colors
change 167, 170
command handshake timeout 122
Command Signature 49
Command Verification policy 49
communications timeout 109
configure
formatted reports 179
list reports 179
report footings 173
report headings 173
user preferences 165
continuous phase 142
cross invocation
default values 113
example 136
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
219
Index
D
data server definition file (DSDF) 14
database
names 159
Network Editor 159
SQL Server 213
default
cross invocation values 113
hyperlink values 114
descriptors
cross invocation 113
hyperlink label 114
directory share 13
disable
Archiver service 103
DSDF 14
dwell time 143
E
electronic batch record 185
Electronic Signatures
policy setting 63
eProcedure
hyperlinks 114
Equipment Editor
access modes 39
security 37
error message
application log is full 213
license for component not found 213
recipe directory file not found 213
ErrorLogDirectory 187
errors
troubleshooting 213
event journal signatures
electronic batch records 109
event journals 24
Event Viewer 123
external security device 36
220
F
FactoryTalk AssetCentre
message fields 79
FactoryTalk Batch server install configuration 19
FactoryTalk Directory 25
FactoryTalk Help 25
FactoryTalk Security 25
FactoryTalk Services Platform 25
FactoryTalk Windows Firewall Configuration Utility 21
failure
handshake timeout 109
phase 109
watchdog timeout 109
formatted report 179
G
General Usage Phase Logic Requests 61
H
HMI
change logged-on user 34
hold propagation
setting 109
hyperlink
default values 114
I
Incremental Archiver 103
L
list report 179
list view properties
change 170
log files 24
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
Index
reports
change margins 173
column and row preferences 173
configure footings 173
configure headings 173
resource types
cross invocation 113
hyperlinks 114
restart Batch Server 183
restore a batch 185
M
manual failover 118
Material Manager 115
Maximum Log File Size box 109
Minimum Disk Space box 109
N
Network Editor
database 159
network model
information 159
synchronize 163
S
O
Object Database Connectivity (ODBC) 97, 103
OLE for process control (OPC) 14
OPC groups 14
P
Period (msec) box 109
permissions 13
phase
material-enabled 139
phase logic simulation 139
policy settings
ESignature Network Directory 63
print preview 180
print reports
print a range of pages 181
product policies 26
R
Recipe Editor
access modes 39
configuration options 41
recipes
release to production 213
report preferences
set 173
security
automatic logoff time period 33
Batch View 28
event journal 24
external device 36
file 24
folder 24
log file 24
Windows 15
Server Options
Archiver (End of Batch) 103
Archiver (Incremental) 103
Archiver Event Filters 108
Batch Reporting tab 103
Batch Server tab 109
Cross Invocation tab 113
edit 97
redundant servers 101
Restart Control tab 101
Server Options dialog box 85
set
report preferences 173
user preferences 165
shared directory 13
Signature Requests
General Usage 61
Signature Templates 47
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
221
Index
simulator 139
ack/clear requests 153
change dwell time 143
command a phase 151
indicate a continuous phase 145
interface 141
phase configuration 142
phase ownership 150
phase parameter tag 146
phase status 146
report parameter tag 148
request data tags 148
request sequence 144
restore/clear requests 154
unit tag status 156
synchronize 163
System Log file 213
system problems 183
T
tag verification 186
troubleshoot
ActiveX controls 213
application event log 213
Batch Server failure 183
Batch Service Manager 213
batch terminated 185
error messages 183
event journal files 213
recipes not visible 213
SQL Server selection 213
system problems 183
tag verification 186
text in Batch dialog boxes 213
User Preference dialog box
change colors 167, 170
change fonts 170
change view properties 170
column and row preferences 173
edit information tips 169
list view properties 170
set 165
User-Defined (End of Batch) 103
V
view properties 170
W
Windows Desktop 33
Windows Event Log
modify settings 127
tag verification 188
Windows registry
.NET key 116
Windows services
Archiver 82
Batch Server 82
workgroup
configuring client 26
U
user account
create 16
222
Rockwell Automation Publication FactoryTalk Batch Administrator Guide - February 2017
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
Editor introduction
Additional resources .......................................................................................................... 15
FactoryTalk Batch Equipment Editor security ............................................................ 16
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
models overview
XML area models ............................................................................................................... 27
Import an XML area model ..................................................................................... 28
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
FactoryTalk Batch
Parameters and reports in recipes.................................................................................... 45
Parameters example.................................................................................................... 46
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
4
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
Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017
Table of contents
Chapter 7
Recipe approval tasks ......................................................................................................... 84
Configure recipe approval steps ...................................................................................... 85
Recipe Approvals Configuration dialog box ......................................................... 87
Edit a recipe approval ........................................................................................................ 88
Disable recipe approval ..................................................................................................... 89
Recipe approval process
overview
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
6
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
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
8
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
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
configuration
Create an operation sequence ........................................................................................ 234
Edit Operation Sequence dialog box - General tab ........................................... 234
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
changes
10
Area model object warm restart support ..................................................................... 243
Resource classes warm restart support ......................................................................... 244
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
Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017
Table of contents
Appendix B
Troubleshoot issues
Legal Notices
Index
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 ..................................................................................................................... 265
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
Additional resources
Chapter 1
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
Language Reference Guide
Provides quick and easy access to information regarding the
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
Reference Guide
Provides information and instructions about the FactoryTalk®
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
Equipment Editor security
Security for FactoryTalk Batch Equipment Editor uses the FactoryTalk Security
product policy settings defined in the FactoryTalk Directory. Only FactoryTalk
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
Open FactoryTalk Batch
Equipment Editor
Chapter 1
Use these instructions to open FactoryTalk Batch 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
Equipment Editor interface
Use FactoryTalk Batch Equipment Editor to configure the facility area model.
The components defined in the FactoryTalk Batch 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
area
Shows the existing cell classes, unit classes, or phases in the active area model. The column
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
Menu bar
Chapter 1
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
clipboard.
Delete
Copy
Copies the highlighted item and saves it to the
clipboard.
CTRL + C
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
lower level.
None
Go Up
Moves up through the levels and displays the next
higher level.
None
Zoom
Specifies the magnification of the current sequential
function chart (SFC) display.
None
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
Enumerations dialog box.
CTRL + M
Edit Servers
Opens the Create Servers dialog box.
CTRL + D
Synchronize
Synchronizes the equipment area model with the
Logix Designer project file.
CTRL + L
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
Requirements
Opens the Edit Global Unit Binding Requirements CTRL + B
dialog box.
Edit Signature
Templates
Opens the Edit Signature Templates dialog box.
None
Edit Command
Verification Policies
Opens the Edit Command Verification Policies
dialog box.
CTRL + P
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
units within a process cell.
None
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:
Tip:
Restart the FactoryTalk Batch Server to initiate the changes and re-verify
any recipes that run against any modified area model.
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
model
Use these instructions to open an existing area 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
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.
Area models migration
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
Batch Material Manager
When opening area models containing enumeration sets of the same name as the
system enumeration sets (YES_NO, and if FactoryTalk 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
Import system phase classes
Chapter 3
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
command line overview
Convert XML area models to the proprietary binary format from the command
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
overview
A COM object exposes an interface that allows conversion of area models from
XML files to MFC binary files. The COM object,
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
COM object syntax
Chapter 3
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
IAreaModelXMLToBinary
Specifies the path for the
input XML filename.
Specifies the path for output
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
Server-installed system)
Represents the set of materials configured in the FactoryTalk Batch Material
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
Server-installed system)
Represents the set of containers configured in the FactoryTalk Batch Material
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
Server-installed system)
Represents the set of material classes configured in the FactoryTalk Batch
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
enumeration sets
Use these instructions to edit enumerations and 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
enumeration sets
Use these instructions to delete enumerations and 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
recipes
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
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
reports work with phase
tags
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).
Each tag in the phase maps to a specific memory address or tag in the PCD where
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
Additional request, parameter,
and report tags for phases
Chapter 5
A Request tag is one of the ten standard tags associated with every OPC phase.
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
Batch parameters and
reports
Chapter 5
Parameters pass values from the FactoryTalk Batch Server to the
process-connected device (PCD). The PCD uses reports for returning values to
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 processconnected 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
Types of containers
Chapter 5
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
Scale parameters
Chapter 5
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
parameter deviations
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
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
Control strategies example
Chapter 5
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
PARAMETER_A
X
150
PARAMETER_B
X
PARAMETER_C
REPORT_A
X
200
X
X
X
Strategy 2
Value
275
70
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
Parameter and report
subsets overview
Chapter 5
Use the download parameter subsets to define subsets of phase class parameters
for Download (DL) on Start and Download (DL) on Transfer of Control
(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
subsets example
This table is an example of a phase class and how its parameters and reports can be
assigned to the different subsets:
AGITATE_1
Parameters
DL on
Start
DL on
TOC
Reports
UL on Terminal UL on TOC
State
SPEED
X
X
AGITATE_TIME
X
TIME
X
X
AVG_TEMP
X
LEVEL
X
AVG_SPEED
X
TEMP
X
AMT_DUMPED
X
X
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:
58
(OPC or FTD) phases
Logix5000 CIP phases
1501 or 11501 request
PXRQ instruction,
External request: Download Input Parameters Subset
DINT[0] - 1
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
Automatic
Upload/Download
Chapter 5
Automatic Upload/Download decreases batch duration time as well as the
amount of phase logic programming required. Automatic 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
upload/download
parameter subsets
If assigned parameters or reports to upload/download parameter subsets, and
enabled control strategies, only those parameters common to all the involved
subsets and selected control strategy upload or download.
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
Start
DL on
TOC
CS1
Reports
UL on
Terminal
State
UL on
TOC
CS1
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
Signatures can be configured for verification of these runtime FactoryTalk Batch
events:
•
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
work
The steps involved in configuring and executing electronic signatures span the
FactoryTalk Batch product suite.
•
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
Signature template
Chapter 6
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
dialog box
The Edit Signature Templates dialog box contains:
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
signoffs
Use these instructions to configure the signature template 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
signoff
When configuring signoffs for a signature template, specify which users or groups
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
user or group
Complete these steps to remove authority from an individual or group to
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
policies
Set up command verification policies to obtain signatures for batch or phase
commands issued by operators from FactoryTalk Batch View or ActiveX controls.
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
commands
Use these instructions to add electronic signatures to 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
dialog box
The components in the Edit Command Verification Policies 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
for a command
If a command requires a signature and has a signature template specified, follow
these instructions to change the verification policy for the 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
requirement for a command
To remove the verification policy and signature requirement for a command,
complete these steps.
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
82
Electronic signatures
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
steps
Use the Recipe Approvals Configuration dialog box to configure the steps used
by the primary approval process and expedited approval process. This includes
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
dialog box
The Recipe Approvals Configuration dialog box contains:
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 (
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
) to open
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 (
Recipe Editor.
Tip:
) to open FactoryTalk Batch
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
configuration
This flow chart shows the sequence of tasks in the configuration and use of
security authority.
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
OPC data servers
Chapter 9
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
Live Data server
The FactoryTalk Live Data protocol provides services that read and write
real-time manufacturing data from OPC servers and controllers for all
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
server path
Use these instructions to open the FactoryTalk Communication Setup dialog
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
Edit a data server
Chapter 9
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
Assign data servers
Chapter 9
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
sequence to link the equipment piece to the
specified controller.
Assign the same data server to all phases or operation
sequences subsequently created in a unit. Select the
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
Component Requiring Level
Resource
Recipe Name
Behavior of Recipes
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
Operation
CLS_SWEETCREAM_
UP:1
CLS_SWEETCREAM_
OP:1
The unit procedure and
operation sweet cream recipes
running in Unit_A cannot begin
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_CLS1
OPERATION_CLS1 running in
Operation_Sequence_A cannot
begin execution until the
resources required by
Operation_Sequence_A have
been acquired by the
FactoryTalk Batch Server.
Operation_Sequence_A Operation
Sequence
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
for resources
Use these instructions to configure general information.
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
information for resources
On the Edit Resources dialog box Arbitration tab, the Equipment Allocation
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
information for resources
Use the Cross Invocation tab to specify cross invocation labels for different
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
information for resources
This feature, allows hyperlinks to be associated with any of the equipment
resources, used in conjunction with eProcedure only.
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
builder
Create expressions in the Unit Binding Expression Builder. The Unit Binding
Expression Builder contains a type list on the left pane, which displays Recipe
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
Expression operators
Chapter 11
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
requirements
Use these instructions to create global binding 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
process cell instances
Use these instructions to create and configure 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
instance
Use these instructions to configure a process cell 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
process cell
Use these instructions to configure the general data.
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
tab
The General tab of the Edit Process Cell dialog box 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.)
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
for a process cell
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
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 Arbitration tab
The Edit Process Cell dialog box on the Arbitration tab contains:
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
for a process cell
Use these instructions to configure cross invocation data.
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
Invocation tab
The Edit Process Cell dialog box on the Cross Invocation tab contains:
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
Configuration
The cross invocation strings indicate the addition of an item to 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 process cell on page 132
Configure hyperlink data for a
process cell
This feature is used in conjunction with FactoryTalk eProcedure only. Use these
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
The Edit Process Cell dialog box Hyperlink tab contains:
Edit process cell dialog box 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
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 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
Verify icon paths
Chapter 12
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
Unique icons
Process cell overview
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
Create a unit class
Chapter 13
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
unit
Use these instructions to configure the general data for a 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
data
Use these instructions to configure the unit attribute tag 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
Tags tab
The Edit Unit dialog box Attribute Tags tab contains:
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
for a unit
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
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
Allocation by
Resource
A list of the equipment for which ownership is required by this unit 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 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
for a unit
Use these instructions to configure cross invocation data.
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
Invocation tab
The Edit Unit dialog box Cross Invocation 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).
Cross Invocation
Configuration
The cross invocation strings indicate the addition of an item to
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
unit
This feature is used in conjunction with FactoryTalk eProcedure only. Use these
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
Link unit instances
Chapter 13
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
Phase tags
Tags overview
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
Edit tags from the menu
Chapter 14
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
to reflect the names of their respective phases and reset the Access Path of each
access path
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
Tags
Phase class overview
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
classes
Use the Create Phase Class dialog box to create and configure phase 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
attributes
Use the Create Phase Class dialog box General tab to configure the phase class
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:
a.
Use names that can easily be understood. Phase class names display to the operator during batch
execution.
Under Icon, select an appropriate icon. (If the icon area is empty, see
Verify icon paths.)
b. Under Additional Functionality, do the following:
c.
176
•
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.
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.
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 General tab
The phase class general attributes include the phase class name, phase class type,
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
Configure phase class
parameters
Chapter 15
Use the Create Phase Class dialog box Parameters tab to configure phase class
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 Parameters tab
Phase class parameters values pass from the FactoryTalk Batch Server to the phase
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
Parameters
Enables the optional material-based recipe parameters (CONTAINER,
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.)
182
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.
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:
c.
184
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.
Under Accumulate, select how the FactoryTalk Batch Server handles
uploaded report values. These are the valid values:
•
None
•
Phase
•
Batch
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 Reports tab
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 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:
186
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.
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 Messages tab
Phase class messages are typically used for journal entry purposes and for
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
strategies
Use these instructions to edit the default control strategy, create new control
strategies, and delete control strategies. To remove all of the control 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 Control Strategy tab
A control strategy identifies a subset of the phase class and report parameters
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
Verification policies
Chapter 15
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
for parameters and reports
Use the Edit Phase Class dialog box to configure the verification policies 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
198
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.
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
Low-Low/High-High
Low-Low-Low/
High-High-High
These boxes are used in calculating the default parameter deviation limits.
These values can be changed in the recipe, but if no values are provided in the
recipe parameters, the values entered here are used.
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
with control strategies
If implementing control strategies, set up a different verification policy for each
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
affects report verification
policies
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
the target parameter:
•
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
matching parameter and report
names
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
class. In addition, if the MATERIAL parameter exists, it must also have the
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
control strategies configured
If a standard phase class has control strategies configured and Material Based
Recipes is enabled, the material parameters (including optional parameters, if
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
material-enabled phase
class
Disabling Material Based Recipes on a material-enabled phase class automatically
deletes the two reserved parameters (and the optional parameters, if enabled) and
the two reports. If Parameter/Tag Locking is enabled, remove the appropriate
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 (
the lowest level).
) to
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
phase
Use these instructions to configure the Edit Phase dialog box General tab.
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
Parameters Upon START
When a START command issues, the FactoryTalk Batch Server downloads the
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
Parameters Upon COMPLETE
STOPPED
ABORTED
When the batch transitions to a terminal state (COMPLETE, STOPPED, or ABORTED) the
FactoryTalk Batch Server uploads the report values configured with the Upload on
Terminal State option on the phase class. Enable this function so that it occurs for any
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
phase
Configure the tag data for the phase. These instructions only apply to phases
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
Phase tag
Configure phases
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
Phase tag naming conventions
Chapter 16
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
[Phase_Name]P##
CHARGE1P01
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
[Phase_Name]R##
CHARGE1R01
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
[Phase_Name]Q##
CHARGE1Q01
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
Parameter Tags
PARMTR##
Parameter Limit Tags
Report Tags
REPORT##
Report Limit Tags
Request Tags
REQUEST##
Default Tags
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
Edit Phase Tag dialog box
Chapter 16
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
addresses
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.
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
for a phase
Use these instructions to configure the arbitration data.
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
tab
The Edit Phase dialog box on the Arbitration tab contains:
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
Resource
A list of the equipment for which ownership is required by this phase in order for
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
for a phase
Use these instructions to configure cross invocation data.
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
Invocation tab
The Edit Phase dialog box Cross Invocation 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.
Cross Invocation
Configuration
The cross invocation strings indicate the addition of an item to 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 phase on page 218
Configure hyperlink data for a
phase
This feature is used in conjunction with eProcedure only. Use these instructions
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
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 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
tab
The Edit Phase dialog box Containers tab contains:
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
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.
Parameter limit tags
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
Limit Tags tab
Automatically create and maintain the necessary phase parameter tags for the
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
Map parameter tags to
parameter limit tags
Chapter 16
Use the Edit Phase dialog box Parameter Limit Tags tab to map parameter 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
Limit Tags tab
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.
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
Enable report limit tags
Chapter 16
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
tags
If Parameter/Tag Locking is disabled and parameter tags are created manually,
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
report limit tags
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
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,
reports, and phase classes
affect limit tags
After limit tags are enabled or mapped, if the verification method of the parameter
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
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
and operation sequences
between units
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
same phase or operation sequence in the other unit(s). Prior to sharing a phase or
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
sequence
Use these instructions to share a phase or operation 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
sequence
Use these instructions to create an operation 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
box - General tab
The operation sequence general attributes include the operation sequence class
name, equipment ID, and the current assigned data server.
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
operation sequence
Use these instructions to configure general data for an operation sequence, using
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
box - Arbitration tab
The Edit Operation Sequence dialog box Arbitration tab configures resources
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
Resource
A list of the equipment for which ownership is required by this operation sequence
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
arbitration data for an operation sequence.
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
box - Tags tab
The Edit Operation Sequence dialog box Tags tab displays the configuration of
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
parameters
Use the Create Operation Sequence Class dialog box Parameters tab to
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
reports
Use the Create Operation Sequence Class dialog box Reports tab to configure
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.
240
•
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.
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
and operation sequences
between units
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
same phase or operation sequence in the other unit(s). Prior to sharing a phase or
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
sequence
Use these instructions to share a phase or operation 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
restart support
A FactoryTalk Batch area model configuration file (.CFG file) always contains a
single area object by definition.
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
restart support
Select Edit > Resources to created or edited resource classes.
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
support
Select Edit > Resources to create and edit resources.
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
restart support
Select Edit > Tags to create and edit unit attributes.
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
restart support
Create, delete, and edit unit attribute tags using the properties dialog of a unit
object.
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
warm restart support
Equipment phase tags are automatically created by FactoryTalk Batch Recipe
Editor when equipment phases are created.
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
restart support
Select Edit > Enumeration Sets to create and edit enumeration sets.
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
support
Select Edit > Server to create and edit data servers.
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
restart support
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
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
support
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
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
support
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
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
support
Right-click on a Phase icon to create Parameters for a phase in the Edit Phase
dialog box Parameters tab.
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
support
When building a unit operation level recipe, specify a value for each parameter in
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
support
Right-click on a phase class icon to create phase reports in the Edit Phase Class
dialog box Reports tab.
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
support
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
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
restart support
Right-click on a recipe phase class icon to create phase class messages in the Edit
Phase Class dialog box, Messages tab.
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
support
Right-click on a Recipe Phase icon to create and delete Recipe phases.
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
restart support
From the main window in FactoryTalk Batch Equipment Editor, right-click on an
equipment phase icon to create equipment phases.
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
file
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
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
encountered in writing
instruction file
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
illegal in CDATA sections, might be encountered.
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
Server for material support
per container
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
Material Server at the time of the export. It is possible that the Material Server
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
errors
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
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:
258
•
$ACTUAL_AMOUNT
•
$FEED_COMPLETE
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
by deleted group or user
Use these instructions to troubleshoot the Invalid Signoff dialog box triggered
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
required information is omitted
Use this information to troubleshoot the Invalid Signoff dialog box triggered by
these sequence of events:
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
configured within the Area
Model
If no signature templates have been configured in the area model, attempted use of
Signature Template Selection Browse produces this error message:
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
model is secured to a
different FactoryTalk
Network Directory
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
FactoryTalk Network Directory SAI, this error message opens in FTB_EE>:
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
secured to a different
FactoryTalk Network
Directory
When attempting to open FactoryTalk Batch Recipe Editor, and an SAI
mismatch exists between the area model and the FactoryTalk Network Directory,
this error message opens:
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
change 80
configure 78
remove 81
configure 117
unit attribute tag information 145
configure a recipe approval 85
container information
equipment module 220
control strategies
and verification policies 200
example 55
implement 56
overview 54
with upload/download parameter subsets 62
copy a phase 203
create
global unit attribute 169
create area model 22
create phase classes 175
create process cell class 126
cross invocation
definition of 149
cross invocation strings
equipment modules 218
process cells 149
shared resources 115
unit 149
cut and paste a phase 204
A
add
data servers 247
enumeration sets 246
OPC data server 100
process cell classes 247
process cells 248
resource classes 244
resources 244
unit attribute tags 245
unit attributes 245
unit classes 249
units 249
arbitration information
process cell 130
shared resources 113
unit 146
area model
create 22
edit 243
import XML file 30, 31
migration 24
name 22
open 23
secure 93
automatic upload/download 61
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
D
data server
add 97, 247
default item access path 99
delete 106
edit 105
location 99
name 99
OPC 99
RSLinx Enterprise Live 102
scan rates 99
types 99
watchdog item access path 99
watchdog item name 99
watchdog protocol 99
watchdog write item access path 99
watchdog write item name 99
data server definition files 96
data server properties
modify 247
data server protocols
CIP 97
FTD 97
OPC 97
data servers
assign 107
data types
binding expressions 119
enumeration 119
examples 119
integer 119
real 119
string 119
default tags
naming conventions 212
delete
unit instance 152
deviation limits 194
DSDF 96
duplicate a phase 203
E
edit command verification policies dialog box, field descriptions 80
edit signature templates dialog box, field descriptions 68
268
electronic signature template 67
add 69
configure signoffs 71
delete 76
modify 77
electronic signatures
how they work 65
sequence of tasks 65
types 64
use 63
enable
parameter limit tags 223
report limit tags 227
enhanced phase logic request 57, 61
enumeration sets 37
add 246
delete 43
description 37
example 37
negative ordinal values 37
work with 40
enumerations
material database unavailable 39
equipment dependencies
process cells 130
unit 146
Equipment Editor
interface 18
open 16
security 16
equipment module
container information 220
cross invocation strings 218
hyperlink strings 219
OPC tags 212
tag naming conventions 213
tags 164, 212
equipment phase tag properties
modify 246
equipment phases
modify 254
example
unit attribute binding 117
expression builder
unit binding 118
validation-Recipe Editor 120
Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017
Index
L
expressions
operands-Equipment Editor 120
operators-Equipment Editor 119
validation-Equipment Editor 120
limit tags
map to parameter tags 225
map to report tags 228
name conventions 212
tag locking disabled 225, 228
tag locking enabled 223, 227
link
units 153
F
FactoryTalk Live Data 101
G
general information
process cells 209
shared resources 112
global binding requirements 117
global unit attribute
create 169
groups, configure for electronic signatures 71
H
High/Low 193
High-High/Low-Low 193
High-High-High/Low-Low-Low 193
hyperlink strings
equipment module 219
shared resources 116
unit 151
I
icons
create 136
path verification 135
import
enumerations (XML) 30
system phases (XML) 31
XML area model 30, 31
import errors
material-specific 258
XML parser 257
M
material database
area model 25
enumerations 39
material-enabled phases
configure 201
disable 202
material-specific errors 258
menu bar 19
message partners 178
messages
modify 253
modify
area object 243
data server properties 247
equipment phase tag properties 246
equipment phases 254
messages 253
process cell class 247
process cell properties 248
recipe parameter properties 250
recipe phases 253
report parameter properties 252
resource class properties 244
resource properties 244
unit attribute properties 245
unit attribute tag properties 245
unit attribute tags 245
unit class properties 249
unit properties 249
Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017
269
Index
N
No Limits 193
none, verification policy 194
not allowed 194
O
operands
binding expression-Equipment Editor 120
operators, expressions-Equipment Editor 119
P
parameter deviations, select verification method 53
parameter limits 53
parameter tags
map to limit tags 225
naming conventions 212
parameters
overview 45
phase 49
report 50
scale 53
target 200
permissions, configure for electronic signatures 71
phase
configuring to material-enabled 201
copy 203
cut 204
disable material-enabled 202
parameters
definition 49, 250
paste 204
phase commands, configure verification policies 78
phase link group 178
phase logic
enhanced request 57, 61
phase parameters
definition 250
policy
change for a command 80
remove for a command 81
verification 78
270
process cell
add 248
arbitration information 130
class
create 126
edit 127
create 127
cross invocation strings 149
definition 248
general information 209
process cell classes
add 247
modify 247
process cell properties
modify 248
R
recipe approval 85
recipe parameter properties
modify 250
recipe parameters
warm restart 251
recipe phases
modify 253
report parameter properties
modify 252
report parameters
warm restart 252
report tags
map to limit tags 228
name conventions 212
reports
phase 50
request tags, name conventions 212
resource class properties
modify 244
resource classes
add 244
resource properties
modify 244
resources
add 244
Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017
Index
re-verify recipes 22
RSLinx Enterprise 101
RSLinx Enterprise Live Data server 102
RSLinx Enterprise Live Data tags 46
RSLinx Enterprise Server Path 99, 104
S
save area model 22
scale parameters 53
scan rates
data server 99
security permissions, configure for electronic signatures 71
server options 19
share
units 153
shared resources
define 111
description 110
signature requirement, remove for a command 81
signature template
add 69
configure signoffs 71
create 67
delete 76
modify 77
verification policy 194
signature templates dialog box, field descriptions 68
signatures
electronic 63
how they work 65
sequence of tasks 65
types 64
signoff policies, configure for commands 78
signoffs, configure 71
Single Sign-On Equipment Editor 16
T
tags
delete tag class 171
description 157
edit 165
edit from menu 165
edit tag class 171
equipment module information 210
equipment module tags
create 164
map to limit tags 225, 228
naming conventions 212
RSLinx Enterprise Live Data 46
set to default addresses 216
set to default names 167
unit attribute 161
unit attribute tags 158
information 145
work with 157
target parameters, and report verification policies 200
template
add 69
configure signoffs 71
delete 76
modify 77
signature 67
toolbar-Equipment Editor 19
transitions
data types-Equipment Editor 119
U
unique icons 136
unit
arbitration information 146
configure arbitration 146
configure cross invocation 149
configure hyperlinks 151
configure tag information 145
create a unit class 139
create a unit instance 141
create tags 161
cross invocation strings 149
definition 249
delete 152
edit a unit class 140
equipment dependencies 146
hyperlink strings 151
link 153
remove a unit instance 152
share 153
tags information 145
work with 137
Rockwell Automation Publication FactoryTalk Batch Equipment Editor User Guide - February 2017
271
Index
unit attribute binding
example 117
unit attribute properties
modify 245
unit attribute tag properties
modify 245
unit attribute tags 145
add 245
create 161
modify 245
unit attributes
add 245
unit binding expression builder-Equipment Editor 118
unit class properties
modify 249
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
W
watchdog
item access path 99
item name 99
protocol 99
Windows-linked user 16
X
XML
import enumerations 30, 31
XML parser errors 257
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
User Guide
FactoryTalk® Batch Recipe 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
Recipe Editor
introduction
Open FactoryTalk Batch Recipe Editor ........................................................................ 11
Set FactoryTalk Batch Recipe Editor options .............................................................. 12
FactoryTalk Batch Recipe Editor interface................................................................... 14
FactoryTalk Batch Recipe Editor menu bar ......................................................... 15
FactoryTalk Batch Recipe Editor toolbar ......................................................... 16
Recipe construction toolbox .................................................................................... 17
Recipe creation overview .................................................................................................. 18
Additional resources .......................................................................................................... 20
Chapter 2
Sequential Function
Chart overview
SFC components ................................................................................................................ 23
SFC steps.............................................................................................................................. 24
Transition expressions....................................................................................................... 25
Transition operators .................................................................................................. 27
Parameter expression functions ....................................................................... 27
Data types..................................................................................................................... 28
Linked elements.................................................................................................................. 29
SFC limitations................................................................................................................... 30
SFC execution ..................................................................................................................... 31
Null procedures .................................................................................................................. 32
Synchronize execution of steps overview ............................................................... 33
Arbitration ................................................................................................................... 33
Subarbitration ............................................................................................................. 35
Add a null procedure ................................................................................................. 37
Timer steps .......................................................................................................................... 37
Timer step hold behavior .......................................................................................... 38
Recipe comments ............................................................................................................... 39
Chapter 3
Table-based recipes
overview
Recipe structure icons........................................................................................................ 42
Table view transition expressions ................................................................................... 43
Parallel structures ............................................................................................................... 43
Simple parallelism example....................................................................................... 44
Complex parallelism example .................................................................................. 45
Chapter 4
Recipe creation
Procedure levels .................................................................................................................. 47
Unit requirements.............................................................................................................. 48
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
3
Table of contents
Unit-based recipes ...................................................................................................... 49
Unit class-based recipes ............................................................................................. 49
Material-based recipes ............................................................................................... 50
Material class-based recipes ...................................................................................... 50
Dynamic unit allocation ................................................................................................... 50
How dynamic unit allocation affects unit binding .............................................. 51
Binding methods ........................................................................................................ 52
Criteria for unit selection ................................................................................. 53
Unit requirement name ............................................................................................ 53
Downstream unit requirements .............................................................................. 54
Enable dynamic unit allocation ............................................................................... 55
Open recipe ......................................................................................................................... 55
Cannot open recipe error message .......................................................................... 57
Create operations and unit procedures .......................................................................... 58
Change operation/unit procedure unit requirements ........................................ 60
Create a procedure ............................................................................................................. 61
Unit requirement name example ............................................................................ 64
Change procedure unit requirements .................................................................... 64
Smart binding...................................................................................................................... 65
Binding requirements ................................................................................................ 66
Configure binding requirements ..................................................................... 66
Binding preferences.................................................................................................... 67
Configure binding preferences ........................................................................ 68
Create binding expressions ....................................................................................... 69
Recipe header data.............................................................................................................. 71
Add recipe header data .............................................................................................. 73
Recipe storage...................................................................................................................... 74
Copy recipe options ........................................................................................................... 75
Copy a recipe using the backup directory.............................................................. 76
Chapter 5
Build a Sequential
Function Chart
4
Insert steps into an SFC .................................................................................................... 79
Insert timer steps ................................................................................................................ 81
Manually add steps to an SFC ......................................................................................... 82
Add a parallel step to an SFC ........................................................................................... 83
When parallel steps require the same dedicated resource .................................. 83
Add a branch structure to an SFC .................................................................................. 85
Add transitions to an SFC ................................................................................................ 86
Define a step ........................................................................................................................ 86
Link SFC components ...................................................................................................... 87
Remove a link from an SFC ..................................................................................... 88
Assign a transition expression .......................................................................................... 88
Remove a step from an SFC ............................................................................................. 89
Create material loops ......................................................................................................... 89
Recipe comments ............................................................................................................... 90
Add comments to an SFC ........................................................................................ 91
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
Table of contents
Associate recipe comments ....................................................................................... 92
Disassociate recipe comments .......................................................................... 92
Delete recipe comments ............................................................................................ 93
Chapter 6
Build a table
Insert steps into a table ...................................................................................................... 95
Add a parallel step to a table............................................................................................. 96
Add a step before and after parallel steps....................................................................... 97
Define a step ........................................................................................................................ 97
Remove a step from a table ............................................................................................... 98
Chapter 7
Bind Expressions
Expression operators expanded ..................................................................................... 100
Expression data types ............................................................................................... 100
Operands .................................................................................................................... 101
Expression validation....................................................................................................... 101
Chapter 8
Phase, operation
sequence, and recipe
parameters
Phase parameters .............................................................................................................. 103
Operation sequence parameters .................................................................................... 104
Recipe parameters ............................................................................................................ 104
Defer parameters ...................................................................................................... 105
Step formula values and phase report limits ............................................................... 106
Material recipe parameters ..................................................................................... 107
Material report parameters ..................................................................................... 109
Formula Value Entry/Report Expression settings ............................................. 109
Assign parameter values and phase report limits........................................................ 112
Assign formula values to Timer steps ................................................................... 114
Recipe properties .............................................................................................................. 115
Parameters.................................................................................................................. 116
Assign recipe formula parameters ................................................................. 116
Reports ....................................................................................................................... 117
Assign report parameters ................................................................................ 117
Aggregate report values ........................................................................................... 119
Chapter 9
Expressions in
parameters and
reports
Evaluation of recipe parameter expressions ................................................................ 122
Validation of parameters with expressions .......................................................... 122
Calculated recipe parameter expression value override .................................... 123
Evaluation of report parameter expressions ................................................................ 123
Override a calculated report expression ............................................................... 123
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
5
Table of contents
Expression value configurations .................................................................................... 124
Configure expression values in recipe and report parameters ......................... 124
Expression operators ........................................................................................ 127
Parameter expression functions ..................................................................... 127
Chapter 10
Phase link groups
Message partners............................................................................................................... 130
Application of message partners example ............................................................ 130
Link group rules................................................................................................................ 131
Phase communication ..................................................................................................... 132
Create a phase link group ............................................................................................... 132
Delete a phase link group ................................................................................................ 133
Chapter 11
Recipe approval
process overview
Configure recipe approval .............................................................................................. 136
Approve a recipe ............................................................................................................... 137
Revert a recipe approval .................................................................................................. 139
Automatic system signoff ($System) ............................................................................ 141
Chapter 12
Recipe versioning
overview
Recipe versioning.............................................................................................................. 144
How recipe versions are named ..................................................................................... 144
Restrictions for recipe versions ...................................................................................... 146
Enable recipe versioning option .................................................................................... 147
Disable recipe versioning option ................................................................................... 147
Create a recipe version..................................................................................................... 148
Recipe version control ..................................................................................................... 148
Recipe version history .............................................................................................. 151
Obsoleted recipe versions ....................................................................................... 152
Author recipes using version control and recipe approvals...................................... 153
Chapter 13
Security authority
overview
Security authority configuration ................................................................................... 158
Secure recipe ...................................................................................................................... 159
Chapter 14
Complete and
maintain recipe
6
Verify recipe....................................................................................................................... 161
What gets verified? ................................................................................................... 162
SFC validation .................................................................................................................. 163
Run SFC validation ................................................................................................. 164
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
Table of contents
Set allowable SFC permutations ........................................................................... 165
SFC validation error types ...................................................................................... 166
Parallel activation of a linear segment .......................................................... 167
Unreachable terminal step .............................................................................. 168
Parallelism with terminal step ........................................................................ 169
Linear segment cannot reach terminal step................................................. 170
Unreachable linear segment ........................................................................... 171
Release Recipe as Step option ........................................................................................ 172
Release a recipe to production option .......................................................................... 172
Rebuild the recipe directory ........................................................................................... 173
Recipe maintenance ......................................................................................................... 173
Find Recipe References overview .......................................................................... 174
Find recipe references ...................................................................................... 174
Page setup................................................................................................................... 176
Generate reports option .......................................................................................... 176
Print a working set of recipes ......................................................................... 177
Print a single recipe .......................................................................................... 179
Remove a recipe ........................................................................................................ 180
Translation ........................................................................................................................ 181
Chapter 15
Import and export
recipes
Import recipes ................................................................................................................... 183
Select a directory ....................................................................................................... 186
Select a SQL Server database .................................................................................. 187
Export recipes.................................................................................................................... 188
Import conflicts ................................................................................................................ 189
Resolve duplicate name conflict ............................................................................ 190
Resolve recipe basename conflict .......................................................................... 190
Resolve recipe version conflict ............................................................................... 191
Resolve recipe conflict when rebuilding the recipe directory .......................... 192
Import and export restrictions for secured recipes .................................................... 192
Appendix A
Recipe formats
RDB format ....................................................................................................................... 195
Create the MasterRecipes database....................................................................... 196
XML format ...................................................................................................................... 197
XML recipe schema ......................................................................................................... 197
Set recipe file format ........................................................................................................ 198
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
7
Table of contents
Appendix B
Import/Export error
issues
Legal Notices
Improperly secured recipe ineligible for selection...................................................... 201
Verification results for a versioned recipe.................................................................... 202
Solutions for common verification warnings and errors .................................. 202
Modify the area model to reinstate an obsolete procedure example ...... 203
Use Check Out and Redefine Step to remove an area model conflict
example ............................................................................................................... 204
Invalid recipe folder or directory path warning ......................................................... 205
Legal Notices ..................................................................................................................... 207
Index
8
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
Chapter 1
FactoryTalk Batch Recipe Editor
introduction
Use FactoryTalk Batch Recipe Editor to create and configure master recipes for
use in batch automation. A master recipe is a type of recipe that accounts for
equipment capabilities and may include process cell-specific information.
The interface contains 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.
Procedural levels:
Recipes use the ISA S88.01 Batch Control Standards for configuration and
display, which define these levels for the procedural model:
•
Batch control: Consists of a sequence of one or more steps (phases) that
must be performed in a defined order for a finite period of time to process
finite quantities of input material to produce finished product.
•
Procedure: The strategy for carrying out a process. In general, it refers to
the strategy for making a batch within a process cell. It may refer to a process
that does not result in the production of a product.
Examples:
•
Make Product B
Unit Procedure: A strategy for carrying out a contiguous process within a
unit. It consists of contiguous operations and the algorithm necessary for
the initiation, organization, and control of those operations.
Examples:
•
Make Product A
Emulsification
Dehydrogenation
Operation: A procedural element defining an independent processing
activity consisting of the algorithm necessary for the initiation,
organization, and control of phases.
Examples:
Filtration
Reaction
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
9
Chapter 1
FactoryTalk Batch Recipe Editor introduction
•
Phase: The lowest level of the procedural element in the procedural control
model. A phase consists of the control steps and the algorithm necessary for
the initiation, organization, and control of those steps.
Examples:
Agitate
Heat
The recipe phase is the lowest level within a recipe. The phase provides an
interface to basic control. The recipe phase maps directly to the engineered logic
on the plant floor. Base an added phase on a phase already defined in the area
model using the FactoryTalk Batch Equipment Editor. Based on the unit
requirements specified in the recipe, a phase in the FactoryTalk Batch Equipment
Editor maps to a specific phase (an instance of a phase class). This phase is mapped
(using tags) to equipment phase defined in the engineered logic.
An operation consists of one or more recipe phases, and it must run within a single
unit in the area model. Combine multiple operations into a single unit procedure
if each operation runs in the same unit in the area model. Unit procedures
combine to create a procedure, the highest recipe level. Procedures can run across
multiple units, allowing for unit-to-unit transfers.
See also
Open FactoryTalk Batch Recipe Editor on page 11
Set FactoryTalk Batch Recipe Editor options on page 12
FactoryTalk Batch Recipe Editor interface on page 13
Recipe creation overview on page 18
10
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
Chapter 1
FactoryTalk Batch Recipe Editor introduction
Open FactoryTalk
Batch Recipe Editor
Follow these instructions to open the FactoryTalk Batch Recipe Editor.
To open FactoryTalk Batch Recipe Editor:
1. Select Start, navigate to All Programs > Rockwell Software > FactoryTalk
Batch Suite > FactoryTalk Batch, and then select Recipe Editor.
2. If the Log on to FactoryTalk dialog box opens, enter the user name and
password and select OK.
Tip:
If SingleSignOn is configured, the Log On to FactoryTalk dialog
box does not open. Proceed to step 5.
3. If the FactoryTalk user name and password that is not configured to run the
FactoryTalk Batch Recipe Editor, this message opens.
4. If the user is not found, a Logon Message opens. Select OK to close this
message, check the user credentials, and retry or enter other credentials.
5. 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 current FactoryTalk Network Directory, this error message
opens:
Make note of the FactoryTalk Network Directory and host computer
information, then select OK to close the error message and exit the
FactoryTalk Batch Recipe Editor.
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
11
Chapter 1
FactoryTalk Batch Recipe Editor introduction
6. If the recipe directory defined in the FactoryTalk Batch Equipment Editor
contains binary recipes from a previous version of FactoryTalk Batch, a
dialog box opens to translate the recipes to the new schema. After
translation, verify the recipes.
Tip:
If upgrading from a FactoryTalk Batch version older than the previous
major release (such as from version 10.x or earlier to version 12.x),
contact the Rockwell Customer Support Representative to have
recipes upgraded to the new recipe schema.
7. The Recipes Requiring Verification dialog box may open when the
FactoryTalk Batch Recipe Editor opens. Select Verify All to verify any
unverified recipes. Select Verify and Validate All to verify and validate the
SFCs of any unverified recipes.
Important:
FactoryTalk users with ViewOnly permissions to the
FactoryTalk Batch Recipe Editor cannot open the FactoryTalk
Batch Recipe Editor to verify recipes. The FactoryTalk Batch
Recipe Editor closes.
The FactoryTalk Batch Recipe Editor displays the Procedure View and Recipe
Construction panes.
See also
Set FactoryTalk Batch Recipe Editor options on page 12
Set FactoryTalk
Batch Recipe Editor
options
Configure the general FactoryTalk Batch Recipe Editor options, such as
enabling/disabling support for dynamic unit allocation and parallel operations, as
well as configuring the pane size in the FactoryTalk Batch Recipe Editor window.
Selected options apply to all recipes saved after the options are applied.
Tips:
FactoryTalk Batch procedures can have parallel unit procedures and
operations can have parallel equipment phases, regardless of this options
setting.
To refer to the area model, open the FactoryTalk Batch Equipment Editor.
To set FactoryTalk Batch Recipe Editor options:
1. Select View > Options. The Options dialog box opens.
2. Set the FactoryTalk Batch Recipe Editor options as required.
12
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
Chapter 1
FactoryTalk Batch Recipe Editor introduction
3. Select Apply to save selections.
These options are available in the Options dialog box:
Item
Description
Support Dynamic
Unit Allocation
Dynamic unit allocation enables the creation of Unit
Class-based recipes with specific unit requirements (such
as downstream unit requirements) and allows the choice
of unit binding type to apply. If selected, the Procedure Unit Requirements dialog box displays. The Unit
Requirement menu selection becomes active in a
procedure, and the dialog for defining a step includes a
unit requirement selection.
Allow Parallel
Operations
Select this option to allow the creation of AND
convergences and divergences, which allow operations to
run simultaneously within unit procedures.
Font Size
Set the font size for text displayed in the procedure view
outline (left frame). The default is 7 points.
Number of Decimal
Places for the Display
Parameter
This option adjusts the number of decimal places
displayed for real numbers in the SFC View. This value
defaults to 2.
The actual value of the parameter is unaltered. Only the
number displayed in the FactoryTalk Batch Recipe Editor
in the SFC View is affected.
Maximum SFC
Permutations
The maximum number of SFC permutations (caused by
OR Divergences within a recipe) that the SFC Validation
Tool allows. Recipes structures exceeding this limit are
too complex to verify. Please note that the higher this
setting, the longer SFC validation takes.
See also
FactoryTalk Batch Recipe Editor interface on page 13
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
13
Chapter 1
FactoryTalk Batch Recipe Editor introduction
FactoryTalk Batch
Recipe Editor
interface
The FactoryTalk Batch Recipe Editor interface provides a workspace and tools to
graphically construct recipes and specify a sequence of phases in an operation.
Configure the actual phase logic in the process-connected device (PCD).
Configure the interface to the PCD in the FactoryTalk Batch Equipment Editor.
The Procedure View Pane contains a hierarchical list of the current recipe
components. Selecting a component from the list highlights the corresponding
step in the Recipe Construction pane.
Tip:
To resize the panes in the FactoryTalk Batch Recipe Editor, select
and drag the splitter bar between the two panes to the desired size.
The Recipe Construction pane provides a way to construct and view recipe
structures using a sequential function chart (SFC) or a table. The SFC view and
the Table view display exclusively. Tile the Recipe Construction pane to display
both views at the same time. Selecting a component within either view highlights
the corresponding item in the Procedure View pane.
Tip:
14
When using tiled views, selecting a recipe step in one view
highlights the corresponding item in the other view. The
selected step in the active view highlights in dark blue. The
step in the inactive view highlights in light blue. Additionally,
the status bar displays the word Table or SFC accordingly.
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
Chapter 1
FactoryTalk Batch Recipe Editor introduction
See also
FactoryTalk Batch Recipe Editor menu bar on page 15
FactoryTalk Batch Recipe Editor
toolbar on page 16
Recipe construction toolbox on page 17
FactoryTalk Batch
Recipe Editor menu
bar
Opened recipe menu bar commands:
Item
Description
File
Lists options for creating new recipes (New Top Level), open existing
recipes (Open Top Level), close recipes, and save recipes.
Use the File menu to create recipe versions (Check In),
work-in-progress (WIP) copies (Check Out), remove recipes, rebuild
the recipe directory, verify recipes, validate SFCs, import recipes, and
export recipes.
Secure an open recipe using Security Authority.
The Page Setup (printer/paper choices), Generate Reports (print
options), and Exit commands available from the File menu.
Edit
Select, add, or remove a recipe step within the SFC View and Table
View.
Select, add, or remove transitions, links, and material loops within the
SFC View.
The Edit menu contains the option to add, link, or delete recipe
comments (Text Box). These commands are also available in the
Recipe Construction Toolbox.
Recipe
Enter or view recipe header information, view recipe version parent
information, approve or revert recipe approvals, add/delete recipe
formula parameters and reports, edit unit/bind requirements, set bind
preferences, and verify recipes.
Step
Allows redefine, enter formula values, parameter values, and report
limits for a selected step.
Link
Create, edit, and delete phase link groups.
Format
Modify the magnification of the SFC view and align SFC elements to a
grid.
View
Switch between the SFC View, Table View, or to tile the Recipe
Construction Pane for displaying both views.
Customize the FactoryTalk Batch Recipe Editor by hiding/showing the
Toolbar, Status Bar, and recipe construction Toolbox.
Additionally, it allows show/hide the page boundaries and set the
FactoryTalk Batch Recipe Editor options:
• Supporting dynamic unit allocation
• Parallel operations
• Formula parameter decimal places
• Maximum number of SFC validation OR permutations
Help
Provides online help and information about FactoryTalk Batch.
See also
FactoryTalk Batch Recipe Editor interface on page 13
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
15
Chapter 1
FactoryTalk Batch Recipe Editor introduction
FactoryTalk Batch
Recipe Editor toolbar
The FactoryTalk Batch Recipe Editor toolbar contains buttons used to perform
FactoryTalk Batch Recipe Editor commands. Repositioned or detached the
toolbar from the window by selecting and dragging it to the desired position.
When the toolbar is detached from the window, moved or hide by right-clicking it
and selecting Hide or Move from the shortcut menu.
This table describes the FactoryTalk Batch Recipe Editor toolbar buttons and
their corresponding keyboard shortcuts:
Graphic
Name
Description
Keyboard
Shortcut
New Top Level
Creates a new procedure, unit procedure,
or operation.
Ctrl+N
Open Top Level Opens an existing recipe file.
Ctrl+O
Save
Saves the current recipe.
Ctrl+S
Check In
Check in and version the recipe element
(create a recipe version).
None
Check Out
Check out the versioned recipe to edit
(create a work-in-progress (WIP) copy).
None
Generate
Reports
Opens the Generate Reports dialog box
for printing and reporting options.
Ctrl+T
Delete Selection Deletes the currently selected steps,
transitions, or text boxes.
Delete
Go Down
Moves down through the recipe levels and
displays the related recipe structure for the
step.
None
Go Up
Moves up through the recipe levels and
displays the related recipe structure for the
step.
None
Header Data
Enter or change header data for the viewed Ctrl+H
recipe level, including the name.
Version History
View information for the currently open
recipe and its previous version.
Recipe Formula Create, edit, and delete recipe formula
Parameters
parameters.
16
None
Ctrl+R
Verify
Verifies recipes for proper construction and Ctrl+L
displays a list of unresolved problems with
a recipe. Also saves the recipe in the
process.
Verify and
Validate
Verifies recipes based on the current unit
requirements and validates the SFC
structure. Also saves the recipe in the
process.
Ctrl+N
Bind
Requirements
Add or delete binding requirements
assigned to a unit requirement. Available
only with enabled Dynamic Unit Allocation.
Ctrl+M
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
Chapter 1
FactoryTalk Batch Recipe Editor introduction
Graphic
Name
Description
Keyboard
Shortcut
Bind
Preferences
Add, delete, and prioritize unit requirement
binding requirements. Available only with
enabled Dynamic Unit Allocation.
Ctrl+B
Redefine Step
Change the unit procedure, operation, or
phase for the selected step.
Ctrl+I
Value Entry
Enter formula values and modify the phase Ctrl+A
report limits for the selected step.
Zoom
Specify the magnification of the current
SFC display.
Grid Snap
Displays a grid in the Recipe
Ctrl+G
Construction pane, and aligns elements of
the SFC to the grid when moved in the
Recipe Construction pane.
Invoke
Equipment
Editor
Opens the FactoryTalk Batch Equipment
Editor.
None
View as Table
Displays the Table View within the Recipe
Construction pane.
Shift+Q
View a SFC
Displays the SFC View within the Recipe
Construction pane.
Shift+C
Tile Views
Displays the Table View and the SFC
View within the Recipe Construction
pane.
Shift+Z
Show/Hide
Page
Boundaries
Displays the recipe print layout in the SFC
View.
None
None
See also
FactoryTalk Batch Recipe Editor interface on page 13
Recipe construction
toolbox
The Recipe Construction toolbox contains the command buttons for creating and
editing steps, transitions, text boxes, and links in the recipe construction pane.
Reposition or detach the toolbox from the window by selecting and dragging it to
the desired position. When the toolbox is detached from the window, move or
hide it. Right-click the toolbox and select the appropriate option from the
shortcut menu. Press Ctrl+Q to add or remove the toolbox from the FactoryTalk
Batch Recipe Editor window.
The toolbox command buttons and the keyboard shortcut keys:
Graphic
Name
Description
Selection Tool
Selects a step in the Procedure View pane, Table view, Shift+P
or SFC view. Select transitions in the SFC view. Select
and drag the selection pointer over several SFC
elements to select a group of elements.
Step Tool
Adds a new step to the SFC.
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
Keyboard
Shortcut
Shift+S
17
Chapter 1
FactoryTalk Batch Recipe Editor introduction
Graphic
Name
Description
Keyboard
Shortcut
Transition Tool
Adds a new transition to the SFC.
Shift+T
Link Tool
Links recipe components in the SFC view. Select a step
and drag the cursor from the step to a transition to link
the two components.
Shift+L
Remove Link
Tool
Unlinks recipe components in the SFC view. Select a
step and drag the cursor from the step to a transition to
unlink the two components.
Shift+R
Text Box Tool
Adds a text box for recipe comments.
Shift+D
Add Step
Adds a step and transition after the selected recipe
Shift+A
element. The Add Step tool is valid for initial, sequential,
and parallel steps, as well as transitions.
Insert Step
Inserts a step and transition before the selected recipe
element. The Insert Step tool is valid for sequential,
parallel, and terminal steps, as well as transitions.
Shift+I
Shift+Insert
Add Parallel
Adds a step in parallel with the selected step. The Add
Parallel tool is valid for sequential and parallel steps
only.
Shift+E
Add Branch
Adds a step and additional transitions to form a branch
structure. The Add Branch tool is valid for regular steps
only.
Shift+B
Remove Step
Removes a step from the SFC structure, automatically
removing the transitions and rearranging the SFC. The
Remove Step tool is valid for sequential and parallel
steps only.
Shift+M
Insert Step
Before Parallel
Inserts a step before a parallel structure. Select a step
within the parallel structure to enable the tool.
Shift+O
Add Step After
Parallel
Adds a step after a parallel structure. Select a step within Shift+F
the parallel structure to enable the tool.
Create Material
Loop
Creates a material loop for the selected material enabled Shift+N
step. The step must have the preceding and following
elements attached before creating the material loop.
Undo Material
Loop
Removes a material loop just created, before any other
editing takes place.
Shift+X
See also
FactoryTalk Batch Recipe Editor interface on page 13
Recipe creation
overview
A common best practice is to design a recipe top-down and build it bottom-up,
focusing on high-level procedures that accurately depict the process used to make
the product. In determining where to segment the process into Unit Procedures
and Operations, consider breaking the process into reusable modules.
Each recipe level consists of descriptive information, formula information, unit
requirements, and the required processes to make the batch. A batch is a running
control recipe. The material that is being produced or that has been produced by a
single execution of a recipe is also considered a batch.
18
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
Chapter 1
FactoryTalk Batch Recipe Editor introduction
A parameter is used to allow for flexibility in the recipe creation process.
Parameter values are used in transition conditions or for substitution of phase
parameters. A parameter is created for these recipe levels: operation, unit
procedure or procedure. Values are assigned when a unit procedure or operation
step is added to a recipe. A recipe parameter is specific to a recipe and is on the
recipe phase and downloaded to the equipment phase at runtime.
A phase link group identifies phases that may communicate and work together.
The processes involved in building a recipe:
Recipe Creation
For recipe creation:
•
Determine the procedure levels.
•
Specify unit requirements.
•
Enter recipe header data.
•
Define recipe parameters.
•
Save the recipe.
Tip:
After creating a new blank recipe, build the recipe structure by adding and
configuring recipe steps and transitions. Represent the recipe structure using a
SFC (sequential function chart), a table, or both. (See Build a Sequential
Function Chart or Build a Table for more information.)
SFC or Table Creation and Configuration
For SFC or Table creation and configuration:
•
Create a sequential function chart or table.
•
Define the steps.
•
Configure the step parameters.
•
Define the transitions (SFC only).
•
Create phase link groups.
Recipe Completion
To complete recipe creation:
•
Verify the recipe and correct errors.
•
(optional) Create a version of the recipe to set it to read-only and protect it
from further modification.
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
19
Chapter 1
FactoryTalk Batch Recipe Editor introduction
•
•
(optional) Complete the Recipe Approvals process, either in conjunction
with the recipe version process, or on its own.
•
Set the recipe property Release recipe as step to true, or signoff on it
using the approval process.
•
Set the recipe property Release recipe to production to true, or signoff
on it by using the approval process.
(optional) Secure the recipe using Security Authority. When secured, the
recipe is bound to the Security Authority Identifier in the current
FactoryTalk Network Directory. Afterwards, the same FactoryTalk
Network Directory opens the recipe.
Recipe Maintenance
For recipe maintenance:
•
Find recipe references.
•
Create additional recipe versions, or work-in-progress (WIP) copies of a
versioned recipe, to handle modifications to the area model, or changes to
process and formula requirements.
•
Print the recipe documentation.
•
Remove a recipe file.
•
Translate recipes.
See also
Build a Sequential Function Chart on page 79
Build a Table on page 95
Find Recipe References overview on page 174
Additional
resources
20
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.
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
Chapter 1
FactoryTalk Batch Recipe Editor introduction
Resource
Description
FactoryTalk Batch Equipment Editor
User Guide
The FactoryTalk Batch Equipment
Editor is a graphical interface used to
create and maintain an equipment
database. This process equipment
database is called an area model. The
area model is stored in a file with a .cfg
file extension and is available to all
other FactoryTalk Batch programs,
including the Recipe Editor, View, and
Phase Simulator.
FactoryTalk Batch Components
Upgrade and Installation Guide
Provides information and procedures
needed for installing FactoryTalk®
Material Manager.
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 Recipe Editor User Guide - February 2017
21
Chapter 2
Sequential Function Chart overview
In the FactoryTalk Batch Recipe Editor, create a sequential function chart (SFC)
to represent the recipe logic flow. SFC provides a more flexible alternative to
creating recipes. SFC methodologies define each recipe procedure and equipment.
Benefits of SFC:
•
Unambiguous representation of logic.
•
Support for all important logic structures: decisions, loops, and parallelism.
•
Standardized in IEC 61131-3 specification.
See also
SFC components on page 23
Steps on page 24
Transition expressions on page 25
SFC limitations on page 30
SFC execution on page 31
SFC components
Sequential function charts are composed of six graphical structures linked to form
a chart. Each of the graphical structures represents an element in the recipe. The
rules for execution of an SFC describe how the procedure executes. The table
describes each recipe element and the graphical structure used in the SFC.
Step
Purpose
Initial Step
The logical start of the SFC.
Step
A reference to a subordinate recipe
element.
Final Step
The logical end of the SFC.
Transition
Defines how recipe control moves
from step to step.
OR Divergence
Represents a decision, where recipe
control passes to only one of the
subsequent steps.
Example
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
23
Chapter 2
Sequential Function Chart overview
Step
Purpose
Example
AND Divergence
Represents multiple procedures
processed concurrently.
OR Convergence
Indicates where two optional
execution paths converge back into
one execution path.
AND Convergence
Indicates where two simultaneous
execution paths converge back into
one execution path.
See also
Sequential Function Chart overview on page 23
A recipe can contain up to four procedure levels:
SFC steps
•
Procedure
•
Unit Procedure
•
Operation
•
Phase
Each of the first three procedure levels can contain one or more steps, each
referencing a lower level procedure. A step in a procedure references a unit
procedure. A step in a unit procedure references an operation. And a step in an
operation references a phase. Define phases in the area model using the
FactoryTalk Batch Equipment Editor. A phase is a specific instance of a phase
class. The phase maps to the equipment phase, which is the engineered logic
residing in the process-connected device (PCD).
This diagram depicts the relationships between the recipe procedure levels and the
phase logic in the PCD. Equipment phases and phases are the links between the
recipe and the engineered logic.
FactoryTalk Batch Recipe Editor
Procedure
24
Unit
Procedure
Operation
FactoryTalk Batch
Equipment Editor
Process-Connected
Device
Phase
Class
Equipment
Operation/Phase
Phase
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
Chapter 2
Sequential Function Chart overview
See also
SFC components on page 23
Transition
expressions
Transitions are the criteria that must be met before the recipe continues to the
next logical step. Transition expressions are evaluated for syntax at the time they
are created and are designated in the SFC with the name Tn, where n represents a
unique number. The expression associated with each transition follows the
traditional expression evaluation for the arithmetic operators (+, -, *, and /), the
logical operators (AND, OR, and NOT), and the functions (ABS, MOD, TRUN,
RND, and RDUP). The expression must always evaluate to either TRUE or
FALSE.
Tip:
The maximum length of a transition expression is 1023 characters. If the
transition expression exceeds this limit, reorganize the parallel steps in the
recipe.
Transition Identifiers
Example
TRUE
Evaluates to non-zero
FALSE
Evaluates to zero (0)
<unit>.<unit tag>
<unit> represents one of the pre-configured
units, and <unit tag> is a legal tag for the
<unit>
PREMIX_A.L101
<unit class>.<tag class>
PREMIX.LEVEL
For class-based recipes, specify the name of
the <unit class> and an associated <tag
class>
<step name>.<step attribute>
<step name> is the name of one of the steps
in the same level of the recipe
<step attribute> is one of the following:
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
25
Chapter 2
Sequential Function Chart overview
FAILURE
The FAILURE attribute is zero if no error
has been encountered. Otherwise, its
value is greater than zero.
XFR_OUT_1:1.FAILURE = 0
OWNERID
The OWNERID attribute can be either
PROGRAM or EXTERNAL, where
PROGRAM signifies the batch is
controlling the step and EXTERNAL
means that the batch is not controlling the
step.
XFR_OUT_1:1.OWNERID = PROGRAM
PAUSE
XFR_OUT_1:1.PAUSE = TRUE
Set by the FactoryTalk Batch Server. Used
to command the phase to pause at the
next programmed pause transition. Can
have the value of TRUE or FALSE.
PAUSED
Set by phase logic when the phase
reaches a pause location. Can have the
value of TRUE or FALSE
XFR_OUT_1:1.PAUSED = FALSE
SINGLESTEP
Set by the FactoryTalk Batch Server.
Allows the phase to pause at each
location. Can have the value of TRUE or
FALSE
XFR_OUT_1:1.SINGLESTEP= TRUE
STATE
Legal STATE identifiers are: ABORTING,
HOLDING, STOPPING, STARTING,
RESTARTING, RUNNING, HELD,
COMPLETE, STOPPED, ABORTED,
IDLE, and READY
XFR_OUT_1:1.STATE = COMPLETE
STEPINDEX
An integer which represents the current
step index of the active phase.
XFR_OUT_1:1.STEPINDEX= 10
<step name>.<report parameter>
If the step represents a recipe level, phase,
or operation sequence, it may have report
parameters. Report parameters contain
values of tags written from a PCD/phase to
FactoryTalk Batch.
XFR_OUT_1:1.AMOUNT_TRANSFERRED
<step name>.<recipe formula parameter> XFR_OUT_1:1.AMOUNT_TO_TRANSFER
Recipe formula parameters for a step contain
the values for the recipe level, phase, or
operation sequence represented by the step.
<recipe formula parameter>
Each level of the recipe may have recipe
formula parameters. The values for these
parameters may be found in higher levels of
the recipe.
AMOUNT_TO_TRANSFER
See also
Sequential Function Chart overview on page 23
26
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
Chapter 2
Sequential Function Chart overview
Transition operators
Transition expressions support these operators. The precedence of the execution
depicts from highest to lowest. An operator with a higher precedence executes
before an operator of lower precedence.
Transition Operator
Description
()
Expressions within parentheses evaluates before
expressions outside of parentheses.
NOT, unary minus
Logical NOT user, and "-".
*, /, 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
Parameter expression functions on page 27
Sequential Function Charts overview on page 23
Parameter expression
functions
Functions determine how the expression parser handles Real and Integer data
types used in a parameter expression. This table lists available functions and their
behavior on positive and negative values:
Function
Description
Behavior:
Value
Behavior:
Result
RND( )
Round – Numeric values round
to the nearest integer.
6.7
6.5
6.3
-6.7
-6.5
-6.3
7
7
6
-7
-6
-6
RDUP( )
Round up – Numeric values
round to the next larger integer.
6.7
6.5
6.3
-6.7
-6.5
-6.3
7
7
7
-6
-6
-6
TRNC( )
Truncate – Retains only the
integer portion of the numeric
value.
6.7
6.5
6.3
-6.7
-6.5
-6.3
6
6
6
-6
-6
-6
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
27
Chapter 2
Sequential Function Chart overview
Function
Description
Behavior:
Value
Behavior:
Result
ABS( )
Absolute – Numeric values are
positive values.
For example, if the Real or
Integer is 6.7, there is no effect.
If the Real or Integer is -6.7, it
multiplied by -1 and is 6.7.
6
6.7
-6
-6.7
6.7
6
6.7
Modulo – Returns the modulo,
or remainder, of a division.
(Integers only)
7 MOD 6
1
MOD( )
See also
Transition operators on page 27
Data types
The data types supported are integer, real, string, and enumeration. The following
are 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.
Tip:
If the result of the expression is an Integer, the values used
to build the expression must be Integers — Real is not
compatible with an Integer. However, using division in an
expression always results in the value being a Real number.
See also
Transition expressions on page 25
Sequential Function Charts overview on page 23
28
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
Chapter 2
Sequential Function Chart overview
Linked elements
Sequential function charts must follow a step-transition-step pattern to be valid; a
step links to a transition and a transition links to a step. Recipe elements link to
form a simple sequence (step-transition-step), or take any of these paths:
SFC Example #1
Decision logic (OR path) allows an SFC to flow in one direction or another
depending on the choice made by the transition statement. A single horizontal line
connects the two statements. Create the decision construct of an SFC by selecting
two parallel steps and connecting them to the step above them with two separate
transitions.
Parallel logic (AND path) allows more than one step to be active concurrently. A
double horizontal line connects the two statements. Create the parallel
construction of an SFC by selecting one transition and connecting it to two
parallel steps.
The double lines of a parallel structure do not count as either a step or a transition.
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
29
Chapter 2
Sequential Function Chart overview
SFC Example #2
Loop logic (REPEAT path) allows a process to flow from beginning to end and back
again to a previous step where it repeats the loop. Create the loop construction of an
SFC by joining a transition to a previous step.
The single lines of a decision branch do not count as either a step or a transition.
Tip:
To create a material rebinding loop, select a
material-enabled step and then select the Create
Material Loop tool
. Loop logic allows a process to
flow back to a previous step where it repeats the loop.
The system automatically includes a null procedure in
the material loop for rebinding.
See also
Recipe construction toolbox on page 17
Create material loops on page 89
Subarbitration on page 35
SFC limitations
Use the FactoryTalk Batch Recipe Editor to build an SFC of any size. For very
large procedures, divide into multiple procedures each with fewer steps.
The maximum length of a transition expression is 1023 characters. If the
transition expression exceeds this limit, reorganize the parallel steps in the recipe.
Important:
If a batch has more than nine material-enabled, class-based
phases running in parallel, the FactoryTalk Batch Server will
run out of memory and will not write any messages to the
Server log.
See also
Transition expressions on page 25
30
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
Chapter 2
Sequential Function Chart overview
SFC execution
This is an overview of SFC execution:
•
Step 1: Upon activation of this recipe, the initial step is active (indicated by
the step color).
•
Step 2: Control passes to Step A after Transition 1 becomes TRUE.
•
Step 3: After Transition 2 becomes TRUE, Step A deactivates and Steps B
and C become active.
•
Step 4: After Transition 3 becomes TRUE, Step B deactivates and Step D
activates.
•
Step 5: When Transition 4 becomes TRUE, Steps C and D deactivate and
Step E activates.
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
31
Chapter 2
Sequential Function Chart overview
•
Step 6: When Transition 5 becomes TRUE, Step E deactivates and the final
step activates. This indicates that the entire recipe is complete.
See also
SFC limitations on page 30
Null procedures
A null procedure contains no parameters and is not associated with a phase on the
plant floor. Use null procedures to follow the step-transition-step pattern in a
sequential function chart (SFC) and enable the SFC to do arbitration that is more
flexible. This creates otherwise impossible SFC structures, such as separating
consecutive transitions.
Add null procedures at the unit procedure, operation, and phase levels. Null
procedures automatically provided in the Unit Procedure Select, Operation
Select, and Select Phase dialog boxes; there is no need to create null phases in the
FactoryTalk Batch Equipment Editor.
See also
Synchronize execution of steps overview on page 32
Arbitration on page 33
Subarbitration on page 35
Add null procedures on page 36
32
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
Chapter 2
Sequential Function Chart overview
Synchronize execution
of steps overview
One powerful application of null procedures is to synchronize the execution of
steps. In this picture, the CHARGE_A_CLS:1 step and the CHARGE_B_CLS:1
step execute in parallel. The execution of the CHARGE_B_CLS:1 step is does
not occur until the CHARGE_A_CLS:1 step has already charged 1500 liters. To
accomplish this timing, place a null procedure at the beginning of the parallel
structure. A new transition creates before the CHARGE_B_CLS:1 step. This new
transition contains a transition condition that allows the CHARGE_B_CLS:1
step to execute only after the CHARGE_A_CLS:1 step has charged 1500 liters.
See also
Arbitration on page 33
Subarbitration on page 35
Add a null procedure on page 36
Arbitration
Use Null procedures are to regulate the arbitration of resources. A step cannot
release any allocated resources it owns until the transition after the step becomes
true. When this step is part of a parallel structure, a delay in releasing allocated
resources may occur while the step waits for the other steps within the parallel
structure to complete. Similarly, if the step is a shared phase, the phase is not be
released until the other parallel steps have completed.
This picture illustrates the arbitration problem that can occur in a parallel SFC
structure. If the AGITATE_PM_CLS:1 step is a shared phase, it is not released
until CHARGE_B_CLS:1 and HEAT_CLS:1 have completed. Similarly, if
AGITATE_PM_CLS:1 has acquired any shared resources, those resources are not
released until all steps within the parallel structure are complete.
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
33
Chapter 2
Sequential Function Chart overview
A shared resource is a resource used in parallel by an unlimited number of steps at
a time inside a recipe structure. Any other procedures waiting for resources owned
by AGITATE_PM_CLS:1 are forced to wait for those resources, even though the
resources may be available.
This picture illustrates the same parallel structure, using a null procedure to
correct the delay. The null phase inserts below the AGITATE_PM_CLS:1 step,
allowing a transition above the null phase. This transition allows the
AGITATE_PM_ CLS:1 step to complete, even if other phases within the parallel
structure have not, thereby releasing the phase if shared, and releasing any shared
resources.
See also
Subarbitration on page 35
34
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
Chapter 2
Sequential Function Chart overview
Subarbitration
Through the process of subarbitration, the FactoryTalk Batch Server determines
how dedicated resources within a recipe procedure allocate when there are
common resources requested at the same time. This can occur when a recipe with
a parallel structure has parallel steps that require the same dedicated resource. If
the parallel steps occur just after an AND Divergence or just before an AND
Convergence, must add null procedures in order to run batches successfully.
This image shows an AND Divergence of two parallel steps requesting the same
resource. This structure results in the batch HELD until the conflict is resolved
and the errors clear. Because both steps are requesting the same dedicated resource
at exactly the same time, the resource does not release to either one of them.
This image shows the same parallel structure with the addition of two null phases
after the AND Divergence. This changes the timing just enough to allow one side
to process before the other. The FactoryTalk Batch Server can then sub-arbitrate
the resources required for ADD_CREAM:1 and ADD_CREAM:2.
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
35
Chapter 2
Sequential Function Chart overview
This image shows an AND Convergence of two parallel steps requesting the same
dedicated resource. In this case, the recipe appears to continue running, but the
AGITATE:1 step will not release its resource. This prevents the AGITATE:2 step
from acquiring the resource. The batch will not progress to the convergence
transition.
This image shows the same parallel structure with the addition of two null
procedures before the AND Convergence. The Server can then release the
resources and transition past the convergence.
See also
Add a null procedure on page 36
36
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
Chapter 2
Sequential Function Chart overview
Add a null procedure
Add a null procedure instructions are similar to insert a step. The NULL option is
always available in the Unit Procedure Select, Operation Select, and Select
Phase dialog boxes.
To add a null procedure:
1. Using the Selection Tool, select a step or transition that either precedes or
follows the new step.
2. Select Insert Step to insert a new step before the selected element, or select
Add Step to insert a new step after the selected element. A new
UNDEFINED step displays on the SFC with a blue box outlined in a black
dashed line. Additionally, the SFC structure automatically rearranges to
make room for the new elements. One of these dialog boxes opens, based on
the recipe level: Select Phase, Operation Select, or Unit Procedure Select.
3. Select the $Null option.
4. Select OK.
See also
Insert steps into an SFC on page 79
Define a step on page 86
Timer steps
Use timer steps to create a step that causes a branch in a recipe to pause for a
specified period or to create a step that monitors the amount of time a parallel step
executes. The TIMER option is always available in the Unit Procedure Select,
Operation Select, and Select Phase dialog boxes.
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
37
Chapter 2
Sequential Function Chart overview
The two TIMER types have these parameters and reports:
Timer Type
Parameters
Reports
COUNT_DOWN
• TIMER_TYPE
• ELAPSED_TIME
• HOLD_BEHAVIOR
(CONTINUE, RETENTIVE,
and RESET)
• REMAINING_TIME
• SETPOINT
COUNT_UP
• TIMER_TYPE
ELAPSED_TIME
• HOLD_BEHAVIOR
(CONTINUE, RETENTIVE,
and RESET)
See also
Insert timer steps on page 80
Phase and recipe parameters on page 103
Timer step hold behavior on page 38
Timer step hold
behavior
When a Timer step restarts:
•
If configured the Timer as CONTINUE, the Timer step will continue
timing using the initial start time while in the HELD state. The Timer
procedure accumulates time in the RUNNING and HELD states based on
the initial start time.
•
If configured the Timer as RESET, the Timer step is set to restart timing
from 0.
•
If configured the Timer as RETENTIVE, upon entering the RUNNING
state, the timer will continue timing from the last known
ELAPSED_TIME value from when the timer went into HELD.
Once these actions are completed, the Timer procedure transitions to the
RUNNING state. If the Timer procedure cannot determine the type of hold
behavior configured, an error generates, causing the recipe to hold based on the
configured hold propagation.
See also
Timer steps on page 37
38
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
Chapter 2
Sequential Function Chart overview
Recipe comments
Use recipe comments to give written instructions to operators, share notes with
other engineers, or access a reference. Recipe commenting associates data with a
step, transition, or the entire recipe. The comment is viewable at design and at run
time.
The comment, and its associated information, is a text box. Above each text box,
the assigned reference name displays as a C followed by a number. View added
SFC text boxes in the SFC views of FactoryTalk Batch View, FactoryTalk
Procedure, and ActiveX Control.
See also
Sequential Function Chart overview on page 23
Recipe creation overview on page 18
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
39
Chapter 3
Table-based recipes overview
When you build a recipe in the FactoryTalk Batch Recipe Editor you can
represent the logic flow of the recipe using a sequential function chart (SFC) or a
table. Table-based recipes provide a mechanism for creating simple recipes that do
not require a complex recipe structure or complex transition expressions.
Additionally, they allow you to view and edit all recipe parameters without having
to navigate between steps.The logic flow of the recipe is represented using a
sequential function chart (SFC) or a table. Table-based recipes provide a
mechanism for creating simple recipes that do not require a complex recipe
structure or complex transition expressions. Additionally, they allow viewing and
editing of all recipe parameters without having to navigate between steps.
Recipe structures created in the Table view provide a list-based representation of
recipe logic flow. Steps execute in order, starting with the top row, and proceeding
downward through the table. Each row consists of an individual phase and its
associated parameters. When selecting a phase row, the column headings show the
parameter names for that phase. When selecting a different phase, the column
headings change to reflect the selected phase parameters.
Steps are executed starting with row one, and proceeding downward until the end
of the recipe. Steps located within a single parallel structure execute at the same
time. Every step within the Table view displays the name of the Procedure, Unit
Procedure, Operation, or Phase represented by the step. All parameters associated
with the selected step display as the column header. The parameter value displays
below the parameter name and to the right of the step name. To edit parameter
values, select the table cell where the parameter displays and enter a new value (if
enumerations are created for the selected parameter, a list containing the
enumerations is provided).
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
41
Chapter 3
Table-based recipes overview
See also
Recipe structure icons on page 42
Assign recipe formula parameters on page 116
Recipe structure
icons
The Table view provides a graphical representation of a recipe structure in the
form of a structure icon. The Table view is only capable of displaying the
graphical recipe structure for simple recipes. Simple recipes are recipes that do not
have complex recipe structures such as loops and branches. Simple recipes only
have simple parallel structures. No structure icon displays for complex recipe
structures viewed in the Table view.
Every step within the Table view displays the name of the Procedure, Unit
Procedure, Operation, or Phase represented by the step.
The Table view can contain any of these recipe structure icons:
Graphic
Name
Description
Simple Step
Represents a single step within the recipe path.
Begin Parallel
Step
Represents the first step in a parallel structure
containing multiple steps.
Parallel Step
Represents the step located within a parallel
structure containing multiple steps.
End Parallel
Step
Represents the final step in a parallel structure
containing multiple steps.
See also
Table-based recipes overview on page 41
42
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
Chapter 3
Table-based recipes overview
Table view
transition
expressions
Each recipe step has an associated transition. Transitions designate criteria that
must be true before the recipe continues to the next logical step. The transition
expression must always evaluate to either TRUE or FALSE. Transitions generate
automatically for all table-based recipe steps when created. By default, all
table-based recipe transitions contain the transition expression <STEP>.STATE
= COMPLETE, where <STEP> is the step associated with the transition.
Tip:
Transition expressions cannot be edited using the
Table view. To edit a transition expression, use the
Transition Expression Builder dialog box in the SFC
view.
See also
Assign a transition expression on page 88
Table-based recipes overview on page 41
Parallel structures
The FactoryTalk Batch Recipe Editor allows creation of simple parallel structures
using the Table view. These structures can have multiple steps in parallel, but
cannot have more than one step located on the same path. That is, all steps located
within the parallel structure must be preceded by the same AND divergence and
followed by the same AND convergence.
More complex parallel structures created using the SFC view are considered
undetermined when viewed in the Table view. Recipe structure icons do not
display for the entire recipe level in which the parallel structure is located.
See also
Simple parallelism example on page 43
Complex parallelism example on page 44
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
43
Chapter 3
Table-based recipes overview
Simple parallelism
example
This table contains an example of a simple parallel structure displayed in the SFC
view and in the Table view.
SFC
View:
Table
View:
Tip:
If parallel steps require the same dedicated resource,
the FactoryTalk Batch Server automatically
determines how the resources allocate among steps
when the batch runs (called subarbitration). If parallel
steps occur just after an AND divergence or just
before an AND convergence, add null procedures to
the recipe in order for batches to run successfully.
See also
Parallel structures on page 43
44
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
Chapter 3
Table-based recipes overview
Complex parallelism
example
This table contains an example of a complex parallel structure created in the SFC
view and how that same structure displays in the Table view. Notice that there are
no recipe structure icons displayed for the entire recipe level in the Table view.
SFC
View:
Table
View:
See also
Parallel structures on page 43
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
45
Chapter 4
Recipe creation
Before building an SFC or Table structure to define the logical flow of a recipe,
first create the recipe in FactoryTalk. The recipe creation process includes:
•
Determine the recipe level
•
Specify unit requirements
•
Define recipe formula parameters
•
Enter recipe header data
See also
Procedure levels on page 47
Unit requirements on page 48
Dynamic unit allocation on page 50
Open recipe on page 55
Create operations and unit procedures on page 58
Procedure levels
The first step in planning a new recipe is determining the level of the procedure. A
batch recipe may consist of up to four procedure levels. These levels follow the
S88.01 Procedural Model:
•
Procedure
•
Unit Procedure
•
Operation
•
Phase
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
47
Chapter 4
Recipe creation
Procedure-level recipes contain steps called unit procedures. Unit procedure-level
recipes contain steps called operations. Operation-level recipes contain steps called
phases. Because of this hierarchical structure of the S88.01 Procedural Model, plan
recipes from the top down, but build recipes from the bottom up. First, create the
operation, then create the unit procedure, and lastly create the procedure.
If a recipe is run as a single unit (no unit-to-unit transfers are involved), then
building a recipe as an operation may be adequate. If the recipe intends to operate
across multiple units, create a procedure containing a unit procedure for each unit
involved. Each unit procedure may consist of one or more operations.
To begin, have a good definition of what the recipe needs to do, then decide what
process levels are needed. Start by building the operations and configuring the
phases. Add the operations to the unit procedures, then add the unit procedures to
the top-level procedure.
Tip:
Every unit procedure must have at least one operation, and
every procedure must have at least one unit procedure.
See also
Unit requirements on page 48
Unit requirements
When initially building a recipe, define two things:
•
The procedure level: procedure, unit procedure, or operation.
•
The recipe unit requirements.
To properly define the recipe requirements, have a good understanding of the area
model, the equipment classes, and the actual equipment required for recipe
execution. If phases are material-enabled, know what materials and containers
needed for the recipe.
Prior to creating a recipe, determine if the recipe is unit-based, class-based, or a
combination of the two. If Dynamic Unit Allocation is enabled and the recipe is a
procedure containing some or all class-based unit procedure and operation level
recipes, choose a unit allocation method.
See also
Unit-based recipes on page 49
Unit class-based recipes on page 49
Material-based recipes on page 49
Material class-based recipes on page 50
48
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
Chapter 4
Recipe creation
Dynamic unit allocation on page 50
Unit-based recipes
A unit-based recipe includes information regarding the specific units used for the
recipe. During recipe creation, a unit-based recipe is required. Unit-based recipes
use static binding and are bound to a specific unit instance that defined in the area
model.
Also, unit-based recipes include information regarding the specific unit instances
used for the recipe. Define unit instances in the area model. During recipe
creation, the recipe author specifies the required unit instance. As a result,
unit-based recipes use a binding method called static binding. Static binding
means that the recipe can run in only one unit instance. At batch creation time,
unit-based recipes automatically bind to the specified unit instance.
See also
Unit requirements on page 48
Unit class-based
recipes
Create class-based recipes for a unit class rather than for a specific unit instance.
Class-based recipes are useful if a unit class contains many unit instances and a
particular recipe runs in most of those unit instances. The use of class-based
recipes reduces the number of recipes created and maintained. Create only one
recipe per unit class rather than one recipe for each unit instance. At batch
creation time, the operator assigns the specific unit instance in which the
class-based recipe runs, or FactoryTalk Batch Server availability determines
assignment of the unit.
When creating a recipe, the phases that are not common to all the unit instances
built from a particular unit class are available for selection. When adding a
non-common phase to the recipe, the FactoryTalk Batch Recipe Editor
automatically adds a Require Phase bind requirement to the unit requirements so
that only the units having the phase are selectable at run time.
Enabling Dynamic Unit Allocation on a procedure level class-based recipe allows
either the FactoryTalk Batch Server or the operator to select which unit instance
of the unit class to use for each class-based unit procedure contained in the
procedure. Select the unit instance either at batch creation or after the batch has
started, depending on the selected unit allocation method.
See also
Dynamic unit allocation on page 50
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
49
Chapter 4
Recipe creation
Material-based recipes
Material-based recipes contain steps that specify the materials needed to run the
recipe without requiring a definition of the equipment that is required to supply
those materials. Each phase in the FactoryTalk Batch Equipment Editor contains
configurations for material additions and distributions. Material-based recipes,
unit classes, and the FactoryTalk Batch Material Editor drastically reduced the
number of different recipes needed.
See also
Unit requirements on page 48
Material class-based
recipes
Material class-based recipes contain steps configured to utilize any of several
similar materials from a common class of materials. Configure material classes and
specific materials in the FactoryTalk Batch Material Editor.
A material-enabled phase is a phase configured by the FactoryTalk Batch
Equipment Editor and stored in the area model, which is enabled to support the
specification of a material as a means to find appropriate equipment and bind to
that equipment in a control recipe.
Configure material-enabled phases to be material class-based in the FactoryTalk
Batch Equipment Editor. In the FactoryTalk Batch Recipe Editor, insert these
material class-based phases into a recipe. When adding the recipe to the batch list
in the FactoryTalk Batch View, the operator selects a specific material from the
class of materials. Using material class-based recipes reduces the number of recipes
needed. In the FactoryTalk Batch Recipe Editor, create one recipe and change the
configuration of that recipe to be material class-based or material-specific.
See also
Unit requirements on page 48
Dynamic unit
allocation
Dynamic unit allocation is a method for binding specific units to class-based unit
procedure-level recipes that are contained within a procedure-level recipe.
Dynamic Unit Allocation allows different unit procedures with the same unit
requirements within the procedure. Define any downstream units required by
unit instances and unit classes.
Downstream unit requirements may be defined for class-based and instance-based
unit procedures. Downstream unit requirements are used to control batch flow
and to make sure that the appropriate unit is selected during unit-binding.
50
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
Chapter 4
Recipe creation
This is an example procedure-level PREMIX recipe:
See also
How dynamic unit allocation affects unit binding on page 51
Binding methods on page 52
Unit requirement name on page 53
Downstream unit requirements on page 54
Enable dynamic unit allocation on page 54
How dynamic unit
allocation affects unit
binding
When not enabling Dynamic Unit Allocation, allocate a unit to every unit
procedure contained within the procedure-level recipe during batch creation. (A
batch creates when it is on the batch list in the FactoryTalk Batch View or custom
HMI application.) This presents complications if this procedure-level recipe takes
thirty days to complete from the moment the first unit procedure is initiated until
the last unit procedure runs to completion. If some or all of the unit procedures
contained within the procedure are class-based, it may be difficult to predict, at
batch creation time, which units are available when needed.
Dynamic Unit Allocation solves this problem because it allows the bound unit to
be defined when the unit procedure is ready to run, rather than when the batch is
created. Late binding is postponing the unit definition until the unit procedure
requires it to run.
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
51
Chapter 4
Recipe creation
Late binding is a binding method where a step is bound to equipment just before it
is used.
•
For unit procedure steps (also called dynamic unit allocation), two types of
late unit binding are supported: First Available and Prompt binding.
•
For material phase steps, two types of late phase binding are supported:
Automatic and Prompt binding.
See also
Binding methods on page 52
Unit requirement name on page 53
Downstream unit requirements on page 54
Enable dynamic unit allocation on page 54
Binding methods
These four binding methods are options for class-based unit procedures:
•
At Batch Creation - The operator defines the units at batch creation. This
is similar to what occurs with disabled Dynamic Unit Allocation.
•
First Available - The FactoryTalk Batch Server assigns the unit for binding
when the unit procedure is ready to run (FactoryTalk Batch Server-defined
late binding).
Tip:
Once the unit binds using the First Available binding
method, the FactoryTalk Batch Server sorts through
Equipment ID numbers in ascending order and selects
the Equipment ID with the smallest ID number.
•
Prompt - The operator responds to a prompt to assign the unit for binding
when the unit procedure is ready to run (operator-defined late binding).
•
Operator Choice - When the batch creates, the operator can choose the
unit binding methods: At Batch Creation, First Available, or Prompt.
See also
Criteria for unit selection on page 52
52
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
Chapter 4
Recipe creation
Criteria for unit selection
When automatically selecting a unit for binding, the FactoryTalk Batch Server
tries to use the unit that the recipe can acquire first. The unit selected must meet
these criteria:
•
The acquired unit must belong to the unit class of the unit procedure step.
•
Recipes can configure upstream, downstream, or both upstream and
downstream dependencies that define a series of unit classes that a recipe
requires as a recipe executes. The acquired unit supports the flow path to
other units.
•
Recipes containing material phase steps impose additional requirements
when selecting a unit for binding:
•
The acquired unit must be capable of fulfilling the material
requirements of all material phase steps in the recipe to be run in that
unit.
•
Support any recipe to be run upstream or downstream flow path.
See also
Binding methods on page 52
Unit requirement name
A unit requirement name is a user-defined name assigned to a unit class with a
defined binding method. When creating the procedure-level recipe, the recipe
author assigns the appropriate unit requirement name to each unit procedure step
in the recipe. Assigning a unit requirement name solves potential complications
when using Dynamic Unit Allocation.
In the example PREMIX Procedure-level recipe, assume that both of these
class-based unit procedures have the PREMIX_A_CLS unit class assigned:
•
PREMIX_A
•
XFR_UP1_PREMIX
Additionally, there are five unit instances of the PREMIX_A_CLS unit class and
unit procedures, PREMIX_A and XFR_UP1_PREMIX that can bind to any of
the five unit instances. But they must bind to the same unit instance.
If the selected binding method is First Available, define a unit requirement name
for both unit procedures. This is so the Batch Server can bind both unit
procedures to the same unit instance.
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
53
Chapter 4
Recipe creation
For example, in the sample recipe, the recipe author must assign the same unit
requirement name to both unit procedures PREMIX_A and
XFR_UP1_PREMIX. This same unit requirement identifies to the Batch server
that whatever unit instance it binds to unit procedure PREMIX_A, it must also
bind to unit procedure XFR_UP1_PREMIX.
If implementing Unit Attribute Binding, the recipe author can further define the
binding requirements and preferences. The author can configure binding to units
meeting specific criteria, for example, warmest available unit, capacity restrictions,
or non-agitator units.
A procedure-level recipe can contain a mix of class-based unit procedures and
unit-specific unit procedures. If Dynamic Unit Allocation is enabled, all unit
procedures use a unit requirement name, even those that are unit-specific.
Therefore, assign a unit requirement name to a unit instance (rather than to a unit
class) and define the binding method as Static. Static binding means that any unit
procedure steps must always be bound to the specific unit identified for this unit
requirement name.
See also
Dynamic unit allocation on page 50
Downstream unit
requirements
A downstream unit is a unit that follows another specified unit during batch
execution. Downstream unit requirements mirror the linking of units represented
in the area model. Specifying required downstream units allows control of batch
flow and to make sure to select the appropriate unit during unit-binding.
Configure the area model and recipes as follows to enforce these flow paths:
•
Link the units in the area model using the FactoryTalk Batch Equipment
Editor.
•
Define downstream unit requirements in the recipe using the FactoryTalk
Batch Recipe Editor.
When these configurations are in place, the FactoryTalk Batch Server enforces
these flow paths when binding units to a class-based unit procedure or when
displaying a unit selection list to the operator for unit binding.
See also
Dynamic unit allocation on page 50
54
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
Chapter 4
Recipe creation
Enable dynamic unit
allocation
To use enable dynamic unit allocation enable it in FactoryTalk Batch Recipe
Editor.
To enable dynamic unit allocation:
1. From the View menu, select Options to display the Options dialog box.
2. Select Support Dynamic Unit Allocation.
3. Select Apply.
Important:
The allocation setting applies to ALL procedure-level
recipes created, edited, or saved.
See also
Dynamic unit allocation on page 50
Open recipe
Open existing recipes for viewing and editing from within the FactoryTalk Batch
Recipe Editor. Open entire recipe procedures, as well as individual operations or
unit procedures.
To open a recipe:
to display the Open [Type] Recipe dialog box, where
1. Select Open
[Type] is the recipe storage type (binary, XML, or RDB, configured in the
FactoryTalk Batch Equipment Editor Server Options dialog box).
2. From the Recipe Name list, double-click a recipe to open it, or select the
appropriate recipe and select Open.
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
55
Chapter 4
Recipe creation
Recipe header information for a selected recipe displays in the Recipe
Details tab.
In the Approvals Process area, examine the approval process state for each
selected recipe to see which recipes may require approval attention and
action.
In the Recipe Filter tab, set filters as desired to narrow the number of recipe
names. Multiple filters have an additive effect in narrowing the list shown.
For example, effectively search for recipes that require particular approval
step signoffs by setting the Step Name and the Step State filters.
56
Item
Available Selections
Recipe Type
All Procedures, Operation, Unit Procedure, or
Procedure.
Equipment Type
Select ALL to view recipes regardless of
equipment associations in the area model. To
limit the displayed recipes to those that use
particular equipment, select Unit Class or Unit.
Then select from the corresponding classes or
instances in the Class/Instance drop-down list.
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
Chapter 4
Recipe creation
Item
Available Selections
Class/Instance
Unit classes defined in the area model display
when Equipment Type is Unit Class. Similarly,
unit instances display when Equipment Type is
Unit.
Approval Process
Type
ALL, Primary Approval Process, or Expedited
Approval Process. If Recipe Approval Process is
disabled, this list along with Step Name and Step
State are unavailable.
Step Name
ALL, any defined step in the Primary approval
process, Release Recipe as Step, and Release
Recipe to Production (the latter two are the only
steps used for Expedited Approval).
Step State
ALL, Not Started, In Progress, Complete,
Reverting, and $System Signoff Pending (for
translated recipes).
Version Type
Versioned & Unversioned, ALL, and Obsoleted.
Basename
ALL, or any basename (name of the recipe
element without the ~V# or _WIP extension).
Obsoleted recipes display in the list, but the
obsoleted status is not visible from the recipe
name.
See also
Recipe header data on page 70
Cannot open recipe error message on page 57
Cannot open recipe
error message
If Security Authority is enabled for a recipe, and there is a mismatch between the
Security Authority Identifier (SAI) it contains and the SAI in the current
FactoryTalk Network Directory, this error message opens:
Make note of the FactoryTalk Network Directory host computer information,
then select OK to close the error message.
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
57
Chapter 4
Recipe creation
To recover the recipe, saved either as a backup of the FactoryTalk Network
Directory SAI or of the recipe in unsecured form:
•
Restore the FactoryTalk Network Directory SAI which secures the area
model. The name of the computer that hosts that SAI provides in the dialog
box. Use the FactoryTalk Administration Console to restore a saved backup
of the SAI. Then open the secured recipe.
•
Open an unsecured copy of the recipe if saved a copy of the recipe prior to
applying Security Authority.
See also
Open recipe on page 55
Create operations
and unit procedures
Define unit requirements for unit procedures and operations when creating the
recipe. Only indicate the specific unit instance or unit class used for this particular
recipe.
To create operations and unit procedures:
1. Select New
. The New dialog box opens.
2. Select Unit Procedure or Operation, and select OK. The Create Unit
Procedure or Create Operation dialog box opens.
3. Enter recipe information and select OK. Procedure Identifier is the only
required box. The Unit Requirement dialog box opens.
Item
Description
Procedure Identifier The unique name that displays when working with a recipe in the
FactoryTalk Batch View. It is also used as the file name when the
recipe is saved. Follow methodologies for assigning product
identification codes.
The Procedure Identifier can contain letters (A-Z), numbers (0-9),
and underscores ( _ ). For Procedures, the Procedure Identifier
can begin with either a letter or a number. For Unit Procedures
and Operations, it must begin with a letter.
Version Number
Legacy, user-set version number (not related to the Recipe
Versioning feature introduced in FactoryTalk Batch version 12).
Manually update this version number as desired.
Version Data
Defaults to today's date, cannot be changed.
Author
The name of the individual that created the recipe.
Product Code
A short label that uniquely identifies the product.
Procedure
Description
Product or process description at the procedure level. Indicate
whether this is a class-based recipe, or any other distinguishing
information required.
Procedure Abstract A summary or outline of the steps of the procedure.
Version Description Legacy, version description (not related to the Recipe Versioning
feature introduced in FactoryTalk Batch version 12).
58
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
Chapter 4
Recipe creation
4. Select either the Class Based or Instance Based unit requirement. The
Class Based group box shows the unit classes defined in the area model as
class-based. The Instance Based group box shows the unit instances defined
in the area model as unit-based.
If supporting Dynamic Unit Allocation, Bind Requirements and Bind
Preferences are enabled.
5. When binding materials, select either Inventory or Configuration. The
Factory Talk FactoryTalk Batch Server and Material Server determines the
appropriate set of binding candidates at runtime.
•
By Inventory: Containers assigned to a unit must have material in
them.
•
By Configuration: Containers assigned to a unit can have zero
quantity of material in them.
6. Choose either a Unit Class or Unit from the appropriate list.
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
59
Chapter 4
Recipe creation
7. Select OK to return to the Procedure View pane, which shows the default
procedure name (UNIT_PROCEDURE# or OPERATION#) on the
title bar. The SFC view contains the initial and final steps of the sequential
function chart, and the Table view contains a blank table header.
See also
Binding requirements on page 65
Insert steps into an SFC on page 79
Change operation/unit procedure unit requirements on page 60
Change operation/unit
procedure unit
requirements
Edit the unit requirements within a unit procedure or operation at any time.
To change operation/unit procedure unit requirements:
1. Select the appropriate recipe level. Double-click the unit procedure or
operation to edit. Make sure it displays in the Recipe Construction pane.
2. From the Recipe menu, select Unit Requirements. If not using the unit
procedure or operation in a higher level recipe, the appropriate Unit
Requirement dialog box opens.
3. Select Class Based or Instance Based and then determine the unit class or
unit instance from the appropriate list. If the unit procedure or operation
has been used in a higher level recipe, a warning message displays indicating
what higher level recipes needs to be modified the unit requirements are
changed. Select Proceed to updated affected recipes.
4. Select OK to return to the Procedure View pane.
60
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
Chapter 4
Recipe creation
Tip:
If modifying the unit requirements for a unit procedure or operation
used in a higher level recipe, then make the required adjustments to
the unit requirements of higher level recipes. If not making
corrections, the Released to Production check boxes clears for
higher level recipes.
See also
Create operations and unit procedures on page 58
Create a procedure
When creating a procedure, indicate all unit instances and unit classes used within
the procedure. If the Support Dynamic Unit Allocation option is enabled in the
View > Options dialog box, each unit instance or unit class must have a unit
requirement name assigned when used in a procedure.
To create a procedure:
1. Select New
. The New dialog box opens.
2. Select Procedure and select OK. The Create Procedure dialog box opens.
3. Enter recipe information and select OK. Procedure Identifier is the only
required box.
Item
Description
Procedure Identifier The unique name that displays when working with a recipe in
the FactoryTalk Batch View. It is also used as the file name
when the recipe is saved. Follow methodologies for assigning
product identification codes.
The Procedure Identifier can contain letters (A-Z), numbers
(0-9), and underscores ( _ ). For Procedures, the Procedure
Identifier can begin with either a letter or a number. For Unit
Procedures and Operations, it must begin with a letter.
Version Number
Legacy, user-set version number (not related to the Recipe
Versioning feature introduced in FactoryTalk Batch version 12).
Manually update this version number as desired.
Version Date
Defaults to today's date, cannot be changed.
Author
The name of the individual that created the recipe.
Product Code
A short label that uniquely identifies the product.
Procedure
Description
Product or process description at the procedure level. Indicate
whether this is a class-based recipe, or any other
distinguishing information required.
Procedure Abstract A summary or outline of the steps of the procedure.
Version Description Legacy, version description (not related to the Recipe
Versioning feature introduced in FactoryTalk Batch version 12).
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
61
Chapter 4
Recipe creation
If Support Dynamic Unit Allocation is enabled, the Procedure-Unit
Requirements dialog box opens.
4. Select Add Unit Requirement to display the Add Unit Requirement
dialog box.
5. Type a unique name in the Name box. The name can contain alphanumeric
characters (A through Z, 0 through 9), an underscore (_), or a colon (:), but
it must begin with an alphanumeric character.
Any unit procedure mapped to this unit requirement name uses the same
unit to which this unit requirement name is bound. Bind the unit
requirement name to the unit class or to a unit instance.
6. Select Class Based or Instance Based to enable the corresponding group
box.
7. Select the required unit class or unit from the appropriate list.
62
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
Chapter 4
Recipe creation
8. If adding Class Based requirements, select the appropriate binding method
from the Binding Method list.
9. If needed, add applicable Bind Requirements and Bind Preferences.
10. In the Available Downstream Unit Requirements list, select the unit
requirement name for the unit that is downstream from the unit
requirement being defined and select the right arrow. The unit requirement
is added to the Selected Downstream Unit Requirements list.
Tip:
Specify Downstream Unit Requirements only after all additional unit
requirements are specified. The list box contains the unit requirement
names for all available units defined in the Procedure-Unit
Requirements dialog box (except the one currently being defined).
To return all selected downstream units to the available downstream
units, select Remove All.
11. Select OK to return to the Procedure-Unit Requirements dialog box.
12. Repeat steps 4 through 10 to define additional unit requirements for this
procedure.
13. Select Close in the Procedure-Unit Requirements dialog box to return to
the Procedure View pane, which now shows the default procedure name
on the FactoryTalk Batch Recipe Editor title bar. The SFC view contains
the initial and the final steps of the sequential function chart, and the Table
view contains a blank table header.
See also
Unit requirement name example on page 64
Dynamic unit allocation on page 50
Binding requirements on page 65
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
63
Chapter 4
Recipe creation
Configure binding requirements on page 66
Unit requirement name
example
The unit requirement name is a label and acts as a lookup table for the
FactoryTalk Batch Server. When a recipe is on the Batch List and the server
encounters the unit requirement name, it looks up all the unit classes (or unit
instances) mapped to the unit requirement name.
For example, a plant has two mixers that used to run one recipe. When the recipe
runs, the operator or the FactoryTalk Batch Server (depending on the binding
method) must pick which mixer to use. In the area model, these mixers are each
assigned a unit instance (MIXER_1 and MIXER_2) from the same unit class
(MIXER). In the recipe, create a unit requirement name (MIXERS) configured to
the MIXER unit class, with the binding method at batch creation. When the
recipe is on the Batch List, the FactoryTalk Batch Server encounters the label
MIXERS, which tells it that piece of equipment is required for this recipe. The
server looks for all the unit instances of the unit class defined with this unit
requirement name and prompts the operator to select either MIXER_1 or
MIXER_2.
Any unit procedure, including its subordinate operations, mapped to this unit
requirement name uses the specified unit class and the associated binding method.
Because recipes using dynamic unit allocation require that all unit procedures use a
unit requirement name, assign a unit requirement name to all instance-based unit
procedures and define the binding method used as Static.
See also
Create a procedure on page 61
Change procedure unit
requirements
If Support Dynamic Unit Allocation is enabled, edit unit requirements within a
procedure at any time. If disabled, the Unit Requirement dialog box is not
available at the procedure level. Remove a unit requirement from a procedure at
any time, as long as no steps within this procedure define this unit requirement.
To change procedure unit requirements:
1. Open an existing procedure.
2. Select the procedure level of the recipe.
3. From the Recipe menu, select Unit Requirements to display the
Procedure-Unit Requirements dialog box.
4. To edit a unit requirement, select the row containing the unit requirement,
and then select Edit Unit Requirement to display the Edit Unit
Requirement dialog box.
64
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
Chapter 4
Recipe creation
5. Make the required modifications to the unit requirement. Select OK to
return to the Procedure-Unit Requirements dialog box.
Tip:
Modifying from a class-based requirement to an instance-based
requirement deletes all of the binding requirements and preferences.
6. To delete an existing unit requirement, select the row containing the unit
requirement and select Delete Unit Requirement. If the procedure has,
any steps defined using this unit requirement, a message displays stating that
the requirement cannot be deleted. In this case, delete all steps defined
against the unit requirement first. Deletion of a unit requirement removes
the unit from any referenced downstream lists.
See also
Create a procedure on page 61
Smart binding
In addition to late binding, smart binding, also referred to as unit attribute
binding, further enhances Dynamic Unit Allocation by allowing custom,
user-defined binding requirements and binding preferences. With smart binding,
specify:
•
A binding requirement, such as "The unit must be in service."
•
A binding preference, such as "I want the mixer cleaned less than 3 days
ago."
Configure custom unit attributes such as VESSEL_STATUS in the FactoryTalk
Batch Equipment Editor. The recipe author then configures binding requirements
and binding preferences based on those custom attributes in the FactoryTalk
Batch Recipe Editor.
See also
Dynamic unit allocation on page 50
Binding requirements on page 65
Binding preferences on page 67
Create binding expressions on page 69
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
65
Chapter 4
Recipe creation
Binding requirements
Bind requirements define subsets of class-based unit procedures and operations.
Configure subsets as one of these options:
•
Expression – Used to reference Unit Attributes assigned to the Unit Class
associated with the Unit Requirement. Expression objects can also reference
Recipe Header values such as BATCH_SIZE, output parameters on the
parent recipe, and report and formula parameters on the peer steps within
the recipe.
•
Require Phase – Used when a Unit Requirement must be bound to a Unit
that supports a specified recipe phase.
•
Reject Phase – Used when a Unit Requirement must be bound to a Unit
that does not support a specified recipe phase. This requirement prevents
recipes from using units with unneeded capabilities.
•
Require Attribute – Used when a Unit Requirement must be bound to a
Unit that supports a specified Unit Attribute. It is a demand for a Unit that
provides an attribute tag for support of the specified unit attribute.
•
Reject Attribute – Used when a Unit Requirement must be bound to a
unit that does not support a specified Unit Attribute. This requirement
prevents recipes from using units with unneeded attributes.
See also
Binding preferences on page 67
Create binding expressions on page 69
Configure binding
requirements
Once the appropriate custom Unit Attribute definitions, assignments, and
configurations are complete in the FactoryTalk Batch Equipment Editor, define
the bind requirements in the FactoryTalk Batch Recipe Editor.
To configure binding requirements:
1. Open a new or existing unit procedure or operation recipe.
2. From the Recipe menu, select Unit Requirements to display the Unit
Requirement dialog box.
66
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
Chapter 4
Recipe creation
3. Select Bind Requirements to display the Bind Requirements for Unit
Requirement: [CLASS_NAME] dialog box.
Tip:
Any global unit attributes list automatically and are view-only. Configure
global unit attributes in the FactoryTalk Batch Equipment Editor.
4. Select Add Requirement. A new row displays containing the unit
procedure/operation name and boxes for the bind Type and Description.
5. Configure the Type and Description columns with the applicable bind
requirements.
Tip:
The Description information changes based on the Type selected. If the
to open the Unit Binding
Type is an Expression, select Browse
Expression Builder.
6. Select OK twice to return to the Procedure View Pane.
See also
Binding preferences on page 67
Create binding expressions on page 69
Binding preferences
A bind preference is an object that evaluates against an instance of a Unit Class in
order to sort the legal bind targets for a Unit Requirement into a most preferred
order. A bind preference can specify a preferred Phase or Unit Attribute, an
expression to minimize or maximize, or a Phase or Attribute to avoid. The priority
number indicates the order of evaluation for the FactoryTalk Batch Server.
Configure these preferences in recipes as using one of these options:
•
Expression – A boolean expression used to reference unit attributes
assigned to the unit class associated with the Unit Requirement. Expression
objects can also reference Recipe Header values such as BATCH_SIZE.
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
67
Chapter 4
Recipe creation
•
Minimize Expression – An expression that evaluates to either an integer or
real value. Legal bind targets for which the expression evaluates to a lower
value are more preferred bind targets than those for which the expression
evaluates to a higher value.
•
Maximize Expression – An expression that evaluates to either an integer or
real value. Legal bind targets for which the expression evaluates to a higher
value are more preferred bind targets than those for which the expression
evaluates to a lower value.
•
Prefer Phase – Used as a recipe phase inclusion for bind preferences. The
preferred unit supports the specified phase.
•
Avoid Phase – Used as a recipe phase exclusion for bind preferences. The
preferred unit does not support the specified phase.
•
Prefer Attribute – Used as a recipe phase inclusion, it is a request for a
Unit that provides an attribute tag for support of the specified unit
attribute.
•
Avoid Attribute – Used as a recipe phase exclusion, it is a request for a
Unit that lacks support for the specified recipe phase.
See also
Smart binding on page 65
Configure binding preferences on page 68
Configure binding
preferences
Use this procedure to configure binding preferences.
To configure binding preferences:
1. Open a new or existing unit procedure or operation recipe.
2. From the Recipe menu, select Unit Requirements to display the Unit
Requirement dialog box.
3. Select Bind Preferences to display the Bind Preferences for Unit
Requirement: [CLASS_NAME] dialog box.
68
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
Chapter 4
Recipe creation
4. Select Add Preference. A new row displays containing the unit
procedure/operation name and drop-down boxes for the Bind Type and
Description.
5. Configure the Type and Description columns with the applicable bind
requirements.
Tip:
The Description information changes based on the Type selected. If the
to open the Unit Binding
Type is an Expression, select browse
Expression Builder.
6. Select OK twice to return to the Procedure View Pane.
See also
Create binding expressions on page 69
Create binding
expressions
When selecting one of the Expression types as the Type of bind preference or
requirement, define that expression in the Unit Binding Expression Builder
dialog box.
To create binding expressions:
1. From the Bind Requirements or Bind Preferences dialog box, select Add
Preference or Add Requirement.
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
69
Chapter 4
Recipe creation
2. From the Type list, select the type of expression, and then select browse
to the right of the Description to display the Unit Binding Expression
Builder dialog box.
Tip:
Bind requirement and preference expressions can reference items that
are unit class attributes or a recipe procedure’s recipe header, and step
parameters.
3. From the tree view in the left pane, select the value type for building the
expression, unit attributes or recipe header, or step parameters.
4. From the middle pane, select the operand used for the expression. The
example shown lists operands like CAPACITY and GLASS_LINED.
5. Select an operator button to enter the desired operation into the expression.
Type the operation directly into the Expression text box. The example uses
the greater than or equal to operator.
6. If the operand is an Enumeration, double-click the value in the right pane to
add the value to the expression in the text box; otherwise, type the desired
value directly into the expression.
7. Select OK to save and validate the expression, and then return to the dialog
box from which the Expression Builder was opened. The new bind
requirement or preference displays.
8. Select OK to close the Bind Requirement or Bind Preference dialog box.
See also
Bind Expressions on page 99
70
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
Chapter 4
Recipe creation
Recipe header data
Header data is general information about the recipe. The Header Data dialog box
contains:
Item
Description
Procedure Identifier The unique name that displays when working with a recipe in the
FactoryTalk Batch View. It is also used as the file name when the
recipe is saved. Follow methodologies for assigning product
identification codes.
The Procedure Identifier can contain letters (A-Z), numbers (0-9),
and underscores ( _ ). For Procedures, the Procedure Identifier
can begin with either a letter or a number. For Unit Procedures
and Operations, it must begin with a letter.
Version Number
Legacy, user-set version number (not related to the Recipe
Versioning feature introduced in FactoryTalk Batch version 12).
Manually update this version number as desired.
Version Date
Defaults to today's date, cannot be changed.
Author
The name of the individual that created the recipe.
Approved By
The name of the individual who approved the recipe.
Product Name
The product name the recipe produces.
Product Code
A short label that uniquely identifies the product.
Batch Size
• Min - a numeric value indicating the minimum size of the
completed batch.
• Default - a numeric value indicating the default size of the
completed batch.
• Max - a numeric value indicating the maximum size of the
completed batch.
• Units of Measure - the type of measurement used to designate
the minimum, default, and maximum batch sizes, such as
kilograms, pounds, liters, and other units.
Estimated
Approximate length of time it takes to run and complete a batch
using the recipe (minutes).
Procedure
Description
Product or process description at the procedure level. Indicate
whether this is a class-based recipe, or any other distinguishing
information required.
Procedure Abstract A summary or outline of the steps of the procedure.
Area Model File
Name
Indicates the location and filename of the area model file against
which the recipe was last verified. If the entire path and filename
is not visible, place the cursor in the box and use the right arrow
key to scroll to the right.
Date/Time Stamp
of Area Model
Date and time the area model was last saved.
Time of Verification Date and time the recipe was verified. If the recipe was never
verified, this information is also indicated.
File Name
Recipe filename.
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
71
Chapter 4
Recipe creation
Item
Description
Approval Process
The title of this area changes to reflect the active Approval
Process for the recipe:
Area (recipe
approvals enabled) • Approval Process Not Started
• Primary Approval Active
• Expedited Approval Active
• Pending Recipe Selection
Recipe Approval Process steps, and their current state, are listed
in this area. Hover the cursor over an approval process step to
view a description of the approval step.
• Check boxes are read-only and controlled by the Approval
Process.
• When checked, Release Recipe as Step signifies the recipe
(or unit procedure or unit operation) is approved for inclusion as
a step in another recipe.
• When checked, Release Recipe to Production signifies the
recipe is approved for inclusion on the Recipe List in the
FactoryTalk Batch View, in eProcedure, or in custom
applications that use Control Recipe List ActiveX controls.
The state of each approval step:
• Not Started - approval sign off not started.
• In Progress - approval started but one or more signoffs still
required.
• Reverting - revert started but one or more signoffs still required.
• $System Signoff Pending - translated (migrated) recipes, or
recipes re-entering an approval process, are set to begin with
the Expedited approval process. Prior to verification, the
Expedited approval steps for these recipes are set to a pending
state.
• Completed - all signoffs made and approval is complete.
(Recipe approvals
disabled )
This area contains check boxes indicating the states of the
Release Recipe as Step and Release Recipe to Production
recipe properties.
The check boxes are active and can be selected to toggle
between true and false.
• Release Recipe as Step, when set to true, signifies the recipe
(or unit procedure or unit operation) can be included as a step
in another recipe, but batches cannot be created from it alone.
• Release Recipe to Production, when set to true, signifies the
recipe can be added to the Recipe List in the FactoryTalk Batch
View, in eProcedure, or in custom applications that use Control
Recipe List ActiveX controls.
See also
Add recipe header data on page 72
72
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
Chapter 4
Recipe creation
Add recipe header data
Use this procedure to add recipe header information to a recipe.
To add recipe header data:
1. With the appropriate recipe level open in the FactoryTalk Batch Recipe
Editor, select Header Data
. The Header Data dialog box opens.
2. Type the required data (Procedure Identifier, Version Number, and
Author) in the Header Data dialog box.
3. (optional) Enter information in the remaining boxes.
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
73
Chapter 4
Recipe creation
Tip:
If Approval Process is enabled for the area model, then
the approval process, along with configured approval
steps, displays in the bottom area of the dialog box. The
two check boxes are read-only (disabled) but shown to
reflect their current state.
4. If disabled Recipe Approvals process, then the two check boxes enable.
Select one or both of the boxes as required.
•
Select Release Recipe As Step to use the recipe or operation as a
component in another recipe. With just this box checked, the recipe
does not appear in the Recipe List.
•
Select Release Recipe To Production for the recipe to appear in the
FactoryTalk Batch View, eProcedure, or ActiveX control Recipe List,
to create production batches.
5. Select OK.
See also
Recipe header data on page 70
Recipe storage
After building the recipe, save the recipe by selecting Save. The recipe is saved in
the location and format defined in the FactoryTalk Batch Equipment Editor
Server Options dialog box.
If recipes are stored using binary files, the recipes save separate files according to
the recipe level:
•
Procedures are stored as .bpc files
•
Unit Procedures are stored as .upc files
•
Operations are stored as .uop files
If recipes are stored using XML, the recipes save separate files according to the
recipe level:
•
Procedures are stored as .pxml files
•
Unit Procedures are stored as .uxml files
•
Operations are stored as .oxml files
If recipes are stored using the RDB format, recipes are stored in a single SQL
Server database (MasterRecipes is the default database name).
See also
Copy recipe options on page 75
74
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
Chapter 4
Recipe creation
Copy recipe options
Copy recipes by using the Save As function or using the backup directory. When
selecting a procedure level or unit procedure level recipe and the Save As function
is used, only the selected recipe level (procedure or unit procedure) saves with a
new name. Recipe Approval steps and their states do not carry over to the new
copy.
Important:
Any lower level recipes (unit procedure, operation, or phase) are
not copied with the selected recipe level. Any changes made to
those lower levels modify the original version. To modify the
original versions, perform a Save As on each of the lower level
recipes.
Many recipes use deferred parameters in order to minimize the number of
different recipes maintained. Because deferred parameter values assign at a higher
level recipe, using the Save As command to copy the recipes with deferred
parameters does not affect the original recipe.
Operations can be copied using Save As because they are the lowest level and do
not point to upper levels. Changes made to the copy do not affect the original
operation.
Tip:
With Recipe Approvals enabled, using Save As clears all
signature-approved approval steps in the new copy. The approval
steps in the original recipe are not affected.
In this example, performing a Save As on the procedure level saves a new copy of
that procedure only. The new procedure still points to the original unit
procedures, operations, and phases. If changing a parameter value on a phase in the
copied recipe, that parameter value changes in the original recipe. The same applies
to the operations and unit procedures; all changes affect the original recipe.
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
75
Chapter 4
Recipe creation
See also
Copy a recipe using the backup directory on page 76
Copy a recipe using
the backup directory
Use this procedure to copy a recipe using the backup directory.
To copy a recipe using the backup directory:
1. Open Windows Explorer to create a backup directory for recipes.
2. Copy all recipes to duplicate to the backup directory.
3. In the FactoryTalk Batch Equipment Editor, open the Server Options
dialog box and change the Recipe Directory to point to the backup
directory.
4. Open the FactoryTalk Batch Recipe Editor. If it was already open, exit the
FactoryTalk Batch Recipe Editor and restart it.
5. Open the recipe to copy. The phases, operations, and unit procedures
display in the Procedure View pane hierarchical list.
6. Select a phase in the first operation of the hierarchical list. From the Recipe
menu, select Header Data to display the operation information.
7. Change the Procedure Identifier to a new name, and then select OK.
Change the other information if needed.
8. A message indicates recipes affected by the change. Select Proceed, and then
select OK.
9. Select the operation that just renamed. Open the Header Data and change
the Procedure Identifier to a new unit procedure name. Select OK, and a
message lists recipes affected by the change. Select Proceed, and then select
OK.
10. Repeat steps 6 through 9 for each operation and unit procedure.
11. Select any unit procedure. Open the Header Data and change the
Procedure Identifier to a new name for the procedure. Select OK and a
message displays the recipes affected by the change. Select Proceed.
12. Save the procedure.
13. Export the renamed recipe back to the original recipe directory.
14. In the FactoryTalk Batch Equipment Editor, open the Server Options
dialog box and change the Recipe Directory to point back to the original
recipe directory.
76
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
Chapter 4
Recipe creation
15. Open the FactoryTalk Batch Recipe Editor to display the newly created
recipe copies.
See also
Copy recipe options on page 75
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
77
Chapter 5
Build a Sequential Function Chart
The creation of an SFC involves the addition of steps, transitions, and links.
During the recipe creation process, an initial SFC displays. This SFC consists of
the initial step, initial transition, final transition, and final step. Add steps to the
chart and then define the steps appropriately. If needed, reconfigure transitions
that require special expressions and include any necessary comments.
Tip:
In addition to using the mouse for navigation, keyboard controls are
also available. When focus is in the SFC view, use the arrow keys to
navigate between recipe elements. Use the arrow keys while
pressing the Ctrl key to move between selected recipe elements.
When deleting a selected step with the delete key, the SFC is not
automatically rearranged. The active step outlines in dark blue and
SFC displays on the status bar at the bottom of the screen when the
SFC view has focus.
See also
Insert steps into an SFC on page 79
Insert timer steps on page 80
Manually add steps to an SFC on page 82
Add a parallel step to an SFC on page 83
Add a branch structure to an SFC on page 84
Insert steps into an
SFC
When constructing a recipe, insert steps into an SFC using the Add Step tool or
the Insert Step tool.
•
The Add Step tool creates a new step after the selected recipe element.
•
The Insert Step tool creates a new step before the selected element.
If required, a new transition automatically creates for the new step and a default
common transition expression automatically configures. If a new transition is not
required, the existing transition modifies to reflect the new step.
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
79
Chapter 5
Build a Sequential Function Chart
Tip:
Add material-enabled phases to operations just like other
phases. When adding a material-enabled phase to the recipe,
define the material parameters.
To insert steps into an SFC:
, select a step or transition that either
1. Using the Selection Tool
precedes or follows the new step.
to insert a new step before the selected element, or
Select Insert Step
select Add Step
to insert a new step after the selected element. A new
UNDEFINED step displays on the SFC with a blue box outlined in a black
dashed line. Additionally, the SFC structure automatically rearranges to
make room for the new elements. One of these dialog boxes opens, based on
the recipe level: Select Phase, Operation Select, or Unit Procedure Select.
2. Make the appropriate selection and select OK.
3. Repeat Steps 1 through 3 until all of the required steps are on the SFC.
Tip:
The word UNDEFINED displays inside the step until
configured.
See also
Recipe construction toolbox on page 17
Define a step on page 86
80
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
Build a Sequential Function Chart
Chapter 5
Insert timer steps
Timer steps are available at all levels of a recipe: operations, unit procedures, and
procedure.
To insert timer steps:
1. Using the Selection Tool
follows the new step.
, select the transition that either precedes or
to insert a new step before the selected element, or
2. Select Insert Step
to insert a new step after the selected element. One of
select Add Step
these dialog boxes opens, based on the recipe level: Select Phase, Operation
Select, or Unit Procedure Select. These instructions are for using the
Select Phase dialog box. For information on inserting a step into a Unit
Procedure or Operation, see Define a step.
3. Select TIMER from the dialog box and select OK to display the Select
Timer - TIMER dialog box.
4. Enter these values:
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
81
Chapter 5
Build a Sequential Function Chart
a.
Type a new name for the Timer step.
b. Select the Timer type (COUNT_DOWN or COUNT_UP).
c.
Select the units of measure (seconds, minutes, hours, or days).
d. Select OK. The new Timer step displays in the SFC.
Tip:
If a COUNT_UP timer in parallel with existing steps displays, the
transition expression does not change. If it is the only step, then the
transition defaults to TRUE.
5. Set parameter values for the Timer step. (See Assign formula values to
Timer steps for more information.)
See also
Define a step on page 86
Assign formula values to Timer steps on page 114
Manually add steps
to an SFC
Manually add a step to a sequential function chart using the Step Tool on the
Recipe Construction toolbox. When using the Step Tool, no new transitions are
added, no existing transitions are modified, no links are created for the step, and
the SFC structure is not automatically rearranged to make room for the new step.
To manually add steps to an SFC:
1. Select Step Tool
.
2. In the SFC view, place and click the cursor in the desired location.
The step is placed on the sequential function chart and is outlined in blue
(indicated by the dashed lines) until another step is placed or another tool is
selected. The step displays in red until configured. UNDEFINED is
displayed inside the step until it is defined.
3. Repeat Step 2 until all of the required steps for the process display on the
sequential function chart.
See also
Recipe construction toolbox on page 17
Define a step on page 86
82
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
Chapter 5
Build a Sequential Function Chart
Add a parallel step
to an SFC
Use the Add Parallel tool to add a step. to an SFC in parallel with another. The
Add Parallel tool creates a parallel step, the appropriate links, and redefines the
existing transition to reflect the new parallel structure.
To add a parallel step:
1. Use the Selection Tool
run in parallel.
to select the step with which the new step is to
2. Select Add Parallel
. A new UNDEFINED step creates in parallel with
the selected step on the SFC and outlines in blue. Additionally, the SFC
structure automatically rearranges to make room for the new elements. One
of these dialog boxes opens, based on the recipe level: Select Phase,
Operation Select, or Unit Procedure Select. Make the appropriate
selection and select OK. The existing transition modifies to reflect the new
step and the parallel structure.
See also
Recipe construction toolbox on page 17
Define a step on page 86
When parallel steps
require the same
dedicated resource
If parallel steps require the same dedicated resource, the FactoryTalk Batch Server
automatically determines how the resources allocate between steps when the batch
runs. This is subarbitration. If parallel steps requiring the same resource occur just
after an AND divergence or just before an AND convergence, add null procedures
to the recipe in order for batches to run successfully.
This example shows the correct placement of null procedures in a sequential
function chart (SFC) that contains parallel steps requiring the same phase.
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
83
Chapter 5
Build a Sequential Function Chart
In this SFC, each set of parallel steps is requesting the same phase.
•
The first set of steps after the AND Divergence, ADD_CREAM:1 and
ADD_CREAM:2, require a set of null procedures before them so
subarbitration can work. Without the null procedures, the batch goes into a
HELD state before it reaches these steps.
•
The FactoryTalk Batch Server automatically subarbitrates for the second
set, ADD_EGG:1 and ADD_EGG:2.
•
The third set, AGITATE:1 and AGITATE:2, requires a set of null
procedures before the AND Convergence so subarbitration can work.
Without the null phases, the batch appears as though it is still running, but
it never is able to transition past these steps to the Convergence.
See also
Add a parallel step to an SFC on page 83
84
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
Chapter 5
Build a Sequential Function Chart
Add a branch
structure to an SFC
Add a branch structure to an SFC using the Add Branch tool, which creates a
new step, a new transition preceding the step, and a new transition following the
step. The new preceding transition contains the transition condition FALSE and
the new following transition contains the transition condition
STEP.STATE=COMPLETE.
Tip:
Due to the variation and complexity of SFC branch
structures, it is necessary to redefine one or both
transitions.
To add a branch structure:
1. Use the Selection Tool
structure is to border.
to select the step on which the new branch
2. Select Add Branch
. A new step creates on the SFC and outlines in blue
(indicated by the dashed lines). A new transition precedes the new step, and
a new transition follows the new step. Additionally, the SFC structure
automatically rearranges to make room for the new elements. One of these
dialog boxes opens, based on the recipe level: Select Phase, Operation
Select, or Unit Procedure Select. Make the appropriate selection and
select OK.
3. Define the new preceding and following transition expressions, if necessary.
See also
Recipe construction toolbox on page 17
Assign a transition expression on page 88
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
85
Chapter 5
Build a Sequential Function Chart
Add transitions to
an SFC
Use the Transition Tool to add transitions to an SFC. The Transition Tool
creates a single transition requiring a manual link to the appropriate steps and
defines the transition expression.
To add a transition:
1. Select Transition Tool
.
2. Place the cursor in the desired location in the SFC View and click. The
transition, with its name (T followed by a number), is placed on the SFC.
Tip:
The transition displays in blue until another transition is
added or the Recipe Construction tool is selected. The
transition then displays in red until configured.
3. Link the transition to the appropriate steps.
4. Assign a transition expression.
Tip:
In FactoryTalk eProcedure recipes, all loops and transitions
must branch to the right side of the SFC steps.
See also
Recipe construction toolbox on page 17
Link SFC components on page 87
Assign a transition expression on page 88
Define a step
Newly added steps are UNDEFINED. Only valid lower level recipes are used in
the step definition. When a process for a step is selected, that process is assigned to
that particular step in the recipe, and the step is marked with the process name.
Redefine a step at any time.
To define a step:
1. Double-click a step marked UNDEFINED. One of these dialog boxes
opens, based on the recipe level: Select Phase, Operation Select, or Unit
Procedure Select.
2. To define a phase or operation either select from the option list and then
select OK. Or, select New Phase or New Operation to create a new phase
or operation. See Create operations and unit procedures.
86
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
Chapter 5
Build a Sequential Function Chart
3. To define a unit procedure:
a.
From the Alias list, select the alias to associate with this unit procedure.
b. The Alias list contains a list of all units defined in the procedures unit
requirements.
a.
If this unit runs in parallel with other units, and if each of the units
at this level must acquire in order to initiate this level of the recipe,
then select Acquire unit prior to starting unit procedure.
b. If the units running in parallel can run independently of each
other, clear this check box for all of the units at this level. The
recipe then runs the individual units acquired, regardless of
whether the other units acquire.
c.
Select the appropriate unit procedure to associate with this step. Or,
select New Unit Procedure to create a new unit procedure.
d. Select OK.
See also
Create operations and unit procedures on page 58
Add a null procedure on page 36
Link SFC
components
Use this procedure to link SFC components.
To link SFC components:
1. Select Link Tool
.
2. Place the cursor at the links starting step. Drag the link to the connecting
step, and release the mouse button to complete the link. The elements are
now connected.
Tip:
In FactoryTalk Procedure recipes, all loops and transitions
must branch to the right side of the SFC steps.
See also
Recipe construction toolbox on page 17
Remove a link from an SFC on page 88
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
87
Chapter 5
Build a Sequential Function Chart
Remove a link from an
SFC
Follow these instructions to remove a link from an SFC.
To remove a link from an SFC:
1. Select Remove Link Tool
. The cursor changes to a + sign.
2. Place the cursor at the links starting step. Drag the cursor to the connecting
step.
3. Release the mouse button to remove the link.
See also
Recipe construction toolbox on page 17
Link SFC components on page 87
Assign a transition
expression
After adding a transition to the SFC, assign a transition expression.
To assign a transition expression:
1. Double-click a transition in the SFC view. The Transition Expression
Builder dialog box appears.
2. Enter the expression for the transition condition or build an expression by
selecting options from the three different sections. Press Enter to continue
the expression on the next line.
3. Select OK to return to the SFC view.
See also
Transition expressions on page 25
88
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
Chapter 5
Build a Sequential Function Chart
Remove a step from
an SFC
Remove a step from an SFC using the Selection tool.
To remove a step from an SFC:
1. Using the Selection Tool
2. Select Remove Step
, select the step to remove.
.
The selected step is removed and all affected transitions are removed or
modified to reflect the new SFC structure. Additionally, the SFC structure
rearranges automatically to recover the space created by any removed
elements. If there are no recipe elements bordering the removed step (if the
step was added to the SFC view without being linked), a blank space is left
in the SFC structure. Any blank spaces left within the SFC structure must
.
be linked manually using the Link Tool
Tip:
Transitions following parallel structures can be extremely
complex so they are not automatically reconfigured. If the
transition following the removed parallel step requires
reconfiguration, it must be configured manually.
See also
Manually add steps to an SFC on page 82
Create material
loops
If the SFC contains a material-enabled step, create a material loop that allows the
step to automatically rebind when a feed is not completed. Because material loops
disable the ability to create complex recipe structures, add them after the SFC is
set up with AND and OR convergences and divergences. For example, to create
three material equipment phases in parallel, create the three parallel recipe phases
first, and then add the material loop.
To create material loops:
1. Using the Selection Tool
loop.
2. Select Create Material Loop
two required null procedures.
, select the material enabled step to add to the
. The material loop is added, including the
To remove a material loop immediately after adding it, select Undo
Material Loop
.
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
89
Chapter 5
Build a Sequential Function Chart
This example shows how a material loop appears when the material-enabled step is
preceded and followed by a transition. The material loop may look different and
contain more than one null procedure if it is preceded or followed by a
convergence or a divergence.
SFC without a material rebinding loop
SFC after a material rebinding loop was added
around the material-enabled step MBR_ADD:1
See also
Recipe construction toolbox on page 17
Link SFC components on page 87
Recipe comments
Use recipe comments to give written instructions to operators, share notes with
other engineers, or access a reference. Recipe commenting associates data with a
step, transition, or the entire recipe. The comment is viewable at design and at run
time.
The comment, and its associated information, is a text box. Above each text box,
the assigned reference name displays as a C followed by a number. View added
SFC text boxes in the SFC views of FactoryTalk Batch View, FactoryTalk
Procedure, and ActiveX Control.
See also
Recipe creation overview on page 18
90
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
Chapter 5
Build a Sequential Function Chart
Add comments to an
SFC
Use these instructions to add comments to an SFC.
To add comments to an SFC:
1. Select Text Box Tool
.
2. Move the cursor (text box) to the desired location, click, and the text box is
displayed. When placing the text box, pick an area in the SFC that does not
interfere with viewing existing steps and transitions as these elements do not
relocate when the text box is generated. If necessary, text boxes, steps, and
transitions can be moved by selecting and dragging them to new locations.
3. Use the selection tool to add the required information inside the text box.
When finished typing the text, select outside the box. The text box resizes to
accommodate the comment. If needed, use the Selection Tool to edit
existing text.
Tip:
The maximum number of characters contained in a
text box is 1024. If more capacity (space) is required
for a recipe comment, use additional text boxes and
associated them with the step or transition.
See also
Recipe construction toolbox on page 17
Associate recipe comments on page 91
Disassociate recipe comments on page 92
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
91
Chapter 5
Build a Sequential Function Chart
Associate recipe
comments
When a text box is created, the default is a general recipe procedure comment.
The associated information section is blank.
To associate a recipe comment with a step or transition:
1. Select Link Tool
, select inside the text box, and drag to the desired step
or transition. Completing this step in reverse order is also an option.
2. Release the button, and the bottom portion of the text box displays the
associated step or transition name.
Tip:
A text box can only be associated with one step or
transition. Linking a text box to a step or transition that is
already associated to another element results in
assigning the most recently associated step or transition
name.
See also
Recipe construction toolbox on page 17
Disassociate recipe comments on page 92
Disassociate recipe
comments
Use these instructions to disassociate a comment.
To disassociate a recipe comment from a step or transition:
, select inside the text box, and drag to the
1. Select Remove Link Tool
associated step or transition. This step can be performed in reverse order
with the same result.
2. The associated step name is removed from the text box and now associated
with the entire recipe.
92
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
Chapter 5
Build a Sequential Function Chart
Tip:
If a step or transition associated with a text box is deleted, the text box
becomes associated with the entire recipe procedure and the association
label is blank.
See also
Recipe construction toolbox on page 17
Delete recipe comments on page 93
Delete recipe
comments
Follow these instructions to delete recipe comments.
To delete recipe comments:
1. Select the text box to be deleted.
2. From the Edit menu, select Delete Selection or press Delete.
The comment and text box are removed from the SFC.
See also
Add comments to an SFC on page 91
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
93
Chapter 6
Build a table
The creation of a table involves the addition and configuration of steps to the table
structure. Add steps to the table and then define the steps appropriately.
Tip:
While in the Table view, the active step is highlighted in dark
blue and Table is displayed on the status bar at the bottom of
the screen when the Table view has focus. Delete a selected
step in the table by pressing the Delete key.
See also
Insert steps into a table on page 95
Add a parallel step to a table on page 96
Add a step before and after parallel steps on page 97
Define a step on page 86
Remove a step from a table on page 98
Insert steps into a
table
When constructing a recipe, steps can be inserted into a table using the Add Step
tool or the Insert Step tool. The Add Step tool creates a new step after the
selected step, while the Insert Step tool creates a new step before the selected step.
Tip:
Material-enabled phase steps are added to operation recipes
similar to all other phase steps.
To insert steps into a table:
1. Select the table row that either precedes or follows the new step.
to insert a new step before the selected row, or select
2. Select Insert Step
to insert a new step after the selected row. A new
Add Step
UNDEFINED step is created in the table and highlighted in dark blue. One
of these dialog boxes opens, based on the recipe level: Select Phase,
Operation Select or Unit Procedure Select.
3. Make the appropriate selection and select OK.
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
95
Chapter 6
Build a table
4. Repeat steps 1 through 3 until all of the required process steps are placed in
the table.
Tip:
The word UNDEFINED displays inside the step until it is
configured.
See also
Recipe construction toolbox on page 17
Build a table on page 95
Add a parallel step to a table on page 96
Add a parallel step
to a table
To add a step to a table in parallel with another step use the Add Parallel tool.
To add a parallel step to a table:
1. Select the step that is to run in parallel with the new step.
. A new UNDEFINED step is created in parallel
2. Select Add Parallel
with the selected step and highlighted in blue. To the left of the step, a
parallel icon signifies that the step is a parallel step. One of these dialog
boxes opens, based on the recipe level: Select Phase, Operation Select or
Unit Procedure Select.
3. Make the appropriate selection and select OK.
Tip:
For parallel steps that request the same resource, the
FactoryTalk Batch server determines how the resources
are allocated through the subarbitration process. If
parallel steps require the same resource to occur just
after an AND divergence or just before an AND
convergence, add null procedures to the recipe in order
for batches to run successfully.
See also
When parallel steps require the same dedicated resource on page 83
96
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
Chapter 6
Build a table
Add a step before
and after parallel
steps
Use the Insert Step Before Parallel and Add Step After Parallel tools to add
steps before and after parallel steps.
To add a step before and after parallel steps:
1. Select the parallel step that is to run in parallel to the new step.
. A new UNDEFINED step is
2. Select Insert Step Before Parallel
created before the selected parallel step and is highlighted in blue. One of
these dialog boxes opens, based on the recipe level: Select Phase, Operation
Select or Unit Procedure Select.
3. Make the appropriate selection and select OK.
4. Select the parallel step that runs after the new step.
. A new UNDEFINED step is created
5. Select Add Step After Parallel
after the selected parallel step and highlighted in blue. One of these dialog
boxes opens, based on the recipe level: Select Phase, Operation Select or
Unit Procedure Select.
6. Make the appropriate selection and select OK.
See also
Define a step on page 86
Define a step
Newly added steps are UNDEFINED. Only valid lower level recipes are used in
the step definition. When a process for a step is selected, that process is assigned to
that particular step in the recipe, and the step is marked with the process name.
Redefine a step at any time.
To define a step:
1. Double-click a step marked UNDEFINED. One of these dialog boxes
opens, based on the recipe level: Select Phase, Operation Select, or Unit
Procedure Select.
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
97
Chapter 6
Build a table
2. To define a phase or operation either select from the option list and then
select OK. Or, select New Phase or New Operation to create a new phase
or operation. See Create operations and unit procedures.
3. To define a unit procedure:
a.
From the Alias list, select the alias to associate with this unit procedure.
b. The Alias list contains a list of all units defined in the procedures unit
requirements.
a.
If this unit runs in parallel with other units, and if each of the units
at this level must acquire in order to initiate this level of the recipe,
then select Acquire unit prior to starting unit procedure.
b. If the units running in parallel can run independently of each
other, clear this check box for all of the units at this level. The
recipe then runs the individual units acquired, regardless of
whether the other units acquire.
c.
Select the appropriate unit procedure to associate with this step. Or,
select New Unit Procedure to create a new unit procedure.
d. Select OK.
See also
Create operations and unit procedures on page 58
Add a null procedure on page 36
Remove a step from
a table
Use these instructions to remove a step from a table.
To remove a step from a table:
1. Select the step to remove.
2. From the Recipe Construction toolbox, select Remove Step
DELETE.
See also
Insert steps into a table on page 95
98
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
or press
Chapter 7
Bind Expressions
Use the Unit Binding Expression Builder to build bind requirement and bind
preference expressions. If the bind requirement or preference type is Expression,
next to the Expression box displays the Unit Binding
selecting browse
Expression Builder dialog box. The Unit Binding Expression Builder dialog
box contains a tree view in the left pane. The tree view shows Recipe Header and
Unit Attribute data used to build an expression.
Select Recipe Header, a list of recipe header parameters displays in the list view
(in the middle). The Recipe Header names map to the same boxes defined within
a Recipe Header.
Create or edit an expression by typing directly in the Expression Builder text box,
select items in the list view and enumerations view, or select various operators. The
operator buttons of the Expression Builder are always enabled. The selected
operator is inserted into the expression at the current cursor position and
displayed in the Expression Builder text box.
When the expression is complete, selecting OK validates and saves the expression
and returns to the Bind Requirements or Bind Preferences dialog box.
There are three types of Bind Expressions: Boolean, Minimize, Maximize. Boolean
expressions must evaluate to true or false. Minimize and maximize expressions
evaluate to real or integer values.
See also
Expression operators expanded on page 100
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
99
Chapter 7
Bind Expressions
Expression data types on page 100
Operands on page 101
Expression validation on page 101
Expression
operators expanded
Parameter expressions support these operators. The precedence of the execution
depicts from highest to lowest. An operator with a higher precedence executes
before an operator of lower precedence.
Operator
Description
()
Expressions within parentheses are evaluated
before expressions outside of parentheses
NOT, -
Logical NOT, negation (of a single argument)
*, /, AND
Multiplication, division, logical AND
+, -, OR
Addition, subtraction, logical OR
<,<=,>,>=
Less than, less than or equal to, greater than,
greater than or equal to
=, <>
Equal to, not equal to
Tip:
If the result of the expression is an Integer, the values used
to build the expression must be Integers — Real is not
compatible with an Integer. However, using division in an
expression always results in the value being a Real number.
See also
Expression data types on page 100
Operands on page 101
Expression data types
The data types supported are integer, real, string, and enumeration. These are 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.
100
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
Chapter 7
Bind Expressions
Tip:
If the result of the expression is an Integer, the values used
to build the expression must be Integers — Real is not
compatible with an Integer. However, using division in an
expression always results in the value being a Real number.
See also
Operands on page 101
Operands
Operands used within a binding expression can reference Recipe Header data,
Unit Attributes, and constants. This table illustrates 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
Bind Expressions on page 99
Expression
validation
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.
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.
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
101
Chapter 7
Bind Expressions
See also
Bind Expressions on page 99
102
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
Chapter 8
Phase, operation sequence, and
recipe parameters
Within a recipe, there are three kinds of parameters:
•
Phase parameters
•
Operation sequence parameters
•
Recipe parameters
See also
Phase parameters on page 103
Recipe parameters on page 104
Operation sequence parameters on page 104
Assign parameter values and phase report limits on page 112
Recipe properties on page 115
Phase parameters
When adding recipe phases to an operation-level recipe, specify the formula values
for its associated phase parameters. Recall that a recipe phase links to an
equipment phase configured in the area model. The recipe phase parameters
originate from the parameters defined in the FactoryTalk Batch Equipment
Editor for the associated equipment phase. Therefore, the recipe phase formula
value parameters are the phase parameters defined for the associated equipment
phase in the area model. These parameters pass data directly to the process
connected device (PCD).
Configure the phase parameter values in one of four ways:
•
Specify them in the FactoryTalk Batch Recipe Editor for the recipe phase at
recipe creation time.
•
Specify them prior to the execution of the recipe phase in a running recipe
after batch creation. (Done most often with an operator prompt.)
•
Specify them as a parameter expression.
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
103
Chapter 8
Phase, operation sequence, and recipe parameters
•
Defer them to a recipe parameter, which allows defining at batch creation
time.
See also
Recipe parameters on page 104
Operation sequence
parameters
When adding an operation sequence to a unit procedure recipe, specify the
formula values for its associated operation sequence parameters.
Configure to have values in one of five ways:
•
Assign values to operation sequence parameters using the FactoryTalk
Batch Recipe Editor.
•
Specify them before the phase or operation sequence step runs, by assigning
a value from an FactoryTalk Batch user control.
•
Specify them when an unacknowledged prompt requests the value for a
phase parameter. The Origin value for the parameter is Operator.
•
Specify the value is calculated from a parameter expression. The Origin
value for the parameter is Expression.
•
Defer them to a recipe parameter, which allows defining at batch creation
time. The Origin value for the parameter is Defer.
See also
Recipe parameters on page 104
Phase parameters on page 103
Formula Value Entry/Report Expression settings on page 109
Recipe parameters
Recipe parameters are parameters associated with the recipe as a whole, not a
particular phase. Recipe parameters:
•
Are created and defined in the FactoryTalk Batch Recipe Editor.
•
Are specific to the recipe.
•
Define any recipe level: operation, unit procedure, or procedure.
The values of the highest level recipe parameters within a batch are defined at
batch creation time.
104
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
Chapter 8
Phase, operation sequence, and recipe parameters
Recipe parameters are:
•
Used in transition conditions.
•
Used to assign parameter values to lower level steps in a process called
deferring.
•
Phase formula value parameter values may defer to the value of
Operation-level recipe parameters.
•
Operation-level recipe parameters may defer to the value of Unit
Procedure-level recipe parameters.
•
Unit Procedure-level recipe parameters may be deferred to the value of
Procedure-level recipe parameters.
Tip:
•
Recipe parameters of unit procedures and operation steps can also use
expressions to reference parent and peer step data (for example, to
calculate a value that other parameter expressions reference).
Procedure-level recipe parameters define at batch creation.
Recipe Formula Parameters
Formula Values
Procedure
Batch creation
Unit Procedure
Procedure
Operation
Unit Procedure
Phase in FactoryTalk Batch
Equipment Editor
Operation
Tip: The grayed cells indicate the function cannot perform within the FactoryTalk
Batch Recipe Editor.
See also
Defer parameters on page 105
Defer parameters
Define the values of the highest level recipe parameters within a batch at batch
creation time. For example, assume:
•
A phase parameters value defers to an operation-level recipe parameter
defined for its containing operation-level recipe.
•
The operation-level recipe parameters value defers to a unit-procedure-level
recipe parameter defined for its containing unit procedure-level recipe.
When creating a unit procedure-level recipe instance, the operator defines the
value for the unit-procedures recipe parameter at batch creation time because this
is the highest level recipe of the batch. The value the operator defines for the
unit-procedure’s recipe parameter passes down to the operation-level recipe
parameters value, which then passes down to the phase parameters value at batch
creation time. When the FactoryTalk Batch Server downloads parameters to the
process-connected-device prior to starting the recipe phase, the phase parameters
value is sent to the process-connected device.
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
105
Chapter 8
Phase, operation sequence, and recipe parameters
Deferring phase parameter values to recipe parameters provides a way to define the
recipe parameter value at batch creation time rather than waiting for the Server to
initiate the phase within the recipe after batch creation time. This frees the
operator from closely monitoring the running recipe for phase parameter value
prompts that would not occur until the Server initiates the phase.
Deferring phase parameters also provides a way for third-party scheduling
packages or other applications working through the Server API (such as the
ActiveX Controls) to create batches and define the values of the corresponding
recipe parameters for those batches at batch creation time.
See also
Recipe parameters on page 104
Step formula values
and phase report
limits
Assign formula values by specifying the values and choosing the step parameter
displayed within an operation. Report parameters pass phase information to the
FactoryTalk Batch server for reports. Typically, this information is a process value.
The parameters and report limits that display in the Formula Value
Entry/Report Expression dialog box are the configured phase parameters and
report limits defined in the area model. Configure the step formula values and
modify the report limits in the Formula Value Entry/Report Expression dialog
box.
If control strategies are configured for the phase class, the first item in the
Parameters values area is named CONTROL_STRATEGY and the Value
column for this item contains a list of configured control strategies. Only the
parameters and reports associated with the selected control strategy display. Select
the appropriate control strategy before configuring parameters and report limits.
106
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
Chapter 8
Phase, operation sequence, and recipe parameters
When configuring parameters, the parameter values may be assigned as literal
values or deferred to another parameter at a higher level in the recipe.
If the step selected is a material-enabled phase class, the Formula Value
Entry/Report Expression dialog box also contains the recipe parameters
(MATERIAL and AMOUNT) and the report parameters (ACTUAL_
AMOUNT and FEED_COMPLETE) associated with material phases. If
optional parameters are enabled, it will also contain the optional material recipe
parameters CONTAINER, LOT, LABEL, and MATERIAL_CLASS.
Tip:
To enable the optional parameters in the FactoryTalk Batch
Equipment Editor, double-click the phase class to open the Edit
Phase Class dialog box. On the Parameters tab, make sure the Add
Optional Material Parameters box is selected.
See also
Material recipe parameters on page 107
Material report parameters on page 108
Parameter Value Entry/Report Limit settings on page 109
Material recipe
parameters
The values of the MATERIAL, LOT and LABEL parameters are combined to
create the material specification. The material specification is used to determine
the container from which a material is drawn, or into which a material is
distributed, when a batch is run. The material specification always contains a
material name. Optionally, the specification can include a lot, a label, or both.
Material recipe parameters:
Parameter Name
Purpose
AMOUNT
Indicates the quantity of the material to be used, or
created, in the recipe. A positive number or zero (0),
indicates a material addition. A negative number or zero
(0), indicates a material distribution. If needed, defer the
value assignment for the AMOUNT parameter to a higher
recipe level or to the operator.
CONTAINER
Cannot be modified. This parameter is used only at run
time. Each time a step is bound to a container, the
FactoryTalk Batch Server stores the container's Controller
ID (the CONTAINER’s enumeration set ordinal value) and
string into this parameter. The container associations are
defined for each phase in the area model.
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
107
Chapter 8
Phase, operation sequence, and recipe parameters
LABEL
Indicates a specific sublot of material to be used in the
recipe, either as a material addition or a material
distribution. If a specific sublot is not needed, leave the
value of the parameter blank and the FactoryTalk Batch
Server selects a sublot based on the material specified,
the unit in which the phase is running, and the phases
container associations. When distributing, the value of the
LABEL parameter is assigned to the Distributed Sublot.
The LABEL parameter value assignment cannot be
deferred.
LOT
Indicates the lot to be used in the recipe either as an
addition or a distribution. If the recipe does not require a
specific lot, leave the parameter value blank and the
FactoryTalk Batch Server selects a lot based on the
material specified, the unit in which the phase is running,
and the phase’s container associations. In distributions,
the LOT parameter value is assigned to the Distributed
Sublot. The LOT parameter value assignment cannot be
deferred.
MATERIAL
Indicates a specific material to be used in this particular
phase. A value must be assigned; and cannot defer to the
value assignment. If the operator selects from a class of
materials at the time the batch is run, select
NULL_MATERIAL in order to enable the MATERIAL
CLASS parameter.
MATERIAL CLASS Indicates a class of materials to be used in this particular
recipe. Assign a value; the value assignment cannot be
deferred. If a material class is selected, the operator is
prompted to select a specific material from the material
class at the time the batch is added to the batch list in
FactoryTalk Batch View. Only one specific material is to
be used in this phase, select NULL_CLASS in order to
enable the MATERIAL parameter.
Tip:
Materials and material classes are configured in the FactoryTalk Batch
Material Editor. Use the same recipe to change back and forth between
a material-specific recipe and a material class-based recipe by
changing the MATERIAL and MATERIAL_CLASS parameters.
See also
Step formula values and phase report limits on page 106
Material report parameters on page 108
Parameter Value Entry/Report Limit settings on page 109
108
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
Chapter 8
Phase, operation sequence, and recipe parameters
Material report
parameters
The FEED_COMPLETE parameter reports that a material addition or
distribution is complete.
The ACTUAL_AMOUNT report parameter records the actual quantity of the
material produced or consumed.
See also
Parameter Value Entry/Report Limit settings on page 109
Formula Value
Entry/Report
Expression settings
The Formula Value Entry/Report Limit Entry dialog box is used to define the
phase, operation sequence, or recipe parameters and reports associated with a
recipe step. The Formula Value Entry/Report Limit Entry dialog box contains:
Item
Description
Parameters value entry
Name
The formula parameter name associated with this step.
(view-only)
Type
The parameter data type as configured in the area model (for
phase parameters) or the FactoryTalk Batch Recipe Editor (for
recipe parameters). Valid types include Real, Integer,
Enumeration, and String. (view-only)
Origin
A single word description of where the value for this parameter
is assigned. Valid entries for the Origin box are:
Value: This assigns a default fixed value for the parameter
(not valid for Timer steps).
Operator: Only available for timer, phase, or operation
sequence step formula values. Postpones the value
assignment to the operator. A prompt is generated in
FactoryTalk Batch View when the recipe is run. The operator
is prompted for a value when the phase or operation sequence
is executing. The operator must enter a value for the
parameter for that phase or operation sequence to continue
running.
Defer: Defers the value assignment to the next higher recipe
level. When Defer is selected, a list of appropriate recipe
parameters to which this phase or recipe parameter may be
deferred is presented in the Value column. This list only
includes existing recipe formula parameters that have the
same data type as the lower level phase or recipe parameter,
and a range less than or equal to the lower level phase or
recipe parameter.
These material parameters cannot be deferred: MATERIAL,
LOT, LABEL, or MATERIAL CLASS.
Expression: Allows assignment of an expression result as the
value for the parameter. Select browse ( ) to open the
Parameter Expression Builder.
Recipe formula parameters must be created if the step formula parameter is
deferred.
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
109
Chapter 8
Phase, operation sequence, and recipe parameters
Item
Description
Parameters value entry
Min
The minimum value for this parameter. This is determined
when the phase parameter is defined in the area model or the
recipe parameter is defined in FactoryTalk Batch Recipe
Editor. (view-only)
Value
The value that is to be assigned to this parameter. This is
dependent on the selected Origin.
For material-enabled phases:
MATERIAL — contains a list of materials retrieved from the
material database.
AMOUNT — dependent on the selected Origin. May be set to
a material amount if the Origin box is Value. The sign of this
value specifies whether the phase is a material distribution
(amount is negative) or a material addition (amount is positive
or zero). The default value is zero.
Max
The maximum value for this parameter. This is determined
when the phase parameter is defined in the area model or the
recipe parameter is defined in FactoryTalk Batch Recipe
Editor. (view-only)
Enum/EU
Enumeration/Engineering Units. The engineering units
associated with the parameter value. This is assigned when
the phase parameter is defined in the area model or the recipe
parameter is defined in FactoryTalk Batch Recipe Editor.
(view-only)
Display
Indicates display of this parameter value in the step in the
SFC. Only one parameter may be displayed per step.
Verification
Method
The algorithm that specifies which policy and set of limits
verify the parameter value validity. There are four possible
verification methods:
• High-High-High/Low-Low-Low
• High-High/Low-Low
• High/Low
• No Limits
The Verification Method is set in FactoryTalk Batch
Equipment Editor. (view-only)
110
LLL
The Low-Low-Low limit value for the parameter (Real,
Integer). This is only enabled if the Verification Method is
High-High-High/Low-Low-Low.
LL
The Low-Low limit value for the parameter (Real, Integer).
This is only enabled if the Verification Method is
High-High-High/Low-Low-Low or High-High/Low-Low.
L
The Low limit value for the parameter (Real, Integer). This is
disabled if the Verification Method is No Limits.
H
The High limit value for the parameter (Real, Integer). This is
disabled if the Verification Method is No Limits.
HH
The High-High limit value for the parameter (Real, Integer).
This is only enabled if the Verification Method is
High-High-High/Low-Low-Low or High-High/Low-Low.
HHH
The High-High-High limit value for the parameter (Real,
Integer). This is only enabled if the Verification Method is
High-High-High/Low-Low-Low.
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
Chapter 8
Phase, operation sequence, and recipe parameters
Item
Description
Parameters value entry
Container
Binding area
(material-en
abled phase
only)
Specifies the method used to bind the material-enabled phase
to a container.
Automatic: The FactoryTalk Batch Server selects the
appropriate container based upon the container associations
configured in the area model and the material specification.
Prompt: The operator is prompted to choose the container
and phase to which the phase is to be bound.
Feed Type
area
(material-en
abled phase
only)
The selection available is dependent upon the phase
parameter values defined in the area model.
If the phase is an addition (material is added to a recipe),
Addition is selected and cannot be edited.
If the phase is a distribution (material is added to inventory),
Distribution is selected and cannot be edited.
If the phase is configured as both, specify the material feed
type associated with this step. The Max and Min values adjust
accordingly.
Many aspects of recipe configuration are dependent upon accessing data
from the material database using the FactoryTalk Batch Material Server. If
the Material Server is not available, the MATERIALS, CONTAINERS, and
MATERIAL CLASS enumeration sets are recreated with the
NULL_MATERIAL, NULL_CONTAINER, and NULL_CLASS, respectively.
reconfigure the materials after the server becomes available.
Report Limits area
Name
The parameter name. (view only)
ID
The number, unique to the phase that identifies this
parameter. (view only)
Type
The parameter data type. Valid types include: Real, Integer,
Enumeration, and String. (view only)
Accumulate
Displays the type of accumulation for the report as defined in
the phase class in the area model. (view only)
Verification
Method
The type of verification method used for the parameter. This
method sets the limits and policies for verifying report values
(view-only).
Limit
Calculation
The equation type used to calculate the limit. There are three
ways to calculate this limit:
Absolute: Absolute value for the parameter.
Percentage: Target Parameter + (Target Parameter *
Percentage)
Relative: Target Parameter + Value (view-only)
Target
Parameter
The recipe parameter used in calculating the limit when the
Limit Calculation is Percent or Relative. (view-only)
LLL
The Low-Low-Low limit for the parameter (Real, Integer). This
is only enabled if the Verification Method is
High-High-High/Low-Low-Low.
LL
The Low-Low limit for the parameter (Real, Integer). This is
only enabled if the Verification Method is
High-High-High/Low-Low-Low or High-High/Low-Low.
L
The Low limit for the parameter (Real, Integer). This is
disabled if the Verification Method is No Limits.
H
The High limit for the parameter (Real, Integer). This is
disabled if the Verification Method is No Limits.
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
111
Chapter 8
Phase, operation sequence, and recipe parameters
Item
Description
Parameters value entry
HH
The High-High limit for the parameter (Real, Integer). This is
only enabled if the Verification Method is
High-High-High/Low-Low-Low or High-High/Low-Low.
HHH
The High-High-High limit for the parameter (Real, Integer).
This is only enabled if the Verification Method is
High-High-High/Low-Low-Low.
EU
The engineering units associated with the parameter, such as
Degrees F or Kilograms. (view only)
See also
Recipe properties on page 115
Step formula values and phase report limits on page 106
Assign parameter
values and phase
report limits
Use these instructions to assign parameter values and phase report limits.
To assign parameter values and phase report limits:
1. Select a step in either the SFC view or Table view.
to display the Formula Value Entry/Report
2. Select Value Entry
Expression dialog box.
112
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
Chapter 8
Phase, operation sequence, and recipe parameters
Tip:
If the step is a phase with configured control strategies,
the first item in the Formula Value Entry/Report
Expression dialog box is named
CONTROL_STRATEGY, and the Value column for this
item defaults to the control strategy assigned as the area
model default.
3. If the step is a phase for which control strategies are defined, select the
appropriate control strategy from the Value list in the row named
CONTROL_STRATEGY. Only parameters and reports associated with
the selected control strategy display.
4. For each formula parameter, select the appropriate origin from the Origin
list. (If the step is a phase or operation sequence, the list includes Operator.)
5. In the Value box, type a value for each parameter.
6. If the data Type is Enumeration, select an enumeration from the Value list
based on the selected origin.
Tip:
The list of enumerations displays in alphabetical order
and configure in the area model.
7. Select Display to see the step formula value for this parameter in the SFC
view step (step formula values always display in the Table view).
8. To change the default parameter deviation limit values defined for the phase
in the area model, edit the limit values for this recipe in the LLL, LL, L, H,
HH, and HHH boxes. The values entered determine deviation events at
run time.
9. If this is a material-enabled phase, select the type of binding in the
Container Binding area.
10. If this is a material-enabled phase, and the parameter is configured for
addition and distribution, specify the material feed type associated with this
step in the Feed Type area.
11. In the Report Limits area, enter the report deviation limit values for this
recipe in the LLL, LL, L, H, HH, and HHH boxes. The values entered
determine deviations in a report value at run time.
12. Select OK to return to the FactoryTalk Batch Recipe Editor window.
See also
Step formula values and phase report limits on page 106
Formula Value Entry/Report Expression settings on page 109
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
113
Chapter 8
Phase, operation sequence, and recipe parameters
Assign formula values
to Timer steps
There are three parameters available for a COUNT_DOWN timer and two
parameters available for a COUNT_UP timer.
To assign formula values to Timer steps:
1. Select a timer step in either the SFC view or Table view.
2. Select Value Entry
dialog box appears.
. The Parameter Value Entry/Report Limit Entry
3. For the HOLD_BEHAVIOR formula parameter, select the appropriate
origin from the Origin list.
114
•
The origin of the SETPOINT and HOLD_BEHAVIOR parameters
of a COUNT_DOWN Timer can be set to OPERATOR, DEFER, or
to the result of an EXPRESSION. When a COUNT_DOWN Timer
parameter is OPERATOR, the FactoryTalk Batch Server prompts the
operator on start of the Timer step to supply a runtime value for the
parameter. When a COUNT_DOWN Timer parameter is DEFER,
the FactoryTalk Batch Server looks to the parent procedure (or upper
level recipe) for the value as defined on the Recipe Formula Parameter
list.
•
Select one of three values for HOLD_BEHAVIOR: CONTINUE,
RETENTIVE, and RESET. The default value is CONTINUE.
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
Chapter 8
Phase, operation sequence, and recipe parameters
•
The origin of the HOLD_BEHAVIOR parameter of a COUNT_UP
Timer can be OPERATOR, DEFER, or EXPRESSION. When a
COUNT_UP Timer parameter is OPERATOR, the FactoryTalk
Batch Server prompts the operator on start of the COUNT_UP Timer
step to supply a runtime value for the parameter. When a
COUNT_UP Timer parameter is set to DEFER, the FactoryTalk
Batch Server looks to the recipe parameter to supply the value for the
step parameter.
•
When the Origin is VALUE, at runtime, the value for the parameter
comes from the value specified in the Value column.
4. The second parameter displayed is SETPOINT. The SETPOINT
determines how long the timer step runs. The default value for the
SETPOINT parameter is the default value configured for the SETPOINT
parameter of the TIMER system phase. The SETPOINT parameter is of
the type Real.
5. The third parameter displayed is TIMER_TYPE. It is set to the
enumeration value of COUNT_UP or COUNT_DOWN. If all the boxes
of this parameter disable; default values cannot change.
6. Select the Display check box to display the SETPOINT, TIMER_TYPE,
or HOLD_BEHAVIOR parameter values on a timer step.
7. Select OK to return to the FactoryTalk Batch Recipe Editor window.
See also
Expressions in parameters and reports on page 121
Recipe properties
Use the Procedure Properties dialog box to configure parameters and reports for
recipe procedures and steps. There are two tabs on the Procedure Properties
dialog box – Parameters and Reports.
See also
Parameters on page 115
Reports on page 117
Aggregate report values on page 118
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
115
Chapter 8
Phase, operation sequence, and recipe parameters
Parameters
Recipe formula parameters provide flexibility when creating recipes. Use recipe
parameters in transition conditions or to substitute for lower-level phase or recipe
parameters. Create a recipe parameter for Operation, Unit Procedure, or
Procedure recipe levels.
Recipe parameter values assign as follows:
•
If the operation is the highest level recipe for the batch, operation recipe
parameter values assign when the operation step is added to a unit
procedure-level recipe or at batch creation.
•
If the unit procedure is the highest level recipe for the batch. unit procedure
recipe parameter values assign when the unit procedure step is added to a
procedure-level recipe or at batch creation.
•
Procedure-level recipe parameter values always assign at batch creation
because this is the highest possible recipe level for the batch.
A recipe formula parameter is a parameter specific to a recipe. A parameter can
be used to pass values from one level of a recipe to the next lower level. A recipe
formula parameter is configured in the FactoryTalk Batch Recipe Editor on a
procedure or operation step. Recipe parameters can be deferred to recipe formula
parameters.
See also
Assign recipe formula parameters on page 116
Assign recipe formula
parameters
Use these instructions to assign recipe formula parameters on the Properties
dialog box, Parameters tab.
To assign recipe formula parameters:
1. Select Recipe Formula Parameters
.
2. On the Parameters tab, select Add Parameter to create a new recipe
formula parameter. A new parameter row displays and is populated with
default values.
116
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
Chapter 8
Phase, operation sequence, and recipe parameters
3. Type the appropriate information in the boxes.
4. Repeat steps 2 and 3 until all recipe formula parameters are defined.
5. Select Apply to save changes and keep the Properties dialog box open,
select OK to save any changes and return to the FactoryTalk Batch Recipe
Editor.
6. To delete a recipe formula parameter, select the row to delete and select
Delete. Select OK to save any changes and return to the FactoryTalk Batch
Recipe Editor.
See also
Parameters on page 115
Use report parameters in transition conditions or to substitute for lower-level
phase or recipe parameters. Create a report parameter for Operation, Unit
Procedure, or Procedure recipe levels. Reports on operation, unit procedure, and
procedure recipes accumulate data from their child steps to aid report generation
activities. Report values are calculated and recorded in the batch event journal
when the state of the procedure is Complete, Aborted, or Stopped.
Reports
See also
Assign report parameters on page 117
Assign report parameters
Use these instructions to assign report parameters on the Properties dialog box
Reports tab.
Assign report parameters:
1. Select Recipe Formula Parameters
.
2. On the Reports tab, select Add Report to create a new report parameter. A
new row displays.
3. Enter a name for the report.
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
117
Chapter 8
Phase, operation sequence, and recipe parameters
4. Select the data type from the list in the Type column, and enter the
appropriate engineering units in the Enum/EU column.
If the Type is Enumeration, select an enumeration from the Enum/EU list.
next to the Report Expression box to display the
5. Select browse
Report Expression Builder dialog box.
6. Create the desired expression to use as the report value, and then select OK
to save the expression into the Report Expression box.
7. Repeat steps 2 through 6 until all reports are defined.
8. Select Apply to save changes and keep the Properties dialog box open,
select OK to save any changes and return to the FactoryTalk Batch Recipe
Editor.
9. To delete a report, select the row to delete and select Delete. Select OK to
save any changes and return to the FactoryTalk Batch Recipe Editor.
See also
Expression value configurations on page 124
118
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
Phase, operation sequence, and recipe parameters
Aggregate report
values
Chapter 8
The report parameters of phases cannot have expressions because a control
program running outside the FactoryTalk Batch Server supplies these values.
There is one exception—the ability to accumulate the values uploaded by phase
logic. The phase logic does not sum integer and real values for reporting purposes.
See also
Reports on page 117
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
119
Chapter 9
Expressions in parameters and
reports
A parameter expression is an arithmetic expression assigned to a recipe parameter
or report parameter of a recipe or a step. Assign a parameter expression to all levels
of the procedural control hierarchy (phase, operation, unit procedure, batch
procedure) where it is appropriate.
Parameters provide a means to perform calculations in the structure of the recipe.
The use of parameter expressions avoids complex and awkward downloading and
uploading of parameter data so the control can perform needed mathematical
operations. A key application is the ability to aggregate report (output) parameter
data into key process indicators (KPIs) at the appropriate level of the recipe. A
secondary application is to enable flexibility in calculating recipe (input)
parameters.
The terms of the expression may reference several different sources of data. Recipe
and report parameters behave differently because their expected roles are different.
A recipe parameter supplies data to the process. A report parameter reports a result
of the process. The two kinds of parameters evaluate and the result is stored as the
value of the parameter at different times.
A parameter expression contains one or more terms with arithmetic operations
connecting them. A term may be a constant value, a data reference, or another
expression. For recipe parameters, the data references are subscribed. As the data
sources change their values, the expression is notified. The expression evaluates the
value and stores the new value for the recipe parameter.
For report parameters, evaluation of the expression does not update as references
change, but as the expression triggers. Conceptually, report parameters intend to
record data resulting from the execution of the process the step represents. This
data typically comes from below the recipes level of the recipe hierarchy (child
data). Or the data references the current level (peer data or data on the same step)
and may include recipe header data, equipment data, and runtime data.
Configure report parameter expressions on operation, unit procedure, and batch
procedure recipes. Expressions on phase report parameters are not supported.
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
121
Chapter 9
Expressions in parameters and reports
See also
Evaluation of recipe parameter expressions on page 122
Evaluation of report parameter expressions on page 123
Expression value configurations on page 124
Evaluation of recipe
parameter
expressions
At runtime, parameter expressions constantly evaluate. Subscriptions create to
each data reference. As these values update, the expression evaluates and updates
the value of its parameter. To avoid overwhelming the event journal with frivolous
events, not every change in value of an input expression records in the event
journal.
It is possible for an expression to evaluate to a value outside the range limits of the
recipe parameter. When this happens, the parameter assigns the value
BAD_VALUE. There are several ramifications for a parameter with the
BAD_VALUE assignment:
•
A download request to a controller will cause the requesting equipment
phase to be HELD.
•
A transition expression referencing the BAD_VALUE parameter will itself
evaluate to BAD_VALUE, which will prevent the transition from firing.
•
A binding expression referencing the BAD_VALUE parameter is unable to
find binding candidates. Binding is pending and the recipes execution does
not advance.
•
An input parameter expression referencing a parameter with a
BAD_VALUE will evaluate its expression to BAD_VALUE.
See also
Validation of parameters with expressions on page 122
Calculated recipe parameter expression value override on page 123
Validation of
parameters with
expressions
When a parameter expression evaluates, the result compares to the verification
policy (Hi/Low, Hi-Hi/Low-Low, or Hi-Hi-Hi/Low-Low-Low). If the value falls
outside the expected range, the appropriate verification policy action triggers. A
value of BAD VALUE does not trigger a verification policy.
Tip:
Parameter validation limits, which can result in the invocation of an
electronic signature, only support phases.
See also
Calculated recipe parameter expression value override on page 123
122
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
Chapter 9
Expressions in parameters and reports
Calculated recipe
parameter expression
value override
The value of a parameter having an expression cannot change unlike parameters
having an origin of VALUE. The Batch View and Batch ActiveX controls provide
the ability to override the expression and assign a value when responding to
extraordinary circumstances. The new displayed value is marked as using the
Override function.
See also
Validation of parameters with expressions on page 122
Evaluation of report
parameter
expressions
At runtime, report parameter expressions differ from recipe parameter expressions
when evaluated. Recipe parameter expressions update continuously. Report
parameter expressions are configured to update on triggers. The report values are
uploaded to the FactoryTalk Batch Server based on the configured report
parameter to upload on terminal state, or if an upload is requested by the phase
logic.
There are two scenarios for phases:
•
One, the phase step transitions to a terminal state and the values
automatically upload.
•
Two, an upload is requested by the phase logic (2XXX and 12XXX upload
commands). So the upload is made on demand. Thus, report parameter
expressions update when their step transitions to a terminal state
(COMPLETE, STOPPED, and ABORTED).
For operation sequences, report parameter expressions update when their step
transitions to a terminal state (COMPLETE, STOPPED, and ABORTED).
See also
Override a calculated report expression on page 123
Override a calculated
report expression
The operator under any circumstances may not change calculated report
parameters. This corrupts the record of the execution of a procedure. There are
two exceptions where the value of a report expression may be changed:
1. A transition expression references the report parameter and its value is
preventing the transition from firing. In this case, use the Force Transition
function to force the transition to fire.
2. A recipe parameter is dependent on a report parameter to provide its value.
If the report parameter is incorrect or undesirable, there is cause to change
it. In this case, use the Override function to change the recipe parameter's
value.
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
123
Chapter 9
Expressions in parameters and reports
See also
Evaluation of report parameter expressions on page 123
Expression value
configurations
A parameter expression is an arithmetic expression that may be assigned to an
input parameter or output parameter of a phase, operation, or unit procedure step
that can reference other parameters and recipe header data within a recipe. The
expression is evaluated and the result stored as the value of the parameter.
A recipe parameter expression may also reference recipe/formula parameters of the
parent operation recipe, data in the operations recipe header, the phases own
recipe parameters, and the phases own report parameters. The FactoryTalk Batch
Server will evaluate the expression and store the result in the phase steps
parameter.
For example, in a control system, the quantity of sugar added is a function of the
quantity of water added by another phase. Configure a recipe parameter
referencing the ADD_WATER report parameter of another phase and use an
expression to calculate the amount of sugar added as the ADD_SUGAR formula
parameter on this phase.
See also
Configure expression values in recipe and report parameters on page 124
Parameter expression functions on page 27
Configure expression
values in recipe and
report parameters
Use these instructions to configure expression values.
Before you begin:
Make sure:
•
The data types of the referenced parameters in the expression are
compatible.
•
The data types real, integer, enumeration, and string are supported (no
string manipulation is allowed).
•
The expression reference phase parameters and report parameters within
the open active step.
To configure expression values in recipe and report parameters:
1. Select a step in either the SFC view or Table view.
124
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
Chapter 9
Expressions in parameters and reports
2. Select Value Entry to display the Parameter Value Entry/Report Limit
Entry dialog box.
3. Select a recipe parameter or report.
in the
4. Select Expression from the Origin list, and then select browse
Value column. (If the step is a phase, the list will include Operator.) The
Parameter Expression Builder opens.
5. From the tree view in the left pane, select the step containing the recipe or
report parameter.
6. From the right pane, double-click the recipe or report parameter used for
the expression to copy it to the text box (or select it and select Paste).
7. Select an operator or function button to enter the desired operation or
math function into the expression. Type directly into the Expression text
box.
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
125
Chapter 9
Expressions in parameters and reports
For this example, a value of 2 times the amount of milk added is used to
determine the amount of sugar to add:
Tip:
The maximum length of a parameter expression is 1023 characters.
8. Select OK to save and validate the expression and to return to the
Parameter Value Entry/Report Limit Entry dialog box. The report
parameter expression displays.
9. Select OK to close the Parameter Value Entry/Report Limit Entry dialog
box and validate the expression.
In a running batch, the parameter expression continuously evaluates. In the
example used in these instructions, the calculation and resulting value is the
amount for the ADD_SUGAR phase. This amount would be 2 times the water
added (50 KG) for a total amount of 100 KG of sugar.
See also
Expression value configurations on page 124
Expression operators on page 126
Parameter expression functions on page 27
126
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
Chapter 9
Expressions in parameters and reports
Expression operators
Parameter expressions support these operators. The precedence of the execution
depicts from highest to lowest. An operator with a higher precedence executes
before an operator of lower precedence.
Operator
Description
()
Expressions within parentheses are evaluated
before expressions outside of parentheses
*, /
Multiplication, division
+, -
Addition, subtraction
Tip:
If the result of the expression is an Integer, the values used
to build the expression must be Integers — Real is not
compatible with an Integer. However, using division in an
expression always results in the value being a Real number.
See also
Parameter expression functions on page 27
Parameter expression
functions
Functions determine how the expression parser handles Real and Integer data
types used in a parameter expression. This table lists available functions and their
behavior on positive and negative values:
Function
Description
Behavior:
Value
Behavior:
Result
RND( )
Round – Numeric values round
to the nearest integer.
6.7
6.5
6.3
-6.7
-6.5
-6.3
7
7
6
-7
-6
-6
RDUP( )
Round up – Numeric values
round to the next larger integer.
6.7
6.5
6.3
-6.7
-6.5
-6.3
7
7
7
-6
-6
-6
TRNC( )
Truncate – Retains only the
integer portion of the numeric
value.
6.7
6.5
6.3
-6.7
-6.5
-6.3
6
6
6
-6
-6
-6
ABS( )
Absolute – Numeric values are
positive values.
For example, if the Real or
Integer is 6.7, there is no effect.
If the Real or Integer is -6.7, it
multiplied by -1 and is 6.7.
6
6.7
-6
-6.7
6.7
6
6.7
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
127
Chapter 9
Expressions in parameters and reports
Function
Description
Behavior:
Value
Behavior:
Result
MOD( )
Modulo – Returns the modulo,
or remainder, of a division.
(Integers only)
7 MOD 6
1
See also
Transition operators on page 27
128
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
Chapter 10
Phase link groups
Phase link groups identify phases that may communicate and work together for
these reasons:
•
Synchronization – For example, one phase running logic will not proceed
until another phase is at a certain point within its own phase logic.
•
Permissives – For example, one phase must pass a certain point in its phase
logic before its partners can begin their phase logic.
•
Data Transfer – For example, moving data from one phase to another.
Phases that need to communicate with each other are message partners. Message
partners organize into link groups in the FactoryTalk Batch Recipe Editor. When
a recipe containing message partner phases is on the Batch List, the link group
definition informs the FactoryTalk Batch Server which phases need to
communicate with each other.
There are three programs involved in implementing message partners:
•
FactoryTalk Batch Equipment Editor – defines the number of message
partners for a phase class within the Area Model.
•
FactoryTalk Batch Recipe Editor – defines the grouping of message
partner phases into link groups.
•
Phase Logic – where the actual communication between the phases occurs.
Tip:
Before defining phase link groups, define the corresponding
message partners in the area model.
A phase link group must contain the same number of phases as there are message
partners plus one (the phase itself), configured in the area model for each of the
phases that are included in the group. For example, if each phase in a phase link
group is configured with three message partners, then there must be a total of four
phases in the phase link group (each phase has three message partners plus itself).
Message partners are configured in the FactoryTalk Batch Equipment Editor.
See also
Message partners on page 130
Create a phase link group on page 132
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
129
Chapter 10
Phase link groups
Delete a phase link group on page 133
Message partners
When a recipe containing message partner phases is on the Batch List, the link
group definition informs the FactoryTalk Batch Server which phases need to
communicate with each other.
There are three programs involved in implementing message partners:
•
FactoryTalk Batch Equipment Editor – defines the number of message
partners for a phase class within the Area Model.
•
FactoryTalk Batch Recipe Editor – defines the grouping of message
partner phases into link groups.
•
Phase Logic – where the actual communication between the phases occurs.
Tip:
Before defining phase link groups, define the corresponding
message partners in the area model.
A phase link group must contain the same number of phases as there are message
partners plus one (the phase itself), configured in the area model for each of the
phases that are included in the group. For example, if each phase in a phase link
group is configured with three message partners, then there must be a total of four
phases in the phase link group (each phase has three message partners plus itself).
Configure message partners in the FactoryTalk Batch Equipment Editor.
See also
Application of message partners example on page 130
Application of
message partners
example
A common message partner application is with a Transfer-Out phase on one unit
and a Transfer-In phase on another unit running in parallel within a
Procedure-level recipe.
When the Transfer-Out phase on a unit is ready to send its material to the next
unit, the Transfer-Out phase’s running logic sets its _RQ value equal to 5501
(where 01 is the message number). The Transfer-Out phase’s running logic, if
coded to do so, halts and waits for the Transfer-In phase to set its _RQ value.
When the Transfer-In phase is ready to receive the material from the previous
unit, the Transfer-In phase’s running logic sets its _RQ value equal to 5201 (where
01 is the message number) and, if coded to do so, halts and waits.
The FactoryTalk Batch Server then coordinates the messaging when it sees that
both message partners have either a 55xx or a 52xx value in their respective _RQ
memory registers and their xx value (the message number) is the same. The
FactoryTalk Batch Server then commands the PLI to reset both message partners’
_RQ values to 0. Once both message partners see their _RQ registers reset to 0,
their running logic (which had halted while they were waiting for their respective
message partner) then continues to execute.
130
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
Chapter 10
Phase link groups
The sequence of events is as follows:
•
T1: Transfer-Out phase is ready; sets _RQ = 5501 and halts its running
logic.
•
T2: Transfer-In phase is ready; sets _RQ = 5201 and halts its running logic.
•
T3: FactoryTalk Batch Server commands the PLI to reset both _RQ
registers to 0.
•
T4: PLI resets both _RQ registers to 0.
•
T5: All running logic resumes execution.
See also
Create a phase link group on page 132
Delete a phase link group on page 133
Link group rules
The rules involving link groups are as follows:
•
Up to 200 link groups per recipe.
•
Up to 20 phases per link group.
•
Define all phases in a link group with the same number of message partners
in the area model’s phase class definition.
•
The total number of phases within a link group must be equal to the
number of configured message partners plus one.
•
Assign each phase instance to only one link group per recipe.
•
Phases in phase link groups must have unique names. If the phase names are
not unique, it will result in missing message partners in the linked groups.
Message partners must run in parallel within a recipe and the phase logic must run
in parallel so the phases can synchronize.
Tip:
When using phase link groups in conjunction with control strategies,
the number of phase link groups cannot vary between control
strategies configured for a single phase. For example, if a phase
configures with two control strategies, CONTROL_STRATEGY_1
and CONTROL_STRATEGY_2, and the phase has two configured
phase link groups, then both control strategies must also have two
phase link groups. CONTROL_STRATEGY_1 cannot have a
different number of phase link groups than
CONTROL_STRATEGY_2.
See also
Phase link groups on page 129
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
131
Chapter 10
Phase link groups
Phase
communication
The actual communication between the phases is programmed in the phase logic
using the _RQ = 5Xxx request category. Commonly implemented between two
individual phases using 55xx and 52xx where:
•
55xx means Request to Wait for a message from another phase.
•
52xx means Send Message and Wait for One Receiver.
•
xx means the message number from 00 to 99. All message partners must
utilize the exact same message number.
One phase is responsible for sending a message to its partners at the appropriate
time. The synchronization occurs when one phase in the group sends the message
and the appropriate number of phase partners wait for the message.
See also
Create a phase link group on page 132
Delete a phase link group on page 133
Create a phase link
group
Use these instructions to create a phase link group.
Tip:
A phase may only be contained in one phase link group.
To create a phase link group:
1. From the Link menu, select Link Groups.
2. Select the appropriate group column heading. The cells in the column
highlight.
3. Select the appropriate phase in the Procedure View pane, or select a phase
step in the Recipe Construction pane.
4. Select Add. The selected phase is added to the link group.
5. Repeat steps 3 and 4 until all phases have been added to the group.
132
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
Chapter 10
Phase link groups
6. Select OK to save changes.
See also
Link group rules on page 131
Delete a phase link group on page 133
Delete a phase link
group
Follow these instructions to remove a phase link group.
To remove a phase link group:
1. From the Link menu, select Link Groups to display the Phase Link Group
dialog box.
2. Select the column header of the group to delete. The cells in the column are
highlighted.
3. Select Delete. The selected group is removed.
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
133
Chapter 10
Phase link groups
Tip:
Phase link groups can exist at any level of a recipe, but only the root level
link groups can be seen or edited.
All of these recipe elements can contain phase link groups. To edit the phase link
group contained in Operation A, open Operation A by itself.
See also
Create a phase link group on page 132
134
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
Chapter 11
Recipe approval process overview
Use the recipe approval process to validate the development and maintenance of
batch recipes. Signature certification allows the recipe approval process to
safeguard the design workflow in a formalized manner. This ensures validation of
each recipe by authorized personnel before released to production, or released as a
component within a larger recipe.
Configure and enable Recipe Approval in the FactoryTalk Batch Equipment
Editor, and executed in the FactoryTalk Batch Recipe Editor.
In addition to the Primary Approval process with up to six approval steps (three
optional), a two-step Expedited Approval process is available.
Use the Expedited Approval process instead of the Primary Approval process, for
example in the early stages of recipe design. A recipe can go through initial review
using the expedited approval process. After the recipe is deemed ready, the
Expedited approval process can be reverted to its starting point, and then the
Primary approval process can be used to validate it for release as a step (procedure
or operation) used in a larger recipe, or to release it to production.
Revert option
Both primary and expedited processes provide a Revert option to allow forward
and reverse progress through the recipe approval process.
•
Revert into the initial Not Started state. The Not Started state allows restart
of the recipe approval process, obtain area model recipe approval process
changes, or switch between the primary and expedited approval processes.
•
Revert returns to the beginning of any incomplete approval step and/or to
any previous approval step without restarting the entire approval process.
•
The revert process operates the same for both the primary approval process
and the expedited approval process.
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
135
Chapter 11
Recipe approval process overview
Release Recipe to Production
With Recipe Approval enabled, Release Recipe to Production is a recipe
approval step, and must be approved to allow the recipe to generate production
batches. Similarly, with Recipe Approval enabled, Release Recipe as Step is a
recipe approval step, and must be approved to allow the recipe to be incorporated
into other recipes.
With Recipe Approval disabled, Release Recipe to Production is a recipe
property and must be checked (set to true) to allow the recipe to generate
production batches. The same is true for Release Recipe as Step--when this recipe
property is set to true, the recipe can be incorporated into other recipes.
When Recipe Approval changes from disabled to enabled in the area model, a
recipe property set to true becomes an approved step, with Recipe Editor using the
$System approver.
See also
Configure recipe approval on page 136
Approve a recipe on page 137
Revert a recipe approval on page 139
Automatic system signoff ($System) on page 141
Configure recipe
approval
136
This chart shows the sequence of tasks in the setup, configuration, and execution
of recipe approval.
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
Chapter 11
Recipe approval process overview
Configure the signature templates used in the Recipe Approval process within the
FactoryTalk Batch Equipment Editor. Approval steps and their signoffs are also
configured in the FactoryTalk Batch Equipment Editor. The process
configuration becomes part of the specific Area Model used by the recipe
elements. Manage the Approval process, primary or expedited, within the
FactoryTalk Batch Recipe Editor.
See also
Recipe version control on page 148
Recipe approval process overview on page 135
Revert a recipe approval on page 139
Automatic system signoff ($System) on page 141
Approve a recipe
Use these instructions to approve a recipe.
Before you begin:
•
In the FactoryTalk Batch Equipment Editor:
•
Enable and configure the Recipe Approval process.
•
Create the required signature templates in the appropriate area model.
•
Save the area model.
To approve a recipe:
1. Open the FactoryTalk Batch Recipe Editor. If prompted to translate the
recipes, select Yes.
•
(optional) Select Verify All Recipes.
•
Select Accept when the verification has finished.
•
If Auditing is enabled, add any desired audit comments. Select OK to
close the Audit Comments dialog box.
•
Select Close to close the Verification Process dialog box.
2. From the File menu, select Open Top Level.
3. From the Recipe Name list, double-click the recipe to open, or select the
appropriate recipe and select Open. The selected recipe opens in the
Procedure View pane.
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
137
Chapter 11
Recipe approval process overview
4. From the Recipe menu, select either Primary Approval or Expedited
Approval depending on the current approval state of the recipe. If an
approval process has not started, either process is available.
5. Depending on which process chosen, the Primary Approval or Expedited
Approval dialog box opens to the Approve tab, showing the next step
available for approval (marked with a pencil
icon). If all step approvals
are completed, the dialog box opens to the Summary tab. Signature
credentials are entered in the area below the signoff step list.
•
In the User box, type the name of a user with the required permissions
for the signoff (configured in the FactoryTalk Batch Equipment Editor
under the Edit menu).
•
Enter the correct password in the Password box.
•
Enter a Comment (mandatory or optional, as configured in the area
model).
•
If a signoff is required to be last in a series of signoffs for an approval
step, it is marked with a checkered flag
•
icon.
If a FactoryTalk Security Permission is invalid, it is preceded by a
in the Security Permission(s) column. Hover over
warning icon
an invalid permission to show any valid permissions for that signoff.
6. Select Approve.
Continue with the approval process for all steps to approve. If a different user is
required to sign off on an approval step, save and close the recipe after any
approval step. The recipe can then be opened by the next authorized signer.
When a signature requires multiple signoffs, each signoff must be made using a
unique UserID and password. Reuse of the same UserID and password results in
this warning:
Be sure to provide a unique UserID and password (different from the UserID
quoted in the warning message) and continue with the signoff.
138
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
Chapter 11
Recipe approval process overview
Tip:
• With the completion of the first signoff on an approval
step, the recipe becomes read-only. To make the
recipe editable, revert all approvals back to the not
started state.
• Any time a recipe is copied using Save As, the
Release Recipe as Step and Release Recipe to
Production states are cleared in the copy.
• Approval steps and their status are included when a
recipe is exported, and retained during import.
See also
Revert a recipe approval on page 139
Revert a recipe
approval
Any completed approval step can be reverted. When a step is reverted, all
completed approval steps that follow it in the approval process are also reverted to
their Not Started state. Reverting the first formal step has the effect of reverting
an entire recipe approval back to its Not Started state. To revert an approved step:
To revert a recipe approval:
1. Open the desired recipe in the FactoryTalk Batch Recipe Editor.
2. From the Recipe menu, select either Primary Approval or Expedited
Approval, determined by which process was used to approve the recipe.
Tip:
Use keyboard shortcuts for the approval process:
• Primary approval process is Ctrl+J
• Expedited approval process is Ctrl+E
3. Select the Revert tab. The Revert tab displays steps that are available to be
reverted.
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
139
Chapter 11
Recipe approval process overview
4. Select the step to revert by selecting on the signature line below the step
name. Gray shading signifies that the step is selected.
5. Enter the signoff credentials to revert that step in the bottom area of the
dialog box and select Revert. If a FactoryTalk Security Permission is invalid,
icon preceding it in the Security
it is indicated by a warning
Permission(s) column. Hover over an invalid permission to show any valid
permissions for that signoff.
6. If the signoff fails, select Clear to empty all values in this area, re-enter the
credentials, and retry the operation.
7. (optional) Select the Summary tab. The Summary shows the selected
approval step marked as Not Started (when a single signature is required) or
Reverting (if more than one signature is required).
8. If more than one signature is required, the other signers must also sign off in
the Revert tab. The Revert tab displays the next required signature with
that line highlighted. The final required signature is marked with a
checkered flag
icon.
When all signatures are entered and the approval process step is reverted, make
and save the necessary edits to the recipe. Navigate to the Approval tab of the
desired approval process, and continue the approval process. Reverting back to the
first step provides the option of switching between approval processes (primary to
expedited, or vice versa).
140
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
Chapter 11
Recipe approval process overview
Tip:
Changing the recipe approval process from enabled to
disabled in the area model has the effect of removing all
signoffs from the current recipe set.
When Recipe Approval is disabled in the area model, and recipes in the current
working set have existing signoffs, the Inconsistency between Area Model and
Recipes dialog box opens.
•
Remove opens the recipe set with all approval step signoffs removed.
•
Exit closes the FactoryTalk Batch Recipe Editor and retains existing
signoffs. Return to the FactoryTalk Batch Equipment Editor, re-enable
recipe approvals, and continue with the recipe approval process in the
FactoryTalk Batch Recipe Editor.
See also
Recipe approval process overview on page 135
Automatic system signoff ($System) on page 141
Automatic system
signoff ($System)
Following recipe translation from FactoryTalk Batch version 11.x to FactoryTalk
Batch version 12, and with Recipe Approvals enabled, the FactoryTalk Batch
Recipe Editor automatically creates the two Expedited Approvals process steps.
The FactoryTalk Batch Recipe Editor creates the Release Recipe to Production
step when:
•
The recipe was migrated from a previous FactoryTalk Batch version that
did not support recipe approvals.
•
Recipe Approvals are enabled in the area model.
If the Release to Production recipe property in the recipe was previously set to
true, then the $System signoff is applied to approve the step.
Similarly, Release Recipe as Step is added (always with approval signoff $System)
when:
•
The recipe was migrated from a previous FactoryTalk Batch version that
did not support recipe approvals.
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
141
Chapter 11
Recipe approval process overview
•
Recipe Approvals are enabled in the area model.
Check if the $System signoff has been applied to a recipe in the FactoryTalk Batch
Recipe Editor. Open the Recipe > Expedited Process dialog box, then select the
Summary tab. Look under the Approver column:
Release Recipe as Step and Release Recipe to Production are managed
differently depending on whether Recipe Approvals are enabled or not:
•
When Recipe Approvals are enabled, Release Recipe as Step is a recipe
approval step and is approved as part of a formal or expedited approval
process. When approved, the recipe can be used within other recipes.
•
With Recipe Approvals disabled, Release Recipe as Step is a recipe
property, and set to true or false by the user in the Recipe > Header Data
dialog box. When true, the recipe can be used within other recipes.
•
When Recipe Approvals are enabled, Release Recipe to Production is a
recipe approval step and is approved as part of a formal or expedited
approval process. When approved, the recipe is placed on the Recipe List in
FactoryTalk Batch View, FactoryTalk eProcedure, or FactoryTalk Batch
ActiveX controls, and the recipe can be used to generate production
batches.
•
With Recipe Approvals disabled, Release Recipe to Production is a recipe
property, and set to true or false by the user in the Recipe > Header Data
dialog box. When true, the recipe is placed on the Recipe List in
FactoryTalk Batch View, FactoryTalk eProcedure, or FactoryTalk Batch
ActiveX controls, and the recipe can be used to generate production
batches.
See also
Recipe approval process overview on page 135
142
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
Chapter 12
Recipe versioning overview
Recipe Versioning enhances management of recipes. A versioned recipe is a saved,
read-only snapshot of the recipe taken at a particular point in time. Recipe
versioning is useful when an author, or a team of authors, need to store and protect
unique versions of the recipe at chosen development milestones.
Recipe versioning starts with a new or existing recipe before it has had a version of
it created. When the recipe has reached a development state the recipe author
wants to protect, the Check In command creates the first instance of a versioned
recipe. At that point, the recipe version is saved, set to read-only, and can no longer
be edited.
Using the Check Out command, an editable work-in-progress (WIP) copy of a
versioned recipe can be created. Typically, a WIP recipe undergoes further
development before being checked in as the next version of the recipe.
Subsequently, a new WIP copy can be made and used in the next iteration of
recipe development.
If a versioned recipe fails verification, it is marked by the system as obsoleted.
Verification can fail due to modifications to the recipe's underlying area model, or
if the recipe references other missing or obsoleted recipes. An obsoleted recipe
cannot be revised in order to pass verification. A WIP copy of an obsoleted version
can be created and then modified to pass verification.
See also
How recipe versions are named on page 144
Restrictions for recipe versions on page 145
Enable recipe versioning option on page 146
Recipe version control on page 148
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
143
Chapter 12
Recipe versioning overview
Recipe versioning
Below the Store Recipes Using area is the Enable Recipe Versioning check box.
Check this box to enable Recipe Versioning, a system-enforced naming
convention that stores and protects recipe revisions. By default the box is
unchecked and recipe versioning is disabled.
Important:
FactoryTalk Full Edit access to FactoryTalk Batch
Equipment Editor is required to enable and disable
recipe versioning.
See also
Recipe versioning overview on page 143
How recipe versions
are named
Recipe versions are maintained through a naming convention enforced by the
FactoryTalk Batch Recipe Editor.
Recipe version naming has three components:
•
Basename is the unique name of a recipe. The recipe author gives the recipe
this name. The basename is identifies all related versions and
work-in-progress (WIP) copies.
•
Version name is the name assigned by the FactoryTalk Batch Recipe Editor
to a versioned recipe created from a new, existing, or WIP recipe. The
versioned recipe's name includes the basename and an appended version
number (for example ~V1).
•
WIP name is the name assigned by the FactoryTalk Batch Recipe Editor to
a WIP copy of a recipe. The name includes the basename, the version
number of the copied versioned recipe, and an appended _WIP, indicating
it is a work-in-progress recipe. The FactoryTalk Batch Recipe Editor
increments the version number for a WIP copy to the next unassigned
version number.
This illustration includes two examples of how recipe version names are derived.
In both examples, the recipe basename is Make_Sauce. The first version saved is
Make_Sauce~V1, and the first work-in-progress copy of that version is
Make_Sauce~V2_WIP.
Tip:
144
When a WIP copy is made using the Check Out command,
FactoryTalk Batch Recipe Editor looks ahead to when the WIP
is saved as a version. For example, the WIP copy of
Make_Sauce~V1 is saved as the second version
Make_Sauce~V2.
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
Chapter 12
Recipe versioning overview
The example on the left shows a straightforward, linear progression from V1 to V4
of the Make_Sauce recipe. The right shows the WIP numbering method, where
earlier versions are used as the basis for creating the next version. FactoryTalk
Batch Recipe Editor manages version naming to avoid duplicates of version
numbers and WIP copy names.
See also
Recipe versioning overview on page 143
Restrictions for recipe versions on page 145
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
145
Chapter 12
Recipe versioning overview
Restrictions for
recipe versions
When using recipe versioning, observe these restrictions:
•
A versioned recipe can only reference other versioned recipes or steps.
•
Once a recipe version, or work-in-progress recipe (WIP), is created, its
basename cannot be changed afterwards, even if recipe version control is
disabled.
•
A new recipe’s basename must be unique; it cannot be the same as an
existing recipe basename or existing recipe name (in the current working
set).
•
A recipe's basename cannot contain any of the naming conventions used by
the system, namely ~V or _WIP. These strings are reserved for use by the
FactoryTalk Batch Recipe Editor.
•
Prior to creating a versioned recipe, the recipe is automatically verified by
the FactoryTalk Batch Recipe Editor; it must pass this verification without
any errors.
•
If a recipe makes reference to missing or obsoleted recipes, it will not pass
verification, and is marked by the system as obsoleted.
•
Import of versioned recipes can result in conflicts, both with version
numbering and version naming.
Tip:
Tip:
Recipe versioning and the recipe approval process are
independent of each other. Recipe steps can be
approved or reverted without being considered as edits
to a versioned recipe.
Recipe version control works with all recipe storage
formats (BINARY, XML, and RDB).
See also
Import conflicts on page 189
146
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
Chapter 12
Recipe versioning overview
Enable recipe
versioning option
Configure Recipe Versioning within the FactoryTalk Batch Equipment Editor.
Area Model authors must have FactoryTalk Full Edit access to FactoryTalk Batch
Equipment Editor to enable and disable versioning.
The FactoryTalk Batch Recipe Editor handles enforcement of versioning naming.
This flow chart shows the sequence of tasks to enable and use recipe versioning.
See also
Disable recipe versioning option on page 147
Disable recipe
versioning option
When recipe versioning is disabled, previously versioned recipes remain read-only
and have all header boxes disabled. It is still prohibited to name a new recipe in
conflict with any existing basename, in order to avoid name collisions if recipe
versioning is re-enabled.
Rename a previously versioned recipe by using the Save As command to create a
new recipe. Edit and save a previous work-in-progress (WIP) recipe--use Save As
and provide a new recipe name to disassociate the recipe from its former
basename.
See also
Copy recipe options on page 75
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
147
Chapter 12
Recipe versioning overview
Create a recipe
version
Prior to starting this procedure, ensure that recipe versioning is enabled in the
Server Options dialog box in the FactoryTalk Batch Equipment Editor.
To create a recipe version:
1. Create a new recipe using any of these options:
•
Use the File menu New command.
•
Use the Save As command.
•
Create a new recipe as part of adding a step to an open recipe.
Be sure to specify a unique basename when creating the new recipe. Observe
naming restrictions.
2. Edit the recipe, and then Save the recipe.
3. Use the Check In command to create the first version.
•
To edit this version of the recipe, use the Check Out command to
create an editable copy and make the necessary changes.
•
When finished editing, use the Check In command again to create the
next version of the recipe.
4. Use the Check Out command to create an editable copy of this version.
This process can be repeated as many times as required (the only restriction is that
the length of the recipe name cannot exceed 50 valid characters).
See also
Enable recipe versioning option on page 146
Restrictions for recipe versions on page 145
Recipe version
control
With recipe version control enabled, these menu items (and their corresponding
toolbar icons) are available:
Check In (under the File menu)
- Creates a read-only recipe version from a
new or Checked Out work-in-progress (WIP) recipe. Enabled if a new or Checked
Out recipe is open in the FactoryTalk Batch Recipe Editor. A Checked In recipe
cannot be edited, but recipe step approvals can be signed off.
•
148
Check Out (under the File menu)
- Creates an editable WIP recipe
from a recipe version. Enabled if a versioned or obsolete recipe is open in the
FactoryTalk Batch Recipe Editor.
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
Chapter 12
Recipe versioning overview
•
Version History (under the Recipe menu)
- Opens a dialog box
displaying information about the Previous recipe version and the current
recipe. Enabled when any recipe is open in the FactoryTalk Batch Recipe
Editor.
With recipe version control enabled, the File menu commands in the FactoryTalk
Batch Recipe Editor operate as follows, depending on the type of recipe
(unversioned, WIP, or versioned) that is open:
Command
Unversioned recipe
or new recipe
New
• Creates a new recipe.
Checked Out
(WIP) recipe
Checked In
(versioned) recipe
Not allowed.
• Prompts to provide a unique
name for the recipe.
Observe the naming
restrictions.
Save
Saves changes in the open file Saves the changes in the
to the working set.
WIP file to the working set.
• Versioned recipes cannot be
edited--they cannot be
saved.
• If Recipe Approvals are
enabled, the recipe with its
approval state is saved
automatically with every
approval or revert signoff.
Save As
• Saves the current recipe as
a new recipe with a new
name.
• Saves the current recipe as a new recipe with a unique,
user-specified basename. Observe the naming restrictions.
• The original recipe is closed
and unchanged.
• Version history information is removed.
• Any approval steps are
removed.
Modify
• The original recipe is closed and unchanged.
• Any approval steps are removed.
• If Recipe Approvals are enabled and an approval process is • Versioned recipes cannot be
not active:
edited.
• Any user with editing rights is allowed to edit all
aspects of the recipe.
• See Rename command below.
Export
• If Recipe Approvals are
enabled, approval steps can
be signed and reverted.
• Save an exact copy of a specified recipe to the specified working set of recipes.
• User is prompted before overwriting an existing versioned file.
• Existing recipe approval steps are maintained.
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
149
Chapter 12
Recipe versioning overview
Command
Unversioned recipe
or new recipe
Checked Out
(WIP) recipe
Checked In
(versioned) recipe
Import
• Import an exact copy of a
recipe from another working
set of recipes into the
current working set of
recipes.
• If a version conflict exists,
choose which version to
import.
• Confirm to overwrite an
existing versioned file.
• Existing recipe approval
steps are maintained.
• If a recipe basename
conflict exists with one or
more recipes in the working
directory, import the recipe
that causes the conflict.
• Existing recipe approval
steps are maintained.
• If no name conflict exists,
this imports an exact copy of
a recipe from another
working set of recipes into
the current working set of
recipes.
• If a version conflict exists,
prompts to resolve the
conflict.
• If a recipe basename conflict
exists with one or more
recipes in the working
directory, the recipe that
causes the conflict cannot
be imported.
• Existing recipe approval
steps are maintained.
Remove
Recipe
• Deletes the recipe from the working set (any referencing recipe will then have a missing
element).
Rebuild
Recipe
Directory
• If a recipe is added or
deleted from the recipe
directory without using the
FactoryTalk Batch Recipe
Editor, this command
rebuilds the recipe directory
and provides an option to
verify all recipes within it.
• If a recipe basename or version numbering conflict exists
with two recipes in the recipe directory, choose which recipe
to retain in the directory.
Rename
(Change
Header data
& Save)
• Changes the name of the
file and automatically
propagates to all referencing
files.
Not allowed.
• Updates all the transition
expressions and parameters
with the new name.
• Name cannot change if an
approval process is active.
• The recipe remains a New
Recipe.
150
Print
Print the recipe.
Verify
Standard verification process.
Additional verification rules
apply. If the recipe refers to a
missing or obsolete unit
procedure or operation, the
recipe is marked as obsolete.
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
Chapter 12
Recipe versioning overview
Command
Unversioned recipe
or new recipe
Checked Out
(WIP) recipe
Checked In
(versioned) recipe
Check In
• If the recipe verifies, create
a new file (basename~V1)
• If the recipe verifies, create Not Applicable.
a new file (basename~Vn)
• Replace all references to the • Replace all references to
basename with
the WIP recipe with
basename~V1.
basename~Vn.
• Recipe basename is
deleted.
• Existing recipe approval
steps are maintained.
Check Out
• WIP recipe is deleted.
• Existing recipe approval
steps are maintained
• Creates the next WIP recipe
for the current recipe
(basename~Vn_WIP).
Not Applicable.
• Existing recipe approval
steps are removed.
See also
Restrictions for recipe versions on page 145
Recipe versioning overview on page 143
Import conflicts on page 189
Recipe version history
Select Version History
to view recipe version information.
The version history consists of:
•
Recipe name
•
Version description
•
Version creation date
•
Version verification date
•
Area model date (when last saved)
•
Area model name against which the version was verified
All boxes are read-only with the exception of the Version Description box under
Current Recipe. This box can be edited if:
•
The recipe itself is editable (editable recipes are both unversioned and
work-in-progress (WIP) recipes that have not started a recipe approval
process).
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
151
Chapter 12
Recipe versioning overview
•
The FactoryTalk user has full access rights.
See also
Obsoleted recipe versions on page 152
Obsoleted recipe
versions
During verification, the area model configuration stored in the recipe is compared
against the current area model. If the recipe configuration and area model do not
match, the recipe fails verification and is subsequently marked by FactoryTalk
Batch as Obsoleted.
Obsoleted recipes:
•
Are still versions of the basename recipe.
•
Can be imported and exported, and removed from the working recipe set
(using the Remove Recipe command).
•
Cannot be opened, modified, renamed, checked in, printed, checked in, or
saved.
•
Do not allow a containing recipe to verify--an obsolete recipe is treated as a
missing recipe element. See Verification issues with a versioned recipe in
the section on Troubleshooting for more information.
•
Any step in a visible recipe that references an obsoleted recipe is outlined in
red.
To work with an obsoleted recipe:
•
Use the Save As command to create a new recipe. The new recipe is not
marked as obsoleted.
•
Use the Check Out command to create a new, editable, work-in-progress
(WIP) recipe. The FactoryTalk Batch Recipe Editor will make all required
area model configuration changes to the WIP as it is created, indicating the
modifications in the verification progress dialog box. The original obsoleted
recipe remains unchanged.
Once the WIP recipe is checked back in:
152
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
Chapter 12
Recipe versioning overview
•
It is given the latest version number.
•
The original obsoleted recipe remains in the working directory.
Alternatively, to reinstate an obsoleted recipe (clear its obsoleted status), modify
the area model in the FactoryTalk Batch Equipment Editor to match the recipe
configuration. When the recipe next undergoes verification by the FactoryTalk
Batch Recipe Editor, it is reinstated as a current versioned recipe.
Tip:
If a Recipe Approval Process is associated with a recipe when it is
marked as obsoleted, its approval properties remain in effect and
can be approved or reverted as needed.
See also
Verification results for a versioned recipe on page 202
Author recipes
using version
control and recipe
approvals
Use these examples to help determine whether to enable recipe versioning or
recipe approvals:
Recipe versioning can be used in conjunction with the Recipe Approval
Process--playing a complementary role in recipe development.
Tip:
When using recipe versioning and approvals together,
consider applying expedited approvals to a checked-out
(WIP) recipe, and the formal approval process to a
checked-in (Versioned) recipe.
This section details the four scenarios when enabling or disabling Recipe Version
Control and the Recipe Approvals Process:
Recipe Versioning
Disabled
Recipe Versioning
Enabled
Recipe Approvals
Process Disabled
Scenario 1
Scenario 2
Recipe Approvals
Process Enabled
Scenario 3
Scenario 4
•
Scenario 1: Recipe Versioning and Recipe Approvals are disabled.
Commands in the FactoryTalk Batch Recipe Editor operate in their normal
fashion. No enhanced version control or formal approval process is involved
in authoring and readying a recipe for production use. The Release Recipe
as Step and Release Recipe to Production properties function in this way:
•
To use a recipe or operation in another recipe, select the Release
Recipe as Step check box in the Recipe Header Data dialog box.
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
153
Chapter 12
Recipe versioning overview
•
•
Scenario 2: Recipe Versioning is disabled and Recipe Approvals are
enabled. The approval process governs if the Release Recipe as Step and
Release Recipe to Production steps are approved or not.
•
Scenario 3: Recipe Versioning is enabled and Recipe Approvals are
disabled: These additional commands are available in the FactoryTalk
Batch Recipe Editor (enabled or disabled depending on what versioning
state the current open recipe is in): Check In, Check Out, and Parent
information.
•
154
To add a recipe to the Recipe List in FactoryTalk Batch View,
FactoryTalk eProcedure, or FactoryTalk Batch ActiveX controls, select
the Release Recipe to Production check box in the Recipe Header
Data dialog box.
•
When a version of a recipe is created using Check In, the Release
Recipe as Step and Release Recipe to Production properties are
carried over unchanged.
•
When a work-in-progress (WIP) recipe copy is created using Check
Out, the Release Recipe as Step and Release Recipe to Production
properties are always cleared (set to false).
•
When a new recipe is created using Save As, the Release Recipe as
Step and Release Recipe to Production properties are always cleared
(set to false). The original recipe is unchanged.
•
To use a versioned or WIP recipe in another recipe, select the Release
Recipe as Step check box in the Recipe Header Data dialog box.
•
To add a versioned or WIP recipe to the Recipe List in FactoryTalk
Batch View, FactoryTalk eProcedure, or the FactoryTalk Batch
ActiveX controls, select the Release Recipe to Production check box
in the Recipe Header Data dialog box. All sub-recipes and procedures
within a recipe must also have their Release Recipe to Production
check boxes selected.
Scenario 4: Recipe Versioning and Recipe Approvals are enabled:
Versioning commands in the FactoryTalk Batch Recipe Editor are available
(some may be disabled depending on the state of the open recipe), as are
menu commands for Approvals Process and Expedited Approval.
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
Chapter 12
Recipe versioning overview
Tip:
Changing the Release Recipe as Step and the Release
Recipe to Production approval states is not considered
an edit or change to a recipe itself.
•
A new recipe (created using Save As or New) is set to Approval
process not started and can go through either the formal approval
process or expedited process.
•
A newly-created version or WIP recipe keeps any completed or
in-progress approval steps from the original recipe.
•
When a version of a recipe is created, the Release Recipe as Step and
Release Recipe to Production properties (Recipe Approvals disabled)
or approval steps (Recipe Approvals enabled) are carried over
unchanged.
•
Approve and revert steps in a versioned recipe--there is no need to
create a WIP recipe to do this.
See also
Recipe versioning overview on page 143
Recipe approval process overview on page 135
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
155
Chapter 13
Security authority overview
FactoryTalk Batch Security Authority, when enabled, protects intellectual
property (as contained in recipes) and ensures it is only used within its intended
scope. Security Authority helps secure recipes from unauthorized copying, editing,
import, export, and use. Binary is the only recipe format that is allowed for the
Security Authority setting.
The FactoryTalk Batch Recipe Editor, when directed by an authenticated user to
secure a recipe, associates the Security Authority Identifier (SAI) stored in the
FactoryTalk Network Directory with the recipe. When the FactoryTalk Batch
Recipe Editor is later directed to open the secured recipe, the SAI in the recipe is
compared to the current SAI in the current FactoryTalk Network Directory. If
they match, the FactoryTalk Batch Recipe Editor opens the recipe. 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 recipe and stops the process.
Important:
If the SAI in a FactoryTalk Network Directory is
changed or lost, access to any recipe that is bound
to it may be lost. Rockwell Automation
recommends that, before securing a recipe, back
up the FactoryTalk Network Directory, and store
unsecured versions of the recipe files in binary
(.OUP, .UPC or .BPC), XML (.oxml, .uxml, or
.bxml), or RDB formats in a secure location.
See also
Security authority configuration on page 157
Secure recipe on page 159
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
157
Chapter 13
Security authority overview
Security authority
configuration
This flow chart shows the sequence of tasks in the configuration and use of
security authority.
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
Import and export restrictions for secured recipes on page 192
Security authority overview on page 157
158
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
Chapter 13
Security authority overview
Secure recipe
Recipes are secured using the Security Authority command. Use these
instructions to secure the recipe.
To secure a recipe:
1. Open the recipe to secure in the FactoryTalk Batch Recipe Editor.
Important:
Before securing a recipe to a specific FactoryTalk Network Directory, Rockwell
Automation recommends backing up the FactoryTalk Network Directory and
store unsecured versions of the recipe files in binary (.OUP, .UPC or .BPC),
XML (.oxml, .uxml, or .bxml), or RDB 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 a recipe is secured to a particular FactoryTalk Network Directory, it cannot
be opened if the security authority identifier associated with that directory no
longer exists.
2. Select Recipe > Security Authority. The Security Authority dialog box
opens.
3. Select the check box to secure the recipe. If the check box is not enabled, the
user account is not authorized to use this feature.
4. Select Save.
See also
Security authority configuration on page 157
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
159
Chapter 14
Complete and maintain recipe
Once the recipe is saved, verify the recipe and release to production for batch
operator access.
See also
Verify recipe on page 161
SFC validation on page 163
Release Recipe as Step option on page 172
Release a recipe to production option on page 172
Rebuild the recipe directory on page 172
Verify recipe
Verify recipe is the process that checks the recipe for completion and accuracy. A
recipe must be verified to ensure that all connections and references are properly
made. The verification process examines the selected recipe and all lower-level
recipes. If there are errors in the recipes being verified, messages explaining the
nature of the error are displayed.
Tip:
To verify all recipes, from the File menu select Verify All Recipes or
Verify All Recipes and Validate All SFCs.
To verify a recipe:
1. Open the recipe to verify.
2. Select Verify or select Verify Recipes from the Recipe menu. The
FactoryTalk Batch Recipe Editor reads the current recipe and displays a list
of the recipe’s outstanding problems, if any, and saves the recipe in the
process.
Important:
FactoryTalk users with ViewOnly permissions to the
FactoryTalk Batch Recipe Editor cannot open the FactoryTalk
Batch Recipe Editor to verify recipes. The FactoryTalk Batch
Recipe Editor will close.
3. If there are errors, double-click an error message to open the recipe to the
recipe level where the error was detected.
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
161
Chapter 14
Complete and maintain recipe
Tip:
Copy the error text and paste it to a text document or spreadsheet if
desired. Hold down Ctrl and select on the errors to copy. Use the Ctrl+C
command to copy to the Clipboard.
4. Fix the problem and run the verification again. Continue this process until
the recipe verifies successfully.
5. When the recipes are successfully verified, the SFC structure can be
validated. From the File menu select Verify All Recipes and Validate All
SFCs.
See also
SFC validation
What gets verified?
on page 163
When a recipe is opened in FactoryTalk Batch Recipe Editor, FactoryTalk Batch
Recipe Editor checks that all the phases, operation sequences, parameters, and
reports in the recipe also exist in the area model. If any parameters or reports have
changed in the area model since the recipe was originally built, FactoryTalk Batch
Recipe Editor automatically adds or removes parameters or reports from the recipe
accordingly. Material references are also checked when the recipe is opened. If the
material is not present in the material database, the material parameter is reset to
NULL_MATERIAL.
When a recipe is verified, these items are also checked:
162
•
Basic Structure is verified to ensure there is an initial step, a terminal step,
other steps, and that they are all linked together.
•
Unit Requirements are verified against the area model. For example, does
the Unit Class or the Unit Instance exist in the area model? Is there a flow
path in the area model that satisfies the Procedure Unit Requirement
specified flow path?
•
Deferred Parameters are within the min/max and limits of the parameters
that are deferred to them.
•
Enumeration set names and elements found in the area model.
•
Phase links referential integrity (have partners), along with the message
partner information found in the area model.
•
Phase class names found in the area model.
•
Header Identifier, version, timestamp and author are not empty.
•
Recipe Approval Steps that are incomplete use valid signoffs (signature
templates are assigned to valid FactoryTalk users and/or groups).
•
Release Recipe as Step property is enabled on recipes.
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
Chapter 14
Complete and maintain recipe
•
Recipe Versions are compatible with other parent or offspring recipes with
the same basename. The verification results include information on Recipes
to be Obsoleted and Obsoleted Recipes to be Repaired.
•
All step recipe paths are valid (only if Verify All Recipes and Validate All
SFCs is selected). For Procedures, this means that each referenced Unit
Procedure recipe exists. For Unit Procedures, it means that each referenced
Operation exists. For Operations, it means the Phase is in the area model.
•
Referenced recipes existence (through the step name).
Important:
If a working recipe is changed and fails verification, the
Release Recipe as Step and the Release Recipe to
Production properties in the recipe header are
preserved. Due to verification errors, the recipe may be
unavailable for use in production. Fix all verification errors
to make the recipe available for use.
See also
Verify recipe on page 161
SFC validation
The verification feature ensures that basic SFC legality rules, such as
step-transition-step sequencing, are enforced, but the recipe verification check
does not detect logic errors within the SFC structure. Beginning with FactoryTalk
Batch v. 10, the FactoryTalk Batch Recipe Editor provides SFC validation which
is an error check that looks for logic errors in the SFC structure defined within a
recipe.
For example, this SFC is structurally invalid:
While the above SFC structure would pass the current verification checks done by
the FactoryTalk Batch Recipe Editor, this structure would never run to
completion for this reason: The final transition condition following the AND
Convergence cannot execute unless all prior steps above it are concurrently active.
The OR Divergence ensures that only one of the steps prior to the AND
Convergence can be active at one time. While the error in the SFC shown above is
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
163
Chapter 14
Complete and maintain recipe
relatively easy to identify, this type of SFC flaw and others can be much more
difficult to identify in more complex recipe structures.
The SFC Validation tool can detect a variety of programming errors that result in
invalid or illegal SFC programs. SFC structures identified as invalid by the tool
results in recipe verification warnings. Note that the Release Recipe to
Production approval or check box is not cleared by the verification checks.
See also
FactoryTalk Batch Recipe Editor
toolbar on page 16
Run SFC validation on page 164
Set allowable SFC permutations on page 165
SFC validation error types on page 165
Run SFC validation
While SFC validation is optional, it is good practice to get in the habit of
validating the SFC structures.
Tip:
To validate all recipes, from the File menu, select Verify all
Recipes and Validate all SFCs.
To run SFC validation:
1. Open the recipe containing the SFC to validate.
2. From the Recipe menu, select Verify all Recipes and Validate all SFCs, or
select Verify and Validate.
The FactoryTalk Batch Recipe Editor reads the current recipe structure,
determines its validity, displays a list of the recipe’s outstanding problems,
and saves the recipe.
Errors display in the Recipe Verification dialog box.
3. If there are errors, double-click an error message to open the recipe
containing the error.
4. Fix the problem and run the validation again. Continue this process until
the recipe validates successfully.
See also
Set allowable SFC permutations on page 165
SFC validation error types on page 165
164
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
Chapter 14
Complete and maintain recipe
Set allowable SFC
permutations
The SFC Validation tool deals with OR Divergences by examining each possible
leg of the divergence as if it were a separate SFC. This leads to a combinatorial
number of possible SFCs when encountering multiple divergences within an SFC.
For example, if an SFC contained three OR Divergences, one with three legs, one
with two legs, and the third with four legs, the number of SFC permutations that
would need to be examined would be 24 (3x2x4 = 24).
If configured a recipe with an extremely large number of OR Divergences,
validation may take several minutes to complete. For this reason, define how many
OR divergences the validation checks.
Tip:
If the recipe contains more OR divergences than the
upper limit allows, the recipe is considered too complex
and validation stops. Configure the upper limit in the
FactoryTalk Batch Recipe Editor Options dialog.
To set allowable SFC permutations:
1. To set the maximum number of SFC permutations, select Options from
the Recipe menu.
2. Change the value in the SFC Validation: Max Number of OR
Permutations box to the desired number.
The default setting is 65535. The allowable range for the configuration
parameter is from 1024 to 2,097,152, inclusive.
3. Select OK to save the changes.
See also
SFC validation error types on page 165
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
165
Chapter 14
Complete and maintain recipe
SFC validation error
types
Five basic errors can occur within an SFC structure. These examples show how to
create and detect these errors.
The SFC Validation function identifies the linear segment of an error. Note that
this may not be the location of the actual structural issue. The error message
generated by SFC Validation when it detects an SFC structure error may include a
linear segment specifier that provides the name of the first step in the linear
segment of the error. If the first step in the linear segment is an Initial Step or
Terminal Step of the SFC, then the step name, as currently used by the
FactoryTalk Batch Server, is INITIALSTEP:1 or TERMINALSTEP:1.
Example:
WARNING: INITIALSTEP:1 >> Parallel Activation of Linear Segment
If there are no steps present in the linear segment, the string STEP NOT
PRESENT IN LINEAR SEGMENT is used.
Example:
WARNING: STEP NOT PRESENT IN LINEAR SEGMENT >>
Parallel Activation of Linear Segment
See also
Parallel activation of a linear segment on page 166
Unreachable terminal step on page 167
Parallelism with terminal step on page 168
Linear segment cannot reach terminal step on page 169
Unreachable linear segment on page 171
166
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
Chapter 14
Complete and maintain recipe
Parallel activation of a
linear segment
The loopback from the right leg of the OR Divergence back into the Linear
Segment prior to the AND Convergence is the source of the error. Two execution
tokens exists in the same linear segment, which is the segment containing the step
marked with an X:
The actual error message text is similar to: WARNING: SFC Validation Tool
detects dual activation of Linear Segment beginning with step:%1 (where %1
is the actual segment identifier). The reported error location may not be close to
the SFC structural issue. Refer to the product documentation for examples of SFC
structures that can report this error. Other errors may or may not be present.
See also
Unreachable terminal step on page 167
Parallelism with terminal step on page 168
Linear segment cannot reach terminal step on page 169
Unreachable linear segment on page 171
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
167
Chapter 14
Complete and maintain recipe
Unreachable terminal step
SFC Validation can detect when an SFC structure makes it impossible for a recipe
execution to reach the SFC terminal step.
In this SFC, the OR Divergence activates only one of the two steps below it. This
means that the transition below the AND Convergence never activates, since it is
not permitted to fire unless all prior steps are active. This error makes it
impossible for an execution token to reach the terminal step of the SFC.
The actual error message text is similar to: WARNING: SFC Validation Tool
detects unreachable Terminal Step. Refer to the product documentation for
examples of SFC structures that report this error. Other errors may or may not be
present.
See also
SFC validation error types on page 165
Parallelism with terminal step on page 168
Linear segment cannot reach terminal step on page 169
Unreachable linear segment on page 171
168
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
Chapter 14
Complete and maintain recipe
Parallelism with terminal
step
SFC Validation can detect when an SFC structure makes it possible to reach the
terminal step of the SFC while other linear segments within the structure still
have active execution tokens.
For example, in the SFC below, the AND Divergence activates both steps below it.
Then, whichever leg of the parallelism completes first has its execution token reach
the terminal step. This results in an execution token reaching the terminal step of
the SFC while another execution token is active within the structure. This is
defined as an illegal behavior — when an execution token reaches the terminal
step of the SFC, it should be the only execution token present in the SFC
structure.
The error message text is similar to: WARNING: SFC Validation Tool detects
parallelism with Terminal Step of Linear Segment beginning with step:%1
(where %1 is the segment identifier). The reported error location may not be
close to the SFC structural issue. Refer to the product documentation for
examples of SFC structures that can report this error. Other errors may or may not
be present.
See also
Linear segment cannot reach terminal step on page 169
Unreachable linear segment on page 171
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
169
Chapter 14
Complete and maintain recipe
Linear segment cannot
reach terminal step
SFC Validation Tool detects when an SFC structure makes it impossible for an
active execution token contained within a linear segment to reach the SFC
terminal step. For example, in the SFC example below, if the active token goes
down the right branch of the first OR Divergence, then the execution token enters
an infinite loop through which it can never reach the terminal step of the SFC.
A second type of SFC structure can also generate this error. In the SFC structure
below, if the recipe execution goes through the right-most transition, indicated by
the arrow, then the execution token reaches a dead end in the second step of the
right-most leg of the AND Divergence and recipe execution is unable to reach the
terminal step.
In this SFC example, the linear segment reported by the Validation Tool as the
source of the error actually contains no steps.
170
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
Chapter 14
Complete and maintain recipe
The actual error message is similar to: WARNING: SFC Validation Tool
detects Linear Segment beginning with step:%1 (where %1 is the segment
identifier) has no path to Terminal Step. Refer to the product documentation
for examples of SFC structures that can report this error. Other errors may or may
not be present.
See also
SFC validation error types on page 165
Unreachable linear segment on page 171
Unreachable linear
segment
SFC Validation also detects when an SFC structure makes it impossible for an
active execution token to reach one or more linear segments within the SFC. For
example, in this SFC, the linear segment under the AND Convergence is
unreachable because it is impossible for both prior steps to have active execution
tokens simultaneously due to the initial OR divergence. This means that if recipe
execution takes the left branch of the first OR Divergence, or the left branch of the
second OR Divergence, then recipe execution becomes hung and unable to
proceed.
The error message is similar to: WARNING: SFC Validation Tool detects
unreachable Linear Segment beginning with step:%1 (where %1 is the
segment identifier). Refer to the product documentation for examples of SFC
structures that report this error. Other errors may or may not be present.
See also
SFC validation error types on page 165
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
171
Chapter 14
Complete and maintain recipe
Release Recipe as
Step option
To use a recipe within another recipe, set the Release Recipe as Step property to
true. When no Recipe Approval process is in use, select the Release Recipe as
Step check box in the Recipe Header dialog box. When enabled Recipe Approval
process, set this property by completing the signoff for Release Recipe as Step
during the recipe approval process.
Tip:
A recipe is valid for release to production only when all
steps and procedures within it are approved as Release
Recipe as Step.
See also
Release a recipe to production option on page 172
Release a recipe to
production option
Only recipes created in the FactoryTalk Batch Recipe Editor have access to
FactoryTalk Batch View, FactoryTalk eProcedure, FactoryTalk Batch ActiveX
controls, or other client applications. If a recipe is to appear as a choice in a client
application Recipe List, release the recipe to production. When no Recipe
Approval process is in use, a recipe is released to production by checking the
Release Recipe to Production check box in the Recipe Header dialog box.
When a Recipe Approval process is enabled, the release to production property is
set by completing all signoffs in the recipe approval process.
A recipe is valid for release to production only when all procedures within it are
respectively approved as Release Recipe as Step.
See also
Release Recipe as Step option on page 172
172
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
Chapter 14
Complete and maintain recipe
Rebuild the recipe
directory
The working set of recipes is stored in the location specified on the Project
Settings tab of the FactoryTalk Batch Equipment Editor Server Options dialog
box. If a recipe has been added to or deleted from this recipe storage location
without using the FactoryTalk Batch Recipe Editor, rebuild the recipe directory.
To rebuild the recipe directory:
1. There are two options:
•
If the FactoryTalk Batch Recipe Editor is closed, open it to rebuild the
recipe directory. Any recipe file additions or deletions are shown when
using the Open, Remove, Import, Export, or Generate Reports
menus in the FactoryTalk Batch Recipe Editor.
•
If the FactoryTalk Batch Recipe Editor is already open, select File >
Rebuild Recipe Directory. The FactoryTalk Batch Recipe Editor
reads all of the currently stored recipes and updates the recipe directory
file.
2. If a recipe version conflict occurs when rebuilding the directory, the
Resolve Version Conflict for Rebuild Recipe Directory Request dialog
box opens. A prompt opens to retain one of the two recipes that conflict.
Tip:
If there are unverified recipes in the recipe directory, the option
to verify all recipes or verify and validate all recipes displays.
See also
Import conflicts on page 189
SFC validation on page 163
Recipe maintenance
Recipe maintenance includes find recipe references, page setup, generating reports,
remove recipe, and translate recipes.
See also
Find Recipe References overview on page 174
Page setup on page 175
Generate reports option on page 176
Remove a recipe on page 180
Translation on page 180
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
173
Chapter 14
Complete and maintain recipe
Find Recipe
References overview
Use Find Recipe References to locate recipes that contain a specified operation
or unit procedure. The reference recipe is the operation or unit procedure
referenced in container recipes searched. A container recipe contains one or more
steps assigned to a specified operation-level recipe or unit procedure-level recipe
retrieved. A step reference is a step within a container recipe configured to
reference an operation or unit procedure.
For example, an ice cream factory wants to use a new SWEETMILK_ORGANIC
operation recipe in place of their SWEETMILK operation recipe. The recipe
author uses Find Recipe References to search for all recipes containing steps with
SWEETMILK (reference recipe) and manually updates them with
SWEETMILK_ORGANIC.
The reference list of recipes that contain steps configured with the specified
operation or unit procedure displays in a table. Every entry in the resulting list is
the full recipe path and corresponding recipe levels to that step. When a container
recipe opens, the highest level recipe opens. In this example,
CLS_SWEETMILK_UP / CLS_SWEETMILK_OP:1 is selected. The recipe
that opens is CLS_SWEETMILK_UP. For an explanation of recipe levels, see the
FactoryTalk Batch Recipe Editor introduction.
See also
FactoryTalk Batch Recipe Editor introduction on page 9
Find recipe references on page 174
Find recipe references
Search recipes for a reference to an operation or unit procedure. Recipes can be
stored as a binary file, XML file, or SQL Server database.
Before you begin:
•
Obtain at least view-only security privileges to view the results.
•
Close all recipes.
•
Verify all recipes (full edit privileges required).
To search for recipe references:
1. Select File > Find Recipe References. The Select Reference Recipe dialog
box opens.
174
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
Chapter 14
Complete and maintain recipe
2. (optional) Set the Recipe Filter to narrow the list of displayed recipes.
3. Select one operation or unit procedure to find. The selected recipe is the
reference recipe.
4. Select Find. The Recipe References dialog box opens. A reference list of
recipes having steps matching the reference recipe displays. The recipes are
container recipes and the steps are step references. Total indicates the
number of step references listed.
Tip:
The search includes checked-in recipes, checked-out
recipes, recipes that are not versioned (versioning is
disabled), obsolete recipes, and recipes having invalid
Security Authority Identifiers.
5. (optional) Select Copy All to copy the entire list to the clipboard and paste
in a document for future reference.
6. Select one step reference and then select Open to view and modify a
container recipe in the list. Edit privileges and recipe status determines if the
recipe can be modified. This table describes possible outcomes (assuming
edit privileges):
Container Recipe Status
Open Result
Invalid Security Authority
Container recipe cannot be opened.
Checked-in
Container recipe cannot be edited.
Checked-out
Container recipe can be edited.
Obsolete
Prompts to update the recipe to be
consistent with area model changes.
Versioning disabled
Container recipe can be edited.
Previously versioned recipes with
versioning disabled
Container recipe cannot be edited.
See also
Find Recipe Reference overview on page 174
Security authority overview on page 157
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
175
Chapter 14
Complete and maintain recipe
Page setup
Page Setup is accessed through the File menu or Ctrl+P, and allows adjustment
of:
•
Margins (must be greater than 0.25 inches)
•
Orientation
•
Paper size and source
•
Preview (view only)
•
Printer and associated properties
Tip:
The print area cannot be smaller than 4 inches (10 cm)
wide or high.
See also
Complete and maintain recipe on page 161
Generate reports
option
Filter and print a complete working set of recipes, or if desired, a single recipe
using the Generate Reports option in the FactoryTalk Batch Recipe Editor. The
report format consists of three sections: the Overview Page, the SFC, and Recipe
Descriptive Information. Choose the sections that meet the reporting
requirements.
When generating reports, the entire recipe procedure appears in the SFC rectangle
grid. An SFC rectangle represents a portion of the SFC that print on one page at
100% scale as defined in the Page Setup. Activating the Show/Hide Page
Boundaries button displays the SFC rectangles in the SFC rectangle grid.
176
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
Chapter 14
Complete and maintain recipe
If a procedure description is in the Header Data dialog box for a recipe, it displays
under the report header information.
If enabled, the approval process data displays in the recipe descriptive information.
If approval process data is defined for the recipe, but disabled, then nothing related
to the approval process displays.
Tip:
Invoke the Generate Reports command for the first time to open the
Page Setup dialog box opens. Make any necessary changes to how
the report is to be rendered. Select Okay. The Generate Reports
dialog box opens.
Tip:
View/read only permissions cannot access the Generate Reports
menu option or toolbar button.
See also
Print a working set of recipes on page 177
Print a single recipe on page 178
Print a working set of
recipes
The Print function in the FactoryTalk Batch Recipe Editor uses the configured
default printer. If there is no default printer specified, a prompted to establish one
opens. Set or change the default printer without having to close the FactoryTalk
Batch Recipe Editor application.
To print a working set of recipes:
1. Close all open recipes. Select File > Close All.
2. Select Generate Reports
. The Generate Reports dialog box opens.
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
177
Chapter 14
Complete and maintain recipe
3. The Recipe Procedures list displays the current working set of recipes. Use
Select All to include all displayed recipes in the report. To customize the
recipe list for printing, use the filters in the Recipe Filter tab to refine
which recipes are displayed. To select nonadjacent files, select the name of
any file, then hold down the Ctrl key and select the name of each additional
file.
Tip:
Improperly secured recipes in the current working set cannot be printed--a
notification window opens and lists the improperly secured recipes.
Recipe names listed can be selected and copied to the clipboard.
4. The Report Selection area contains these options:
•
Overview Page: Displays the entire SFC grid scaled on a single report
page with its page or SFC rectangle boundaries. A cross reference grid
provides numeric vertical and alphabetic horizontal coordinates. The
SFC rectangles are numbered from left to right, top to bottom.
Numbers only appear in the upper right corner of rectangles containing
a portion of the SFC.
•
SFC: Displays the SFC at 100% scale and includes a cross reference grid
with numeric vertical and alphabetic horizontal coordinates. Off-page
references indicate the SFCs continued direction.
•
Descriptive Information: Displays the recipe header information
(with security authority and version history information), unit
requirements, phase link groups, recipe formula parameters, steps, step
parameters, reports, binding preferences, requirements, report
expressions, transitions, and text boxes. Steps and transitions print in
the SFC report order, left to right, top to bottom. If a group,
requirement, parameter value, report limit, or text box does not exist,
the report notes that status also.
•
Report Description: Enter a name or descriptive phrase to display in
the reports footer.
5. Select Page Setup to finalize any page printing adjustments.
6. When all report options have been determined, select Print.
Tip:
Print Preview can only view a single procedure and is not an
option when printing an entire recipe set.
See also
Improperly secured recipe ineligible for selection on page 201
178
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
Chapter 14
Complete and maintain recipe
Print a single recipe
Rather than print a set of recipes, print a single recipe.
To print a single recipe:
1. Open the recipe to print.
2. Select Generate Reports
. The Generate Reports dialog box opens.
3. The Recipe Procedures list displays the selected (root) recipe and its
sub-recipes if any.
4. In the Report Selection area, choose the report elements to print.
•
Overview Page: Displays the entire SFC scaled on a single report page
with its page boundaries. A cross reference grid provides numeric
vertical and alphabetic horizontal coordinates. The SFC rectangles are
numbered from left to right, top to bottom. Numbers only display in
the upper right corner of rectangles containing a portion of the SFC.
•
SFC: Displays the SFC at 100% scale and includes a cross reference grid
with numeric vertical and alphabetic horizontal coordinates. Off-page
references indicate the SFC’s continued direction.
•
Descriptive Information: Displays in text form the recipe header
information (with security authority and version history information),
unit requirements, phase link groups, recipe formula values, steps, step
parameters/reports, binding preferences/ requirements, report
expressions, transitions, and text boxes. Steps and transitions print in
the SFC report order, left to right, top to bottom. If a group,
requirement, parameter value, report limit, or text box does not exist,
the report notes that status also.
•
Report Description: Enter a name or descriptive phrase to display in
the reports footer.
5. Select Page Setup to finalize any page printing adjustments.
6. To view the finished report, select Print Preview.
7. When all report options have been determined, select Print.
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
179
Chapter 14
Complete and maintain recipe
See also
Generate reports option on page 176
Remove a recipe
When a recipe file is no longer needed, remove it from the current working set of
recipes.
To remove a recipe:
1. Select File > Remove Recipe. The Remove Recipe dialog box opens.
2. (optional) Set filters with the Recipe filter to narrow the number of recipe
names displayed.
Tip:
The filter options are the same options as the Open
Recipe dialog box.
3. From the Recipe Name list, select the recipe or recipes to remove, and then
select Remove.
See also
Open recipe on page 55
Recipe maintenance on page 173
180
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
Chapter 14
Complete and maintain recipe
Translation
Recipes created in FactoryTalk Batch 11.x automatically translate as long as the
area model translated correctly, and the recipes are not stored in XML, or SQL.
For recipes created in versions older than FactoryTalk Batch version 11.x, contact
the Rockwell Customer Support Representative.
Tip:
If enabled Recipe Approvals, when 11.x recipes are
translated in the FactoryTalk Batch Recipe Editor, they are
assigned a default Expedited Approvals process with two
steps:
Release Recipe as Step and Release Recipe to
Production
These steps initially have the $System signoff following
verification. Before verification, these steps are in a $System
signoff pending state.
Tip:
The RDB Recipes function no longer supports the use of
Oracle — use Microsoft SQL Server.
See also
Automatic system signoff ($System) on page 141
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
181
Chapter 15
Import and export recipes
The recipe Import and Export commands move exact copies of recipes in and out
of the current working set. Recipes can be imported and exported in binary, XML,
or RDB format.
When Recipe Version Control is enabled, the FactoryTalk Batch Recipe Editor
prompts if version conflicts are encountered during import and export.
•
Recipe Approval states are exported as part of a recipe, and are brought in
unchanged when a recipe is imported.
•
Security Authority supports only the binary file format.
See also
Import recipes on page 183
Export recipes on page 187
Import conflicts on page 189
Import and export restrictions for secured recipes on page 192
Import recipes
Import recipes from any format into the current working set of recipes (binary
only for secured recipes).
Important:
Importing or exporting FactoryTalk Batch recipes to
or from a computer containing more than one
instance of Microsoft SQL Server is not supported.
The SQL Server instance name cannot be defined
in the Import/Export Recipe dialog box.
Before you begin:
•
Make sure the recipe file format (binary, RDB, or XML) for the working set
of recipes is set to the correct format.
•
Create the recipe database on the computer running SQL Server.
FactoryTalk Batch uses a database called MasterRecipes.
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
183
Chapter 15
Import and export recipes
Tip:
If the recipe file format in the FactoryTalk Batch
Equipment Editor was changed, restart the FactoryTalk
Batch Server if it is running, and re-open the FactoryTalk
Batch Recipe Editor for the change to take effect.
To import recipe:
1. Select File > Import Recipe Into Working Set option. The Import
Recipe dialog box opens. The title bar of the dialog box indicates the file
storage type selected for the current working recipe set in the FactoryTalk
Batch Equipment Editor. Imported recipes convert to this format.
2. (optional) In the Recipe directory from which recipes will be imported
area, change the storage format for importing recipes.
3. Select the recipe directory or database that contains the files to import.
•
Binary Files or XML Files
•
Microsoft SQL Server Database
4. (optional) Set the Recipe Filter to narrow the list of displayed recipes.
Tip:
The filter options are the same options as the Open
Recipe dialog box.
5. From the Recipe Name list, select the recipes to be imported.
184
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
Chapter 15
Import and export recipes
•
To select nonadjacent files in the Open dialog box, select the name of
any file. Hold down the Ctrl key and select the name of each additional
file.
•
To select adjacent files in the Open dialog box, select the name of the
first file in the sequence. Hold down the Shift key and select the name
of the last file.
•
To clear a file selection, hold down the Ctrl key and select the file name
again.
6. Select Import. The recipes selected in the Recipe Name list are imported
into the current working set.
Tip:
If one of the imported recipes has the same name as a recipe in the
working set, a notification dialog box opens.
If a versioned recipe would conflict, when imported, with a version in the
working set, a notification dialog box opens.
Improperly secured recipes in the current working set cannot be
imported--a notification window opens and lists the improperly secured
recipes. Recipe names listed can be selected and copied to the clipboard.
See also
Set recipe file format on page 198
Open recipe on page 55
Create the MasterRecipes database on page 196
Select a directory on page 185
Select a SQL Server database on page 186
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
185
Chapter 15
Import and export recipes
Select a directory
If Binary Files or XML Files are imported, select the directory that contains the
binary or XML files to import.
To select a directory:
next to the Recipe Directory box of the selected storage
1. Select browse
format. The Select Directory dialog box opens. The default directory,
BATCHCTL, displays unless another directory was previously selected.
Tip:
If selected the same directory used by the working set of recipes, an error
message displays. Choose another directory."
2. Select the directory, and then select Open. The Recipe Name list in the
Import Recipe dialog box updates with the recipe list from the specified
directory.
See also
Import recipes on page 183
Select a SQL Server database on page 186
186
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
Chapter 15
Import and export recipes
Select a SQL Server
database
If RDB files or export files to RDB format are imported, select the Microsoft SQL
Server database that contains the files to import or the database to export recipes.
To select a SQL Server database:
next to the Computer box to select the computer on
1. Select browse
which the SQL Server database resides. The Select Computer dialog box
opens.
2. In the Enter the object name to select box, type the name of the computer
where the SQL Server database resides, and select OK.
next to the Database box to select the database to import
3. Select browse
recipes or export recipes.
4. Select the database, and then select OK. The Recipe Name list on the
Import Recipe dialog box updates with the list of recipes from the specified
database.
See also
Import and export recipes on page 183
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
187
Chapter 15
Import and export recipes
Export recipes
Export recipes from the current working set of recipes into any supported storage
format, including RDB, XML, or binary (secured recipes only maintain security
when exported to binary).
To export recipes:
1. Open the FactoryTalk Batch Recipe Editor.
2. From the File menu, select Export Recipe from Working Set. The Export
Recipe dialog box opens. The title bar of the dialog box indicates the file
storage type selected for the current working set of recipes (set in the
FactoryTalk Batch Equipment Editor). The recipes export from this
format.
3. In the Recipe directory to which recipes will be exported area, change the
storage format for exporting files.
•
Binary Files or XML Files
•
Microsoft SQL Server Database
Important:
Importing or exporting FactoryTalk Batch recipes to or from a
computer containing more than one instance of Microsoft SQL
Server is not supported. The Import/Export Recipe dialog box
only allows you to enter the name of the computer hosting the
Microsoft SQL Server and an existing database name. The SQL
Server instance name cannot be defined in the Import/Export
Recipe dialog box.
4. (optional) Set the Recipe Filter to narrow the list of recipes displayed for
export.
Tip:
The filter options are the same options as the Open
Recipe dialog box.
5. From the Recipe Name list, select the recipes to export.
188
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
Chapter 15
Import and export recipes
•
To select nonadjacent files in the Open dialog box, select the name of
one file. Hold down the Ctrl key and select the name of each additional
file.
•
To select adjacent files in the Open dialog box, select the name of the
first file in the sequence. Hold down the Shift key and select the name
of the last file. To clear a selected file, hold down the Ctrl key and select
the file name again.
Tip:
Improperly secured recipes in the current working set cannot be printed--a
notification window opens and lists the improperly secured recipes.
Recipe names listed can be selected and copied to the clipboard.
6. Select Export to initiate the export process. If recipes with the same name
exist in the target format, indicate whether or not to overwrite them with
the new recipe file.
See also
Open recipe on page 55
Select a directory on page 185
Select a SQL Server database on page 186
Improperly secured recipe ineligible for selection on page 201
Resolve duplicate name conflict on page 190
Import conflicts
Recipe imports can create naming and versioning conflict. This can take several
forms:
•
Recipe name conflict
•
Versioned recipe basename conflict
•
Recipe version number conflict
•
During import
•
When rebuilding the current working recipe set
See also
Resolve duplicate name conflict on page 190
Resolve recipe basename conflict on page 190
Resolve recipe version conflict on page 191
Resolve recipe conflict when rebuilding the recipe directory on page 192
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
189
Chapter 15
Import and export recipes
Resolve duplicate
name conflict
If one of the imported recipes has the same name as a recipe in the working set, the
Duplicate Recipe Name dialog box opens.
To resolve duplicate name conflict:
1. Select one of the listed options.
Tip:
Tip:
If the versioned recipe basename exists in the working
recipe set, importing versioned recipes can result in a
Recipe basename conflict.
If Recipe Approvals are enabled, the approval states of the
imported recipe overwrite those of the existing recipe.
See also
Resolve recipe basename conflict on page 190
Import conflicts on page 189
Resolve recipe
basename conflict
If a versioned recipe with the same basename as one or more versioned recipes is
imported a warning message opens.
To resolve recipe basename conflict:
1. Select OK to close the warning.
190
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
Chapter 15
Import and export recipes
2. Either rename the recipe to import, or remove the existing versioned recipes
from the current working set that conflict with the recipe to import.
See also
Import conflicts on page 189
Resolve recipe version
conflict
Use these instructions to resolve recipe version conflict.
To resolve recipe version conflict:
1. If a recipe version conflict occurs when importing a versioned recipe into
the current working set, the Resolve Version Conflict for Import Request
dialog box opens.
2. Select one of these options:
•
Select Import with Delete, which continues the import operation.
This deletes the conflicting recipe in the working directory and replaces
it with the imported recipe.
•
Select Cancel Import. This does not overwrite the recipe in the
working set.
See also
Resolve recipe conflict when rebuilding the recipe directory on page 192
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
191
Chapter 15
Import and export recipes
Resolve recipe conflict
when rebuilding the
recipe directory
When rebuilding the recipe directory (File > Rebuild Recipe Directory), and a
recipe version conflict occurs, the Resolve Version Conflict for Rebuild Recipe
Directory Request dialog box opens:
To resolve recipe conflict when rebuilding the recipe directory:
1. Choose which recipe to retain in the recipe directory.
2. Select the corresponding Retain button.
See also
Import conflicts on page 189
Import and export
restrictions for
secured recipes
When recipes are secured with a security authority identifier (SAI), secure import
and export can only occur when:
•
The recipe to import or export is BINARY.
•
The SAI in the recipe matches the SAI in the current FactoryTalk Network
Directory.
These tables summarize recipe import and export operation restrictions:
Import or Export of binary recipes
192
SAI match
SAI mismatch
No SAI
To binary
Allowed
Not allowed
Allowed
To RDB
Not allowed
Not allowed
Allowed
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
Chapter 15
Import and export recipes
To XML
Not allowed
Not allowed
Allowed
Import or Export of XML or RDB recipes
SAI import
SAI export
No SAI
To binary
Allowed, SAI
ignored
Not
applicable
Allowed
To RDB
Allowed, SAI
ignored
Not
applicable
Allowed
To XML
Allowed, SAI
ignored
Not
applicable
Allowed
Operations marked as Not allowed open a warning message.
See also
Import and export recipes on page 183
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
193
Appendix A
Recipe formats
FactoryTalk Batch recipes can be stored in the proprietary FactoryTalk Batch
binary format, XML, or a relational database (RDB) format. The three formats are
mutually exclusive. Converting recipes from one format to the other is allowed.
Select one of these formats in the FactoryTalk Batch Equipment Editor, to store
all recipes created or imported into the working set of recipes in that format.
The binary format is the default for FactoryTalk Batch recipes.
Important:
Only the binary format is secure from outside modification--it
can be viewed and edited only in the FactoryTalk Batch
Recipe Editor. Recipes stored in RDB or XML can be edited in
external or third-party application software. To protect RDB
and XML recipe files that have completed the Recipe
Approvals process, save them in a secured location.
See also
RDB format on page 195
XML format on page 197
Set recipe file format on page 198
RDB format
The RDB recipe format gives greater flexibility when generating reports. A default
Microsoft SQL Server database, MasterRecipes, is created during FactoryTalk
Batch installation and selected Yes, I want to store recipes in SQL Server.
Tip:
The MS SQL Server must be installed before installing FactoryTalk Batch.
Check software compatibility in the FactoryTalk Batch Components
Upgrade and Installation Guide.
Open Database Connectivity (ODBC) is used as the database connectivity
protocol between the FactoryTalk Batch Recipe Editor and the Microsoft SQL
Server database.
Rockwell Automation Publication FactoryTalk Batch Recipe Editor User Guide - February 2017
195
Appendix A
Recipe formats
This diagram describes the flow paths and functional relationships of FactoryTalk
Batch using a relational database:
See also
Create the MasterRecipes database on page 196
Create the
MasterRecipes
database
Before importing recipes into the RDB format, first create the recipe database on
the computer running SQL Server. FactoryTalk Batch uses a database called
MasterRecipes.
Tip:
Follow these instructions if the Yes, I want to store recipes in
SQL Server option was not selected during FactoryTalk Batch
installation, and MS SQL Server is installed.
Before you begin:
•
Install and run SQL Server.
To create the MasterRecipes database:
1. If they do not exist, create the MasterRecipeAuthor and
MasterRecipeViewer local user gro