Rockwell Automation FactoryTalk Batch Original Instructions

Reference Manual

FactoryTalk Batch PC-Based Phase Programming

Reference Manual

FactoryTalk Batch Components 14.00

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

Original Instructions

FactoryTalk Batch PC-Based Phase Programming

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

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

Application notes and example Index

events

phase

Properties .................................................................................................. 27

Methods ......................................................................................................32

Events ......................................................................................................... 34

Appendix B

Application notes ....................................................................................... 35

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

About this manual

Legal Notices

Preface

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

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.

Product Compatibility and Download

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

Resource

Description

FactoryTalk Batch eProcedure® Getting Results

Explains the basics of FactoryTalk Batch eProcedure.

Resource

Description

FactoryTalk Batch ActiveX Controls User Guide

Provides information and instructions for using the

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.

ollowing is a comprehensive list of documentation for the FactoryTalk®

Batch products from Rockwell Automation.

Installation, Quick Start, and Getting Results Guides

FactoryTalk Batch Components Installation and Upgrade Guide

(BATCH-IN002)

FactoryTalk Batch View Quick Start Guide (FTBVS-QS001)

FactoryTalk Batch View HMI Controls Quick Start Guide (BATCH-QS001D)

Guide (BWEPRO-GR011)

FactoryTalk Batch Getting Results Guide (BATCH-GR011)

FactoryTalk Batch Material Manager Getting Results Guide (BWMTR-GR011)

Provides information and procedures for FactoryTalk Batch system installation. Includes information for FactoryTalk Batch Material Manager, FactoryTalk Event Archiver, and associated FactoryTalk Batch Client and Server components.

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.

Introduces the basics of automated batch manufacturing and the FactoryTalk Batch product components.

Introduces the basics of FactoryTalk Batch Material Manager.

User Guides

(BATCH-UM013)

FactoryTalk Batch ActiveX Custom Controls.

Resource

Description

FactoryTalk Batch Material Editor User Guide

Provides access to information and procedural

reference for the formulator.

FactoryTalk Batch PhaseManager™ User Guide

Describes the integration of the FactoryTalk Batch

your Logix 5000 controller.

FactoryTalk Batch Recipe Editor User Guide

Provides instructions on using FactoryTalk Batch Recipe

FactoryTalk Batch View HMI Controls User Manual

Provides details about using FactoryTalk Batch View HMI

FactoryTalk Batch Server.

reference information by the operator.

FactoryTalk Batch View User Guide (legacy)

Provides information and instructions on how to use

Preface

(BWMTR-UM001)

FactoryTalk Batch Equipment Editor User Guide (BATCH-UM004)

(BATCHX-UM011)

(BATCH-UM006)

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.

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

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.

(FTBVS-UM003)

FactoryTalk Batch View User Manual (FTBVS-UM002)

FactoryTalk eProcedure Client User Guide (BWEPRO-UM001)

FactoryTalk Event Archiver User Guide (BATCHUM012)

(FTBVS-UM001)

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

Provides information and instructions specific to the FactoryTalk Event Archiver. Intended for use by the system administrator and production supervisor.

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

Preface

Resource

Description

FactoryTalk Batch eProcedure Administrator Guide

Provides procedures specific to FactoryTalk Batch

(BWEPRO-UM011)

Resource

Description

(BATCH-RM001)

(BATCH-RM004)

FactoryTalk Batch System Files Reference Manual

Provides the technical information for configuration and

engineers and the system administrator.

reference by the instruction file author.

Administrator Guides

FactoryTalk Batch Administrator Guide (BATCH-UM003)

(BWEPRO-UM011)

FactoryTalk Batch Material Manager Administrator Guide

Reference Guides

FactoryTalk Batch ActiveX Controls Library Reference Guide

FactoryTalk Batch Material Server API Technical Reference (BWMTR-RM001)

FactoryTalk Batch PCD Programming Reference Manual

FactoryTalk Batch Server API Reference Manual (BATCH-RM003)

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.

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.

Provides information and instructions specific to FactoryTalk Batch Material Manager. Intended for use by the system administrator and database administrator.

Provides reference information and procedural 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 those who want to develop custom interfaces.

Provides information and instructions about the FactoryTalk Batch PCD interface design. It is intended to be used as a reference guide.

Provides information regarding the interface between the FactoryTalk Batch Server and FactoryTalk Batch View — the Server Application Programming Interface (API). It is intended to be used as a reference guide by those who want to develop custom interfaces.

(BATCH-RM005)

FactoryTalk Batch eProcedure Instruction File Design Reference Manual (BWEPRO-RM001)

maintenance of a FactoryTalk Batch system. It can be used as a reference information for implementation

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

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

IMPORTANT

the batcheqp.ini file.

to a Visual Basic project.)

PC-based phase overview

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.

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

Microsoft Visual Basic Programmer’s Guide

file in any directory, as long as the control is properly registered. (See the

for more information on how to add an ActiveX control

PC-based phases

PC-based phase execution

A PC-based phase allows you to program a phase outside of a process-

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