Rockwell Automation FactoryTalk Administration Manual

FactoryTalk Batch

Material Manager

Administrator Guide

FactoryTalk Batch Components 14.00

Rockwell Automation Publication BWMTR-UM011E-EN-P - October 2020

Supersedes Publication BWMTR-UM011D-EN-P - February 2017

Administrator Guide

Original Instructions

FactoryTalk Batch Material Manager

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 personal injury or death, property damage, or economic loss.

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

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

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: 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

Preface

About this manual

This manual provides administrator instructions for the FactoryTalk Batch Material Manager components. It is one of a set of related manuals that describe installing, programming, and operating the FactoryTalk Batch system.

To review FactoryTalk Batch release notes and latest information regarding product compatibility refer to the Product Compatibility and Download Center (PCDC).

3

Preface

Legal Notices

4

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.

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:

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

Preface

Additional resources

Following is a comprehensive list of documentation for the FactoryTalk® Batch products from Rockwell Automation.

Installation, Quick Start, and Getting Results Guides

Resource	Description
FactoryTalk Batch Components Installation and	Provides information and procedures for FactoryTalk
Upgrade Guide	Batch system installation. Includes information for
(BATCH-IN002)	FactoryTalk Batch Material Manager, FactoryTalk Event
	Archiver, and associated FactoryTalk Batch Client and
	Server components.
FactoryTalk Batch View Quick Start Guide	Provides information about using FactoryTalk Batch View
(FTBVS-QS001)	to create, view, and command control recipes,
	acknowledge prompts and signatures, view equipment
	phases and diagnostic information, and view profile
	information.
FactoryTalk Batch View HMI Controls Quick Start	Provides a general overview of FactoryTalk Batch View
Guide	HMI Controls.
(BATCH-QS001D)
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.
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.

5

Preface

Resource	Description
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.
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.

6

Preface

Resource	Description
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.
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.

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.

7

	Table of Contents
Preface	About this manual.......................................................................................	3
	Legal Notices ...............................................................................................	4
	Additional resources ...................................................................................	5
	Chapter 1
Configuring Material Manager	Identify the material database..................................................................	11
	Setting the Material Server options .........................................................	11
	Enable the automatic deletion of lots with no remaining sublots..........	12

Implementing security

Using the material activity journal

Network Editor

Chapter 2
Security settings.........................................................................................	16
Material Manager Security..................................................................	17
Using workgroup security .........................................................................	18
Using domain security...............................................................................	18
Configuring the domain server ..........................................................	18
Setting security on folders or files ............................................................	19
Adding users and user groups.............................................................	19
Change permissions on the BATCHCTL share ..................................	19
Chapter 3
Enable material journaling ......................................................................	22
Chapter 4
Open the Network Editor..........................................................................	23
Network Editor interface ..........................................................................	23
Hierarchy pane ....................................................................................	24
Detail pane...........................................................................................	24
Results pane.........................................................................................	25
Menu bar..............................................................................................	25
Network Editor toolbar.......................................................................	26
Status bar.............................................................................................	26
Configure your network ...........................................................................	27
Select a network model.......................................................................	27
Add a server .........................................................................................	27
Remove a server...................................................................................	28
Synchronize network models.............................................................	28
User Preferences dialog box .....................................................................	28
User Preferences dialog box - General tab ........................................	28
Edit colors............................................................................................	29
Edit the application font.....................................................................	30

9

Table of Contents
	Edit information tips..........................................................................	30
	User Preferences dialog box - Views tab ............................................	31
	Set report preferences .........................................................................	31
	Report printing formats ............................................................................	32
	Preview reports ....................................................................................	33
	Print reports .........................................................................................	33
	Chapter 5
Troubleshooting	Automatic repair of batch component installation fails.........................	35
	Error: No containers match material container specification...............	35
	Error: Unable to retrieve the Promise ID .................................................	35
	Operating without a Material Server ........................................................	35
	Losing communication........................................................................	36
	Switching to manual...........................................................................	38
	Restoring communication .................................................................	38
	Starting the FactoryTalk Batch server ................................................	39

Change the FactoryTalk Batch server user account

Index

Chapter 6
New user account requirements for the FactoryTalk Batch Server .......	41
Configure your FactoryTalk Batch system...............................................	41
Server account password change locations ......................................	42
Change the server user account for the FactoryTalk Batch Server
service ...................................................................................................	43
Change the server user account in FactoryTalk Batch COM+
applications ..........................................................................................	43
Change the server user account in My Computer properties..........	44

10

Chapter 1

Configuring Material Manager

Identify the material database

Setting the Material Server options

This chapter contains instructions for configuring FactoryTalk® Batch Material Manager. This chapter assumes that the FactoryTalk Batch system is configured and working properly and that Material Manager is installed.

Configure the FactoryTalk Batch Material Manager Server with the location of the SQL database that contains the materials for the recipes.

To identify the material database

1.Navigate to Rockwell Software > Network Editor.

The Network Editor window opens with the Material Server selected by default.

2.Select Configure. The Configure MaterialTrack dialog box opens. The default database is materialbasedrecipe.

3.In the MaterialTrack Database box, enter the name of the database, and select OK.

IMPORTANT The Network Editor does not verify database names. Changes made to the database name are immediate for the clients and servers. If the database name is invalid, the Material Editor will not open.

Before changing the database name, check the spelling of the database name and synchronize the Network Editor. After changing the database name, confirm that the Material Editor opens and reads the databases.

4.Select Synchronize.

5.Select File > Exit, and then select Yes to exit the Network Editor.

Set the options for the Material Server in the FactoryTalk Batch Equipment Editor module.

To identify the material database

1.Click Start > Rockwell Software > Equipment Editor.

2.From the Options menu, select Server Options. The Server Options dialog box opens to the Project Settings tab.

11

Chapter 1	Configuring Material Manager

Enable the automatic deletion of lots with no remaining sublots

12

3. Select the Material Polices tab.

•Option when Material Server Comm is lost

When communication is lost between the FactoryTalk Batch and Material Servers, you can choose to fail and hold the batch or switch the batch to Manual mode.

•Failure and Hold indicates the FactoryTalk Batch Server places the batch in the HELD state.

•Switch to Manual indicates the FactoryTalk Batch Server continues to run the batch prompting the operator for decisions regarding information normally supplied by the Material Server. (See "Troubleshooting" for more information.)

•Hold on Split Feed

Split feeds occur when a material phase step does not add or distribute all of the material configured by the step.

•No directs the FactoryTalk Batch Server to continue processing a batch when a split feed occurs. If you select this option, add a material loop to the recipe so that the binding process can select another container for material additions. (See the FactoryTalk Batch Recipe Editor User Guide for more information on material loops.)

•Yes directs the FactoryTalk Batch Server to hold the batch when a split feed occurs. The Material Server calculates and sends new AMOUNT parameters to the FactoryTalk Batch Server. To resume processing, the operator must perform an active step change away from the unfinished step, manually rebind the unfinished step, perform an active step change back to the unfinished step, and then restart the batch.

4.Make your selections, and then click OK.

Use the following procedure to enable the automatic deletion of lots with no remaining sublots to free up space in the material database.

Tip: Sublots are identified as labels in Material Editor and FactoryTalk Batch View.

Chapter 1	Configuring Material Manager

To enable the automatic deletion of lots with no remaining sublots

1. On the Material Manager Server machine, create a registry key.

• 32 bit system Registry Editor location: [HKEY_LOCAL_MACHINE\SOFTWARE\MaterialTrack\Material Recipe\Setup

• 64 bit system Registry Editor location: [HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\MaterialTr ack\Material Recipe\Setup

2.Create a new string value DeleteLotOnZeroSubLots and set the Value to TRUE.

13

Chapter 2

Implementing security

FactoryTalk® Batch Material Manager security controls who has permissions for certain actions, such as viewing, adding, removing, and changing an item. Security is set using COM+ role-based security and Windows user groups and users.

Through the use of COM+ role-based security, administration of security for Material Manager is greatly simplified. COM+ role-based security allows an application to have preset user categories called roles. These roles have preset permissions and have preset Windows user groups added to them. To implement security, an administrator must create the preset user groups and add the appropriate user accounts to these groups.

15