Rockwell Automation FactoryTalk Batch Components Installation Manual
Installation and Upgrade Guide
FactoryTalk Batch Components Installation and Upgrade Guide
FactoryTalk
Batch Components 14.00
Rockwell Automation Publication BATCH-IN002C-EN-D - October 2020
Supersedes Publication BATCH-IN002B-EN-D - November 2018
Original Instructions
FactoryTalk Batch Components Installation and Upgrade Guide
personal injury or death, property damage, or economic loss.
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.
Labels may be on or inside the equipment, for example, a drive or motor, to alert people that surfaces may reach dangerous
temperatures.
Labels may be on or inside the equipment, for example, a motor control center, to alert people to potential Arc Flash. Arc Flash
for Personal Protective Equipment (PPE).
Important User Information
Read this document and the documents listed in the additional resources section about installation, configuration, and
operation of this equipment before you install, configure, operate, or maintain this product. Users are required to familiarize
themselves with installation and wiring instructions in addition to requirements of all applicable codes, laws, and standards.
Activities including installation, adjustments, putting into service, use, assembly, disassembly, and maintenance are required to
be carried out by suitably trained personnel in accordance with applicable code of practice.
If this equipment is used in a manner not specified by the manufacturer, the protection provided by the equipment may be
impaired.
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
ATTENTION:
Labels may also be on or inside the equipment to provide specific precautions.
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:
ARC FLASH HAZARD:
will cause severe injury or death. Wear proper Personal Protective Equipment (PPE). Follow ALL Regulatory requirements for safe work practices and
2
Preface
FactoryTalk Batch system
Pre-installation administrative
Install FactoryTalk Batch
Table of Contents
overview
tasks
About this manual 7
Legal Notices 7
Additional resources 8
Chapter 1
Server placement guidelines 14
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
Obtain administrator privileges on target computer 21
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
Server, FactoryTalk eProcedure
Server, and FactoryTalk Event
Archiver
3
Chapter 3
Install the FactoryTalk Batch components 36
FactoryTalk Updater 39
Modify an installation 39
Post-installation tasks for FactoryTalk Batch components 40
Configure the FactoryTalk network directory 41
Configure SQL Server 2017 to enable FactoryTalk Event Archiver
with Reporting Services 41
Table of Contents
Install FactoryTalk Batch Client
Install FactoryTalk Batch
Install FactoryTalk Batch
FactoryTalk Activation
Upgrade FactoryTalk Batch
Configure SQL Server 2014 or SQL Server 2016 to enable
FactoryTalk Event Archiver with Reporting Services 43
Configure SQL Server 2012 to enable FactoryTalk Event Archiver
with Reporting Services 43
Grant access to the FactoryTalk Batch directory on the SQL Server
computer 44
Add a server to the FactoryTalk Batch system 44
Event log settings 45
Create a shared directory 45
Define redundant servers (optional) 46
Configure server options 47
Set security on logs and journals folders 48
Configure browser compatibility view settings 49
Chapter 4
Install the FactoryTalk Batch Client 52
components
Material Manager Server
components
Material Manager Client
components
Chapter 5
Install the FactoryTalk Batch Material Manager Server 54
Post-installation for FactoryTalk Batch Material Manager Server 55
Identify the material database 55
Chapter 6
Install the FactoryTalk Batch Material Manager Client components 57
Chapter 7
Cumulative unit licensing 60
Chapter 8
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
Troubleshoot FactoryTalk Batch
installation or upgrade
Use FactoryTalk Batch with a
Install FactoryTalk eProcedure
Uninstall FactoryTalk Batch
version 14.00
Index
Windows Workgroup
Table of Contents
Convert binary recipes to XML or RDB 68
Convert migrated recipes back to XML format 68
Convert migrated recipes back to RDB format 69
Configure recipe storage 69
Chapter 9
Manually configure the Windows Firewall 71
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
Windows Workgroup 75
Create Windows accounts 75
Add an incoming firewall rule 75
Disable Administrative Approval Mode 76
Client components
Appendix B
Install the FactoryTalk eProcedure Client 78
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 the FactoryTalk Batch system 83
Uninstall the FactoryTalk Batch components 83
Uninstall FactoryTalk Batch Material Manager 84
Delete the default directories 84
Delete databases 85
5
About this manual
Legal Notices
Preface
This guide provides information and procedures for installing and upgrading
a FactoryTalk®
• 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.
Before starting installation or upgrade of FactoryTalk Batch components,
review FactoryTalk Batch release notes and product compatibility information
at the Product Compatibility and Download Center (PCDC)
Batch system, which includes:
.
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.
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.
The default location of this file is:
C:\Program Files (x86)\Common Files\Rockwell\license.rtf
Open Source Software Licenses
The software included in this product contains copyrighted software that is
licensed under one or more open source licenses.
7
You can view a full list of all open source software used in this product and
their corresponding licenses by opening the oss_license.txt file located your
product's OPENSOURCE folder on your hard drive. This file is divided into
these sections:
Preface
Resource
Description
FactoryTalk Batch Components Installation and
Provides information and procedures for FactoryTalk
Server components.
Additional resources
• 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:
C:\Program Files (x86)\Common Files\Rockwell\Help\<product
name>\Release Notes\OPENSOURCE\oss_licenses.txt
You may obtain Corresponding Source code for open source packages
included in this product from their respective project web site(s).
Alternatively, you may obtain complete Corresponding Source code by
contacting Rockwell Automation via the Contact form on the Rockwell
Automation website:
http://www.rockwellautomation.com/global/aboutus/contact/contact.page. Please include "Open Source" as part of the request
text.
Following is a comprehensive list of documentation for the FactoryTalk®
Batch products from Rockwell Automation.
Installation, Quick Start, and Getting Results Guides
Upgrade Guide
(BATCH-IN002)
FactoryTalk Batch View Quick Start Guide
(FTBVS-QS001)
FactoryTalk Batch View HMI Controls Quick Start
Guide
(BATCH-QS001D)
Batch system installation. Includes information for
FactoryTalk Batch Material Manager, FactoryTalk Event
Archiver, and associated FactoryTalk Batch Client and
Provides information about using FactoryTalk Batch View
to create, view, and command control recipes,
acknowledge prompts and signatures, view equipment
phases and diagnostic information, and view profile
information.
Provides a general overview of FactoryTalk Batch View
HMI Controls.
8
FactoryTalk Batch eProcedure® Getting Results
Guide
(BWEPRO-GR011)
FactoryTalk Batch Getting Results Guide
(BATCH-GR011)
Explains the basics of FactoryTalk Batch eProcedure.
Introduces the basics of automated batch manufacturing
and the FactoryTalk Batch product components.
Resource
Description
FactoryTalk Batch Material Manager Getting
(BWMTR-GR011)
Introduces the basics of FactoryTalk Batch Material
Resource
Description
reference for the formulator.
your Logix 5000 controller.
FactoryTalk Batch Server.
Preface
Results Guide
User Guides
FactoryTalk Batch ActiveX Controls User Guide
(BATCH-UM013)
FactoryTalk Batch Material Editor User Guide
(BWMTR-UM001)
FactoryTalk Batch Equipment Editor User Guide
(BATCH-UM004)
FactoryTalk Batch PhaseManager™ User Guide
(BATCHX-UM011)
Manager.
Provides information and instructions for using the
FactoryTalk Batch ActiveX Custom Controls.
Provides access to information and procedural
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 materialbased recipes. This information is intended as a
Provides information on creating and maintaining an
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.
Describes the integration of the FactoryTalk Batch
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
9
FactoryTalk Batch Recipe Editor User Guide
(BATCH-UM006)
FactoryTalk Batch View HMI Controls User Manual
(FTBVS-UM003)
FactoryTalk Batch View User Manual
(FTBVS-UM002)
FactoryTalk eProcedure Client User Guide
(BWEPRO-UM001)
Provides instructions on using 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.
Provides details about using FactoryTalk Batch View HMI
Controls to monitor and interact with the production
process within a FactoryTalk View SE Display Client.
Provides information and procedural instructions for
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
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.
Preface
Resource
Description
FactoryTalk Event Archiver User Guide (BATCH-
Provides information and instructions specific to the
system administrator and production supervisor.
Resource
Description
operators, such as the FactoryTalk Batch Server.
Resource
Description
FactoryTalk Batch ActiveX Controls Library
(BATCH-RM001)
Provides reference information and procedural
those who want to develop custom interfaces.
UM012)
FactoryTalk Batch View User Guide (legacy)
(FTBVS-UM001)
Administrator Guides
FactoryTalk Batch Administrator Guide
(BATCH-UM003)
FactoryTalk Batch eProcedure Administrator Guide
(BWEPRO-UM011)
FactoryTalk Event Archiver. Intended for use by the
Provides information and instructions on how to use
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).
Provides instructions for configuring security and
services, and implementation and use of components not
typically accessed or used by batch operators, such as
the FactoryTalk Batch Server.
Provides procedures specific to FactoryTalk Batch
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
FactoryTalk Batch Material Manager Administrator
Guide
(BWEPRO-UM011)
Reference Guides
Reference Guide
FactoryTalk Batch Material Server API Technical
Reference
(BWMTR-RM001)
FactoryTalk Batch PCD Programming Reference
Manual
(BATCH-RM004)
Provides information and instructions specific to
FactoryTalk Batch Material Manager. Intended for use by
the system administrator and database administrator.
instructions for the FactoryTalk Batch ActiveX Custom
Controls.
Provides access to information regarding the interface
between the FactoryTalk Batch Material Server and the
FactoryTalk Batch Material Editor and FactoryTalk Batch.
It is intended to be used as a reference information by
Provides information and instructions about the
FactoryTalk Batch PCD interface design. It is intended to
be used as a reference guide.
10
Resource
Description
FactoryTalk Batch Server API Reference Manual
Provides information regarding the interface between the
Preface
(BATCH-RM003)
FactoryTalk Batch System Files Reference Manual
(BATCH-RM005)
FactoryTalk Batch eProcedure Instruction File
Design Reference Manual
(BWEPRO-RM001)
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.
Provides the technical information for configuration and
maintenance of a FactoryTalk Batch system. It can be
used as a reference information for implementation
engineers and the system administrator.
Includes information about the building of instruction
files for use in equipment database creation and recipe
development. This information is intended to be used as a
reference by the instruction file author.
View or download publications at
http://www.rockwellautomation.com/literature
. To order paper copies of
technical documentation, contact your local Allen-Bradley® distributor or
sales representative.
11
Site Level
eProcedure Clients
FactoryTalk Batch Material Manager
FactoryTalk Batch Server, eProcedure Server, and
for Master Recipe Storage
Chapter 1
FactoryTalk Batch system overview
FactoryTalk Batch components are configurable products that help define,
manage, monitor, and control manufacturing at local or remote sites. A
typical FactoryTalk Batch architecture consists of one or more computers on a
single network; there can be up to ten FactoryTalk Batch servers in a
FactoryTalk Batch system that includes Material Manager. Review the
application release notes, manuals, installation information for the
FactoryTalk Batch components planned for your architecture before setting
up the FactoryTalk Batch system.
This diagram illustrates an example of a FactoryTalk Batch network.
13
Clients
FactoryTalk Batch Material Server
SQL Server
FactoryTalk Batch Clients
TCP/IP
Plant Floor
FactoryTalk Batch View Server
FactoryTalk Batch Server connects to SQL Server
FactoryTalk Batch Clients
Proprietary Network
Process-Connected Device (PCD)
FactoryTalk Event Archiver Database
Chapter 1 FactoryTalk Batch system overview
FactoryTalk Batch Server.
Server placement
FactoryTalk Batch View
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
• 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 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
browsers such as Google Chrome or Microsoft Edge.
Installation information
about FactoryTalk Batch
System requirements and
The FactoryTalk Batch View Server is installed automatically with the
FactoryTalk Batch Server. The FactoryTalk Batch View web client does not
require any additional installation.
Chapter 1 FactoryTalk Batch system overview
View
Tip: FactoryTalk Batch View performs best with Chromium-based
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:
• BatchesList control: Creates control recipes, displays current control
recipes, and commands a control recipe. In FactoryTalk View SE, maps
to BatchViewHMI.BatchesList in the Insert an ActiveX Control dialog
box and the Property Panel.
• PromptsList control: Displays a list of prompts that are waiting to be
acknowledged, a list of electronic signatures associated with a batch
that are waiting for signoff, and instructions waiting to be
acknowledged. In FactoryTalk View SE, maps to
BatchViewHMI.PromptsList in the Insert an ActiveX Control dialog
box and the Property Panel.
• SFC control: Enables the ability to command batches during
FactoryTalk View SE run-time on the Details and Summary pages of
the SFC. In FactoryTalk View SE, maps to BatchViewHMI.SFC in the
Insert an ActiveX Control dialog box and the Property Panel.
• Full control: Accesses the entire FactoryTalk Batch View site. In
FactoryTalk View SE, maps to BatchViewHMI.FullView in the Insert
an ActiveX Control dialog box and the Property Panel.
supported software
overview
For more information about FactoryTalk Batch View, see the FactoryTalk
Batch View online help.
Review these minimum and recommended system requirements for
installing, configuring, and running FactoryTalk Batch components. Unless
noted these requirements assume that no other applications are installed on
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
Supported operating systems
• 4 GB of RAM memory
• 30 GB free hard disk space
• Intel Core i5 standard power processor or greater
• Windows Server®
• Windows Server 2019 Standard Edition (preferred)
• Windows Server 2016 Standard Edition (preferred)
• Windows Server 2019 DataCenter Edition
• Windows Server 2016 DataCenter Edition
• Windows Server 2012 R2 Standard Edition or DataCenter
• Windows Server 2012 Standard Edition or DataCenter
• Windows®
• Windows 10 Professional (64-bit) Build 1909 or later (preferred)
• Windows 10 Enterprise (64-bit) Build 1909 or later
Supported database applications
(for storing recipes, materials, reports, and journal archives)
• SQL Server®
• SQL Server 2019 (English version only)
• SQL Server 2017 (English version only)
• SQL Server 2016 Service Pack 1 (English version only)
• SQL Server 2014 Service Pack 3 (32-bit and 64-bit, English version
only)
• SQL Server 2012 Service Pack 4 (32-bit and 64-bit, English version
only)
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
Logix firmware requirements
(for FactoryTalk Batch only)
• Firmware version 18 or later on ControlLogix 5570 and CompactLogix
5370 family of controllers – for integration of PhaseManager with
FactoryTalk Batch
• Firmware version 32 or later on ControlLogix 5580 and CompactLogix
5380 family of controllers – for integration of PhaseManager with
FactoryTalk Batch
• Firmware version 29 or later - for integration of SequenceManager
with FactoryTalk Batch
Logix Designer requirements
(for FactoryTalk Batch only)
• Logix Designer version 18 or later - for synchronization of
PhaseManager with FactoryTalk Batch Equipment Editor
FactoryTalk View SE requirements
(for integration of FactoryTalk Batch View HMI Controls and legacy
FactoryTalk Batch ActiveX controls only)
• FactoryTalk View SE version 12.0 (preferred)
• FactoryTalk View SE version 11.0
FactoryTalk Services requirements
• FactoryTalk Services Platform version 6.20 (CPR 9 SR 12) or later
• FactoryTalk Linx version 6.20 (CPR 9 SR 12) or later
• FactoryTalk Activation Manager version 4.04 or later
Rockwell Automation Test Environment
Rockwell Automation tests software products under a standard configuration
of operating systems and antivirus software. For additional information see
the Knowledgebase Document ID:
Antivirus Software.
PN24 - Rockwell Software Products and
17
Chapter 1 FactoryTalk Batch system overview
IMPORTANT
Compatibility and Download Center (PCDC).
IMPORTANT
Select installation
Warranty
The warranty does not cover systems that do not meet the minimum
requirements for the version of software.
FactoryTalk Batch components for version 14.00 support only the
versions of operating systems. For more information about supported operating
systems and other Rockwell Software product version support, refer to the
U.S. English
Product
• The FactoryTalk Batch Server computer cannot be configured as a:
• Domain controller
• DHCP server
• WINS server
• RAS server
• DNS server
• Master Browser
• The FactoryTalk Batch Server computer does not support replication.
• Install FactoryTalk Batch software on an NTFS formatted hard drive,
as Windows security features are available only for drives formatted to
use NTFS.
• Warranty does not cover systems with modified DCOM configuration
settings. Configuring settings using DCOMCNFG may stop the
FactoryTalk Batch Server and prevent the FactoryTalk Batch Service
Manager from functioning correctly.
FactoryTalk Batch version 14.00 components do not support touch screen
technology.
instructions for each
computer
18
After completing the pre-installation administrative tasks, follow the
installation instructions for each computer in the system, or repeat the
installation instructions for several computers based on your FactoryTalk
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
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
Obtain administrator
Prepare the operating
Chapter 2
Pre-installation administrative tasks
This section describes administrative tasks to perform before installing
FactoryTalk Batch components. Tasks include:
privileges on target
computer
• Obtain administrator privileges on target computer on page 21
• Prepare the operating system on page 21
• Create users and user groups on page 24
• Update Windows Firewall settings on page 25
• Configure the Remote Registry service on page 27
• Set the system date and time on page 27
• Prepare the SQL Server installation on page 27
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 the computer and that has been granted permission to create
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
system
21
Before starting the installation procedure close any open applications.
Before installing FactoryTalk Batch Server, FactoryTalk Material Manager
Server, or FactoryTalk eProcedure Server components make sure that the
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:
• Configure the Windows Server operating system
• Configure the Windows desktop operating system
Chapter 2 Pre-installation administrative tasks
Tip: FactoryTalk Batch Server does not require any additional configuration of Windows Server 2016
or 2019.
Windows configuration
Configure the Windows
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.
Configure the Windows Server operating system features to support
FactoryTalk Batch Server, FactoryTalk Batch Material Manager Server, or
Server operating system
FactoryTalk eProcedure Server.
To configure the Windows Server operating system
1. If installing FactoryTalk Batch Server enable the required server
Tip: All supported operating systems are tested and warrantied for
FactoryTalk Batch version 14.00.
features:
• In Server Manager, select Add Roles and Features.
• In Add Roles and Features Wizard, select Next.
• For Installation Type, select Role-based or feature-based
installation.
• For Server Selection, choose Select a server from the server pool,
and then choose the appropriate server from the Server Pool list
and then select Next.
• (Windows Server 2012) For Server Roles, select Application Server.
2. If installing FactoryTalk Batch Material Manager Server go to
Features, and select Message Queuing.
3. If installing FactoryTalk eProcedure Server, enable these additional
settings under Web Server (IIS) > Role Services.
• IIS6 Management Compatibility
• IIS6 Metabase compatibility
• IIS6 Management Console
• Web Server > Application Development:
• For Windows Server 2012:
• ASP
• ASP.NET 3.5
• ASP.NET 4.5
• For Windows Server 2016 or Windows Server 2019
• ASP
• ASP .NET 3.5
• ASP .NET 4.7
• Web Server
22
IMPORTANT
Enabling some features automatically selects new required
for Windows desktop operating systems.
Configure the Windows
desktop operating system
Chapter 2 Pre-installation administrative tasks
• Common HTTP Features
additional features and updates the feature list accordingly.
Select Add Feature to accept the default selections for these
options.
4. Verify the selections, and then select Install.
5. When the installation process is complete, select Close.
Perform this procedure to configure the Windows desktop operating system
for the FactoryTalk Batch Material Manager Server, and FactoryTalk
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
To configure Windows desktop operating system
1. On the computer where the FactoryTalk Batch Material Manager
Server or FactoryTalk eProcedure Server will be installed, select
Control Panel > Programs > Turn Windows features on or off.
Windows Features opens.
Tip: In Windows Features the box next to the feature name represents
the installation status of the feature:
• A checkmark represents a fully installed feature.
• A black square represents an installed feature with optional features
that are not enabled.
•
Empty boxes represent uninstalled features.
2. If installing FactoryTalk Batch Material Manager Server select
Microsoft Message Queue (MSMQ) Server. Microsoft Message Queue
(MSMQ) Server Core is selected by default.
3. If installing FactoryTalk Batch eProcedure Server select these features:
• Internet Information Services
• Web Management Tools
• IIS 6 Management Compatibility
- IIS 6 Management Console
- IIS 6 Metabase and IIS 6 configuration compatibility
• IIS Management Console
23
• Internet Information Services > World Wide Web Services
• Application Development Features
-.Net Extensibility 3.5
-.Net Extensibility 4.6
-ASP
-ASP .NET 3.5
Chapter 2 Pre-installation administrative tasks
DEP settings
Create users and user
4. Select OK to enable the features and close the dialog box.
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
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.
-ASP .NET 4.6
-ISAPI Extensions
-ISAPI Filters
• Common HTTP Features
- Static Content
.
FactoryTalk Batch users/user groups
The installation of the FactoryTalk Batch Server creates the Windows user
group batchsvr_group 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 adds the FactoryTalk Batch Server user account to the
following:
• Administrators group
• batchsvr_group
• Batch COM+ Application
• FactoryTalk Batch Server service
• FactoryTalk Event Archiver service
• FactoryTalk eProcedure Server service (eProcedure Server installation)
The services for the FactoryTalk Batch Server, FactoryTalk Event Archiver,
FactoryTalk eProcedure Server, and the Batch COM+ Application require
identical user accounts to support the FactoryTalk Batch Server functionality.
24
IMPORTANT
When managing the Windows Firewall settings externally, the installation program
Update Windows Firewall
Chapter 2 Pre-installation administrative tasks
FactoryTalk Batch Material Manager user groups
For FactoryTalk Batch Material Manager, you must create these required
domain user groups.
Required domain user groups
• 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
settings
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.
To allow the installation program to configure the firewall exceptions
automatically, enable the Windows Firewall Service prior to installation. The
installation program uses the Rockwell Software Windows Firewall
Configuration Utility to add the necessary exceptions.
cannot change the Windows Firewall settings.
The installation program updates Windows Firewall settings to allow these
applications to communicate through the firewall:
• 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
25
Chapter 2 Pre-installation administrative tasks
Windows Firewall Exceptions
• batchsvr.exe (Batch server installs)
• OPCEnum.exe
• batchvew.exe (Batch client installs)
• Port 1433 TCP (SQL Server installs)
• 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
IMPORTANT
Windows Firewall
Typically, Windows Firewall appears under Control Panel > System and
Security > Windows Firewall. For more information, see the Windows
operating system for the current installation.
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:
• DaClient.exe • Port 137 NetBIOS Name Service
•
•
•
•
NmspHost.exe
•
•
•
If the Windows Firewall is enabled, and not externally controlled, the
Windows Firewall Configuration Utility runs automatically during
installation. If this utility does not run automatically, manually run it on each
computer in your FactoryTalk Batch system after installing servers or clients.
To manually run the FactoryTalk Windows Firewall Configuration Utility,
navigate to Start > Rockwell Software > Windows Firewall Configuration
Utility.
If you are using a different firewall with your system, add equivalent exceptions to
enable communication through the firewall by the FactoryTalk Batch components.
26
IMPORTANT
IMPORTANT
Configure the Remote
Registry service
Set the system date and
Prepare the SQL Server
time
Chapter 2 Pre-installation administrative tasks
Remote Registry is enabled to support network synchronization of the
FactoryTalk Batch components across computer boundaries. Before installing
the FactoryTalk Batch Server or FactoryTalk Batch Material Manager Server
on any operating system, configure the Remote Registry service for automatic
startup.
To configure the Remote Registry service
1. Navigate to Control Panel > System and Security > Administrative
Tools. Double-click Services.
2. In the Services (Local) pane, right-click Remote Registry and select
Properties.
3. For Startup type, select Automatic.
4. Select OK.
Set the date and time on each computer on the FactoryTalk Batch network to
the same date and time.
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.
installation
These applications can use SQL Server:
• FactoryTalk Batch Server (to store recipes in RDB format)
• FactoryTalk Event Archiver (to archive batch event records and to use
Batch reports)
• FactoryTalk Batch Material Manager Server (to store materials for
recipes)
Install a supported version of SQL Server as listed in the System
requirements and supported software overview section and select these
features:
• Database Engine Services
• Reporting Services (if using FactoryTalk Event Archiver with Batch
reports)
Configuration of SQL Server Reporting Services differs depending on the
version of SQL Server installed. Reporting Services for SQL Server 2017 are
installed separately.
Visit the Microsoft website (https://www.microsoft.com/en-us/sql-server/sql-
server-downloads) to get the latest supported version of SQL Server for the
FactoryTalk Batch system.
27
Consider these items when installing SQL Server for use with the FactoryTalk
Batch system:
Loading...