Rockwell Automation FactoryTalk Batch Original Instructions

FactoryTalk Batch

PC-Based Phase Programming

Reference Manual

FactoryTalk Batch Components 14.00

Rockwell Automation Publication BATCH-RM008A-EN-D - October 2020

Reference Manual

Original Instructions

FactoryTalk Batch PC-Based Phase Programming

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

Preface

PC-based phases

Create a PC-based phase

Use a PC-based phase

About this manual.......................................................................................	5
Legal Notices ...............................................................................................	5
Additional resources ...................................................................................	6
Chapter 1
PC-based phase overview ..........................................................................	11
PC-based phases.........................................................................................	12
PC-based phase execution...................................................................	12
Chapter 2
Add the Batch Phase Execution control to a Visual Basic project ..........	15
Place the Batch Phase Execution control on a form ..........................	16
Set the PC-based phase properties .....................................................	16
Set custom properties in the Property Pages dialog box ............	16
Program the PC-based phase ..............................................................	17
Methods ................................................................................................	18
Events....................................................................................................	19
Event example using OnRestart event .........................................	19
Create the executable...........................................................................	19
Add the phase execution control to a Visual C++ project .......................	20
Create a new project ...........................................................................	20
Add the control to the project.............................................................	20
Add the control to the dialog ..............................................................	20
Access control properties from Visual C++ .......................................	20
Configure the BaseTagName property...............................................	21
Add control events................................................................................	21
Add a member variable derived from the Phase Control Class ........	21
Add phase logic to event handlers.......................................................	21
General usage signature requests .............................................................	21
Parameter and report parameter limits ..................................................	22
Distribute PC-based phase applications..................................................	22
Chapter 3
Update the area model...............................................................................	23
Change the default tag separators for a PC-based phase.................	24
Set tag items to default names...........................................................	25
Add the new phase to a recipe ..................................................................	26
Run a recipe with a PC-based phase ........................................................	26
Appendix A

Table of Contents
Properties, methods, and	Properties ..................................................................................................	27
events	Methods ......................................................................................................	32
	Events .........................................................................................................	34
	Appendix B
Application notes and example	Application notes .......................................................................................	35
phase	PC-based phase example ...........................................................................	37
	Create a new PC-based phase ...................................................................	39
	Add a new data server definition to an area model ...........................	39
	Use limit tags on a PC-based phase ...................................................	40
	Add limit tags to a PC-based phase.....................................................	41
Index

Preface

About this manual

Legal Notices

This manual provides usage instructions for the FactoryTalk Batch PC-Based Phase programming. 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).

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.

Preface

Additional resources

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

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.

Preface

Resource	Description

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

Preface

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

Preface

Chapter 1

PC-based phases

This guide was developed to provide information and procedures required to create and use PC-based phases, and is intended to be used as a reference guide.

	IMPORTANT DDE server is no longer supported. When upgrading from RSBatch 4.X or an earlier
	version, set all tags to use an OPC server. Also, due to a functional address change in
	batchphs.ocx, the tag separator has changed from an underscore (_) to a period (.).
	Change the FactoryTalk Batch Equipment Editor tag separator to a period by editing
	the batcheqp.ini file.
PC-based phase overview	The PC-Based Phase option is an ActiveX control that allows you to design
	phases for use in FactoryTalk Batch recipes. Use these phases for a variety of
	tasks, such as operator prompts, timers and calculations. A PC-based phase
	communicates with the FactoryTalk Batch Server, and does not require a
	process-connected device. Use in place of phase logic to decrease the amount
	of memory required within a process-connected device.
	PC-based phases use the Batch Phase Execution control, which encapsulates
	the FactoryTalk Batch phase logic interface and the OPC interface. The Batch
	Phase Execution control functions as a data server for PC-based phases and
	supports the full functionality of a FactoryTalk Batch phase. It is an SP88-
	aware component and is used to provide Level 2 control of the FactoryTalk
	Batch control system. The Batch Phase Execution control is a persistent
	component that supports automatic checkpointing. It can be accessed directly
	from within Visual Basic, Access, or any other Microsoft-compatible control
	container.
	Tip: The Batch Phase Execution control is part of a group of FactoryTalk Batch ActiveX controls
	found in the BATCHPHS.OCX file. When distributing your application, you may install the
	BATCHPHS.OCX file in any directory, as long as the control is properly registered. (See the
	Microsoft Visual Basic Programmer’s Guide for more information on how to add an ActiveX control
	to a Visual Basic project.)
	See also
	Create a new PC-based phase on page 39
	Use a PC-based phase on page 23
	Properties, methods, and events on page 27
	Application notes and example phase on page 35
	11

Chapter 1 PC-based phases

PC-based phases

PC-based phase execution

A PC-based phase allows you to program a phase outside of a processconnected device (PCD). You can program the phase to meet your own unique requirements from within your Microsoft-compatible control container. The PC-based phase works the same way as any phase defined in a PCD, communicating with the FactoryTalk Batch Server through the Batch Phase Execution control. This saves your system’s memory for processes requiring interaction with hardware.

After a PC-based phase is created, the FactoryTalk Batch area model must be updated to include the new phase and the appropriate equipment module(s). Because the Batch Phase Execution control behaves as a data server, a new data server definition must be created. The data server definition is created using FactoryTalk Batch Equipment Editor, and defined using the Batch Phase Execution control’s communication parameters. The phase can then be added to your recipes. The PC-based phase must remain active during recipe execution, allowing the phase to communicate with the FactoryTalk Batch Server through the Batch Phase Execution control.

An activity log file is created for each PC-based phase when it runs. This log file, Singleton.log, is written to the WINDOWS\system32 directory.

	Charge_X:1
	Charge_X:1.State = Complete
Recirc:1		Temp_Ctl:1
	Recirc:1.State = Complete AND
	Temp_Ctl:1.State = Complete
	QC_Chk:1	4
		4
	QC_Chk:1.State = Complete AND
	QC_Result <= 100
	Dump_1:1
	Dump_1:1.State = Complete			1
	Activity			PC-Based
	Activity			Phase:
	Log			Phase:
	Log			QC_Chk
	File			QC_Chk
	File
		Phase
		Execution
		Control		2
	Batch			2
	Batch
	Server
			Operator Interface
			1. Have QC take a sample
	3		2. Enter QC Results
	3
Electronic Batch Record
QC Results Added

Rockwell Automation FactoryTalk Batch Original Instructions

Important User Information

Table of Contents

Preface

About this manual

Legal Notices

Additional resources

PC-based phase overview

PC-based phases

PC-based phase execution