Factorytalk Batch Components Installation and Upgrade Guide
Factorytalk Batch Components Installation and Upgrade Guide
Factorytalk Batch Components Installation and Upgrade Guide
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.
IMPORTANT Identifies information that is critical for successful application and understanding of the product.
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.
ARC FLASH HAZARD: Labels may be on or inside the equipment, for example, a motor control center, to alert people to potential Arc Flash. Arc Flash
will cause severe injury or death. Wear proper Personal Protective Equipment (PPE). Follow ALL Regulatory requirements for safe work practices and
for Personal Protective Equipment (PPE).
2
Table of Contents
Preface About this manual 7
Legal Notices 7
Additional resources 8
Chapter 1
FactoryTalk Batch system Server placement guidelines 14
overview FactoryTalk Batch View 14
Installation information about FactoryTalk Batch View 15
System requirements and supported software overview 15
Select installation instructions for each computer 18
Chapter 2
Pre-installation administrative Obtain administrator privileges on target computer 21
tasks Prepare the operating system 21
Windows configuration requirements 22
Configure the Windows Server operating system 22
Configure the Windows desktop operating system 23
DEP settings 24
Create users and user groups 24
Update Windows Firewall settings 25
Windows Firewall exceptions 26
Configure the Remote Registry service 27
Set the system date and time 27
Prepare the SQL Server installation 27
Install Reporting Services for SQL Server 2017 28
Configure Reporting Services for SQL Server 2012 or SQL Server
2014 29
Configure SQL Server 2016 for reporting services 30
Configure Reporting Services for SQL Server 2017 31
Configure Windows Firewall for FactoryTalk Event Archiver 32
Chapter 3
Install FactoryTalk Batch Install the FactoryTalk Batch components 36
Server, FactoryTalk eProcedure FactoryTalk Updater 39
Modify an installation 39
Server, and FactoryTalk Event
Post-installation tasks for FactoryTalk Batch components 40
Archiver Configure the FactoryTalk network directory 41
Configure SQL Server 2017 to enable FactoryTalk Event Archiver
with Reporting Services 41
3
Table of Contents
Chapter 4
Install FactoryTalk Batch Client Install the FactoryTalk Batch Client 52
components
Chapter 5
Install FactoryTalk Batch Install the FactoryTalk Batch Material Manager Server 54
Material Manager Server Post-installation for FactoryTalk Batch Material Manager Server 55
Identify the material database 55
components
Chapter 6
Install FactoryTalk Batch Install the FactoryTalk Batch Material Manager Client components 57
Material Manager Client
components Chapter 7
FactoryTalk Activation Cumulative unit licensing 60
Chapter 8
Upgrade FactoryTalk Batch Pre-upgrade tasks for FactoryTalk Batch 61
Allow the Message Queue to clear for FactoryTalk Batch Material
Manager 62
Export XML or RDB recipes to binary 62
Back up files 62
Uninstall a previous version of FactoryTalk Batch 64
Upgrade the FactoryTalk Batch components 64
Post-upgrade tasks 65
Restore backup files 65
Migrate area models from FactoryTalk Batch version 13.00 or
13.00.02 67
Migrate recipes from FactoryTalk Batch version 13.00 or 13.00.02 67
4
Table of Contents
Chapter 9
Troubleshoot FactoryTalk Batch Manually configure the Windows Firewall 71
installation or upgrade Define or reset a disabled FactoryTalk Administrator account 72
Communication with FactoryTalk Batch Server times out 72
Configure Internet Explorer security settings for Trusted Sites 73
Internet Explorer intranet zone 73
Run as Administrator on eProcedure Client on Windows Server
operating systems 73
Manually recreate the masterrecipes database 74
Appendix A
Use FactoryTalk Batch with a Windows Workgroup 75
Windows Workgroup Create Windows accounts 75
Add an incoming firewall rule 75
Disable Administrative Approval Mode 76
Appendix B
Install FactoryTalk eProcedure Install the FactoryTalk eProcedure Client 78
Client components Post-FactoryTalk eProcedure Client component installation 79
Set the Internet Explorer home page for FactoryTalk eProcedure
Clients 79
Configure Internet Explorer to view FactoryTalk eProcedure
pages 79
Configure Internet Explorer compatibility view settings 80
Select Windows theme in Windows 7 81
Appendix C
Uninstall FactoryTalk Batch Uninstall the FactoryTalk Batch system 83
version 14.00 Uninstall the FactoryTalk Batch components 83
Uninstall FactoryTalk Batch Material Manager 84
Delete the default directories 84
Delete databases 85
Index
5
Preface
About this manual This guide provides information and procedures for installing and upgrading
a FactoryTalk® Batch system, which includes:
• FactoryTalk Batch
• FactoryTalk eProcedure®
• FactoryTalk® Event Archiver Database, with Batch Reports and
Database Management Tool
• FactoryTalk Batch Material Manager
• FactoryTalk® Batch View
This guide is organized into a conceptual overview of a FactoryTalk Batch
system that includes information about pre-installation administrative tasks,
followed by installation and post-installation procedures for the different
system components.
Readers should be familiar with installing Windows applications and
configuring operating system options.
Legal Notices Rockwell Automation publishes legal notices, such as privacy policies, license
agreements, trademark disclosures, and other terms and conditions on the
Legal Notices page of the Rockwell Automation website.
7
Preface
• Components
Includes the name of the open source component, its version number,
and the type of license.
• Copyright Text
Includes the name of the open source component, its version number,
and the copyright declaration.
• Licenses
Includes the name of the license, the list of open source components
citing the license, and the terms of the license.
The default location of this file is:
FactoryTalk Batch eProcedure® Getting Results Explains the basics of FactoryTalk Batch eProcedure.
Guide
(BWEPRO-GR011)
FactoryTalk Batch Getting Results Guide Introduces the basics of automated batch manufacturing
(BATCH-GR011) and the FactoryTalk Batch product components.
8
Preface
Resource Description
FactoryTalk Batch Material Manager Getting Introduces the basics of FactoryTalk Batch Material
Results Guide Manager.
(BWMTR-GR011)
User Guides
Resource Description
FactoryTalk Batch ActiveX Controls User Guide Provides information and instructions for using the
(BATCH-UM013) FactoryTalk Batch ActiveX Custom Controls.
FactoryTalk Batch Material Editor User Guide Provides access to information and procedural
(BWMTR-UM001) instructions required to configure materials and the
containers to hold them. The material data is stored in the
material database, which is used to create material-
based recipes. This information is intended as a
reference for the formulator.
FactoryTalk Batch Equipment Editor User Guide Provides information on creating and maintaining an
(BATCH-UM004) equipment database (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 PhaseManager™ User Guide Describes the integration of the FactoryTalk Batch
(BATCHX-UM011) software with the Studio 5000 Logix Designer®
application and the Logix 5000™ family of controllers.
The integration simplifies the configuration and
maintenance of the FactoryTalk Batch automation
system, provides better communication between the
FactoryTalk Batch Server and the Logix 5000 controller,
and significantly reduces the programming effort
required to develop the phase logic code that resides in
your Logix 5000 controller.
FactoryTalk Batch Recipe Editor User Guide Provides instructions on using FactoryTalk Batch Recipe
(BATCH-UM006) 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 HMI Controls User Manual Provides details about using FactoryTalk Batch View HMI
(FTBVS-UM003) Controls to monitor and interact with the production
process within a FactoryTalk View SE Display Client.
FactoryTalk Batch View User Manual Provides information and procedural instructions for
(FTBVS-UM002) using FactoryTalk Batch View in a modern and intuitive
portal into a comprehensive batching solution for
effective operations, leveraging its own web server using
HTML5 technology to provide native connectivity into a
FactoryTalk Batch Server.
FactoryTalk eProcedure Client User Guide Provides information and procedural instructions
(BWEPRO-UM001) required to create and command batches using the
FactoryTalk eProcedure Client, and can be used as a
reference information by the operator.
9
Preface
Resource Description
FactoryTalk Event Archiver User Guide (BATCH- Provides information and instructions specific to the
UM012) FactoryTalk Event Archiver. Intended for use by the
system administrator and production supervisor.
FactoryTalk Batch View User Guide (legacy) Provides information and instructions on how to use
(FTBVS-UM001) FactoryTalk Batch View 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).
Administrator Guides
Resource Description
FactoryTalk Batch Administrator Guide Provides instructions for configuring security and
(BATCH-UM003) services, and implementation and use of components not
typically accessed or used by batch operators, such as
the FactoryTalk Batch Server.
FactoryTalk Batch eProcedure Administrator Guide Provides procedures specific to FactoryTalk Batch
(BWEPRO-UM011) eProcedure, such as implementing security and
configuring the user-defined area Active Server Page.
Included are instructions for tasks specific to FactoryTalk
Batch, such as configuring security and services to
support FactoryTalk Batch eProcedure. Provides
instructions on the implementation and use of
components not typically accessed or used by batch
operators, such as the FactoryTalk Batch Server.
FactoryTalk Batch Material Manager Administrator Provides information and instructions specific to
Guide FactoryTalk Batch Material Manager. Intended for use by
(BWEPRO-UM011) the system administrator and database administrator.
Reference Guides
Resource Description
FactoryTalk Batch ActiveX Controls Library Provides reference information and procedural
Reference Guide instructions for the FactoryTalk Batch ActiveX Custom
(BATCH-RM001) Controls.
FactoryTalk Batch Material Server API Technical Provides access to information regarding the interface
Reference between the FactoryTalk Batch Material Server and the
(BWMTR-RM001) FactoryTalk Batch Material Editor and FactoryTalk Batch.
It is intended to be used as a reference information by
those who want to develop custom interfaces.
FactoryTalk Batch PCD Programming Reference Provides information and instructions about the
Manual FactoryTalk Batch PCD interface design. It is intended to
(BATCH-RM004) be used as a reference guide.
10
Preface
Resource Description
FactoryTalk Batch Server API Reference Manual Provides information regarding the interface between the
(BATCH-RM003) 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 Batch System Files Reference Manual Provides the technical information for configuration and
(BATCH-RM005) maintenance of a FactoryTalk Batch system. It can be
used as a reference information for implementation
engineers and the system administrator.
FactoryTalk Batch eProcedure Instruction File Includes information about the building of instruction
Design Reference Manual files for use in equipment database creation and recipe
(BWEPRO-RM001) development. This information is intended to be used as a
reference by the instruction file author.
11
Chapter 1
13
Chapter 1 FactoryTalk Batch system overview
Server placement Use these guidelines to decide where to place FactoryTalk Batch system
servers on the network:
guidelines
• Install the eProcedure Server and the FactoryTalk Batch Server on the
same computer.
Tip: The FactoryTalk Batch View Server is installed automatically with the
FactoryTalk Batch Server.
• Install the FactoryTalk Batch Material Manager Server on a computer
with SQL Server.
• Do not install the FactoryTalk Batch Material Manager Server on the
same computer as the FactoryTalk Batch Server.
• A maximum of ten FactoryTalk Batch Servers can exist in a FactoryTalk
Batch network that includes FactoryTalk Batch Material Manager
Server.
• Install the FactoryTalk Event Archiver Database and Management Tool
on a computer with SQL Server.
• For best performance, install the FactoryTalk Event Archiver Database
and Management Tool on a different computer than the FactoryTalk
Batch Server.
FactoryTalk Batch View FactoryTalk Batch View is a modern, browser-based interface that allows you
to initiate and control the batch process anywhere there is an internet
connection. The FactoryTalk Batch View interface adapts across smartphones,
such as iOS and Android, to tablets and PCs. Users can access real-time
information and interact with their process from the plant floor to the
production office.
FactoryTalk Batch View is well-suited for large industrial facilities that have
workstation infrastructure limitations and require multiple access points
across the plant. With personalized user profiles that are tailored to the user,
such as language switching options, workers at different levels of the
organization can stay mobile yet connected to their process operations.
Key capabilities of the solution include:
• A modern web interface offers adaptation to new or existing platforms
and environments with backward compatibility to previous versions of
FactoryTalk Batch software; single-server architecture allows for new
features and functions to be added with minimal impact to operations.
• Information-enabled and secure. Uses common system security
policies for access control similar to any workstation, as a node on the
plant network.
• Interfaces support multiple mobile devices and are easily integrated
with HMI screens onto workstations.
14
Chapter 1 FactoryTalk Batch system overview
Installation information The FactoryTalk Batch View Server is installed automatically with the
FactoryTalk Batch Server. The FactoryTalk Batch View web client does not
about FactoryTalk Batch require any additional installation.
View Tip: FactoryTalk Batch View performs best with Chromium-based
browsers such as Google Chrome or Microsoft Edge.
If you are using a FactoryTalk View SE Display Client, install the FactoryTalk®
Batch View HMI controls to provide an interface that allows users to monitor
and interact with the production process. The FactoryTalk Batch View HMI
controls consist of:
System requirements and Review these minimum and recommended system requirements for
installing, configuring, and running FactoryTalk Batch components. Unless
supported software noted these requirements assume that no other applications are installed on
overview the computer. Preferred operating systems and software applications are
prioritized for support, testing, and post-release patch qualifications.
Hardware requirements
• Server requirements
• 8 GB of RAM memory
• 100 GB free hard disk space
• Intel® Core™ i5 standard power processor or greater
• Client requirements
15
Chapter 1 FactoryTalk Batch system overview
• 4 GB of RAM memory
• 30 GB free hard disk space
• Intel Core i5 standard power processor or greater
Web browsers
(for eProcedure Client only)
• Internet Explorer® 11(32-bit)
(for FactoryTalk Batch View only)
• Google® Chrome™ browser (preferred)
• Microsoft Edge™ based on Chromium version: 80.0.361.50 or higher
• Apple® Safari®
• Firefox®
16
Chapter 1 FactoryTalk Batch system overview
17
Chapter 1 FactoryTalk Batch system overview
Warranty
The warranty does not cover systems that do not meet the minimum
requirements for the version of software.
IMPORTANT FactoryTalk Batch components for version 14.00 support only the U.S. English
versions of operating systems. For more information about supported operating
systems and other Rockwell Software product version support, refer to the Product
Compatibility and Download Center (PCDC).
Select installation After completing the pre-installation administrative tasks, follow the
instructions for each installation instructions for each computer in the system, or repeat the
installation instructions for several computers based on your FactoryTalk
computer Batch system configuration. For example, if the FactoryTalk Batch system
includes a FactoryTalk Batch Server and several FactoryTalk Batch Clients,
determine which components to install on each computer. Each set of
installation instructions includes a checklist of all related tasks and specific
post-installation tasks for the component.
• Install FactoryTalk Batch Server, FactoryTalk eProcedure Server, and
FactoryTalk Event Archiver on page 35
• Install FactoryTalk Batch Client components on page 51
• Install FactoryTalk Batch Material Manager Server components on
page 53
• Install FactoryTalk Batch Material Manager Client components on
page 57
• Install eProcedure Client components on page 77
18
Chapter 1 FactoryTalk Batch system overview
If you are upgrading your system from a previous version of FactoryTalk
Batch use the Upgrade FactoryTalk Batch instructions.
19
Chapter 2
Obtain administrator To install each of these software applications on the target computer, you
must be logged onto the computer using an account that has administrator
privileges on target privileges on the computer and that has been granted permission to create
computer databases, stored procedures, and logins on SQL Server.
• FactoryTalk Batch Server
• FactoryTalk Batch Client
• FactoryTalk Event Archiver
• FactoryTalk eProcedure Server
• FactoryTalk eProcedure Client
• FactoryTalk Batch Material Manager Server
• FactoryTalk Batch Material Manager Client
Before starting the installation procedure close any open applications.
Prepare the operating Before installing FactoryTalk Batch Server, FactoryTalk Material Manager
Server, or FactoryTalk eProcedure Server components make sure that the
system operating system for the target computer is properly configured.
Server operating systems and desktop operating systems have different
configuration requirements.
Pre-installation configuration task include:
21
Chapter 2 Pre-installation administrative tasks
Windows configuration If setting up new computers for the FactoryTalk Batch system, install the
operating system using the default settings. Then configure the operating
requirements system as described for the components.
Tip: All supported operating systems are tested and warrantied for
FactoryTalk Batch version 14.00.
Configure the Windows Configure the Windows Server operating system features to support
FactoryTalk Batch Server, FactoryTalk Batch Material Manager Server, or
Server operating system FactoryTalk eProcedure Server.
Tip: FactoryTalk Batch Server does not require any additional configuration of Windows Server 2016
or 2019.
22
Chapter 2 Pre-installation administrative tasks
• Common HTTP Features
IMPORTANT Enabling some features automatically selects new required
additional features and updates the feature list accordingly.
Select Add Feature to accept the default selections for these
options.
Configure the Windows Perform this procedure to configure the Windows desktop operating system
for the FactoryTalk Batch Material Manager Server, and FactoryTalk
desktop operating system eProcedure Server. Use the Turn Windows features on or off control panel
item for this configuration process.
Tip: FactoryTalk Batch Server and Client components do not require any additional configuration
for Windows desktop operating systems.
23
Chapter 2 Pre-installation administrative tasks
-ASP .NET 4.6
-ISAPI Extensions
-ISAPI Filters
• Common HTTP Features
- Static Content
4. Select OK to enable the features and close the dialog box.
DEP settings Data Execution Prevention (DEP) uses hardware and software security
features to prevent the execution of malicious code in Windows operating
systems.
Rockwell Automation supports DEP OptIn and OptOut settings. For more
information, see Microsoft KB article 875352.
Create users and user Before installing FactoryTalk Batch, you must create at least one domain user
account that serves as the FactoryTalk Batch Server user account. If your
groups installation includes FactoryTalk Batch Material Manager Server you must
also create several domain user groups. When you run the installation
program you will need to provide the FactoryTalk Batch Server user account
and password for the FactoryTalk Batch Server and FactoryTalk Batch
Material Manager Server to run under.
24
Chapter 2 Pre-installation administrative tasks
• MTBatchServer
Add the FactoryTalk Batch user account under which the FactoryTalk
Batch Server service is running to the MTBatchServer group. This is
the group that the FactoryTalk Batch Server uses to access the material
database.
• MTGeneral
Required to use Material Editor.
• MTLotAuthor
Add any domain users that require the ability to add, edit, and delete
material lots in the Material Editor.
• MTMaterialAuthor
Add any domain users that require the ability to add, edit, and delete
materials and containers in the Material Editor.
• MTMaterialViewer
Add any domain users that require read-only access to materials and
containers in the Material Editor. The installation adds the five domain
groups and domain user account for the FactoryTalk Batch Material Manager
Server to the appropriate COM+ roles and/or local user groups. For more
information about security settings, see Security settings in the FactoryTalk
Batch Material Manager Administrator Guide.
Update Windows Firewall To allow the installation program to configure the firewall exceptions
automatically, enable the Windows Firewall Service prior to installation. The
settings installation program uses the Rockwell Software Windows Firewall
Configuration Utility to add the necessary exceptions.
IMPORTANT When managing the Windows Firewall settings externally, the installation program
cannot change the Windows Firewall settings.
25
Chapter 2 Pre-installation administrative tasks
Typically, Windows Firewall appears under Control Panel > System and
Security > Windows Firewall. For more information, see the Windows
operating system for the current installation.
Windows Firewall If the Windows Firewall is enabled when you install FactoryTalk Batch or
FactoryTalk eProcedure applications, the installation program adds the
exceptions following exceptions to the local computer:
Windows Firewall Exceptions
• batchsvr.exe (Batch server installs) • OPCEnum.exe
• batchvew.exe (Batch client installs) • Port 1433 TCP (SQL Server installs)
• DaClient.exe • Port 137 NetBIOS Name Service
• EventClientMultiplexer.exe • Port 135 TCP
• EventServer.exe • Port 80 TCP (FactoryTalk eProcedure Client installs)
• Flexsvr.exe • RDcyHost.exe
• FTCounterMonitor.exe • RnaDiagnosticsSrv.exe
• FTSPVStudio.exe • RnaDiagReceiver.exe
• FTSysDiagSvcHost.exe • RnaDirServer.exe
• iexplore.exe • RsvcHost.exe
• Imgrd.exe • VStudio.exe
• NmspHost.exe
26
Chapter 2 Pre-installation administrative tasks
Configure the Remote Remote Registry is enabled to support network synchronization of the
FactoryTalk Batch components across computer boundaries. Before installing
Registry service the FactoryTalk Batch Server or FactoryTalk Batch Material Manager Server
on any operating system, configure the Remote Registry service for automatic
startup.
Set the system date and Set the date and time on each computer on the FactoryTalk Batch network to
the same date and time.
time
IMPORTANT The dates and times for all computers on the network must match each other so that
events, journals, and logs in the FactoryTalk Batch system are properly synced.
Prepare the SQL Server These applications can use SQL Server:
Consider these items when installing SQL Server for use with the FactoryTalk
Batch system:
27
Chapter 2 Pre-installation administrative tasks
• Before starting the FactoryTalk Batch installation create a SQL Server
database login for the user that will performing the FactoryTalk Batch
installation. Make sure that the user account has been granted
dbcreator permissions in SQL Server. That permission is required to
create a database.
• The user installing FactoryTalk Batch Material Manager must have
Read and Write access to the SQL Server database.
• SQL Server can reside on the same computer as the FactoryTalk Batch
Server.
• If using a single SQL Server installation, install SQL Server on the
same computer where the FactoryTalk Batch Material Manager Server
will be installed.
• If using a single SQL Server installation for recipes, Batch reports, and
materials, use the default instance name (MSSQLSERVER). The
FactoryTalk Batch Material Manager Server supports only default
instances.
• Support for named instances:
• FactoryTalk Batch and the FactoryTalk Batch Material Manager
Server do not support named instances.
• FactoryTalk Event Archiver supports named instances.
• Add TCP Port 1433 as an exception in the Windows Firewall to store
recipes from FactoryTalk Batch Recipe Editor on a remote SQL Server.
• Install the FactoryTalk Event Archiver Management Tool on the same
computer as SQL Server.
For SQL Server installation instructions, see the SQL Server Installation Guide
on the Microsoft website.
Install Reporting Services If using SQL Server 2017 or SQL Server 2019 you must install the
corresponding SQL Server eporting Services to create FactoryTalk Batch
for SQL Server 2017 or report using FactoryTalk Event Archiver.
SQL Server 2019 You can download SQL Server 2017 Reporting Services and
SQL Server 2019 Reporting Services from the Microsoft web site.
28
Chapter 2 Pre-installation administrative tasks
5. Select Next to install the report server only.
Reporting Services uses the Database Engine installed with SQL Server
to store the report server database.
6. In Specify an install location accept the default location for the report
server. Select Install to continue.
Tip: The default path is C:\Program Files\Microsoft SQL Server Reporting
Services.
7. If prompted to restart your computer, do so.
Configure Reporting Configure SQL Server Reporting Services so that FactoryTalk Event Archiver
can create FactoryTalk Batch reports.
Services for SQL Server
Tips:
2012 or SQL Server 2014 • Use this procedure if the "Install only" option was selected when
installing Reporting Services, or when modifying an existing SQL Server
installation to add the Reporting Services feature and the option to
configure reporting services was not selected.
• Use the same user account for installing FactoryTalk Batch and
FactoryTalk Event Archiver and configuring Reporting Services. If using
a different user account, the application might prompt repeatedly for
user credentials.
29
Chapter 2 Pre-installation administrative tasks
Tip: Some configurations might require:
• An additional login to the site
• Starting the browser using the Run as administrator option
• Adding the Report Manager URL to the Local intranet zone if using
Internet Explorer with the Enhanced Security Configuration enabled.
5. In Home - Report Manager, select Folder Settings.
6. In Security, select New Role Assignment.
7. In New Role Assignment, in Group or user name, enter a group or a
user name to allow these users to run reports. Use the format
domain_name\account_name.
Tip: Make sure that the group or user specified is granted EXECUTE and INSERT
permissions to the BatchHistoryEX and ReportServer databases after installation is
complete.
8. Select the Role check box to select all of the roles.
9. Select OK. The new role displays on the SQL Server Security page.
Configure SQL Server 2016 If you are using SQL Server 2016 with FactoryTalk Batch the reporting
services configuration is slightly different than in previous versions
for reporting services
30
Chapter 2 Pre-installation administrative tasks
6. In Home - SQL Server Reporting Services, select Manage folder.
7. In Security, select + Add group or user.
8. In New Role Assignment, for Group or user name enter the
domain\user name that was used when SQL Server was installed.
Tip: Make sure that the group or user specified is granted EXECUTE and INSERT
permissions to the BatchHistoryEX and ReportServer databases after installation is
complete.
9. Select Role to select all of the roles.
10. Select OK. The new role is added to the list on the SQL Server
Reporting Services Security page.
Configure Reporting If you are using SQL Server 2017 with FactoryTalk Batch the reporting
services configuration is slightly different than in SQL Server 2016.
Services for SQL Server
Before you can install FactoryTalk Batch with FactoryTalk Event Archiver, you
2017 must configure the Web Service URL, database and Web Portal URL.
31
Chapter 2 Pre-installation administrative tasks
• Select Test Connection to verify the user account can login to the
server.
• Select Next.
9. On the Database page, in Database Name provide a name for the
initial reporting database and then select Next.
10. On the Credentials page specify an existing account that the report
server will use to connect to the report server database and then select
Next.
11. On the Summary page confirm the settings are correct and then select
Next.
12. Once the report server database is created, select Finish to close the
wizard.
13. On the left pane, select Web Portal URL.
14. Select Apply to accept the default values. Observe the Results pane. If
all tasks completed successfully, continue the configuration.
15. In the Web Portal URL pane (on the right), select the URLs: link to
open SQL Server Reporting Services in a web browser.
IMPORTANT If this is the first time accessing the SQL Server Reporting
Services page, depending on your browser security settings,
you might receive several warning messages. To continue,
select Close or Add for each warning.
Configure Windows Firewall If you are running Windows Firewall on the same computer as the SQL
Server, remote connections to the SQL Server will be blocked unless the SQL
for FactoryTalk Event Server and SQL Browser service can communicate through the firewall. You
Archiver will have to add an exception in Windows Firewall for these services to make
connection from the FactoryTalk Batch Archiver client to the remote
FactoryTalk Batch Archiver SQL Server.
By default, SQL Server uses static TCP port number 1433 for the default
instance MSSQLSERVER. If you configure SQL Server to use a static port
other than the default port add that port to the firewall exception list instead
of the default port.
Alternatively, you can configure SQL Server to use a dynamic port. If you use
dynamic port allocation, you specify port number zero in the network
configuration. Once SQL Service restarts, it requests a free port number from
the operating system and assigns that port to SQL Server. When dynamic
32
Chapter 2 Pre-installation administrative tasks
ports are used, the SQL Browser service provides the port number to the
requesting FactoryTalk Batch component.
b. For Protocol and Ports, select UDP and enter the port 1434 and then
click Next.
c. For Action, select Allow the Connection and then click Next.
d. For Profile, select the appropriate network profile and then click
Next.
e. (optional) For Name, type a name and description for the inbound
rule. Click Finish.
33
Chapter 2 Pre-installation administrative tasks
c. Enter the path to your SQL Server executable then click Open.
Example: C:\Program Files\Microsoft SQL
Server\MSSQL17.MSSQLSERVER\MSSQL\Binn\sqlservr.exe.
g. (optional) For Name, type a name and description for the inbound
rule. Click Finish.
34
Chapter 3
This section provides instructions for installing the FactoryTalk Batch Server,
eProcedure Server, and FactoryTalk Event Archiver software on the same
computer.
Tip: We recommend using the default installation directories for all components.
Use this checklist to help you successfully set up the FactoryTalk Batch
environment:
Pre-Installation administration tasks
Tasks Notes
Obtain administrator privileges on target
computer
Create users and user groups
Update Windows firewall settings
Configure the Remote Registry service
Set the system date and time
Prepare the SQL Server installation
Pre-Installation operating system configuration
Configure the Windows Server operating
system for the FactoryTalk Batch Server and
eProcedure Server
Configure the Windows desktop operating
system for the FactoryTalk Batch Server and
eProcedure Server
35
Chapter 3 Install FactoryTalk Batch Server, FactoryTalk eProcedure Server, and FactoryTalk Event Archiver
Installation
Install the FactoryTalk Batch components
Run FactoryTalk Updater to check for updates
the components
Post-Installation configuration
Configure the FactoryTalk network directory
Configure <MSSQL> to enable FactoryTalk
Event Archiver with Reporting Services
• Configure SQL Server 2017 to enable
FactoryTalk Event Archiver with Reporting
Services
• Configure SQL Server 2014 or SQL Server
2016 to enable FactoryTalk Event Archiver
with Reporting Services
• Configure SQL Server 2012 to enable
FactoryTalk Event Archiver with Reporting
Services
Grant access to the FactoryTalk Batch
directory on the SQL Server computer
Add a server to the FactoryTalk Batch system
Configure event log settings
Create a shared directory
Define redundant servers (optional)
Configure server options
Set security on logs and journals folders
Configure browser compatibility view settings
Install the FactoryTalk After preparing the computer operating systems, install the FactoryTalk Batch
Server, FactoryTalk eProcedure Server, FactoryTalk Batch View Server, and
Batch components FactoryTalk Event Archiver components.
• The FactoryTalk Batch Server controls system information, phases,
and recipes.
• The FactoryTalk eProcedure Server:
• Provides services to the FactoryTalk Batch Server to use HTML
instruction files.
• Formats parameters and report parameters from material-based
recipes into instruction files.
• The FactoryTalk Event Archiver stores the FactoryTalk Batch ASCII
electronic batch records (.evt files) into a SQL Server database. The
database can be queried for batch data or can be used by the optional
FactoryTalk Batch reporting tools to generate web-based batch reports.
Tip: Prerequisite checks are run automatically to ensure a successful
installation. If an issue occurs during installation, an error message with
steps to resolve is displayed.
36
Chapter 3 Install FactoryTalk Batch Server, FactoryTalk eProcedure Server, and FactoryTalk Event Archiver
37
Chapter 3 Install FactoryTalk Batch Server, FactoryTalk eProcedure Server, and FactoryTalk Event Archiver
installation. Removing both options removes FactoryTalk Event
Archiver Components v14.00 from the installation.
• Select and then expand FactoryTalk eProcedure v14.00. Select the
Server Components and Client Components options to install them
with FactoryTalk eProcedure v14.00.
• Select and then expand Tools. FactoryTalk Updater Agent v2.00.00
is installed by default. Select all options to include them in the
installation.
4. On the Permission Requested page:
• Select Yes, allow changes to this computer.
5. On the Options page:
• Network Directory is required and is selected by default.
• To store recipes in SQL Server instead of individual files, select
Recipe Storage.
• Enter a port to use for the FactoryTalk Batch View Server. Port 443 is
the default and is the recommended port.
• Select Next.
6. On the System Details page, complete these fields:
• In User Name, enter the domain\user name for user account
created for the FactoryTalk Batch Server Service to run under. If
the user account is in the current domain, the domain does not need
to be specified.
• In Password enter the password for the domain\user name.
• Select Next.
7. (optional) On the Event Archiver SQL Connection page, if installing
FactoryTalk Event Archiver components, complete these items:
• In Server Name, enter the SQL Server name.
• In Instance Name, enter the instance name if using a named
instance.
Tip: If using a single SQL Server installation for recipes, Batch reports, and
materials, use the default instance name MSSQLSERVER. The FactoryTalk
Batch Material Server supports only default instances.
If using multiple SQL Server installations, FactoryTalk Event Archiver Batch
Reports support named instances.
• In Data Source Name, enter the data source name.
• Select Include Batch Reports.
• Select Next.
8. On the Connection Validated page, select Install.
9. On the End User License Agreements page, review the agreement and
select Accept all.
10. If the Would you like to install this device software page appears,
select Install.
Tip: The installation progress wheel and the specific components and supporting
files are displayed.
38
Chapter 3 Install FactoryTalk Batch Server, FactoryTalk eProcedure Server, and FactoryTalk Event Archiver
11. (optional) If prompted on the Almost There page, select Activate your
software, and then select Next.
12. If prompted on the That's it page, restart the computer.
FactoryTalk Updater When you start the installation process for your FactoryTalk Batch system one
of the optional installation components is FactoryTalk Updater. FactoryTalk
Updater assists in management of installed Rockwell Automation software by
announcing new versions and patch roll-ups for the software on your
computer. Registering for updates is not required to receive announcements
from the FactoryTalk Updater. FactoryTalk Updater includes these
components:
• FactoryTalk Updater Agent
The agent collects information and activation license data from the
Rockwell Automation software installed on the computer. Install the
FactoryTalk Updater Agent on each computer that requires data
collection.
• FactoryTalk Updater Client
Displays information collected by the FactoryTalk Updater Server
and enables you to review updates and patches.
• FactoryTalk Updater Server
Communicates with online FactoryTalk Updater Agents to receive
collected data.
Connects to the Product Compatibility and Download Center to
retrieve the latest software information.
Responds to requests from the FactoryTalk Updater Client.
Supports ~100 online Agents.
To avoid issues, limit FactoryTalk Updater Server installations to
one instance per intranet.
System logs and some application data are stored in this folder:
C:\Users\Public\Documents\Rockwell\Updater\Data
The logs and application data can be helpful when contacting Rockwell
Automation Technical Support. System logs are automatically deleted
after 90 days.
Tip: To receive notifications of new versions and patch roll-ups, the
FactoryTalk Updater application requires access to the Download Center
web service. Verify that the firewall does not block access to this URL:
https://api.rockwellautomation.com/es-be-pcdc-vpcprod/
See the FactoryTalk Updater help for more information about using
FactoryTalk Updater.
Modify an installation Use the Modify and Repair installation method to change the optional
components selected with the FactoryTalk Batch system installation or to run
a repair operation on installed components. If at least one FactoryTalk Batch
component is already installed when the installation program is started, an
39
Chapter 3 Install FactoryTalk Batch Server, FactoryTalk eProcedure Server, and FactoryTalk Event Archiver
option to modify the current installation is displayed in the installation
wizard. You can also access Modify and Repair by opening Windows Control
Panel and selecting Change for a Rockwell Automation software application.
To modify an installation
1. Run Setup.exe.
2. On the Setup page, select Modify.
3. On the Modify page, select the components to install.
4. Select Next.
5. Complete any remaining pages that open. The pages and options vary
based on the components selected.
6. On the Modification Complete page, select Close.
Post-installation tasks for After installing the FactoryTalk Batch Server, FactoryTalk eProcedure Server,
FactoryTalk Batch View Server, and FactoryTalk Event Archiver components
FactoryTalk Batch there are several settings that should be configured before putting the system
components into production. Review these tasks to determine which items are applicable
to your installation:
40
Chapter 3 Install FactoryTalk Batch Server, FactoryTalk eProcedure Server, and FactoryTalk Event Archiver
• Define redundant servers
• Set security on logs and journals folders
• Configure browser compatibility view settings
Configure the FactoryTalk If you are installing FactoryTalk Batch components on a new system,
network directory FactoryTalk Batch installation will install FactoryTalk Services Platform and
configure the computer as the FactoryTalk network directory server for the
rest of the system. After installing additional components, use the Specify
FactoryTalk Directory Location utility to point each computer in the network
to the FactoryTalk Directory network directory server.
Configure SQL Server 2017 If including reporting services in the FactoryTalk Batch system installation,
you must configure SQL Server to enable FactoryTalk Event Archiver with
to enable FactoryTalk Event Reporting Services to connect to and insert records into the FactoryTalk
Archiver with Reporting Batch database. This procedure uses SQL Server Management Studio to set
up permissions for the BatchHistory or BatchHistoryEx database.
Services
See the FactoryTalk Event Archiver User Guide to configure the reporting option
for End of Batch or Incremental.
IMPORTANT All users of the FactoryTalk Batch Reporting Services must have a user login and read
and write access to the source databases, such as BatchHistoryEx or the
FactoryTalk® Alarms and Events FTAE_Historian databases. Add any additional users
or groups when adding the login account for the FactoryTalk Batch Server.
41
Chapter 3 Install FactoryTalk Batch Server, FactoryTalk eProcedure Server, and FactoryTalk Event Archiver
42
Chapter 3 Install FactoryTalk Batch Server, FactoryTalk eProcedure Server, and FactoryTalk Event Archiver
Configure SQL Server 2014 If including reporting services in the FactoryTalk Batch system installation,
you must configure SQL Server to enable FactoryTalk Event Archiver with
or SQL Server 2016 to Reporting Services to connect to and insert records into the FactoryTalk
enable FactoryTalk Event Batch database. This procedure uses SQL Server Management Studio to set
up permissions for the BatchHistory or BatchHistoryEx database.
Archiver with Reporting
See the FactoryTalk Event Archiver User Guide to configure the reporting option
Services for End of Batch or Incremental.
IMPORTANT All users of the FactoryTalk Batch Reporting Services must have a user login and read
and write access to the source databases, such as BatchHistoryEx or the
FactoryTalk® Alarms and Events FTAE_Historian databases. Add any additional users
or groups when adding the login account for the FactoryTalk Batch Server.
Configure SQL Server 2012 If including reporting services in the FactoryTalk Batch system installation,
you must configure SQL Server to enable FactoryTalk Event Archiver with
to enable FactoryTalk Event Reporting Services to connect to and insert records into the FactoryTalk
Archiver with Reporting Batch database. This procedure uses SQL Server Management Studio to set
up permissions for the BatchHistory or BatchHistoryEx database.
Services
43
Chapter 3 Install FactoryTalk Batch Server, FactoryTalk eProcedure Server, and FactoryTalk Event Archiver
4. Under BatchHistory\Programmability or
BatchHistoryEX\Programmability, add the EXECUTE permission for
the FactoryTalk Batch Server user account to dbo.BHInsert properties.
5. For BatchHistoryEX\Programmability, add the EXECUTE permission
for the FactoryTalk Batch Server user account to dbo.BHRecovery
properties.
Grant access to the By default, the FactoryTalk Batch directory on the SQL Server computer is not
shared to domain users. Therefore, domain users cannot access the
FactoryTalk Batch directory appropriate application .log file when an error message refers them to it.
on the SQL Server computer To enable domain users to read application logs, share the FactoryTalk Batch
directory on the SQL Server computer in the FactoryTalk Batch system to
domain users and give the share Read-Only permissions.
Add a server to the If your FactoryTalk Batch system includes a Material Manager server you will
need to configure the system with the newly installed servers and synchronize
FactoryTalk Batch system your FactoryTalk Batch system. The synchronization process copies the
network model data from your computer to each of the computers included in
your FactoryTalk Batch system. Use the Network Editor utility to perform this
procedure.
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 system. The computers running FactoryTalk Batch components that have
been installed need to be present in the network model for your system. Each
Material Manager server can support ten FactoryTalk Batch servers. After the
initial install each computer has a local network model that needs to be
synchronized for the components to work together.
The Network Editor is installed automatically with the FactoryTalk Batch and
Material Servers.
44
Chapter 3 Install FactoryTalk Batch Server, FactoryTalk eProcedure Server, and FactoryTalk Event Archiver
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 the Synchronize button.
7. Click OK.
The Network Editor refreshes and the results of the synchronization
process display in the Results pane.
Event log settings The Windows Event Log service records application, system, and security
information.
Logging events can fill log space very quickly. If logging is enabled, we
recommend that you configure the Windows Application and Services logs on
Windows Server to use the Overwrite events as needed setting.
For more information about event log settings, see Modify Event Log Settings
in the FactoryTalk Batch Administrator Guide.
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.
IMPORTANT Administrative privileges are required to create a shared directory.
45
Chapter 3 Install FactoryTalk Batch Server, FactoryTalk eProcedure Server, and FactoryTalk Event Archiver
4. Select Share.
Define redundant servers Configure FactoryTalk Batch to store batch journals and batch restart
information in two separate locations. If there is a hardware failure on the
(optional) primary FactoryTalk Batch Server computer, using a secondary server allows
for a manual failover.
The second computer must be capable of running the server. Redundant
servers are defined by specifying the primary and secondary restart paths. If
the system experiences a failure, these paths indicate where system files are
written. If a secondary path is not specified, FactoryTalk Batch does not write
any secondary files.
FactoryTalk Batch can be configured to store batch journals and batch restart
information in two separate locations.
46
Chapter 3 Install FactoryTalk Batch Server, FactoryTalk eProcedure Server, and FactoryTalk Event Archiver
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.
Configure server options Before configuring the FactoryTalk Batch Server, make sure that all project
directories are shared. Configure the FactoryTalk Batch Server using the
FactoryTalk Batch Equipment Editor Server Options dialog box.
Tip: In FactoryTalk Batch Equipment Editor, access Options > Server Options,
Project Settings tab. Verify that the location listed in Initialization File Name is
where the batchsvr.ini resides on the computer.
47
Chapter 3 Install FactoryTalk Batch Server, FactoryTalk eProcedure Server, and FactoryTalk Event Archiver
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.
For more information about configuring server options, see the FactoryTalk
Batch Administrator Guide.
Set security on logs and To prevent losing data in the log files and the event journal (.evt) files, set
security permissions on the logs and event journal folders. The system
journals folders administrator determines who needs access to these files and assigns the
appropriate permissions. The accounts under which the FactoryTalk Batch
Server and FactoryTalk Event Archiver are running must be given full access
to these folders.
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.
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.
48
Chapter 3 Install FactoryTalk Batch Server, FactoryTalk eProcedure Server, and FactoryTalk Event Archiver
Configure browser Configure Internet Explorer Compatibility View settings for the FactoryTalk
eProcedure Client to ensure that:
compatibility view settings
• The FactoryTalk eProcedure Client command buttons work and
display correctly.
• The current user is displayed and has permissions to view the batch
list.
• The buttons on the left side are all the same size.
49
Chapter 4
Use this checklist to help you successfully set up the FactoryTalk Batch Client
components:
Pre-Installation administration tasks
Tasks Notes
Obtain administrator privileges on target
computer
Update Windows firewall settings
Set the system date and time
Installation
Install the FactoryTalk Batch Client
51
Chapter 4 Install FactoryTalk Batch Client components
Install the FactoryTalk Installing the FactoryTalk Batch Client also installs these components:
52
Chapter 5
Use this checklist to help you successfully set up the FactoryTalk Batch
Material Manager environment:
Pre-Installation administration tasks
Tasks Notes
Obtain administrator privileges on target
computer
Create users and user groups
Update Windows firewall settings
Configure the remote registry service
Set the system date and time
Prepare the SQL Server installation
Configure Microsoft Message Queuing Service
• Configure the Windows Server operating
system
• Configure the Windows desktop operating
system
Installation
Install the FactoryTalk Batch Material Manager
Server
Post-installation tasks
Identify the material database
Add a server to the FactoryTalk Batch system
53
Chapter 5 Install FactoryTalk Batch Material Manager Server components
Install the FactoryTalk Use this procedure to install the FactoryTalk Batch Material Manager Server.
Batch Material Manager Tip: Prerequisite checks are run automatically to verify that the required software is present on the
target computer. If an issue occurs during installation, suggested resolution steps are provided.
Server
To install the FactoryTalk Batch Material Manager Server:
1. Run Setup.exe.
2. On the Setup page, select Customize.
3. On the Customize page:
• Select and expand FactoryTalk Batch Material Manager v14.00.
• Select Server Components.
• Clear all other selections.
Tip: FactoryTalk Services Platform v6.20.00 is always installed with FactoryTalk Batch
Material Manager v14.00.
• Select Next.
4. On the Permission Requested page, select Yes, allow changes to this
computer, and then select Next.
Installing this component will make these changes to users and
groups:
• MTUsers will be assigned permissions to the MaterialBasedRecipe
database
• MTBatchServer will be added to the MTBatchServer role.
• MTLotAuthor will be added to the MTLotAuthor role.
• MTMaterialAuthor will be added to the MTMaterialAuthor role.
• MTMaterialViewer will be added to MTMaterialViewer role.
5. On the Options page:
• Under Material Activity Journal select Record activity to the
MaterialBasedRecipe_MAJ database if you will be using
FactoryTalk Event Archiver reporting with FactoryTalk Batch
Material Manager.
• Select Next.
6. On the System Details page, complete these fields:
• Under User Account in User Name, enter the domain\user name for
user account created for the FactoryTalk Batch Material Manager
Server to run under. If the user account is in the current domain,
the domain does not need to be specified.
• In Password enter the password for the domain\user name.
• Select Install.
7. On the End User License Agreements page, review the agreement and
select Accept all.
8. (optional) If prompted on the Almost There page, select Activate your
software, and then select Next.
9. If prompted on the That's it page, restart the computer.
54
Chapter 5 Install FactoryTalk Batch Material Manager Server components
Post-installation for After installing the FactoryTalk Batch Material Manager Server, complete
these configuration items before transitioning the system into production:
FactoryTalk Batch Material
• Identify the material database
Manager Server • Add a server to the FactoryTalk Batch system
(If the Material Manager Server is on a different server than the
FactoryTalk Batch server)
Identify the material Configure the FactoryTalk Batch Material Manager Server with the location of
database the SQL database that contains the materials for the recipes.
4. Select Synchronize.
5. Select File > Exit, and then select Yes to exit the Network Editor.
55
Chapter 6
Install the FactoryTalk Use this procedure to install the FactoryTalk Batch Material Manager Client.
Batch Material Manager Tip: Prerequisite checks are run automatically to verify that the required software is present on the
target computer. If an issue occurs during installation, suggested resolution steps are provided.
Client components
To install the FactoryTalk Batch Material Manager Client
1. Run Setup.exe.
2. On the Customize page:
• Select and expand FactoryTalk Batch Material Manager v14.00.
• Select Client Components.
• Clear all other selections.
Tip: FactoryTalk Services Platform v6.20.00 is always installed with FactoryTalk Batch
Material Manager v14.00.
• Select Next.
3. If prompted, on the System Details page, specify the name of a
computer that has the FactoryTalk Batch Server installed, and select
Install.
4. On the End User License Agreements page, review the agreement, and
select Accept all.
5. On the That's it page, if prompted to do so, restart your computer.
57
Chapter 7
FactoryTalk Activation
59
Chapter 7 FactoryTalk Activation
Client computer that includes:
• FactoryTalk Batch Client
• eProcedure Client
• FactoryTalk Batch View
IMPORTANT The FactoryTalk Batch Server checks for valid licenses and the correct number of
unit licenses for FactoryTalk Batch and eProcedure at start up.
Cumulative unit licensing Software licenses are split into a product license and multiple unit licenses.
For example, a 30-unit FactoryTalk Batch product contains a 30-unit
FactoryTalk Batch Server license, which includes a bundled license for
FactoryTalk Batch Server, eProcedure Server, and FactoryTalk Batch Material
Manager Server, and 30 new unit licenses.
When the FactoryTalk Batch Server starts, it performs a license check to
determine which applications have a license. It then attempts to check out
individual unit licenses up to the number of units specified in the area model.
The FactoryTalk Batch Server then sets the maximum number of allowable
units to the total number of successful individual unit license checkouts.
60
Chapter 8
If you have an existing FactoryTalk Batch system, you can upgrade the
environment instead of doing a new installation.
Use this checklist to help you to successfully upgrade the FactoryTalk Batch
environment:
Pre-upgrade tasks
Tasks Notes
Allow the Message Queue to clear for Material
Manager
Export XML or RDB recipes to binary
Back up files
Uninstall a previous version of FactoryTalk
Batch
FactoryTalk Batch component upgrade tasks
Upgrade the FactoryTalk Batch components
Post-upgrade tasks
Restore back up files
Migrate area models from FactoryTalk Batch
version 13.00 or 13.00.02
Migrate recipes from FactoryTalk Batch
version 13.00 or 13.00.02
(optional) Convert binary recipes to XML or
RDB
Convert migrated recipes back to XML format
(optional)
Convert migrated recipes back to RDB format
(optional)
Configure recipe storage
Pre-upgrade tasks for This section describes steps to perform before upgrading the software,
including:
FactoryTalk Batch
• Allowing the Message Queue to clear (Material Manager)
• If using XML or RDB recipes, exporting them to binary
• Backing up existing data files
• Uninstalling previous versions of FactoryTalk Batch components
61
Chapter 8 Upgrade FactoryTalk Batch
Allow the Message Queue to Allow the message queues for communication to clear between the
FactoryTalk Batch Material Manager Server and the Material Activity Journal.
clear for FactoryTalk Batch
IMPORTANT This procedure applies to FactoryTalk Batch Material Manager only.
Material Manager
See also
Upgrade FactoryTalk Batch components on page 61
Export XML or RDB recipes Before upgrading FactoryTalk Batch components to a later version, export
recipes to binary format and delete any RDB recipe database.
to binary
Back up files Before uninstalling the previous versions of FactoryTalk Batch components,
close all applications, and stop all FactoryTalk Batch services, including the
eProcedure Server, then back up the configuration and data files.
62
Chapter 8 Upgrade FactoryTalk Batch
Tip: Back up the .ini files so that you can revert to the previous installation
if needed.
63
Chapter 8 Upgrade FactoryTalk Batch
Uninstall a previous version Uninstall FactoryTalk Batch components from version 13.00 or 13.00.02.
of FactoryTalk Batch Tip: Users must have administrative privileges on the target computer to
uninstall the software.
Prerequisites
• Back up all the files and databases associated with the applications
being uninstalled.
• Close all applications.
• Stop all FactoryTalk Batch services.
Upgrade the FactoryTalk After backing up files and uninstalling the previous version of FactoryTalk
Batch, install the latest versions of FactoryTalk Batch components to upgrade
Batch components to the latest version:
• Install the FactoryTalk Batch components on page 36
• Install the FactoryTalk Batch Client on page 52
64
Chapter 8 Upgrade FactoryTalk Batch
Post-upgrade tasks After upgrading the FactoryTalk Batch software, perform these tasks before
putting the system into production:
• Restoring back-up files
• Migrating area models and binary recipes, including XML or RDB
recipes that were exported to binary before the upgrade
• (Optional) Converting binary recipes back to XML or RDB
Restore backup files Before opening the FactoryTalk Batch Recipe Editor or the FactoryTalk Batch
Equipment Editor, restore backed up files to their original locations. This
preserves the Batch Server and Client files and the databases for use with the
upgraded version of FactoryTalk Batch.
IMPORTANT Do not delete installed FactoryTalk Batch, eProcedure, or Material Manager product
files from their installed locations.
Removing product files from their original locations may cause unexpected failures
and error messages in the Microsoft Install Resiliency feature. Instead, replace or
overwrite the product files with other files of the same name.
For example, overwrite BatchIDCreation.dll, RAMSCustom.dll and other hot fix files,
but never delete and then replace these files.
65
Chapter 8 Upgrade FactoryTalk Batch
• Binary recipes (if using XML or RDB, first update the exported binary
versions after upgrading the FactoryTalk Batch software, and then
export them back to XML or RDB format)
• Area models (Batch\<project name>\recipes folder)
IMPORTANT Do not restore the FactoryTalk Batch version 13 module .ini
files. The .ini files are only restored when you are reverting to
the previous installation.
66
Chapter 8 Upgrade FactoryTalk Batch
Migrate area models from After upgrading FactoryTalk Batch you must migrate any area models and
recipes to the 14.0 schema so they can be used by the system.
FactoryTalk Batch version
13.00 or 13.00.02
Prerequisites
• Use the FactoryTalk Administration Console to confirm that any linked
FactoryTalk and Windows users and groups that are required by
signature templates are configured in the FactoryTalk Network
Directory.
Migrate recipes from The FactoryTalk Batch Recipe Editor schema has changed from version 13 to
version 14. When opening the Recipe Editor, some recipes might require
FactoryTalk Batch version translation before using the Recipe Editor.
13.00 or 13.00.02 These instructions are for recipes stored in the default binary files and for
migrating the binary recipes export of XML or RDB recipes.
67
Chapter 8 Upgrade FactoryTalk Batch
Convert binary recipes to After installing the latest version of FactoryTalk Batch components and
migrating the area model, convert binary format recipes to an XML or RDB
XML or RDB format if needed.
Convert migrated recipes Use this procedure to convert updated binary recipes back to XML format.
68
Chapter 8 Upgrade FactoryTalk Batch
6. In the Import Recipe into XML directory dialog box, select Binary
Files and set the path to the location of the translated binary files.
7. In the Recipe Name list, select all the recipes, and then select Import.
Recipes are imported into the working set of recipes in XML format.
Convert migrated recipes Use this procedure to convert migrated binary recipes back to RDB format.
Configure recipe storage Recipes can be stored either as binary files, in a SQL Server Database, or as
XML files
69
Chapter 8 Upgrade FactoryTalk Batch
• XML Files: Stores recipes in separate .xml files:
Stores procedures as .pxml files
Stores unit procedures as .uxml files
Stores operations as .oxml files
4. Select OK to apply the configuration settings.
70
Chapter 9
Manually configure the If the Windows Firewall is enabled, and not externally controlled, the
Windows Firewall Configuration Utility runs automatically. If this utility
Windows Firewall does not run automatically, manually run it on each computer in the
FactoryTalk Batch system after installing servers or clients.
71
Chapter 9 Troubleshoot FactoryTalk Batch installation or upgrade
Define or reset a disabled The FactoryTalk Directory Configuration Wizard runs silently during the
FactoryTalk Service Platform installation or upgrade. Run the wizard
FactoryTalk Administrator manually to define or reset a disabled Administrator account. FactoryTalk
account Batch and FactoryTalk Batch ActiveX Controls store client configuration
settings in the Local and Network Directory.
Communication with If the FactoryTalk Batch and eProcedure Servers run on a workgroup, add an
Incoming Firewall Rule to allow the FactoryTalk Batch Service Manager to
FactoryTalk Batch Server connect to the Server in a timely manner. For more information about adding
times out an Incoming Firewall Rule, see Add an incoming firewall rule.
Disable Administrative Approval Mode for all administrators on the
FactoryTalk Batch Server when running on a workgroup. This ensures that
administrators do not have to install or run programs using elevated
privileges.
For more information about disabling Administrative Approval, see Disable
Administrative Approval Mode.
72
Chapter 9 Troubleshoot FactoryTalk Batch installation or upgrade
Configure Internet Explorer Use these instructions to configure Internet Explorer security settings for
Trusted Sites.
security settings for
Trusted Sites
To configure Internet Explorer security settings for Trusted Sites
1. Using Internet Explorer, open Settings > Internet Options.
2. Select the Security tab.
3. Select Trusted sites.
4. Under Security level for this zone, drag the slider to lower the security
level for the Trusted sites zone to Low or Medium-low.
5. If the eProcedure Trusted sites differ from the default installation,
select Sites to open the Trusted sites dialog box.
• Under Websites, scroll through the list and verify that the
eProcedure Server computer and about:blank sites are listed.
• If the eProcedure Server computer and about:blank sites are not
listed, select Add and add them.
• Select Close when finished.
6. Select OK to apply the changes.
Internet Explorer intranet The installation of the eProcedure Server installs a Security_HKLM_Only key
and sets the key to 1 (enabled). The key exists in the location:
zone
HKEY_LOCAL_MACHINE\Software\Policies\Microsoft\Windows\CurrentVe
rsion\Internet Settings
Internet Explorer uses intranet security settings when:
• The Security_HKLM_Only key is 0 (disabled) or removed
• The eProcedure Server name does not appear on the list of trusted sites
• The site qualifies as an intranet site
Configure the ActiveX settings for the intranet zone.
Run as Administrator on To launch the eProcedure Client on a computer running Windows Server you
must be logged in with an account that has administrator privileges.
eProcedure Client on
Windows Server operating
To run as Administrator on Windows Server operating systems:
systems
• Right-click the eProcedure Client icon and select Run as
administrator.
73
Chapter 9 Troubleshoot FactoryTalk Batch installation or upgrade
Manually recreate the If the database name is not masterrecipes, follow these steps to edit the .bat
file and the createmasterrecipedb.sql script to specify the name of the
masterrecipes database
database and recreate it.
If the database needs to be recreated at any time, the .bat file can also be used
to recreate it.
Tip: If Store recipes in RDB format was selected when installing FactoryTalk Batch, running the
createmasterrecipedb.bat file is not required.
Prerequisites
• Use the Rockwell Software\Batch\Scripts\createmasterrecipedb.bat
file to recreate the recipe database.
Tip: This batch file uses the default database name masterrecipes. It executes these SQL
scripts in the Batch\Scripts folder to create the database and tables:
• createmasterrecipedb.sql
• createrecipetables.sql
74
Appendix A
Windows Workgroup This section describes steps to configure FactoryTalk Batch to run under a
Windows Workgroup.
If the FactoryTalk Batch system runs under a Windows Workgroup, you will
need to perform these additional tasks:
• Create Windows accounts
• Add an incoming firewall rule
• Disable Administrative Approval Mode
Create Windows accounts If the FactoryTalk Batch application servers use a local account, create
Windows accounts with the same name and password on all computers in the
workgroup.
Add an incoming firewall Add incoming firewall rules for these applications:
75
Appendix A Use FactoryTalk Batch with a Windows Workgroup
• In Name, in the Name box, enter Port 49157 TCP, and then select
Finish.
• Verify that Port 49157 TCP rule exists in the Inbound Rules list.
• Close Windows Firewall with Advanced Security.
Disable Administrative Disable the User Account Control: Run all administrators in Admin Approval
Mode security policy setting on the FactoryTalk Batch Server computer when
Approval Mode running on a Windows Workgroup. This ensures that users do not have to
install or run programs using elevated privileges.
IMPORTANT If this security setting is configured to Disabled, the Windows Security Center notifies
you that the overall security of the operating system has been reduced. As a result of
this change Windows User Account Control (UAC) is not used, and any security
benefits and risk mitigations that are dependent on UAC are not present on the
computer. Additionally, when this setting is changed, the computer must be restarted.
76
Appendix B
77
Appendix B Install FactoryTalk eProcedure Client components
Important: To run the FactoryTalk eProcedure Client on a Windows Server
machine, first do the following:
• Disable Internet Explorer Enhanced Security Configuration.
• Obtain the required privileges to execute the FactoryTalk
eProcedure Client, right-click the FactoryTalk eProcedure Client
icon and select Run as administrator.
Install the FactoryTalk The FactoryTalk eProcedure Client is a web-based application that creates and
commands batches. A batch is composed of a combination of process-
eProcedure Client connected phase logic and instruction files that step the operator through the
manual process of producing a batch of products.
Tip: Prerequisite checks are run automatically to verify that the required software is present on the
target computer. If an issue occurs during installation, suggested resolution steps are provided.
78
Appendix B Install FactoryTalk eProcedure Client components
Set the Internet Explorer The FactoryTalk eProcedure Client install sets the home page only for the user
home page for FactoryTalk who installed the product. Any other users who will be using the FactoryTalk
eProcedure Client on that computer must set the FactoryTalk eProcedure
eProcedure Clients Client as the home page.
Configure Internet Explorer Use these instructions to configure Internet Explorer to view FactoryTalk
eProcedure pages.
to view FactoryTalk
eProcedure pages
To configure Internet Explorer to view FactoryTalk eProcedure
pages
1. In Internet Explorer, select Tools > Internet Options.
Tip: If using the global policy editor, use gpedit.msc.
79
Appendix B Install FactoryTalk eProcedure Client components
Tip: When adding sites to Internet Explorer Security Zones, be aware that:
• The FactoryTalk eProcedure installation modifies the Trusted sites
security setting for the local computer. This provides all users with
consistent FactoryTalk eProcedure Client operation. The instructions
provided in this guide enable the current user to customize the
FactoryTalk eProcedure Client operation and addition of sites into the
current user's Internet Explorer security zones. Incorrectly following the
instructions may result in undesired FactoryTalk eProcedure Client
behavior or damage to the configuration of the computer, or both.
• Third-party computer and network security products, like Symantec,
interact with Internet Explorer to secure computing environments.
Modifying the default FactoryTalk eProcedure installation may lock
down some settings and prevent the FactoryTalk eProcedure Client
from successfully operating.
4. In the Trusted sites dialog box, verify that Require server verification
(https:) for all sites in this zone is disabled.
5. In the Add this Web site to the zone box, type http://<name of
computer hosting FactoryTalk eProcedure server>. Select Add to add
the Web site to the Web sites box.
6. In the Add this Web site to the zone box, type about:blank. Select Add
to add about:blank to the list of websites.
7. In the Add this Web site to the zone box, type about:internet. Select
Add to add about:internet to the list of websites.
8. Close the Trusted sites dialog box.
9. In the Internet Explorer Options dialog box, select Custom Level.
10. In the Security Settings dialog box, select Enable for these options:
• Download signed ActiveX controls
• Download unsigned ActiveX controls
• Initialize and script ActiveX controls not marked safe
• Run ActiveX controls and plug-ins
• Script ActiveX controls marked safe for scripting
11. Select OK. A confirmation message is displayed.
12. Select Yes to change the security settings and close the Security
Settings dialog box.
13. Select OK. If prompted, restart the computer.
Configure Internet Explorer Use these instructions to configure the Internet Explorer compatibility view
settings.
compatibility view settings
80
Appendix B Install FactoryTalk eProcedure Client components
Tip: To enable the current user to maintain a separate set of eProcedure
Client security settings than those for the local computer, see Configure
Internet Explorer security settings for Trusted Sites.
Select Windows theme in Windows 7 requires the Windows Classic theme to use the eProcedure Client.
Using other themes (such as Windows Basic) may cause unpredictable issues
Windows 7 with color and display.
81
Appendix C
Uninstall the FactoryTalk Use this procedure to uninstall all FactoryTalk Batch components on the
computer at once.
Batch system
Prerequisites
• Close all FactoryTalk Batch applications.
• Stop all Batch services.
Uninstall the FactoryTalk As an alternative to uninstalling the entire FactoryTalk Batch System, use the
Uninstall page to uninstall unnecessary components and keep useful
Batch components components. Multiple components can be selected.
Prerequisites
• Close all FactoryTalk Batch applications.
• Stop all Batch services.
83
Appendix C Uninstall FactoryTalk Batch version 14.00
Uninstall FactoryTalk Batch Uninstall FactoryTalk Batch Material Manager to move it to another server or
to permanently uninstall FactoryTalk Batch Material Manager if it is not
Material Manager being used.
Prerequisites
• Close all FactoryTalk Batch applications.
• Stop all Batch services.
• Allow the Message Queue to clear
Delete the default Delete the default directories or the directories of the FactoryTalk Batch
components after uninstalling the applications to free up space on the file
directories system.
84
Appendix C Uninstall FactoryTalk Batch version 14.00
2. Right-click the Batch folder and select Delete. A message box confirms
the deletion.
3. Select Yes.
4. Close Windows Explorer.
Delete databases After uninstalling FactoryTalk Batch, delete any remaining databases in SQL
Server to free up space in the database.
Databases that might be present are:
• BatchHistory or BatchHistoryEx
• MaterialBasedRecipe
• MaterialBasedRecipe_MAJ
• Sample2_Materials
To delete databases
1. Open SQL Server Management Studio and expand Databases.
2. Right-click the database and select Delete.
3. Click OK.
85
Index
P
R
A
RDB 59, 60, 62, 63, 65, 66, 67, 72
accounts 73
recipes 15, 25, 33, 51, 53, 59, 60, 62, 63,
administrator privileges 19, 33, 49, 51
65, 66, 67, 72
redundant 33, 44
B
remote registry 25, 33
back up 59, 60, 62, 63 reporting services 25, 27, 33, 41
batchhistory 14, 33, 41, 60, 63, 83 restart 33, 44, 50, 52, 55, 62, 76, 77
C S
compatibility view 33, 47, 78 server options 33, 45, 65, 66, 67
SQL Server 13, 14, 15, 25, 27, 33, 41, 42, 51,
D 60, 63, 67, 72, 83
start 15, 25, 27, 34, 37, 44, 50, 52, 55, 57,
data execution prevention (DEP) 22
58, 62, 69, 76, 77, 79
database 13, 14, 22, 25, 33, 34, 37, 41, 53,
system overview 13
60, 62, 63, 65, 66, 72, 81, 82, 83
system requirements 13, 14, 15, 20, 25, 33,
date 23, 25, 33, 49, 51, 63, 65, 66
34, 49, 50, 76, 79
delete 22, 33, 60, 63, 81, 82, 83
directories 33, 34, 42, 43, 50, 60, 65, 66, T
70, 76
disabled 69, 70, 71, 74, 77 time 14, 25, 27, 33, 49, 51, 69, 70, 72
troubleshooting 69
F
U
firewall 15, 20, 23, 25, 33, 49, 51, 60, 69,
70, 73, 74 uninstall 59, 60, 62, 81, 82, 83
upgrading 59, 62, 63, 69
I users 22, 27, 41, 42, 65
L X
licensing 57, 58 XML 59, 60, 62, 63, 65, 66, 67
logs 25, 33, 42, 43, 46
M
MasterRecipes 60, 66, 72
message queuing 60
migrate 62, 65, 66, 67
87
Rockwell Automation support
Use these resources to access support information.
Technical Support Center Find help with how-to videos, FAQs, chat, user forums, and product notification rok.auto/support
updates.
Knowledgebase Access Knowledgebase articles. rok.auto/knowledgebase
Local Technical Support Phone Numbers Locate the telephone number for your country. rok.auto/phonesupport
Literature Library Find installation instructions, manuals, brochures, and technical data publications. rok.auto/literature
Product Compatibility and Download Center Get help determining how products interact, check features and capabilities, and rok.auto/pcdc
(PCDC) find associated firmware.
Documentation feedback
Your comments help us serve your documentation needs better. If you have any suggestions on how to improve our content, complete the form at
rok.auto/docfeedback.
Rockwell Automation maintains current product environmental information on its website at rok.auto/pec.
Allen-Bradley, expanding human possibility, Logix, Rockwell Automation, and Rockwell Software are trademarks of Rockwell Automation, Inc.
Trademarks not belonging to Rockwell Automation are property of their respective companies.
Rockwell Otomayson Ticaret A.Ş. Kar Plaza İş Merkezi E Blok Kat:6 34752, İçerenkÖy, İstanbul, Tel: +90 (216) 5698400 EEE YÖnetmeliğine Uygundur
Rockwell Automation Publication# BATCH-IN002C-EN-D - October 2020 Copyright © 2020 Rockwell Automation Technologies, Inc. All Rights Reserved. Printed in the U.S.A.
Supersedes Publication# BATCH-IN002B-EN-D