Sei sulla pagina 1di 173

Symphony Plus - Harmony

S+ Engineering: Composer Harmony


Batch Data Manager 6.6
User Manual

Symphony Plus
Symphony Plus - Harmony

S+ Engineering: Composer Harmony


Batch Data Manager 6.6
User Manual
NOTICE
This document contains information about one or more ABB products and may include a description of or a
reference to one or more standards that may be generally relevant to the ABB products. The presence of any
such description of a standard or reference to a standard is not a representation that all of the ABB products
referenced in this document support all of the features of the described or referenced standard. In order to
determine the specific features supported by a particular ABB product, the reader should consult the product
specifications for the particular ABB product.

ABB may have one or more patents or pending patent applications protecting the intellectual property in the
ABB products described in this document.

The information in this document is subject to change without notice and should not be construed as a
commitment by ABB. ABB assumes no responsibility for any errors that may appear in this document.

In no event shall ABB be liable for direct, indirect, special, incidental or consequential damages of any nature
or kind arising from the use of this document, nor shall ABB be liable for incidental or consequential damages
arising from use of any software or hardware described in this document.

This document and parts thereof must not be reproduced or copied without written permission from ABB, and
the contents thereof must not be imparted to a third party nor used for any unauthorized purpose.

The software or hardware described in this document is furnished under a license and may be used, copied,
or disclosed only in accordance with the terms of such license. This product meets the requirements specified
in EMC Directive 2004/108/EC and in Low Voltage Directive 2006/95/EC.

TRADEMARKS
Symphony is a registered or pending trademark of ABB S.p.A.
All rights to copyrights, registered trademarks, and trademarks reside with their respective owners.
Copyright © 2013 ABB.
All rights reserved.

Release: July 2013


Document Number: 2VAA001872-660
Preface

The Batch Data Manager (BDM) interface provides a set of tools that support Batch 90™ and User Defined Function (UDF)
codes for the Symphony system. Composer Version 5.1 and later of the Batch Data Manager software provides the
capability of creating and compiling Batch 90 programs using the phase execution (PHASEX) function code. The ABB batch
management software is used to create all recipes that use the PHASEX functionality. All previous Batch and UDF tools are
still supported.
Support Services

ABB will provide assistance in the operation and repair of its products. Requests for sales or application services should be
made to your nearest sales or service office. ABB can also provide installation, repair and maintenance contract services.

When ordering parts, use nomenclature or part numbers and part descriptions from equipment manuals. Parts without a
description must be ordered from the nearest sales or service office. Recommended spare parts lists, including prices are
available through the nearest sales or service office.

ABB has modern training facilities available for training your personnel. On-site training is also available. Contact your
nearest ABB sales office for specific information and scheduling.

Additional copies of this instruction, or other instructions, can be obtained from the nearest ABB sales office at a reasonable
charge.
Trademarks and Registrations
Registrations and trademarks used in this document include:

Batch 90™ Trademark of ABB.


Composer™ Trademark of ABB.
INFI 90™ Registered trademark of ABB.
OperateIT™ Trademark of ABB.
Symphony™ Trademark of ABB.
TABLE OF CONTENTS

TABLE OF CONTENTS

1. Introduction.................................................................................................... 1-1
1.1 Overview ..............................................................................................................1-1
1.2 Intended User ......................................................................................................1-1
1.3 Instruction Content .............................................................................................1-1
1.4 How to Use this Instruction ................................................................................1-2
1.5 Document Conventions ......................................................................................1-2

2. Description and Operation............................................................................ 2-1


2.1 Batch Process .....................................................................................................2-1
2.2 Batch Recipes......................................................................................................2-1
2.3 Batch Data Manager ............................................................................................2-1
2.3.1 BSEQ Batch Projects.......................................................................................2-1
2.3.2 PHASEX Batch Projects ..................................................................................2-6
2.3.3 UDF Projects....................................................................................................2-7
2.4 Online Batch Program Changes ........................................................................2-8
2.5 Directory Structure..............................................................................................2-8
2.6 Startup ..................................................................................................................2-8

3. Projects........................................................................................................... 3-1
3.1 Introduction .........................................................................................................3-1
3.2 Add .......................................................................................................................3-1
3.3 Drive Refresh .......................................................................................................3-1
3.4 Backup .................................................................................................................3-1
3.5 Change Project Password ..................................................................................3-2
3.6 Close.....................................................................................................................3-3
3.7 Copy .....................................................................................................................3-3
3.8 Delete....................................................................................................................3-3
3.9 Open .....................................................................................................................3-3
3.10 Properties.............................................................................................................3-5
3.10.1 Drive.................................................................................................................3-5
3.10.2 Project..............................................................................................................3-5
3.10.3 Users List .........................................................................................................3-6
3.11 Rename ................................................................................................................3-6
3.12 Restore .................................................................................................................3-6
3.13 Upgrade Project...................................................................................................3-7
3.14 Security ................................................................................................................3-7
3.14.1 Add User ..........................................................................................................3-8
3.14.2 Delete...............................................................................................................3-9

2VAA001872-660 i
TABLE OF CONTENTS

3.14.3 Delete All Names .............................................................................................3-9


3.14.4 Modify ..............................................................................................................3-9
3.14.5 Refresh ............................................................................................................3-9
3.14.6 Reset Password...............................................................................................3-9
3.14.7 User Information Manager .............................................................................3-10

4. Class Libraries and Classes ......................................................................... 4-1


4.1 Introduction .........................................................................................................4-1
4.2 Class Libraries.....................................................................................................4-1
4.2.1 Add ..................................................................................................................4-1
4.2.2 Copy.................................................................................................................4-2
4.2.3 Delete...............................................................................................................4-2
4.2.4 Properties.........................................................................................................4-2
4.2.5 Remove Reference ..........................................................................................4-2
4.2.6 Rename ...........................................................................................................4-2
4.3 Classes.................................................................................................................4-3
4.3.1 Add ..................................................................................................................4-3
4.3.2 Change Class Program....................................................................................4-3
4.3.3 Copy.................................................................................................................4-3
4.3.4 Delete...............................................................................................................4-4
4.3.5 Properties.........................................................................................................4-4
4.3.6 Rename ...........................................................................................................4-5

5. Batch 90 and UDF Programs ........................................................................ 5-1


5.1 Introduction .........................................................................................................5-1
5.2 Batch 90 Programs..............................................................................................5-1
5.2.1 Add ..................................................................................................................5-1
5.2.2 Compile............................................................................................................5-1
5.2.3 Copy.................................................................................................................5-3
5.2.4 Delete...............................................................................................................5-3
5.2.5 Edit...................................................................................................................5-3
5.2.6 Print..................................................................................................................5-4
5.2.7 Properties.........................................................................................................5-4
5.2.8 Rebuild All .......................................................................................................5-4
5.2.9 Rename ...........................................................................................................5-4
5.2.10 Source File.......................................................................................................5-4
5.3 Units......................................................................................................................5-4
5.3.1 Add ..................................................................................................................5-5
5.3.2 Compile............................................................................................................5-5
5.3.3 Delete...............................................................................................................5-5

ii 2VAA001872-660
TABLE OF CONTENTS

5.3.4 Print..................................................................................................................5-5
5.3.5 Properties.........................................................................................................5-6
5.4 UDF Programs .....................................................................................................5-6
5.4.1 Add ..................................................................................................................5-6
5.4.2 Compile............................................................................................................5-7
5.4.3 Copy.................................................................................................................5-8
5.4.4 Delete...............................................................................................................5-8
5.4.5 Edit...................................................................................................................5-9
5.4.6 Print..................................................................................................................5-9
5.4.7 Rename ...........................................................................................................5-9
5.4.8 Source File.......................................................................................................5-9

6. Unit Procedures and Unit Recipes ............................................................... 6-1


6.1 Introduction .........................................................................................................6-1
6.2 Unit Procedures...................................................................................................6-1
6.2.1 Add ..................................................................................................................6-1
6.2.2 Copy.................................................................................................................6-2
6.2.3 Delete...............................................................................................................6-2
6.2.4 Edit...................................................................................................................6-2
6.2.5 Print..................................................................................................................6-7
6.2.6 Properties.........................................................................................................6-7
6.2.7 Rename ...........................................................................................................6-9
6.2.8 Save.................................................................................................................6-9
6.3 Unit Recipe...........................................................................................................6-9
6.3.1 Add ..................................................................................................................6-9
6.3.2 Copy...............................................................................................................6-10
6.3.3 Delete............................................................................................................. 6-11
6.3.4 Delete All........................................................................................................ 6-11
6.3.5 Edit................................................................................................................. 6-11
6.3.6 Print................................................................................................................6-12
6.3.7 Properties.......................................................................................................6-12
6.3.8 Rename .........................................................................................................6-13

7. Master Recipes and Control Recipes .......................................................... 7-1


7.1 Introduction .........................................................................................................7-1
7.2 Master Recipes ....................................................................................................7-1
7.2.1 Add ..................................................................................................................7-1
7.2.2 Copy.................................................................................................................7-2
7.2.3 Delete...............................................................................................................7-2
7.2.4 Edit...................................................................................................................7-2
7.2.5 Print................................................................................................................7-10

2VAA001872-660 iii
TABLE OF CONTENTS

7.2.6 Properties....................................................................................................... 7-11


7.2.7 Rename .........................................................................................................7-14
7.2.8 Save...............................................................................................................7-14
7.3 Control Recipes.................................................................................................7-14
7.3.1 Add ................................................................................................................7-14
7.3.2 Copy...............................................................................................................7-15
7.3.3 Delete.............................................................................................................7-15
7.3.4 Edit.................................................................................................................7-16
7.3.5 Print................................................................................................................7-17
7.3.6 Properties.......................................................................................................7-17
7.3.7 Rename .........................................................................................................7-18

8. Information Download ................................................................................... 8-1


8.1 Introduction .........................................................................................................8-1
8.2 Download .............................................................................................................8-1
8.2.1 Batch 90 Program Files ...................................................................................8-2
8.2.2 Control Recipes ...............................................................................................8-2
8.2.3 UDF Program Files ..........................................................................................8-2
8.2.4 Unit Recipes.....................................................................................................8-2
8.2.5 Units.................................................................................................................8-2
8.3 Verify.....................................................................................................................8-3
8.3.1 Batch 90 Program Files ...................................................................................8-3
8.3.2 Control Recipes ...............................................................................................8-3
8.3.3 UDF Program Files ..........................................................................................8-3
8.3.4 Unit Recipes.....................................................................................................8-3
8.3.5 Units.................................................................................................................8-3
8.4 Delete....................................................................................................................8-3
8.4.1 Batch 90 Program Files ...................................................................................8-4
8.4.2 Control Recipes ...............................................................................................8-4
8.4.3 UDF Program Files ..........................................................................................8-4
8.4.4 Unit Recipes.....................................................................................................8-4
8.4.5 Units.................................................................................................................8-4
8.5 Print ......................................................................................................................8-4
8.6 Properties.............................................................................................................8-5
8.7 Size .......................................................................................................................8-5
8.8 Controller Utilities ...............................................................................................8-5
8.8.1 Format..............................................................................................................8-6
8.8.2 Change Controller Mode..................................................................................8-7
8.8.3 Communication Settings ..................................................................................8-7
8.8.4 Read Controller Directories..............................................................................8-7

iv 2VAA001872-660
TABLE OF CONTENTS

8.8.5 Print Controller Directories...............................................................................8-8


8.9 Search for Controllers ........................................................................................8-8

9. Dynamic Debugger Utility ............................................................................. 9-1


9.1 Introduction .........................................................................................................9-1
9.2 Debugger Capabilities.........................................................................................9-2
9.2.1 Breakpoints ......................................................................................................9-2
9.2.2 Change Operation............................................................................................9-3
9.2.3 Change Phase Debugged................................................................................9-3
9.2.4 Escape Loop ....................................................................................................9-3
9.2.5 Find Specific Text .............................................................................................9-3
9.2.6 Go To Specific Line ..........................................................................................9-4
9.2.7 Line Tracking ...................................................................................................9-4
9.2.8 Properties.........................................................................................................9-4
9.2.9 Remove Variables from Watch.........................................................................9-5
9.2.10 Start Execution.................................................................................................9-5
9.2.11 Step Execution .................................................................................................9-5
9.2.12 Stop Execution .................................................................................................9-5
9.2.13 View and Watch Variables ...............................................................................9-5
9.3 Online Recipe Parameter Editing.......................................................................9-6
9.3.1 Batch Debugger Window .................................................................................9-6

10. Batch Archive Log ....................................................................................... 10-1


10.1 Introduction .......................................................................................................10-1
10.2 Delete..................................................................................................................10-1
10.2.1 All Messages..................................................................................................10-1
10.2.2 One Message.................................................................................................10-2
10.2.3 Multiple Messages .........................................................................................10-2
10.3 Filters..................................................................................................................10-2
10.3.1 Display Filter ..................................................................................................10-2
10.3.2 Write Filter......................................................................................................10-2
10.4 Log Size..............................................................................................................10-2
10.5 Pause..................................................................................................................10-3
10.6 Print ....................................................................................................................10-3
10.6.1 Complete Log.................................................................................................10-3
10.6.2 One Message.................................................................................................10-3
10.6.3 Multiple Messages .........................................................................................10-4
10.7 Properties...........................................................................................................10-4
10.8 Resume ..............................................................................................................10-5
10.9 Sort .....................................................................................................................10-5
10.10View ....................................................................................................................10-5

2VAA001872-660 v
TABLE OF CONTENTS

11. Script Language............................................................................................11-1


11.1 Introduction ....................................................................................................... 11-1
11.2 Script File ........................................................................................................... 11-2
11.2.1 Script Command Line Syntax ........................................................................ 11-2
11.2.2 Script File Outline........................................................................................... 11-2
11.2.3 Compile Batch 90 Program............................................................................ 11-3
11.2.4 Compile UDF Program................................................................................... 11-4
11.2.5 Compile Unit Recipe ...................................................................................... 11-5
11.2.6 Create Master Recipe Train........................................................................... 11-7
11.2.7 Compile Control Recipe ................................................................................. 11-8
11.2.8 Delete Unit Recipe ......................................................................................... 11-9
11.2.9 Delete All Unit Recipes ................................................................................ 11-10
11.2.10Delete Batch 90 Program............................................................................ 11-11
11.2.11Delete Control Recipe ................................................................................. 11-12
11.2.12Delete Segment .......................................................................................... 11-13
11.2.13Delete Unit .................................................................................................. 11-13
11.2.14Delete UDF Program .................................................................................. 11-14
11.2.15Delete Unit Definition File ........................................................................... 11-14
11.2.16Download All Unit Recipes.......................................................................... 11-15
11.2.17Download Batch 90 Program ...................................................................... 11-16
11.2.18For Non-Unit Relative Class ....................................................................... 11-16
11.2.19Download Control Recipe ........................................................................... 11-17
11.2.20Download Segment..................................................................................... 11-17
11.2.21Download Unit............................................................................................. 11-18
11.2.22Download Unit Recipe ................................................................................ 11-18
11.2.23Download UDF Program............................................................................. 11-20
11.2.24Download Unit Definition File...................................................................... 11-21
11.2.25Import Master Recipe.................................................................................. 11-21
11.2.26Import Unit Procedure................................................................................. 11-22
11.3 ASCII Unit Procedure Script........................................................................... 11-23
11.3.1 Keywords ..................................................................................................... 11-23
11.3.2 Comments.................................................................................................... 11-23
11.3.3 Unit Procedure Section ................................................................................ 11-23
11.3.4 Unit Parameters Section .............................................................................. 11-24
11.3.5 Operation Section ........................................................................................ 11-24
11.3.6 Phase Section.............................................................................................. 11-25
11.3.7 Super Phase Section ................................................................................... 11-26
11.3.8 Example ....................................................................................................... 11-26
11.4 ASCII Master Recipe Script ............................................................................ 11-28
11.4.1 Keywords ..................................................................................................... 11-28

vi 2VAA001872-660
TABLE OF CONTENTS

11.4.2 Comments.................................................................................................... 11-28


11.4.3 Segment Section.......................................................................................... 11-29
11.4.4 Unit Procedure Section ................................................................................ 11-29
11.4.5 Unit Parameters Section .............................................................................. 11-29
11.4.6 Operation Section ........................................................................................ 11-30
11.4.7 Phase Section.............................................................................................. 11-30
11.4.8 Super Phase Section ................................................................................... 11-31
11.4.9 Example ....................................................................................................... 11-32

12. Recipe Conversion and Project Upgrades ................................................ 12-1


12.1 Introduction .......................................................................................................12-1
12.2 EDT Recipe Conversion....................................................................................12-1
12.3 Batch Recipe Manager Recipe Conversion ....................................................12-2
12.4 Batch Data Manager 6.1 Project Upgrade .......................................................12-3

13. Error Messages and Recovery ................................................................... 13-1


13.1 Compiler Error Codes .......................................................................................13-1
13.2 Run-Time Fault Codes ......................................................................................13-4

2VAA001872-660 vii
TABLE OF CONTENTS

viii 2VAA001872-660
LIST OF TABLES

LIST OF TABLES

Table 2-1: Batch Data Manager Files .........................................................................2-9


Table 3-1: Access Levels ............................................................................................3-9
Table 11-1: Unit Procedure Script Keywords ..........................................................11-23
Table 11-2: Master Recipe Script Keywords ...........................................................11-28
Table 13-1: Compiler Error Messages ......................................................................13-1
Table 13-2: BSEQ Run-Time Fault Codes ................................................................13-4
Table 13-3: PHASEX Run-Time Fault Codes ...........................................................13-6

2VAA001872-660 ix
LIST OF TABLES

x 2VAA001872-660
LIST OF FIGURES

LIST OF FIGURES

Figure 2-1: Composition of a Recipe .......................................................................... 2-1


Figure 2-2: Unit Procedure Application Creation ........................................................ 2-2
Figure 2-3: Master Recipe Application Creation ......................................................... 2-3
Figure 2-4: Phase Execution Batch Application Creation ........................................... 2-4
Figure 2-5: UDF Program Application Creation .......................................................... 2-5
Figure 2-6: Batch Data Manager Directory Structure ................................................. 2-8
Figure 2-7: Batch Data Manager Window................................................................. 2-12
Figure 3-1: Project Backup Wizard Window 1 of 3 ..................................................... 3-2
Figure 3-2: Project Backup Wizard Window 2 of 3 ..................................................... 3-2
Figure 3-3: New BSEQ Batch Project Window ........................................................... 3-4
Figure 3-4: New UDF Project Window........................................................................ 3-5
Figure 3-5: Project Restore Wizard Window............................................................... 3-7
Figure 3-6: Users List Window.................................................................................... 3-8
Figure 3-7: User Information Manager...................................................................... 3-10
Figure 3-8: Print Options Window............................................................................. 3-11
Figure 4-1: Class Library Window Containing Classes (BSEQ Batch Project)........... 4-1
Figure 5-1: Batch 90 Editor Window ........................................................................... 5-2
Figure 5-2: Compiler Options Dialog Box ................................................................... 5-2
Figure 5-3: Class Library Window (BSEQ Batch Project) Containing Units ............... 5-5
Figure 5-4: UDF Editor Window.................................................................................. 5-7
Figure 6-1: Unit Procedures Window.......................................................................... 6-1
Figure 6-2: Unit Procedure Editor Window (Unedited) ............................................... 6-3
Figure 6-3: Unit Procedure Editor Window (Edited).................................................... 6-3
Figure 7-1: Master Recipes Window........................................................................... 7-1
Figure 7-2: Master Recipe Editor Window (Unedited) ................................................ 7-3
Figure 7-3: Master Recipe Editor Window (Edited) .................................................... 7-3
Figure 8-1: Batch Downloader Utility Window ............................................................ 8-1
Figure 8-2: Controller Utilities Menu Dialog Box......................................................... 8-6
Figure 8-3: Print Options Window............................................................................... 8-8
Figure 9-1: Batch Debugger Window (BSEQ Batch Project)...................................... 9-1
Figure 10-1: Batch Archive Log Window ................................................................... 10-1
Figure 10-2: Print Options Window ........................................................................... 10-3
Figure 12-1: EDT Recipe Conversion Dialog Box ..................................................... 12-1
Figure 12-2: BRM Recipe Conversion Dialog Box .................................................... 12-2

2VAA001872-660 xi
LIST OF FIGURES

xii 2VAA001872-660
1. Introduction Overview

1. Introduction
1.1 Overview
The Batch Data Manager (BDM) window of the Composer interface provides an interactive tool for creating, managing, and
utilizing Batch 90 and user defined function (UDF) programs. The Batch Data Manager is composed of four applications
that are licensed as parts of the Composer interface:
• Batch 90 and Unit Procedure Editor - Provides a text editor that is used to create and compile Batch 90 programs
for the batch sequence (BSEQ) function code. Three major functions provided by this option are:
Unit procedure editor - Creates recipes in a graphical format.
Batch download utility - Maintains the batch files located in the controller.
Dynamic debugger - Allows detailed monitoring of batch programs.
• Master Recipe Editor - Provides the ability to create master recipes. This editor is used in conjunction with Batch
90 programs created and compiled for the batch sequence (BSEQ) function code.
• Batch 90 for Phase Execution (PHASEX)- Provides a text editor that is used to create and compile Batch 90
programs for the phase execution function code. Two major functions provided by this option are:
Batch download utility - Maintains the batch files located in the controller.
Dynamic debugger - Allows detailed monitoring of batch programs.
• User Defined Function - Provides a text editor that is used to create and compile user defined function (UDF)
programs. Two major functions provided by this option are:
Batch download utility - Maintains the UDF files located in the controller.
Dynamic debugger - Allows detailed monitoring of UDF programs.

1.2 Intended User


This instruction provides information about how to operate the Batch Data Manager interface. It is intended for engineers
and operations personnel with batch process or sequential logic control experience, and a working knowledge of function
codes.

1.3 Instruction Content


This instruction contains 13 sections. It also includes a Table of Contents, List of Figures, List of Tables, and Index giving
several options to locate specific information quickly. The sections that make up this instruction include:

Introduction
Provides an overview of the Batch Data Manager and this instruction.

Description and Operation


Describes the functions, capabilities, and usage of the Batch Data Manager.

Projects
Describes what projects are and how they are created.

Class Libraries and Classes


Explains what class libraries and classes are and how they are created.

Batch 90 and UDF Programs


Provides an overview of Batch 90 and UDF programs and how to create or edit them using the Batch Data Manager. Also
described are units and how they are created.

Unit Procedures and Unit Recipes


Details what unit procedures and unit recipes are and how they are created.

Master Recipes and Control Recipes


Describes what master recipes and control recipes are and how they are created.

Information Download
Details how to download Batch 90 and UDF project contents. Also explains the batch download utility and its functions.

Dynamic Debugger Utility


Explains how to use this utility to debug Batch 90 and UDF programs.

2VAA001872-660 1-1
How to Use this Instruction 1. Introduction

Batch Archive Log


Describes how to set up and use the archive log.

Script Language
Explains the script language and how to use it.

Recipe Conversion and Project Upgrades


Details how to convert batch recipes created with the EDT (edit) and batch recipe manager recipe editors to recipes the
Batch Data Manager can use.

Error Messages and Recovery


Provides a listing of the possible error messages and corresponding recovery procedures.

1.4 How to Use this Instruction


Read this instruction through in sequence before attempting to use the Batch Data Manager. It is important to become
familiar with the entire contents of the instruction prior to creating, managing, and downloading any Batch 90 or UDF
projects.
This instruction limits the information presented in each section to only specific items required to complete the desired task.
The organization enables finding specific information quickly, and permits using this instruction as a reference after
becoming fully familiar with the Batch Data Manager interface.
Be sure to read notes in text. Notes provide:
• Additional information.
• Information that should be considered before using a certain command or statement.

1.5 Document Conventions


This document uses standard text conventions to represent keys, display items and user data inputs:

Display Item
Any item displayed on a screen appears as italic text. Example:
Running

User Data Input


Bold - Identifies any part of a command line that is not optional or variable and must be entered exactly as shown.
Italic - Identifies a variable parameter entered in a command line.
[ ] - Indicates an optional parameter; text within the brackets follows the previously described conventions.
Example:
CUP [port] [baud] [file_name.CSP]
SPECIAL KEYS - Identifies a specific key that is not alphabetic, numeric or punctuation. Examples:
Press ENTER.
Press ESC V M. (Press and release each key in sequence.)
Press CTRL-ALT-SHIFT-DEL. (Press all keys in sequence without releasing any one key until you have pressed
them all.)

File Names
Name - Indicates a file or directory name. Example:
file1.exe
c:\new

Revision Variable
A ? indicates a value that may change depending on the version of an item. Example:
Part number: 1234567?0
Part number: 1234567??

1-2 2VAA001872-660
2. Description and Operation Batch Process

2. Description and Operation


2.1 Batch Process
Manufacturing processes are generally classified as continuous or batch. The process classification depends on whether
the output from the process appears in a continuous flow or in discrete quantities.
In a continuous process, a product is made by passing material through different pieces of equipment. Each of these pieces
of equipment operates in a steady state and performs one dedicated processing function. The output from the continuous
process is a continuous flow.
In a batch process, a product is made by processing measured quantities of raw materials in a sequential order using one
or more pieces of equipment. Each piece of equipment performs a specific processing function on a finite quantity of
material. The product generated by a batch process is referred to as a batch.

2.2 Batch Recipes


Every batch production facility uses a recipe. The recipe is a complete set of information that specifies the control
requirements for making a batch of product. The recipe is a combination of procedure, formula, header, and equipment
requirements. Procedures define the order in which actions are performed. Formulas are sets of parameters that define
information such as quantities of ingredients, duration, and magnitude of process variables. Headers provide information
about the purpose and version of the recipe, such as product identification and description. Equipment requirements specify
the type and number of pieces of equipment needed to produce a batch. The following Figure 2-1 represents the
composition of a recipe.

Figure 2-1: Composition of a Recipe

When using Batch 90 with the batch sequence (BSEQ) function code, the unit procedure or master recipe is a generic form
of the recipe. In this form, the recipe provides the header, procedure, formula information, and defines the class of
equipment used. It does not specify a particular unit within a class. The unit definition or train includes the additional
information required to make the recipe equipment specific. In this form, the recipe contains the equipment specific
information necessary to complete the making of a batch of product.
When using Batch 90 with the phase execution (PHASEX) function code, the recipes are created using the Symphony
batch management software product.

2.3 Batch Data Manager


The Batch Data Manager software is an interactive tool for the creating, editing, managing, downloading (to controllers),
and debugging of Batch 90 and UDF applications. The following Figure 2-2, Figure 2-3, Figure 2-4, and Figure 2-5 show the
sequence of operations required to produce batch and UDF applications using the Batch Data Manager. These figures
assume the appropriate function codes have been configured into the function blocks of the controller.

2.3.1 BSEQ Batch Projects


Typically, a plant site is organized by areas and process cells. A process cell contains all of the equipment required to make
one or more batches. A large complex facility may contain many process cells, while a small facility may be defined by only

2VAA001872-660 2-1
BSEQ Batch Projects 2. Description and Operation

a single process cell. Projects are the foundation of the Batch Data Manager system and include all of the equipment in one
or more process cells. Projects are the largest grouping of information for a batch application in the Batch Data Manager.

Figure 2-2: Unit Procedure Application Creation

2-2 2VAA001872-660
2. Description and Operation BSEQ Batch Projects

Figure 2-3: Master Recipe Application Creation

2.3.1.1 Create Batch Project


The first step in creating a batch application for the batch sequence (BSEQ) function code is to create a BSEQ batch project
(formerly called a B90 project). The Batch Data Manager uses projects to organize the many pieces of information that
comprise a batch application. During the creation of a project a class library is created (or referenced). A class library is a

2VAA001872-660 2-3
BSEQ Batch Projects 2. Description and Operation

directory that will hold classes. A project directory is created with a .PRJ extension. The project directory contains the BAL
(batch archive log) events and recipes.

Figure 2-4: Phase Execution Batch Application Creation

2-4 2VAA001872-660
2. Description and Operation BSEQ Batch Projects

2.3.1.2 Add Classes


The second step in creating a BSEQ batch application is to add a class to the class library for each different type of process
equipment that exists within the process area associated with the project. Each class will have one Batch 90 program
associated with it. However, one Batch 90 program may be associated with multiple classes.

Figure 2-5: UDF Program Application Creation

2.3.1.3 Create Class Programs


The third step in creating a BSEQ batch application is to create a batch program that contains (among other things) phase
subroutines that describe all the process actions possible by a certain type of equipment. Add or reference this program to
the class to create a generic list of phases supported by all equipment of this type. Class program files have a .B90
extension.

2.3.1.4 Add Unit Definition Files


The fourth step in creating a BSEQ batch application is to create a unit (unit definition file) for each specific process unit
within the equipment class. The unit definition file contains specific information such as constant values (capacity, design
pressure, etc.), unit specific strings (unit name, material of construction, etc.) and block address information for unit specific
control devices (device drivers, common sequences, multistate device drivers, etc.). Unit definition files have a .UNT
extension.

2.3.1.5 Develop Recipes


The fifth step in creating a BSEQ batch application is to develop the recipes used to produce a batch of product. Master
recipes and unit procedures are two ways of developing recipes.

Unit Procedures and Unit Recipes


Unit procedures specify the sequence of operations and phases a class of equipment must perform to produce a batch of
product. Like the class program, this file is generic to all equipment of the type specified by the class. The unit procedure

2VAA001872-660 2-5
PHASEX Batch Projects 2. Description and Operation

(generic) and a unit definition file (specific) are merged to create a unit specific recipe that will produce a batch of product on
the equipment specified in the unit. This recipe is called a unit recipe.
In order to execute a unit procedure on a specific process unit, generate a unit recipe by merging the unit procedure with
the unit definition file for the process unit and download the resulting unit recipe. The unit recipe remains resident in the
controller and can be executed manually by the operator or automatically (from other batch programs) through common
sequence function blocks only if no other recipe is currently being executed. Unit recipes are known by their recipe name/ID
number and batch sequence function block number. The combination of these two pieces of information must be unique for
each unit recipe.

Master Recipes and Control Recipes


The ability to utilize master recipes is an optional feature that provides for the easy management of processes that involve
multiple process units. Within the Batch Data Manager, master recipes are represented by a collection of unit procedures
and equipment requirements in the form of equipment classes. Production trains are created by selecting specific process
units from the identified equipment classes. The combination of master recipes with production trains results in the creation
of control recipes.
The master recipe editor (MRE) is an optional software package that simplifies recipe management for processes that
involve multiple process units in the production strategy. The master recipe editor provides the ability to create master
recipes and unit procedures, and enables the creation of production trains, which when merged with the master recipe
results in a control recipe.

2.3.1.6 Download Programs, Files, and Recipes


The sixth step in creating a BSEQ batch application is to download the necessary programs, files, and recipes to the
controller that will execute them. The batch download utility (BDU) provides for the downloading of information and the
maintenance of files within the controller. Use the batch download utility to download batch programs, UDF programs, unit
definition files, unit recipes, and control recipes. The Batch Data Manager makes the downloading of programs, files, and
recipes quick and easy.
New programs and unit files can be loaded into the controller anytime it is in execute mode. These files are activated on a
complete-to-run or hold-to-run transition. Recipe files can be loaded at any time if they are not overwriting files. When
loading recipe files that do overwrite existing files, insure the existing files are not executing. Placing the controller into
configure mode automatically deactivates all recipe and program files.

2.3.1.7 Execute Recipes


The seventh step in creating a BSEQ batch application is to try to execute the recipe that makes up the application.
Carefully monitor all important quantities and verify proper recipe execution.

2.3.1.8 Debug Recipes


The eighth and final step in creating a BSEQ batch application is to correct any errors or control logic problems. The
dynamic debugger (DBG) provides the functions necessary to debug programs and recipes. For example, the debugger
permits single step execution, displaying of internal variable values, halting execution, setting of execution break points,
restarting execution, etc. To launch the debugger, the recipe must be active.

2.3.2 PHASEX Batch Projects


Typically, a plant site is organized by areas and process cells. A process cell contains all of the equipment required to make
one or more batches. A large complex facility may contain many process cells, while a small facility may be defined by only
a single process cell. Projects are the foundation of the Batch Data Manager system and include all of the equipment in one
or more process cells. Projects are the largest grouping of information for a batch application in the Batch Data Manager.

2.3.2.1 Create Batch Project


The first step in creating a batch application for the phase execution (PHASEX) function code is to create a PHASEX batch
project. The Batch Data Manager uses projects to organize the many pieces of information that comprise a batch
application. During the creation of a project a class library is created (or referenced). A class library is a directory that will
hold classes. A project directory is created with a .PRJ extension. The project directory contains the BAL (batch archive log)
events and recipes.

2.3.2.2 Add Classes


The second step in creating a PHASEX batch application is to add a class to the class library for each different type of
process equipment that exists within the process area associated with the project. Each class will have one Batch 90
program associated with it. However, one Batch 90 program may be associated with multiple classes.

2-6 2VAA001872-660
2. Description and Operation UDF Projects

2.3.2.3 Create Class Programs


The third step in creating a PHASEX batch application is to create a batch program that contains (among other things)
phase subroutines that describe all the process actions possible by a certain type of equipment. Add or reference this
program to the class to create a generic list of phases supported by all equipment of this type. Class program files have a
.B90 extension.

2.3.2.4 Add Unit Definition Files


The fourth step in creating a PHASEX batch application is to create a unit (unit definition file) for each specific process unit
within the equipment class. The unit definition file contains specific information such as constant values (capacity, design
pressure, etc.), unit specific strings (unit name, material of construction, etc.) and block address information for unit specific
control devices (device drivers, common sequences, multistate device drivers, etc.). Unit definition files have a .UNT
extension.

2.3.2.5 Download Programs and Files


The fifth step in creating a PHASEX batch application is to download the necessary programs and files to the controller that
will execute them. The batch download utility (BDU) provides for the downloading of information and the maintenance of
files within the controller. The Batch Data Manager makes the downloading of programs and files quick and easy.
New programs and unit files can be loaded into the controller any time it is in execute mode. These files are activated on a
complete-to-run or hold-to-run transition. Placing the controller into configure mode automatically deactivates all program
files.

2.3.2.6 Execute Phases


The sixth step in creating a PHASEX batch application is to try to execute the individual phases that make up the
application by using the Operate IT™ Process Portal workstation faceplate or the Symphony batch management software.
Carefully monitor all important quantities and verify proper phase execution.

2.3.2.7 Debug Phases


The seventh step in creating a PHASEX batch application is to correct any errors or control logic problems. The dynamic
debugger (DBG) provides the functions necessary to debug phase logic. For example, the debugger permits single step
execution, displaying of internal variable values, halting execution, setting of execution break points, restarting execution,
etc. To launch the debugger, the program must be active.

2.3.2.8 Create and Debug Recipes


The eighth and final step in creating a PHASEX batch application is to create and debug recipes using the Symphony batch
management software.

2.3.3 UDF Projects


The purpose of the UDF programming language is to create function codes that perform unique algorithms. Projects are the
largest grouping of information about a UDF application.

2.3.3.1 Create Project


The first step in creating a UDF application is to create a UDF project. The Batch Data Manager uses projects to organize
the information that makes up a UDF application.

2.3.3.2 Create Program


The second step in creating a UDF project is to create a UDF program that specifies the series of operations needed to
perform the required algorithm. Typical applications involve complex sequential operations with many steps. UDF program
files have a .UDF extension.

2.3.3.3 Download Program


The third step in creating a UDF application is to download the UDF program to the controller in which it will execute. The
Batch Data Manager makes the downloading of UDF programs quick and easy. The controller receiving the new UDF
program must be in configure mode.

2.3.3.4 Execute Program


The fourth step in creating a UDF application is to try to execute the program. Carefully monitor all important quantities and
verify proper program execution. The UDF program will execute when the controller is placed into execute mode. If the
program fails to execute, an error indication appears on the controller.

2VAA001872-660 2-7
Online Batch Program Changes 2. Description and Operation

2.3.3.5 Debug Program


The fifth and final step in creating a UDF application is to correct any errors or control logic problems. The batch debugger
provides the tools needed to execute the program one line at a time or in groups of lines in order to find any errors or
problems.

2.4 Online Batch Program Changes


Downloading a program sends a copy of the program to the NVRAM memory of the target controller. During the download,
the controller remains in execute mode and can be executing the original version of the program. The copy of the program
in NVRAM memory is the module master copy of the program. When a batch sequence function block starts or restarts a
batch program, it makes a working copy of the program in RAM memory. This allows a modified version of the program to
be downloaded with no immediate effect on the working copy. The following modifications are not allowed on a restart-from-
holding transition but are allowed on a complete-to-run transition:
• Changes to batch data, unit data, and unit parameters.
• Changes to recipe arguments and local data declarations of an active phase subroutine.
• Deletion of phase subroutines.
• Changes to the #MAXPARALLEL value.
If the modified program contains any of these modifications, a -21 run-time fault code will be generated.
To execute the new version of the program:
1. Put the existing program into holding (that is, set the run/hold input to hold and wait for the program to complete
the hold logic).
2. Restart the program (that is, set the run/hold input to run).

The BSEQ function block makes a copy of the new program and checks for changes. Depending on the changes found,
one of the following actions takes place:
• A run-time fault of -21 is generated and the program status changes to complete (inactive). The program can be
started but all previous data will be lost. This action is a result of finding changes in the batch data, unit data, and
unit parameters of the new program. Changes to the active phase subroutine and recipe values will also cause this
action.
• A run-time fault of -21 is generated and the program status remains in holding. The program can be started but all
phase data will be lost. Batch data will not be affected. This action is a result of finding changes to the local data
declarations section of the active phase subroutine. Execution will start at the beginning of the normal logic for each
parallel phase subroutine of the current operation.
• The program status changes to running with all previous data intact. Execution will start at the beginning of the
restart logic for each parallel phase subroutine of the current operation.

2.5 Directory Structure


Figure 2-6 shows the directory structure of a working Batch Data Manager system. Table 2-1 describes the Batch Data
Manager interface, Batch 90 data, and UDF data files generated and in which directory they reside.

Figure 2-6: Batch Data Manager Directory Structure

2.6 Startup
To start up the Batch Data Manager application:

2-8 2VAA001872-660
2. Description and Operation Startup

1. Select ABBAutomation > Batch Data Manager from the Windows start menu.

Table 2-1: Batch Data Manager Files

Directory File Description

installation_directory_name BDM.EXE Batch Data Manager executable file.


BWS_NT (default)
MRE.EXE Master recipe editor executable file.

UPE.EXE Unit procedure editor executable file.

BDU.EXE Batch download utility executable file.

UDF.EXE UDF compiler executable file.

B90.EXE Batch 90 compiler executable file.

DBG.EXE Dynamic debugger executable file.

ARLOG.EXE Batch archive log executable file.

B90NOTES.WRI Batch 90 release notes.

MRENOTES.WRI Master recipe editor release notes.

UDFNOTES.WRI User defined function codes release notes.

UNINST.ISU Uninstall file.

DDL B90UR.B90 Batch 90 source templates.

B90NUR.B90 Batch 90 source templates.

FC.DEF Batch 90 compiler file.

RESWD.DEF Batch 90 reserved words file.

RESWD88.DEF Batch 90 reserved words file.

BRMRESWD.DEF Batch 90 reserved words file.

ERROR.DEF Batch 90 error messages file.

ERROR88.DEF Batch 90 error messages file.

B90CONST.INC Batch 90 compiler file.

UDFRESWD.DEF UDF reserved words file.

UDFERROR.DEF UDF error messages file.

UDF1.UDF UDF source template file.

UDF2.UDF UDF source template file.

PROJECT.DBD Project database schema file.

PROJECT.KEY Project database key file.

PROJECT1.DAT Project database record file.

ARCHLOG.DBD Archive log database schema file.

ARCHLOG.KEY Archive log database key file.

ARCHLOG.DAT Archive log database record file.

RECIPE.DBD Database schema file.

RECIPE.KEY Database key file.

2VAA001872-660 2-9
Startup 2. Description and Operation

Table 2-1: Batch Data Manager Files (Continued)

Directory File Description


DDL (continued) RECIPE1.DAT Database record file.

RECIPE2.DAT Database record file.

RECIPE3.DAT Database record file.

SYMTBL.DBD Symbol table database schema file.

SYMTBL.KEY Symbol table database key file.

SYMTBL1.DAT Symbol table database record file.

SYMTBL2.DAT Symbol table database record file.

SYMTBL3.DAT Symbol table database record file.

HELP BDM.HLP Batch Data Manager help file.

SYNTAX.HLP Batch 90 and UDF syntax help file.

SYNTAX.CNT Syntax help file contents.

BDM.CNT Batch Data Manager help file contents.

SYSTEM GLIB.DLL Shared file.

MFC42.DLL Shared library file.

MSVC.DLL Shared file.

MSVCRT40.DLL Shared library file.

RDMWIN32.DLL Shared file.

project_name.PRJ LOCKFILE.LOK Project multiuser locking file.

PROJECT.DBD Project database schema file.

PROJECT.KEY Project database key file.

PROJECT1.DAT Project database record file.

BDMUPDATE.B61 Project version.

ARCHLOG LOCKFILE.LOK Archive log multiuser locking file.

ARCHLOG.DBD Archive log database schema file.

ARCHLOG.KEY Archive log database key file.

ARCHLOG.DAT Archive log database record file.

unit_procedure_name LOCKFILE.LOK Unit procedure multiuser locking file.

RECIPE.DBD Unit procedure database schema file.

RECIPE.KEY Unit procedure database key file.

RECIPE1.DAT Unit procedure database record file.

RECIPE2.DAT Unit procedure database record file.

RECIPE3.DAT Unit procedure database record file.

master_recipe_name LOCKFILE.LOK Master recipe multiuser locking file.

RECIPE.DBD Master recipe database schema file.

RECIPE.KEY Master recipe database key file.

RECIPE1.DAT Master recipe database record file.

RECIPE2.DAT Master recipe database record file.

RECIPE3.DAT Master recipe database record file.

2-10 2VAA001872-660
2. Description and Operation Startup

Table 2-1: Batch Data Manager Files (Continued)

Directory File Description

class_name program.B90 Class Batch 90 source file.

program.OBJ Compiled class Batch 90 source file.

program.LST Class Batch 90 listing.

program.LIS Class Batch 90 listing file with syntax


highlighting.

program.SYM Class Batch 90 symbol table file.

program.TEM Unit template file.

CLASS.DEF Class program location file.

ADDRESS.DEF Address specification file for non-unit relative


classes.

CONFIGLINKS.PXL PHASEX linked block numbers for non-unit


relative class.

unit.UNT Unit definition source file.

unit.LST Unit definition listing file.

unit.LIS Unit definition listing file with syntax


highlighting.

unit.OBJ Compiler unit definition file.

unit.PXL PHASEX linked block numbers for unit of


unit relative class.

LOCKFILE.LOK Symbol table multiuser locking file.

SYMTBL.DBD Symbol table database schema file.

SYMTBL.KEY Symbol table database key file.

SYMTBL1.DAT Symbol table database record file.

SYMTBL2.DAT Symbol table database record file.

SYMTBL3.DAT Symbol table database record file.

EXPORTS LOCKFILE.LOK Export multiuser locking file.

RECIPE.DBD Export database schema file.

RECIPE.KEY Export database key file.

RECIPE1.DAT Export database record file.

RECIPE2.DAT Export database record file.

RECIPE3.DAT Export database record file.

2. If the temporary file path was not found during software startup, specify the path in the set temporary file path
dialog box. This path can be changed at any time by selecting Set Temporary Directory Path... from the BDM
options menu.

NOTES: It is recommended to set the temporary directory to a unique name.


3. Click OK.
4. If the configuration server path was not found during software startup, enable the Export to Config. Svr. option
and specify the path in the appropriate field. This path can be changed at any time by selecting Set Config. Svr.
Directory Path... from the BDM options menu.

NOTES: The configuration server path is only required for PHASEX batch programs that will be debugged
from the Operate IT Process Portal workstation.
5. Click OK.

2VAA001872-660 2-11
Startup 2. Description and Operation

6. Enter a user name and password in the log on dialog. When logging into the Batch Data Manager for the first
time, the default user name is SYSTEM and the default password is BAILEY.

NOTES: Passwords within the Batch Data Manager are case sensitive.
7. Click OK.

The Batch Data Manager window (refer Figure 2-7) will appear.

Figure 2-7: Batch Data Manager Window

2-12 2VAA001872-660
3. Projects Introduction

3. Projects
3.1 Introduction
The first step in developing any Batch 90 or UDF process control application is to create a project. A project is the largest
grouping of information concerning the process control application. This section provides instructions on how to add, open,
close, copy, delete, edit user list of, refresh, rename a project, and view properties of a project. Also described is the
security available from the Batch Data Manager.

3.2 Add
To add or create a project:
1. Verify no project is open in the current BDM session.
2. In the projects window, right-click the designator of the drive that will contain the project.
3. Select Add BSEQ Batch Project... (formerly B90 project), Add PHASEX Batch Project..., or Add UDF Project....
4. Enter the project name in the add project dialog box.
Project names are forced into uppercase, not case sensitive, and can not begin with an underscore. A maximum
of eight characters can be used. Valid characters include letters A through Z, numbers zero through nine, and
underscores.
5. Click Next.
6. Specify if a new class library is to be created or an existing class library is to be referenced.
7. Click Next.
8. If a new class library is to be created, enter the name of the subdirectory that will contain the class library and
specify the class library path. If an existing class library is to be referenced, select the directory containing the
class library.
9. Click Next.
10. Verify the project name, project location, and class library name displayed in the add project dialog box.
11. Click Next.
12. Click Finish.
If the project was added by a SYSTEM user, the SYSTEM password in the new project will be identical to that of the current
SYSTEM user. If the project was added by any other user, the SYSTEM password in the new project will be BAILEY.

3.3 Drive Refresh


The drive refresh is automatically performed the first time a user expands a drive. The drive refresh creates a cache file of
the projects contained on the drive. This will improve BDM drive expansion performance. The drive refresh should be
performed after adding, renaming or deleting a project from a different BDM client mapped to the same drive. The next drive
expansion will rebuild the cache file with the current project information.
To refresh a drive:
1. In the projects window, right-click the designator of the drive.
2. Select Drive Refresh.

3.4 Backup
To backup a project:
1. Right-click on the project and select Backup to display the project backup wizard window.
2. Select the elements to backup. Refer to the Figure 3-1.
3. Click Next.
4. Select the Destination Location for the project. Refer to the Figure 3-2.
5. Click Next.
6. Click Finish.

2VAA001872-660 3-1
Change Project Password 3. Projects

The selected elements are copied to the destination location.

Figure 3-1: Project Backup Wizard Window 1 of 3

Figure 3-2: Project Backup Wizard Window 2 of 3

3.5 Change Project Password


To change the project-specific password of the currently logged in user:
1. Right-click the project name in the projects window.
2. Select Open....
3. Right-click the project name in the projects, unit procedures, master recipes, class library, or UDF window.
4. Select Change Password....

3-2 2VAA001872-660
3. Projects Close

5. Enter the current password, new password, and the new password for a second time in the change user
password dialog box.
6. Click OK.

NOTES:
1. BDM can create a user without a password. To create a user without a password, log into a project as
the user. Select change password and enter eight spaces. Confirm the eight spaces. From this point on the
user does not have to enter a password when accessing the project.

2. Scripts will fail to execute if a user without a password is used in a script file.

3.6 Close
To close a project:
1. In the projects window, right-click the name of the project to be closed.
2. Select Close.
All Batch Data Manager application windows except the projects window will close.

3.7 Copy
To copy and rename an existing project (SYSTEM user only):
1. In the projects window, right-click the project name.
2. Select Copy....
3. Select the destination drive designator and enter the new project name in the copy project dialog box.
4. Click Next.
5. Specify if unit procedures, master recipes and class libraries are to be copied.
6. Click Next.
7. Click Finish.

3.8 Delete
To delete a project (SYSTEM user only):
1. Verify the project to be deleted is closed.
2. In the projects window, right-click the project name.
3. Select Delete.
4. Click Yes to confirm the action.

3.9 Open
To open a project:
1. Verify no project is open in the current BDM session.
2. In the projects window, right-click the name of the project to be opened.
3. Select Open....

2VAA001872-660 3-3
Open 3. Projects

The unit procedures, master recipes (optional) and class library windows will appear for BSEQ batch projects. The class
library window will for PHASEX projects. The UDF window will appear for UDF projects. Refer to Figure 3-3 and Figure 3-4
for example of new project windows.

Figure 3-3: New BSEQ Batch Project Window

3-4 2VAA001872-660
3. Projects Properties

Figure 3-4: New UDF Project Window

3.10 Properties
There are three types of property displays available from the projects window. They are the drive, project, and users list
properties.

3.10.1 Drive
The properties of a drive consist of:
• Type.
• Size.
• Number of projects contained.
• Label.
• Amount of space available.
• File system used.
To view the properties of a drive:
1. In the projects window, right-click the drive designator.
2. Select Properties.
3. View the desired properties in the properties dialog box.
4. Click OK.

3.10.2 Project
The properties of a project consist of:
• Type (BSEQ batch, PHASEX batch, or UDF) of project.
• Location (drive and directory).
• Date created.

2VAA001872-660 3-5
Users List 3. Projects

• Size of project directory and subdirectories in bytes.


• Number of unit procedures (BSEQ batch only), master recipes (BSEQ batch only), and programs (UDF only)
contained in the project.
• Version number of the project.
• Class library location (batch only).
• A count of the individuals that have access to the project.
• Comments.
To view or edit the properties of a project:
1. Right-click the project name in the projects, unit procedures, master recipes (optional), class library, or UDF
window.
2. Select Properties.
3. View or edit (if the current user has access) the desired properties in the properties dialog box.
4. Click OK.

3.10.3 Users List


The properties of a user list include:
• Name.
• Location.
• Number of individuals on the list.
To view or edit the properties of a users list:
1. In the users list window, right-click the project name.
2. Select Properties.
3. View or edit (if the current user has access) the desired properties in the properties dialog box.
4. Click OK.

3.11 Rename
To give a project a new name:
1. Verify the project to be renamed is closed.
2. In the projects window, right-click the project name.
3. Select Rename....
4. Enter the new project name in the rename project dialog box.
5. Click OK.

3.12 Restore
To restore a project that has previously been backed up:
1. Right-click on the project and select Restore to display the project restore wizard window.
2. Select the project information to restore.
3. Click Next.
4. Select Backup Project Location.
5. Select Class Library to be Restored.
6. Select Class Library Target Location.

NOTES: The default is the location saved in the project information. Changing the target will update the
project information to the new class library location.
7. Click Next.

3-6 2VAA001872-660
3. Projects Upgrade Project

8. Verify the information. Click Finish. Refer to Figure 3-5.

Figure 3-5: Project Restore Wizard Window

3.13 Upgrade Project


Batch Data Manager version 6.0 and earlier project files must be upgraded on a project basis. Project folders are red before
they are upgraded. In order to perform an upgrade, all projects in the current BDM session must be closed.

NOTE: After the upgrade, Batch Data Manager projects can not be accessed by releases prior to Batch Data Manager
6.1.

To upgrade a project:
1. In the projects window, right-click the project name.
2. Select Upgrade Project.

3.14 Security
Security within the Batch Data Manager consists of user names and passwords applied to projects on a per project basis.
These names and passwords reside within a project and restrict or allow access to only that project. The Batch Data

2VAA001872-660 3-7
Add User 3. Projects

Manager contains the default user name SYSTEM (case sensitive) whose password is dependent on who was logged in
when the project was created. The SYSTEM user of a project created by a SYSTEM user will have identical passwords.
The SYSTEM user of a project created by any other user will have BAILEY as a default password. The SYSTEM user
should be the system administrator or other person responsible for the recipes. The system administrator should create the
projects and edit the users list for each project to include the names of the necessary personnel. Access privileges should
be set by the system administrator.
Anyone can create a new project and immediately become a defined user for that project. Only the SYSTEM user for a
project can edit the users list for that project, edit access privileges, rename the project, and delete the project.
User names are utilized as default passwords. Anyone can change their own password at any time. No one, not even the
SYSTEM user can access the password of another user. However, the SYSTEM user can reset any other persons
password to their user name. Refer to Reset Password in this section for more information about resetting a password.
Passwords can contain a maximum of eight ASCII characters. Passwords are case sensitive.
The Edit Users List option (available to SYSTEM users only) opens the selected project and displays the users list window.
This window contains the names of the individuals that have some level of access to the selected project. Refer to the
Figure 3-6 for an example users list window. To display this window:
1. Verify no project is open.

Figure 3-6: Users List Window

2. In the projects window, right-click the name of the project containing the desired users list.
3. Select Edit Users List.
From the window, names can be added or deleted and the properties of the list can be viewed. Privileges can also be
changed from this window.

3.14.1 Add User


To add the name and specify privileges of a new user to a project:
1. In the users list window, right-click the project name.
2. Select Add User....
3. Enter the name of the new user.
User names are forced into uppercase, not case sensitive, and can not begin with an underscore. A maximum of eight
characters can be used. Valid characters include letters A through Z, numbers one through nine, and underscores.

3-8 2VAA001872-660
3. Projects Delete

4. Specify the level of file access and debug access granted to the user for the project. Refer to Table 3-1 for more
information.

Table 3-1: Access Levels

Project Type File Access Levels Accessible Files Debug Access Levels

BSEQ View Batch program No access


Edit Master recipe View only
Download Unit procedure View with parameter edit
Unit definition View with program debug
View with program debug
and parameter edit

PHASEX View Batch program No access


Edit Unit definition View only
Download View with program debug

UDF View UDF program No access


Edit View only
Download View with program debug

5. Click OK.

3.14.2 Delete
To delete a single name (except SYSTEM) from the users list:
1. In the users list window, right-click the name to be deleted.
2. Select Delete.
3. Click OK.

3.14.3 Delete All Names


To delete all names (except SYSTEM) from the user list:
1. In the users list window, right-click the project name.
2. Select Delete All Users.
3. Click Yes.

3.14.4 Modify
To modify the access privileges of a user (except SYSTEM):
1. In the users list window, right-click the name whose access privileges are to be modified.
2. Select Modify....
The user privileges dialog box will appear.
3. Edit the level of file access and debug access granted to the user for the project. Refer to Table 3-1 for more
information.
4. Click OK.

3.14.5 Refresh
To update the users list:
1. In the users list window, right-click the project name.
2. Select Refresh.

3.14.6 Reset Password


Only the SYSTEM user can reset the password of other project users. The password will be reset to the user name (in
uppercase). Call the technical support department for information about resetting the SYSTEM user password.
To reset the password of a user:
1. In the users list window, right-click the name whose password is to be reset.
2. Select Reset Password....

2VAA001872-660 3-9
User Information Manager 3. Projects

3. Click Yes to confirm the action.

3.14.7 User Information Manager


The User Information Manager is only available to the system user. It can be used to add new users, modify existing
privileges, change passwords and delete users from selected projects. Refer to Figure 3-7.

Figure 3-7: User Information Manager

3.14.7.1Add/Modify

Add
To add a user:
1. Type in the new user name.
2. Type in and confirm the new user password.

NOTES:
1. The Preserve Password option assigns the user name as the password.

2. The user information manager can not modify users to have no password.

3. Select the desired user privileges.


4. Select the projects the user will be added to in the drive window.
5. Click Add/Modify.
6. An event is generated for each project the user is added to in the event log.

Modify
To modify a user:

3-10 2VAA001872-660
3. Projects User Information Manager

1. Type in the user name.


2. Type in and confirm the new user password.

NOTES: The Preserve Password option maintains the current user’s password.
3. Select the desired user privileges.
4. Select the projects in the drive window to be modified.
5. Click Add/Modify.
6. An event is generated in the event log for each project that has been modified.

NOTE: If the user does not exist in a selected project the user is added following the add a user steps.

3.14.7.2Delete
To delete a user:
1. Type in the user name.
2. Select the projects in the drive window to be deleted.
3. Click Delete.
4. An event is generated for each project deleted from in the event log.

NOTE: If the user does not exist in a selected project an event is generated stating the user could not be deleted.

3.14.7.3Print Log
Events are not stored. If a permanent record of changes is required print the event log during the session the changes were
performed.

Printer
To print the event log to a printer:
1. Click Print Log during the current session.
2. Select Printer. Refer to the Figure 3-8.
3. Click OK to open the printer dialog box.
4. Select print options as necessary.
5. Click OK.

Figure 3-8: Print Options Window

File
To print the event log to a file:
1. Click Print Log during the current session.
2. Select File. Refer to Figure 3-8.
3. Specify a file name and location.

2VAA001872-660 3-11
User Information Manager 3. Projects

4. Click OK.

NOTE: An ASCII text file is produced. Select Excel compatible print out to generate an ASCII text comma delimited file.

3.14.7.4Update
Update shows the users defined in a project. The Auto Update option updates the project after an action (add or delete a
user) is performed.

NOTE: Auto Update is a time consuming action. For faster computing response time, do not select the Auto Update
option.

To update the project listing:


1. Expand the drive by selecting the drive +.
2. Select the projects using CTRL-click or SHIFT-click.
3. Click Update.

3-12 2VAA001872-660
4. Class Libraries and Classes Introduction

4. Class Libraries and Classes


4.1 Introduction
A class library is a directory that contains classes, each of which resides in a separate subdirectory. A class includes the
Batch 90 program and associated files that define a sequence of operations for a specific type of process equipment. Units
(discussed in Section 5) define the individual pieces of equipment. For example, assume a plant has three machines of the
same model and manufacturer that perform the same process operations. The plant would require one class to define the
equipment phases for all of the machines and three units (and unit definition files) to define each machine.

NOTE: Classes and class libraries are used in batch projects only.

Figure 4-1 shows an example class library window after classes are added to a class library.

Figure 4-1: Class Library Window Containing Classes (BSEQ Batch Project)

4.2 Class Libraries


Only one class library can be specified for each project. This is done during project creation. However, once a project has
been created the class library associated with that project can be changed. To change the class library, the class library
must be deleted or the reference to it must be removed from the project. Add the new class library to complete the change
operation. It is also possible to rename, copy, and view the properties of a class library.

4.2.1 Add
To add a class library to a project:
1. Verify the project does not contain a class library.
2. In the class library window, right-click the project name.
3. Select Add Class Library....
4. Specify if a new class library is to be created or an existing class library is to be referenced in the add class
library dialog box.
5. Click Next.

2VAA001872-660 4-1
Copy 4. Class Libraries and Classes

6. If a new class library is to be created, enter the name of the subdirectory that will contain the class library and
specify the class library path. If an existing class library is to be referenced, select the directory containing the
class library.
Class library names are forced into uppercase, not case sensitive, and can not begin with an underscore. A
maximum of 16 characters can be used. Valid characters include letters A through Z, numbers zero through
nine, and underscores.
7. Click Next.
8. Verify the class library name displayed in the add class library dialog box is correct.
9. Click Next.
10. Click Finish.

4.2.2 Copy
To copy a class library from the current location to another location:
1. In the class library window, right-click the class library name.
2. Select Copy Out....
The copy class library out dialog box will appear.
3. Set the batch copy options by specifying if symbol table, listing, object code, and include files are to be copied.
4. Set the unit copy options by specifying if unit, object code, and listing files are to be copied.
5. Specify if exports (explained in Section 6 and Section 7) are to be copied.
6. Specify the destination directory.
7. Click OK.

4.2.3 Delete
To delete a class library and all associated files from the hard disk drive:
1. In the class library window, right-click the class library name.
2. Select Delete Class Library.
3. Click Yes to confirm the action.

NOTE: Verify the class library is not used by any other project before deleting the class library.

4.2.4 Properties
The class library property display is available from the class library window. The properties of a class library consist of:
• Type.
• Location and name.
• Size (in bytes).
• Number of classes contained in the class library.
To view the properties of a class library:
1. In the class library window, right-click the class library name.
2. Select Properties.
3. View the properties in the properties dialog box.
4. Click OK.

4.2.5 Remove Reference


To remove the reference to a class library from a project:
1. In the class library window, right-click the class library name.
2. Select Remove Reference.
3. Click Yes to confirm the action.

4.2.6 Rename
To rename a class library:
1. In the class library window, right-click the class library name.

4-2 2VAA001872-660
4. Class Libraries and Classes Classes

2. Select Rename....
3. Enter the new name of the class library in the rename class library dialog box.
4. Click OK.

4.3 Classes
Classes can be added, copied within a library, copied to or from another class library directory, renamed, and deleted.

4.3.1 Add
To add a new class to a class library directory:
1. In the class library window, right-click the class library name.
2. Select Add Class....
3. Enter the class name in the add class dialog box.
Class names are forced into uppercase, not case sensitive, and can not begin with an underscore. A maximum
of eight characters can be used. Valid characters include letters A through Z, numbers zero through nine, and
underscores.
4. Click Next.
5. Specify if this class will use a new batch program (New), copy an existing program (Copy), or reference a
program in another class library directory (Link). If a new program is used, select the unit data box to have a unit
data section put in the program shell by the Batch Data Manager software.
6. Click Next.
7. If a new class batch program is to be created, proceed to Step 9. If an existing program is to be copied or
referenced, select Browse.... from the dialog box and specify the Batch 90 source program in the dialog box.
8. Click Next.
9. Verify the class name, class location, and batch source program location are correct.
10. If desired, click in the edit box and click Next to edit the batch source program. Edit the batch program and select
File > Save.
11. Click Finish.

4.3.2 Change Class Program


To change the batch program associated with a class:
1. In the class library window, right-click the class name.
2. Select Change B90 Program.
3. Select the program in the standard Windows open dialog box.
4. Click Open.

4.3.3 Copy

Copy Option
To make a copy of a class within the same class library directory and give it a new name:
1. In the class library window, right-click the class name.
2. Select Copy....
3. Enter the name of the new class in the copy class dialog box.
4. Click OK.

Copy Out Option


To copy all or part of a class from the current class library directory to another directory:
1. In the class library window, right-click the class name.
2. Select Copy Out....
The copy class out dialog box will appear.
3. Set the batch copy options by specifying if symbol table, listing, object code, and include files are to be copied.
4. Set the unit copy options by specifying if source, object code, and listing files are to be copied.
5. Specify if exports (explained in Section 6 and Section 7) are to be copied.

2VAA001872-660 4-3
Delete 4. Class Libraries and Classes

6. Specify the destination directory.


7. Click OK.

Copy Class In Option


To copy all or part of a class from a directory into the current class library directory:
1. In the class library window, right-click the destination class library name.
2. Select Copy Class In....
3. Select the source directory and class name in the copy class in dialog box.
4. Enter a new name for the class (optional).
5. Set the batch copy options by specifying if symbol table, listing, object code, and include files are to be copied.
6. Set the unit copy options by specifying if source, object code, and listing files are to be copied.
7. Specify if exports are to be copied.
8. Click OK.

4.3.4 Delete

Delete Option
To delete a class from the class library directory:
1. In the class library window, right-click the class name.
2. Select Delete.
3. Click Yes in the please confirm class delete dialog box.

Delete Selected Option


To delete one or more classes from the class library directory:
1. In the class library window, right-click the class library name.
2. Select Delete Selected....
3. Select the classes to be deleted in the delete classes dialog box.
4. Click OK.

4.3.5 Properties
The class property display is available from the class library window and from the Batch 90 editor window when editing a
unit.
The properties of a class include:
• Type.
• Location and name.
• Size of the class library directory (in bytes).
• Number of unit definition files associated with the class.
• Batch program location and name.
• Date the program was last compiled.
• Unit relative status (Yes indicates the class is not specific to any unit, No indicates the class is specific to a unit).
• Firmware revision number of the controller for which the class was compiled.
• Indication of usage of the #HIHI and #MAXPARALLEL directives.
• Program ID type.
• Program ID.
• A notice if the class has not yet been compiled.
• Address of unit the class is specific to (non-unit relative classes only).
• Function block addresses of lead and linked PHASEX blocks (PHASEX batch projects and non-unit relative
classes only).

4-4 2VAA001872-660
4. Class Libraries and Classes Rename

• First comment in the Batch 90 program file.

From Class Library Window


To view or edit the properties of a class from the class library window:
1. Right-click the class name.
2. Select Properties.
3. View the desired properties in the properties dialog box.
4. Edit the address tab, if the class is non-unit relative and the current user has access.
5. Edit the PHASEX links tab for a PHASEX batch project, if the class is non-unit relative and the current user has
access.
6. Click OK.

From Batch 90 Editor Window


To view the properties of a class while editing a unit of the class:
1. In the Batch 90 editor window, select Class > Properties.
2. View the desired properties in the properties dialog box.
3. Click OK.

4.3.6 Rename
To rename a class:
1. In the class library window, right-click the class name.
2. Select Rename....
3. Enter the new class name in the rename class dialog box.
4. Click OK.

2VAA001872-660 4-5
Rename 4. Class Libraries and Classes

4-6 2VAA001872-660
5. Batch 90 and UDF Programs Introduction

5. Batch 90 and UDF Programs


5.1 Introduction
This section describes how to create and manipulate Batch 90 programs, unit definitions, and UDF programs.

NOTE: Units (unit definitions) are used in batch projects only.

5.2 Batch 90 Programs


The next step after adding a class to the class library is to edit the Batch program associated with the class. The program
specifies all the logic that will execute on the equipment defined by the class. Logic includes monitors, functions and
phases. Phases include logic sections for continuous logic, normal logic, fault logic hold logic and restart logic. It is also
possible to compile, delete, print, and rename the batch program. Adding batch include files (described later in this section)
to a class should be done at this time.

5.2.1 Add
To add a new source file to a class:
1. In the class library window, right-click the class name.
2. Select Edit
3. In the Batch 90 editor, select Class > Add Source File.
4. Select the source file type.
5. Click OK. The Batch 90 editor window containing the opened program file will appear.
6. Edit the program file as required.
7. Select File > Save As.
Batch program names can be any valid DOS file name.

5.2.2 Compile

Settings
To view or edit the class settings used by the batch compiler when compiling a program file:
1. In the Batch 90 editor window (refer Figure 5-1), open the program file or verify it is the active program file.
2. Select Class > Settings.
The compiler options dialog box (refer Figure 5-2) will appear.
3. Under the Main Options tab, specify if ISA-SP88.01-1995 standard terms are being used in the program.
4. Specify if a cross-reference of program elements to sections of the program is to be put in the listing file.
5. Specify if the listing file should be left justified.
6. Specify if a browse window is opened when a program is compiled. In this window, open the .CFG file whose
function blocks are to be verified.
7. Specify if warnings should be suppressed from the listing file.
8. Under the List Options tab, specify if the executable code generated by the compiler (for the program file) is
included in the listing file.
9. Specify if the executable code sent to the controller by the compiler (for the program file) is included in the listing
file.
10. Specify if the contents of the symbol table file is to be included in the listing file.
11. Specify if the memory allocation calculations (data table memory) are to be included in the listing file.
12. Under the Versions tab, specify the firmware revision used when compiling. Not specifying a revision level
causes the oldest revision allowed (based on syntax used in the program file) to be used.

2VAA001872-660 5-1
Compile 5. Batch 90 and UDF Programs

13. Click OK.

Figure 5-1: Batch 90 Editor Window

Figure 5-2: Compiler Options Dialog Box

Compile
To compile a batch program or unit data file:
1. In the Batch 90 editor window, open the program file or unit data file and verify it is in the active window.

NOTES: The program file must be compiled before compiling a unit data file.
2. Select Class > Compile.

5-2 2VAA001872-660
5. Batch 90 and UDF Programs Copy

When the compiling operation is complete, the output window will display the number of errors and warnings
generated, time required to compile, value for specifications 11 and 12 of the batch sequence function block, and
the minimum firmware version of the Batch 90 software used in the controller.
A listing file (.lst file extension) is created when the compiling operation completes. This file contains diagnostic
information useful in finding the source of errors and warnings.
3. Correct the source of any errors and recompile the program file.

5.2.3 Copy

Copy Option
To make a copy of a batch program in the same program directory and give it a new name:
1. In the class library window, right-click the program file name.
2. Select Copy....
3. Enter the name of the new program file in the copy B90 dialog box.
4. Click OK.

Copy Out Option


To copy all or part of a batch program from the current program directory to another directory:
1. In the class library window, right-click the name of the program file to be copied.
2. Select Copy Out....
The copy B90 out dialog box will appear.
3. Set the batch copy options by specifying if debugger symbol table, listing, and controller object files are to be
copied.
4. Select the destination directory.
5. Click OK.

Copy B90 In Option


To copy all or part of a batch program from another directory to the current project directory:
1. In the class library window, right-click the name of the project that will receive the program file.
2. Select Copy Class In....
3. Select the source directory and program name in the copy B90 in dialog box.
4. Enter a new name for the program (optional).
5. Set the batch copy options by specifying if symbol table, listing, and object files are to be copied.
6. Click OK.

5.2.4 Delete
To delete a batch program from a project:
1. In the class library window, right-click the name of the program file to be deleted.
2. Select Delete.
3. Click Yes to confirm the delete.

5.2.5 Edit
To edit an existing batch program for a class:
1. In the class library window, right-click the class containing the program.
2. Select Edit.
The Batch 90 editor window containing the opened program file will appear. Refer to Figure 5-1 for an example
editor window.
3. Edit the program file as required.
4. Select File > Save.

2VAA001872-660 5-3
Print 5. Batch 90 and UDF Programs

5.2.6 Print
To print a batch program:
1. In the Batch 90 editor window, open the program file or verify it is the active program file.
2. Select File > Print....
3. Specify the printer, print range, and copies settings in the print dialog box.
4. Click OK.

5.2.7 Properties
View the properties of the class containing the program.

5.2.8 Rebuild All


To compile all the batch program and unit definition files (units) defined in a class:
1. In the Batch 90 editor window, select Class > Rebuild All.
The compiling operation output for the program and every unit of the class will be listed in the output window.
The output window also lists all the files that were compiled.
2. Correct the source of any errors and recompile that program or unit.

5.2.9 Rename
To rename a batch program:
1. In the class library window, right-click the program name to be changed.
2. Select Rename....
3. Enter the new name of the program in the rename B90 dialog box.
4. Click OK.

5.2.10 Source File


To add a batch include file to a class:
1. In the class library window, right-click the class name.
2. Select Edit.
The Batch 90 editor window containing the opened program file will appear.
3. Select Class > Add Source File.

NOTES: A #INCLUDE directive is required in the program for it to locate and access the include file.
4. Select the .INC file extension in the add source file dialog box.
5. Click OK.
An include file window will appear within the Batch 90 editor window.
6. Edit the include file as required.
7. Select File > Save As.
8. Specify a destination directory and file name or accept the default values in the save as dialog box.
9. Click Save.

5.3 Units
The next step after successfully compiling the batch program for a class is to define the units included (in the case of unit
relative programs) in that class of equipment. The unit (unit definition file) must be successfully compiled before a unit
recipe can be created for the unit. It is also possible to print and delete unit definition files. Figure 5-3 shows an example of

5-4 2VAA001872-660
5. Batch 90 and UDF Programs Add

units added to classes.

Figure 5-3: Class Library Window (BSEQ Batch Project) Containing Units

5.3.1 Add
To add a new unit to a class:
1. In the Batch 90 editor window, select Class > Add Unit....
2. In the unit file window, specify the unit source file title, descriptor, location (loop, PCU, controller, and batch
sequence function block number), and unit data.
Unit source file names can be any valid DOS file name.
3. Select File > Save.

5.3.2 Compile
Compiling units requires the same procedures used to compile batch programs. Refer to the information about compiling
batch programs.

5.3.3 Delete
To delete a unit from a class:
1. In the Batch 90 editor window, select Class > Delete Unit.
2. Select the unit to be deleted in the delete unit dialog box.

5.3.4 Print
To print a unit source file:
1. In the Batch 90 editor window, open the unit source file or verify it is the active file.
2. Select File > Print....
3. Specify the printer, print range, and copies settings in the print dialog box.

2VAA001872-660 5-5
Properties 5. Batch 90 and UDF Programs

4. Click OK.

5.3.5 Properties
The properties of a unit include:
• Type.
• Location and name.
• Size (in bytes).
• Number of unit recipes associated with this unit.
• Time and date when the unit was last compiled.
• Name of the class containing this unit.
• Time and date when the batch program associated with the class was last compiled.
• Name of the class library containing this unit.
• Firmware revision number of the controller for which this unit was compiled.
• Loop, controller, PCU, and function block address of the unit source file.
• Indication if the class is unit relative or not.
• Batch program ID.
• Unit descriptor.
• Function block addresses of the lead and linked PHASEX blocks (PHASEX batch projects only).

From Class Library Window


To view or edit the properties of a unit from the class library window:
1. Right-click the unit name.
2. Select Properties.
3. View (if the current user has access) the desired properties in the properties dialog box.
4. Edit the PHASEX Links tab for PHASEX batch projects (if the current user has access.
5. Click OK.

From Unit Procedures Window


To view the properties of a unit from the unit procedures window (BSEQ batch projects only):
1. Right-click the unit name.
2. Select Properties.
3. View (if the current user has access) the desired properties in the properties dialog box.
4. Click OK.

From Overview Window


To view the properties of a unit from the overview window of the unit procedure editor (BSEQ batch projects only):
1. Right-click the unit name.
2. Select Properties.
3. View (if the current user has access) the desired properties in the properties dialog box.
4. Click OK.

5.4 UDF Programs


After creating a project, the next step is to create a new UDF program or edit an existing one. This program will specify the
sequential operation of the equipment controlled by this project. UDF programs can be copied within a project, copied to or
from other project directories, compiled, renamed, printed, and deleted. Adding UDF include files to a project should be
done at this time.

5.4.1 Add
To add a new UDF program to a project:

5-6 2VAA001872-660
5. Batch 90 and UDF Programs Compile

1. In the UDF window, right-click the name of the project that will receive the new program.
2. Select Add UDF....
3. Select the source file type and enter the name of the UDF program file in the add source file dialog box.
UDF program names can be any valid DOS file name.
4. Click OK.
The UDF editor window containing the opened program file will appear. Refer to Figure 5-4.

Figure 5-4: UDF Editor Window

5. Edit the program file as required.


6. Select File > Save.

5.4.2 Compile

Settings
To view or edit the settings used by the UDF compiler when compiling a program file:
1. In the UDF editor window, open the program file or verify it is the active program.
2. Select UDF > Settings from the compiler menu.
The compiler options dialog box (refer Figure 5-2) will appear.
3. Under the Main Options tab, specify if ISA-SP88.01-1995 standard terms are being used in the program.
4. Specify if a cross-reference of program elements to sections of the program is to be put in the listing file.
5. Specify if the listing file should be left justified.
6. Specify if a browse window is opened when a program is compiled. In this window, open the .CFG file whose
function blocks are to be verified.
7. Specify if warnings should be suppressed from the listing file.
8. Under the Listing Options tab, specify if the executable code generated by the compiler (for the program file) is
included in the listing file.

2VAA001872-660 5-7
Copy 5. Batch 90 and UDF Programs

9. Specify if the executable code sent to the controller by the compiler (for the program file) is included in the listing
file.
10. Specify if the contents of the symbol table file are to be included in the listing file.
11. Specify if the memory allocation calculations (data table memory) are to be included in the listing file.
12. Under the Versions tab, specify the firmware revision used when compiling. Not specifying a revision level
causes the oldest revision allowed (based on syntax used in the program file) to be used.
13. Click OK.

Compile
To compile a UDF program:
1. In the UDF editor window, open the program file or verify it is the active program file.
2. Select Compile from the compiler menu.
When the compiling operation is complete, the output window will display the number of errors and warnings
generated, time required to compile, program size, size of data for the UDF function block, and the minimum
firmware version of the UDF software that must be used in the controller for the program to execute.
A listing file (.lst file extension) is created when the compiling operation completes. This file contains diagnostic
information useful in finding the source of errors and warnings.
3. Correct the source of any errors and recompile the program.

5.4.3 Copy

Copy Option
To make a copy of a UDF program in the same program directory and give it a new name:
1. In the UDF window, right-click the program file name.
2. Select Copy....
3. Enter the name of the new program file in the copy UDF dialog box.
4. Click OK.

Copy Out Option


To copy all or part of a UDF program from the current program directory to another directory:
1. In the UDF window, right-click the name of the program file to be copied.
2. Select Copy Out....
The copy UDF out dialog box will appear.
3. Set the UDF copy options by specifying if debugger symbol table, listing, and controller object files are to be
copied.
4. Select the destination directory.
5. Click OK.

Copy UDF In Option


To copy all or part of a UDF program from another directory to the current project directory:
1. In the UDF window, right-click the name of the project that will receive the program file.
2. Select Copy UDF In....
3. Select the source directory and program name in the copy UDF in dialog box.
4. Enter a new name for the program (optional).
5. Set the UDF copy options by specifying if symbol table, listing, and object files are to be copied.
6. Click OK.

5.4.4 Delete
To delete a UDF program from a project:
1. In the UDF window, right-click the name of the program file to be deleted.
2. Select Delete.

5-8 2VAA001872-660
5. Batch 90 and UDF Programs Edit

3. Click Yes to confirm the action.

5.4.5 Edit
To edit an existing UDF program within a project:
1. In the UDF window, right-click the program file name.
2. Select Edit.
The UDF editor window containing the opened program file will appear.
3. Edit the program file as required.
4. Select File > Save.

5.4.6 Print
To print a UDF program:
1. In the UDF editor window, open the program file or verify it is the active program file.
2. Select File > Print....
3. Specify the printer, print range, and copies settings in the print dialog box.
4. Click OK.

5.4.7 Rename
To rename a UDF program:
1. In the UDF window, right-click the program name to be changed.
2. Select Rename....
3. Enter the new name of the program in the rename UDF dialog box.
4. Click OK.

5.4.8 Source File


To add a UDF include file to a UDF project:
1. In the UDF window, right-click a name of a program contained in the project.
2. Select Edit.
The UDF editor window containing the opened program file will appear.
3. Select Compiler > Add Source File.
An include file window will appear within the UDF editor window.
4. Edit the include file as required.
5. Select File > Save As....
6. Specify a destination directory and file name or accept the default values in the save as dialog box.
7. Click Save.

2VAA001872-660 5-9
Source File 5. Batch 90 and UDF Programs

5-10 2VAA001872-660
6. Unit Procedures and Unit Recipes Introduction

6. Unit Procedures and Unit Recipes


6.1 Introduction
The next step after adding units to a class is to create a unit procedure, edit a unit procedure, and create a unit recipe. A
unit procedure specifies how the equipment in a specific class is operated. The unit procedure and unit are merged to
create a unit recipe that is downloaded into the controller. For example, a unit procedure might control how one of several
possible chemical compounds is made using a certain type of reactor. The unit provides specific data about the particular
reactor being used. The resulting unit recipe is specific to the type of chemical compound and the particular reactor being
used. This section describes how to add, edit, copy within the project, copy to or from another project directory, rename,
print, save, and delete a unit procedure or unit recipe. Figure 6-1 shows an example unit procedures window after unit
procedures, units, and unit recipes have been added.

NOTE: Unit procedures and unit recipes are used in BSEQ batch projects only.

Figure 6-1: Unit Procedures Window

Unit recipes created with the EDT and batch recipe manager recipe editors can be used by the Batch Data Manager after
they are converted and imported as described in Section 12. These imported recipes can only be used with BSEQ batch
projects.

6.2 Unit Procedures


More than one unit procedure can be added to a project. It is possible to add, edit, copy within the project, copy to or from
another project directory, rename, print, save, and delete a unit procedure.

6.2.1 Add
To add a new unit procedure to a project:
1. In the unit procedures window, right-click the project name.
2. Select Add Unit Procedure....
3. Enter the unit procedure name and select the class type under the Unit Procedure tab.
Unit procedure names are forced into uppercase, not case sensitive, and can not begin with an underscore. A
maximum of 16 characters can be used. Valid characters include letters A through Z, numbers one through nine,
and underscores.
4. Enter any comments under the Comment tab.
5. Enter description information under the Description tab.

2VAA001872-660 6-1
Copy 6. Unit Procedures and Unit Recipes

6. Click OK.

6.2.2 Copy

Copy Option
To make a copy of a unit procedure in the same project directory and give it a new name or revision number:
1. In the unit procedures window, right-click the unit procedure name.
2. Select Copy....
3. In the copy unit procedure dialog box, specify the creation of a new revision or an entirely new unit procedure.
Enter the new unit procedure name when creating a new unit procedure.
4. Click OK.

Copy Out Option


To copy all or part of a unit procedure from the current project directory to another directory:
1. In the unit procedures window, right-click the unit procedure name.
2. Select Copy Out....
3. Select the destination directory in the copy unit procedure out dialog box.
4. Specify if the unit recipes are to be copied.
5. Click OK.

Copy Unit Procedure In


To copy a unit procedure from another directory to the current project directory:
1. In the unit procedures window, right-click the destination project name.
2. Select Copy Unit Procedure In....
3. Select the source project directory and name of the unit procedure to be copied.
4. Enter the new name for the unit procedure.
5. Click OK.

6.2.3 Delete
To delete a unit procedure from a project:
1. In the unit procedures window, right-click the unit procedure name.
2. Select Delete.
3. In the delete dialog box, specify if all revisions of the unit procedure should be deleted or just this revision.
4. Click OK.

6.2.4 Edit
To edit a unit procedure:
1. In the unit procedures window, right-click the unit procedure name.
2. Select Edit.
The unit procedure editor window containing the unit procedure, overview, and output windows will appear.
Figure 6-2 shows an example unit procedure editor window of a new and unedited unit procedure. Figure 6-3
shows an example unit procedure editor window of a fully edited unit procedure. The unit procedure window
shows the unit procedure structure on top and a listing of the arguments associated with selected operation or
phase on the bottom. The overview window displays all the unit recipes associated with the unit procedure. The
output window displays general output messages.
3. Edit the unit procedure as required.
4. Select File > Save.
5. Select File > Exit.

The editing functions available in the unit procedure editor consist of:
• Inserting operations and phases.

6-2 2VAA001872-660
6. Unit Procedures and Unit Recipes Edit

• Exporting unit procedures, operations, and phases.

Figure 6-2: Unit Procedure Editor Window (Unedited)

Figure 6-3: Unit Procedure Editor Window (Edited)

• Importing unit procedures, operations, and phases.

2VAA001872-660 6-3
Edit 6. Unit Procedures and Unit Recipes

• Creating unit recipes.


• Renaming operations.
• Deleting operations and phases.
• Printing unit procedures.
• Changing write protection status.
• Contracting or expanding unit procedure structures.
• Searching for operations, phases, and arguments.
• Refreshing the internal class library RAM memory image.

6.2.4.1 Add Phase

Using Edit Menu


To insert a new phase into the current operation from the menu bar of the unit procedure editor:
1. Verify the unit procedure window is the active window.
2. Select Edit > Add Phase....
3. Specify the type and number of the inserted phase under the Phase tab of the add phase dialog box.
4. Valid phase numbers range from one to the MAXPARALLEL value defined in the source program file for the
class.
5. Specify the operation that will contain the phase.
6. If necessary, select the operation in which the phase will terminate under the Superphase tab.

NOTES: Phases within the first operation (operation 0) of a unit procedure must terminate within the first
operation.
7. Enter any comments under the Comment tab.
8. Click OK.

Using Right-Click Option


To add a new phase to an operation from the unit procedure window of the unit procedure editor:
1. Right-click an existing phase or the name of the operation that will receive the new phase.
2. Select Add Phase....
3. Specify the type and number of the inserted phase under the Phase tab of the add phase dialog box.
4. Specify the operation that will contain the phase.
5. If necessary, select the operation in which the phase will terminate under the Superphase tab.

NOTES: Phases within the first operation (operation 0) of a unit procedure must terminate within the first
operation.
6. Enter any comments under the Comment tab.
7. Click OK.

6.2.4.2 Contract or Expand


To contract or expand the unit procedure structure (like a directory listing) from the unit procedure window of the unit
procedure editor:
1. Right-click the unit procedure name.
2. Select Contract/Expand.

6.2.4.3 Delete
To delete an operation or phase from the unit procedure window of the unit procedure editor:
1. Delete or change the termination operation of any superphase that passes through the operation.
2. Right-click the operation or phase name.

NOTES: The first operation (operation 0) of a unit procedure can not be deleted.
3. Select Delete.

6-4 2VAA001872-660
6. Unit Procedures and Unit Recipes Edit

4. Click Yes to confirm the action.

6.2.4.4 Exiting Unit Procedure Editor


Save the edited unit procedure and select File > Exit. If edited unit procedures are not saved before selecting Exit, the exit
dialog box appears. In this dialog box, confirm the creation of a new revision, overwriting the current revision, not saving, or
creating a new unit procedure. When creating a new unit procedure, enter the new name.

6.2.4.5 Export Operation


To send a copy of an operation to an export subdirectory of the class directory from the unit procedure window of the unit
procedure editor:
1. Right-click the operation name.
2. Select Export....
3. Enter the name of the operation as it will appear in the export directory.
4. Click OK.

6.2.4.6 Export Phase


To send a copy of a phase to an export subdirectory of the class directory from the unit procedure window of the unit
procedure editor:
1. Right-click the phase name.
2. Select Export....
3. Enter the name of the phase as it will appear in the export directory.
4. Click OK.

6.2.4.7 Export Unit Procedure


To send a copy of a unit procedure to an export subdirectory of the class directory from the unit procedure window or
overview window of the unit procedure editor:
1. Right-click the unit procedure name.
2. Select Export....
3. Enter the name of the unit procedure as it will appear in the export directory.
4. Click OK.

6.2.4.8 Import Operation


To import a copy of an operation from the export directory and add it to the current unit procedure from the unit procedure
window of the unit procedure editor:
1. Right-click an existing operation name or the name of the unit procedure that will receive the imported operation.
2. Select Import Operation....
3. Select the name of the imported operation as it will appear in the unit procedure in the import dialog box.
4. Select the name of the operation to be imported.
5. Specify the placement of the operation by selecting an operation and a modifier (before or after).
6. Click OK.

6.2.4.9 Import Phase


To import a copy of a phase from the export directory and add it to the current operation from the unit procedure window of
the unit procedure editor:
1. Right-click an existing phase name or the name of the operation that will receive the imported phase.
2. Select Import Phase....
3. Select the name of the phase, desired phase number, and the operation receiving the phase under the Phase
tab of the import dialog box.
4. If necessary, select the operation in which the phase will terminate under the Superphase tab.

NOTES: Phases within the first operation (operation 0) of a unit procedure must terminate within the first
operation.
5. Click OK.

2VAA001872-660 6-5
Edit 6. Unit Procedures and Unit Recipes

6.2.4.10Import Unit Procedure


To import a copy of a unit procedure from the export directory, change the name to match the current unit procedure, and
delete the current unit procedure from the unit procedure window of the unit procedure editor:
1. Right-click the name of the unit procedure that will be replaced by the imported unit procedure.
2. Select Import....
3. Select the name of the unit procedure to be imported in the import unit procedure dialog box.
4. Click OK.

6.2.4.11Insert Operation

Using Edit Menu


To insert a new operation into the current unit procedure from the menu bar of the unit procedure editor:
1. Verify the unit procedure window is the active window.
2. Select Edit > Insert Operation....
3. Enter the name of the inserted operation under the Operation tab of the insert operation dialog box.
Operation names are forced into uppercase, are not case sensitive, and can not begin with an underscore. A
maximum of 32 characters can be used. Valid characters include letters A through Z, numbers one through nine,
and underscores.
4. Specify the placement of the operation by selecting an operation and a modifier (before or after).

NOTES: Operations can not be inserted before the first operation (operation 0) of a unit procedure.
5. Enter any comments under the Comment tab.
6. Click OK.

Using Right-Click Option


To insert a new operation into the current unit procedure from the unit procedure window of the unit procedure editor:
1. Right-click an existing operation name or the name of the unit procedure that will receive the inserted operation.
2. Select Insert Operation....
3. Enter the name of the inserted operation under the Operation tab of the insert operation dialog box.
4. Specify the placement of the operation by selecting an operation and a modifier (before or after).

NOTES: Operations can not be inserted before the first operation (operation 0) of a unit procedure.
5. Enter any comments under the Comment tab.
6. Click OK.

6.2.4.12Refresh Class Library


To update the RAM memory image of the class library, select Tasks > Refresh Class Library from the unit procedure editor
window. This updating is needed if the class used by the unit procedure is compiled while the unit procedure is open.

6.2.4.13Rename Operation
To give an operation a new name from the unit procedure window of the unit procedure editor:
1. Right-click the name of the operation receiving the new name.
2. Select Rename....
3. Enter the new name in the rename operation dialog box.
4. Click OK.

6.2.4.14Search
To search for a specific operation, phase, or argument from the unit procedure window of the unit procedure editor:
1. Select Operation, Phase, or Argument from the search menu.
2. In the search dialog box, specify where to search and the name of the operation, phase, or argument.
3. Click Find Next or Find Previous.
A box will appear around the found operation, phase, or argument.
4. Click OK to exit the search dialog box.

6-6 2VAA001872-660
6. Unit Procedures and Unit Recipes Print

6.2.4.15Terminate
To change the operation in which a phase will terminate from the unit procedure window of the unit procedure editor:
1. Right-click the phase.
2. Select Terminate....
3. Select the operation in which the phase will terminate in the terminate phase dialog box.

NOTES: Phases within the first operation (operation 0) of a unit procedure must terminate within the first
operation.
4. Click OK.

6.2.4.16Write Protect
When created, a unit procedure can be edited by anyone with the appropriate access privileges. At any time, anyone can
change the unit procedure status to read only and become the owner of it. No user can edit the unit procedure until the
owner changes the write protect status to the default state. The name of the person who enabled the read only status is
displayed in the properties dialog box for as long as the read-only status is enabled.
To change the write protect status of a unit procedure from the unit procedure window of the unit procedure editor:
1. Right-click the unit procedure name.
2. Select Write Protect.

6.2.5 Print
To print all or part of a unit procedure:
1. In the unit procedure window of the unit procedure editor, select a part of the unit procedure (the whole unit
procedure, an operation, or a phase).
2. Select File > Print....
The unit procedure print options dialog box will appear.
3. Specify under the General tab if the entire unit procedure, just the selected item, or a select number of items
residing below the selected item are to be printed.
4. Specify if the selected items will be printed or sent to a specified file location as a .txt file.
5. Specify under the Unit Procedures tab if the comments and unit parameters are to be printed. When printing unit
parameters, specify if the default values and recipe values are to be printed.
6. Specify how many spaces to indent the printout of unit procedures, comments, and unit parameters.
7. Under the Operations tab, specify if the operations and operation comments are to be printed.
8. Specify how many spaces to indent the printout of operations and operation comments.
9. Under the Phases tab, specify if the phases and phase comments are to be printed.
10. Specify how many spaces to indent the printout of the phases and phase comments.
11. Under the Arguments tab, specify if the arguments, default values, recipe values, and types are also to be
printed.
12. Specify how many spaces to indent the printout of arguments, default values, recipe values, and type.
13. Under the Print Profiles tab, specify if the print profile just configured is to be saved or an existing print profile is
to be loaded. When saving a new print profile, enter a print profile name. When loading an existing print profile,
select the print profile name from the list.
14. Click OK.
15. Specify the printer, print range, and copies settings in the print dialog box if the item is to be printed.
16. Click OK if the item is to be printed.
17. In the printing stats dialog box, click OK to confirm the number of bytes and total page count sent to the printer or
the specified file location.

6.2.6 Properties
The operation, phase, unit procedure and unit procedure editor property displays are available from the unit procedures
window.

6.2.6.1 Operation
The properties of an operation include:
• Name of the unit procedure that contains this operation.

2VAA001872-660 6-7
Properties 6. Unit Procedures and Unit Recipes

• Number of phases within the operation.


• Comment.
To view the properties of an operation from the unit procedure window of the unit procedure editor:
1. Right-click the operation name.
2. Select Properties.
3. View the desired properties in the properties dialog box.
4. Click OK.

6.2.6.2 Phase
The properties of a phase include:
• Type.
• Name of operation containing this phase.
• Number of arguments used in this phase.
• Comment.
To view the properties of a phase from the unit procedure window of the unit procedure editor:
1. Right-click the phase name.
2. Select Properties.
3. View the desired properties in the properties dialog box.
4. Click OK.

6.2.6.3 Unit Procedure


The properties of a unit procedure include:
• Type.
• Location and name.
• Date the unit procedure was created.
• Size (in bytes).
• Number of units and unit recipes associated with this unit procedure.
• Date the unit procedure was last compiled.
• Type of unit procedure ID used.
• Write protection status.
• Indication if the unit procedure was merged.
• Notification if the unit procedure is currently opened.
• Name of the class associated with this unit procedure.
• Date the batch program for the class was last compiled.
• Name of the class library containing the class used by this unit procedure.
• Unit relative status.
• Firmware revision number of the controller for which the unit recipe was merged.
• Comments.
• Unit procedure description.

From Unit Procedures Window


To view or edit the properties of a unit procedure from the unit procedures window:
1. Right-click the unit procedure name.
2. Select Properties.
3. View or edit (if the current user has access) the desired properties in the properties dialog box.
4. Click OK.

6-8 2VAA001872-660
6. Unit Procedures and Unit Recipes Rename

From Unit Procedure Editor


To view or edit the properties of a unit procedure from the overview window of the unit procedure editor:
1. Right-click the unit procedure name.
2. Select Properties....
3. View the desired properties in the properties dialog box.
4. Edit the comments or description if the current user has access.
5. Click OK.

From Unit Procedure Editor


To view or edit a subset of the properties of a unit procedure from the unit procedure window of the unit procedure editor:
1. Right-click the unit procedure name.
2. Select Properties....
3. View or edit (if the current user has access) the desired properties in the properties dialog box.
4. Click OK.

6.2.6.4 Unit Procedure Editor


The properties of the unit procedure editor include:
• Color of all objects used.
• Choice of displaying property name, number, or both.
• Option to change font size when object size changes.
• Width and height of objects.
To view or edit the properties of the unit procedure editor from the unit procedure editor:
1. Select Edit > Properties or right-click any empty space in the unit procedure window.
2. View or edit (if the current user has access) the desired properties in the properties dialog box.
3. Click OK.

6.2.7 Rename
To give a unit procedure a new name:
1. In the unit procedures window, right-click the unit procedure name.
2. Select Rename....
3. Enter the new name of the unit procedure in the rename unit procedure dialog box.
4. Click OK.

6.2.8 Save
To save a unit procedure (by overwriting the current revision), select File > Save from the unit procedure editor window.
To save the current unit procedure under a new name or revision level:
1. Select File > Save As.
2. Enable the creation of a new revision, overwriting of the current revision, or creation of a new unit procedure in
the save dialog box. When creating a new unit procedure, enter a new name.
3. Click OK.

6.3 Unit Recipe


After the unit procedure is edited, a unit recipe must be created by merging the unit procedure and unit. It is also possible to
edit, copy, rename, delete, and delete all unit recipes.

6.3.1 Add

From Unit Procedure Window


To generate a new unit recipe and add it to the unit procedure from the menu bar of the unit procedure editor:
1. Verify the unit procedure window is the active window.

2VAA001872-660 6-9
Copy 6. Unit Procedures and Unit Recipes

2. Select File > Add Unit Recipe.


3. Enter a name or ID number for the unit recipe or select one from the list provided.
Unit recipe names can be alphabetic or numeric. Alphabetic unit names are forced into uppercase, not case
sensitive, and can not begin with an underscore. A maximum of 16 characters can be used. Valid characters
include letters A through Z, numbers one through nine, and underscores. Valid numbers for numeric unit recipe
names are one through 65,536.
4. Select the unit to be used when merging.
5. Click OK.
6. If necessary, click any error shown in the overview window. All windows of the unit procedure editor window will
show conditions at the time of the error. Correct the error and repeat the merging process.

From Unit Procedure Window


To generate a new unit recipe from the unit procedure window of the unit procedure editor:
1. Right-click the name of the unit procedure being used to create the unit recipe.
2. Select Add Unit Recipe.
3. Enter a name or ID number for the unit recipe or select one from the list provided.
Unit recipe names can be alphabetic or numeric. Alphabetic unit names are forced into uppercase, not case
sensitive, and can not begin with an underscore. A maximum of 16 characters can be used. Valid characters
include letters A through Z, numbers one through nine, and underscores. Valid numbers for numeric unit recipe
names are one through 65,536.
4. Select the unit to be used when merging.
5. Click OK.
6. If necessary, click any error shown in the overview window. All windows of the unit procedure editor window will
show conditions at the time of the error. Correct the error and repeat the merging process.

From Overview Window


To generate a new unit recipe from the overview window of the unit procedure editor:
1. Right-click the name of the unit procedure being used to create the unit recipe.
2. Select Add Unit Recipe.
3. Enter a name or ID number for the unit recipe or select one from the list provided.
Unit recipe names can be alphabetic or numeric. Alphabetic unit names are forced into uppercase, not case
sensitive, and can not begin with an underscore. A maximum of 16 characters can be used. Valid characters
include letters A through Z, numbers one through nine, and underscores. Valid numbers for numeric unit recipe
names are one through 65,536.
4. Select the unit to be used when merging.
5. Click OK.
6. If necessary, click any error shown in the overview window. All windows of the unit procedure editor window will
show conditions at the time of the error. Correct the error and repeat the merging process.

6.3.2 Copy

From Unit Procedures Window


To make a copy of a unit recipe in the same project directory and give it a new name from the unit procedures window:
1. Right-click the unit recipe name.
2. Select Copy....
3. Enter the new unit recipe name in the copy unit procedure dialog box.
4. Click OK.

From Unit Procedure Editor


To make a copy of a unit recipe in the same project directory and give it a new name from the unit procedure editor:
1. Verify the overview window is the active window.
2. Right-click the unit recipe name.
3. Select Copy....

6-10 2VAA001872-660
6. Unit Procedures and Unit Recipes Delete

4. Enter the new unit recipe name in the copy unit recipe dialog box.
5. Click OK.

6.3.3 Delete

From Unit Procedures Window


To delete a unit recipe from the unit procedures window:
1. Right-click the unit recipe name.
2. Select Delete....
3. Click Yes in the confirm unit recipe delete dialog box.

From Unit Procedure Editor


To delete a unit recipe from the unit procedure editor:
1. Verify the overview window is the active window.
2. Right-click the unit recipe name.
3. Select Delete....
4. Click Yes in the confirm unit recipe delete dialog box.

6.3.4 Delete All

From Unit Procedures Window


To delete all unit recipes associated with a class from the unit procedures window:
1. Right-click the unit name.
2. Select Delete All.
3. Click Yes in the confirm unit recipe delete all dialog box.

From Unit Procedure Editor


To delete all unit recipes associated with a unit from the unit procedure editor:
1. Verify the overview window is the active window.
2. Right-click the unit name.
3. Select Delete All.
4. Click Yes in the confirm unit recipe delete all dialog box.

6.3.5 Edit

From Unit Procedures Window


To edit a unit recipe from the unit procedures window:
1. Right-click the unit recipe name.
2. Select Edit....
The unit procedure editor window containing the unit recipe, overview, and output windows will appear. The unit
recipe window shows the unit procedure structure on top and a listing of the arguments associated with the
selected unit procedure or phase on the bottom. The overview window displays the structure of the unit
procedure after it has been compiled to create a unit recipe. The output window displays general output
messages.
3. Edit the unit recipe as required.
4. Select File > Save.
5. Select File > Exit.

From Unit Procedure Editor


To edit a unit recipe from the unit procedure editor:
1. Verify that the overview window is the active window.
2. Right-click the unit recipe name.

2VAA001872-660 6-11
Print 6. Unit Procedures and Unit Recipes

3. Select Edit....
The unit procedure editor window containing the unit recipe, overview, and output windows will appear.
4. Edit the unit recipe as required.
5. Select File > Save.
6. Select File > Exit.

From Unit Procedure Editor


The only editing function available in the unit recipe is the editing of unit procedure and phase arguments. To edit
arguments:
1. In the unit recipe window of the unit procedure editor, click the unit procedure or phase containing the argument.
2. Double-click the argument.
3. Edit the argument as necessary in the edit dialog box.
4. Click OK.

6.3.6 Print
To print all or part of a unit recipe:
1. In the unit recipe window of the unit procedure editor, select a part of the unit recipe (the whole unit recipe, an
operation, or a phase).
2. Select File > Print....
The unit procedure print options dialog box will appear.
3. Specify under the General tab if the entire unit recipe, just the selected item, or a select number of items residing
below the selected item are to be printed.
4. Specify if the selected items will be printed or sent to a specific file location as a .txt file.
5. Specify under the Unit Procedures tab if the unit procedure, comments, and unit parameters are to be printed.
When printing unit parameters, specify if the default values and recipe values are to be printed.
6. Specify how many spaces to indent the printout of unit procedures, comments, and unit parameters.
7. Under the Operations tab, specify if the operations and operation comments are to be printed.
8. Specify how many spaces to indent the printout of operations and operation comments.
9. Under the Phases tab, specify if the phases and phase comments are to be printed.
10. Specify how many spaces to indent the printout of the phases and phase comments.
11. Under the Arguments tab, specify if the arguments, default values, recipe values, and types are also to be
printed.
12. Specify how many spaces to indent the printout of arguments, default values, recipe values, and type.
13. Under the Print Profiles tab, specify if the print profile just configured is to be saved or an existing print profile is
to be loaded. When saving a new print profile, enter a print profile name. When loading an existing print profile,
select the print profile name from the list.
14. Click OK.
15. Specify the printer, print range, and copies settings in the print dialog box if the item is to be printed.
16. Click OK if the item is to be printed.
17. In the printing stats dialog box, click OK to confirm the number of bytes and total page count sent to the printer or
the specified file location.

6.3.7 Properties
The properties of a unit recipe include:
• Type.
• Location and name.
• Date first compiled.
• Size (in bytes).
• Date last compiled.
• ID type (numeric or alphanumeric).

6-12 2VAA001872-660
6. Unit Procedures and Unit Recipes Rename

• MaxParallel number.
• Address (loop, controller, PCU, block).
• Recipe ID.
• Class associated with unit recipe.
• Program ID of the class batch program.
• Date the class batch program was compiled.
• Class library name.
• Designation if the unit recipe is unit relative or not.
• Firmware revision number of controller containing unit.
• Comment.
• Description.

From Unit Procedures Window


To view or edit the properties of a unit recipe from the unit procedures window:
1. Right-click the unit recipe name.
2. Select Properties.
3. View or edit (if the current user has access) the desired properties in the properties dialog box.
4. Click OK.

From Unit Procedure Editor


To view or edit the properties of a unit recipe from the unit procedure editor:
1. Right-click the unit recipe name in the overview window.
2. Select Properties.
3. View the desired properties in the properties dialog box.
4. Edit the comments or description if the current user has access.
5. Click OK.

6.3.8 Rename

From Unit Procedures Window


To rename a unit recipe from the unit procedures window:
1. Right-click the unit recipe name.
2. Select Rename....
3. Enter the new unit recipe name in the rename unit recipe dialog box.
4. Click OK.

From Unit Procedure Editor


To rename a unit recipe from the unit procedure editor:
1. Verify the overview window is the active window.
2. Right-click the unit recipe name.
3. Select Rename....
4. Enter the new unit recipe name in the rename unit recipe dialog box.
5. Click OK.

2VAA001872-660 6-13
Rename 6. Unit Procedures and Unit Recipes

6-14 2VAA001872-660
7. Master Recipes and Control Recipes Introduction

7. Master Recipes and Control Recipes


7.1 Introduction
The master recipe editor software package provides master recipe management features in the Batch Data Manager. The
ability to create master recipes is not required in order to make a product. Master recipes simplify the creation of the
sequence of operations necessary to make a product.

NOTE:

1. Use of the master recipe editor software is optional.

2. Master recipes and control recipes are used in BSEQ batch projects only.

A master recipe is a collection of unit procedures that are linked together into a sequence of operations that control the
making of a product. This sequence of operations or recipe, unlike unit procedures, can control multiple classes of
equipment. The unit procedures that make up the master recipe and the units (specified in trains) are compiled to create
control recipes which are downloaded into the controllers. For example, a master recipe might control how one of several
possible chemical compounds is made from beginning to end. The unit procedures within the master recipe would control
how the chemical compounds are processed in each of the classes of equipment (raw material loaders, mixers, packagers,
etc.). Trains, which specify units, provide the specific data about the specific units of equipment (raw material loader 5,
mixer 7, packager 2, etc.). The resulting control recipes are specific to the type of chemical compound and the particular
pieces of equipment used. This section describes how to add, edit, and copy within the project, copy to or from another
project directory, rename, print, save, and delete a master recipe or control recipe. Figure 7-1 shows an example master
recipe window after a master recipe, train, and control recipe have been added.

Figure 7-1: Master Recipes Window

7.2 Master Recipes


More than one master recipe can be added to a project. It is possible to add, edit, copy within the project, copy to or from
another project directory, rename, print, save, and delete a master recipe.

7.2.1 Add
To add a new master recipe to a project:

2VAA001872-660 7-1
Copy 7. Master Recipes and Control Recipes

1. In the master recipes window, right-click the project name.


2. Select Add Master Recipe....
3. Enter the master recipe name, select the type of recipe ID, and enter any description information under the
Master Recipe tab of the add master recipe dialog box.
Master recipe names are forced into uppercase, not case sensitive, and can not begin with an underscore. A
maximum of 16 characters can be used. Valid characters include letters A through Z, numbers one through nine,
and underscores.
4. Enter any comments under the Comment tab.
5. Click OK.

7.2.2 Copy

Copy Option
To make a copy of a master recipe in the same project directory and give it a new name or revision number:
1. In the master recipes window, right-click the master recipe name.
2. Select Copy....
3. Specify the creation of a new revision or an entirely new master recipe. Enter the new master recipe name when
creating a new master recipe.
4. Click OK.

Copy Out Option


To copy all or part of a master recipe from the current project directory to another directory:
1. In the master recipes window, right-click the master recipe name.
2. Select Copy Out....
3. Select the destination directory in the copy master recipe out dialog box.
4. Specify if the control recipes are to be copied.
5. Click OK.

Copy Master Recipe In Option


To copy a master recipe from another directory to the current project directory:
1. In the master recipes window, right-click the destination project name.
2. Select Copy Master Recipe In....
3. Select the project directory and name of the master recipe to be copied.
4. Enter the new name for the master recipe.
5. Click OK.

7.2.3 Delete
To delete a master recipe from a project:
1. In the master recipes window, right-click the master recipe name.
2. Select Delete.
3. In the delete dialog box, specify if all revisions of the master recipe should be deleted or just this revision.
4. Click OK.

7.2.4 Edit
To edit a master recipe:
1. In the master recipes window, right-click the master recipe name.
2. Select Edit.
The master recipe editor window containing the master recipe, overview, and output windows will appear.
Figure 7-2 shows an example master recipe editor window of a new and unedited master recipe. Figure 7-3
shows an example master recipe editor window of a fully edited master recipe. The master recipe window shows
the structure on top and a listing of the arguments associated with the selected operation or phase on the

7-2 2VAA001872-660
7. Master Recipes and Control Recipes Edit

bottom. The overview window displays the structure of the master recipe after it has been compiled to create a
control recipe. The output window displays general output messages.

Figure 7-2: Master Recipe Editor Window (Unedited)

Figure 7-3: Master Recipe Editor Window (Edited)

2VAA001872-660 7-3
Edit 7. Master Recipes and Control Recipes

3. Edit the master recipe as required.


4. Select File > Save.
5. Select File > Exit.

The editing functions available in the master recipe editor are:


• Insert segments, operations, and phases.
• Export unit procedures, operations, and phases.
• Import unit procedures, operations, and phases.
• Check unit procedures for errors.
• Create control recipes.
• Rename segments, operations, and trains.
• Delete master recipes, segments, operations, and phases.
• Print master recipes and unit procedures.
• Change master recipe write protection status.
• Contract or expand master recipe, segment, and unit procedure structures.
• Search for segments, operations, phases, and arguments.
• Refresh the RAM memory image of the class library.

7.2.4.1 Add Phase

Using Edit Menu


To insert a new phase into the current operation from the menu bar of the master recipe editor:
1. Verify the master recipe window is the active window.
2. Select Edit > Add Phase.
3. Select the name of the inserted phase from the list provided under the Phase tab.
4. Specify the operation that will contain the phase.
5. Under the Superphase tab, select the operation in which the phase will terminate.

NOTE: Phases within the first operation (operation 0) of a unit procedure must terminate in the first operation.
6. Enter any comments under the Comment tab.
7. Click OK.

Using Right-Click Option


To add a new phase to an operation from the master recipe window of the master recipe editor:
1. Right-click an existing phase or the name of the operation that will receive the new phase.
2. Select Add Phase....
3. Select the name of the inserted phase from the supplied list under the Phase tab.
4. Specify the operation that will contain the phase.
5. Under the Superphase tab, select the operation in which the phase will terminate.

NOTE: Phases within the first operation (operation 0) of a unit procedure must terminate in the first operation.

6. Enter any comments under the Comment tab.


7. Click OK.

7.2.4.2 Add Train

From Master Recipe Window


To add a new train to a master recipe from the master recipe window of the master recipe editor:
1. Verify the master recipe window is the active window.

7-4 2VAA001872-660
7. Master Recipes and Control Recipes Edit

2. Right-click the name of the master recipe that will contain the train.
3. Select Add Train....
4. Enter a name under the Train tab.
Train names are forced into uppercase, not case sensitive, and can not begin with an underscore. A maximum of
16 characters can be used. Valid characters include letters A through Z, numbers one through nine, and
underscores.
5. Enter any comments under the Comment tab.
6. Enter description information under the Description tab.
7. Click OK.
8. Select the unit to be tied to the train in the edit train dialog box.
9. Click OK.

From Overview Window


To add a new train to a master recipe from the overview window of the master recipe editor:
1. Verify the overview window is the active window.
2. Right-click the master recipe name.
3. Select Add Train.
4. Enter a name under the Train tab.
Train names are forced into uppercase, not case sensitive, and can not begin with an underscore. A maximum of
16 characters can be used. Valid characters include letters A through Z, numbers one through nine, and
underscores.
5. Enter any comments under the Comment tab.
6. Enter description information under the Description tab.
7. Click OK.
8. Select the unit to be tied to the train in the edit train dialog box.
9. Click OK.

7.2.4.3 Contract or Expand


To contract or expand the master recipe, segment, or unit procedure structure (like a directory listing) from the master
recipe editor:
1. In the master recipe window, right-click the master recipe, segment, or unit procedure name.

NOTE: Only one unit procedure can be expanded at a time.

2. Select Contract/Expand.

7.2.4.4 Copy Train

From Master Recipe Editor


To make a copy of a train and give it a new name under the same master recipe from the master recipe editor:
1. Verify the overview window is the active window.
2. Right-click the train name.
3. Select Copy....
4. Enter the name of the copy in the copy train dialog box.
5. Click OK.

From Master Recipes Window


To make a copy of a train and give it a new name under the same master recipe from the master recipes window:
1. Right-click the train name.
2. Select Copy....
3. Enter the name in the copy train dialog box.
4. Click OK.

2VAA001872-660 7-5
Edit 7. Master Recipes and Control Recipes

7.2.4.5 Delete
To delete a segment, unit procedure, operation, or phase from the master recipe editor:
1. In the master recipe window, right-click the segment, unit procedure, operation, or phase name.

NOTES:
1. When deleting an operation, delete or change the termination operation of any superphase that passes
through the operation.

2. The first operation (operation 0) of a unit procedure cannot be deleted.

2. Select Delete.
3. Click Yes in the confirm delete dialog box.

7.2.4.6 Delete Train


To delete a train from the master recipe editor:
1. In the overview window, right-click the train name.
2. Select Delete.
3. Click Yes in the delete dialog box.
To delete a train from the master recipes window:
1. Right-click the train name.
2. Select Delete.
3. Click Yes in the delete dialog box.

7.2.4.7 Edit Train


To edit a train from the master recipe editor:
1. Verify that the overview window is the active window.
2. Right-click the train name.
3. Select Edit Train.
4. Select the unit to be tied to the train in the edit train dialog box.
5. Click OK.

7.2.4.8 Exiting Master Recipe Editor


Save the edited master recipe and select File > Exit. If edited master recipes are not saved before selecting Exit, the exit
dialog box appears. In this dialog box, confirm the creation of a new revision, creation of a new master recipe, overwriting
the current revision, or not saving. When creating a new master recipe, enter the new name.

7.2.4.9 Export Operation


To send a copy of an operation to an export subdirectory of the class directory from the master recipe editor:
1. In the master recipe window, right-click the operation name.
2. Select Export....
3. Enter the name of the operation as it will appear in the export directory in the export dialog box.
Operation names are forced into uppercase, are not case sensitive, and can not begin with an underscore. A
maximum of 32 characters can be used. Valid characters include letters A through Z, numbers one through nine,
and underscores.
4. Click OK.

7.2.4.10Export Phase
To send a copy of a phase to an export subdirectory of the class directory from the master recipe editor:
1. In the master recipe window, right-click the phase name.
2. Select Export....
3. Enter the name of the phase as it will appear in the export directory in the export dialog box.
4. Click OK.

7.2.4.11Export Unit Procedure


To send a copy of a unit procedure to an export subdirectory of the class directory from the master recipe editor:
1. In the master recipe window, expand the unit procedure structure.

7-6 2VAA001872-660
7. Master Recipes and Control Recipes Edit

2. Right-click the unit procedure name.


3. Select Export....
4. Enter the name of the unit procedure as it will appear in the export directory in the export dialog box.
Unit procedure names are forced into uppercase, not case sensitive, and can not begin with an underscore. A
maximum of eight characters can be used. Valid characters include letters A through Z, numbers one through
nine, and underscores.
5. Click OK.

7.2.4.12Import Operation
To import a copy of an operation from the export directory and add it to the current unit procedure from the master recipe
editor:
1. Verify the unit procedure receiving the operation is expanded.
2. In the master recipe window, right-click an existing operation name or the name of the unit procedure that will
receive the imported operation.
3. Select Import Operation....
4. Select the name of the operation to be imported in the import dialog box.
5. Specify the placement of the operation by selecting an operation and a modifier (before or after).

NOTE: Operations can not be inserted before the first operation (operation 0) of a unit procedure.

6. Click OK.

7.2.4.13Import Phase
To import a copy of a phase from the export directory and add it to the current operation from the master recipe editor:
1. In the master recipe window, right-click an existing phase name or the name of the operation that will receive the
imported phase.
2. Select Import Phase....
3. Select the name of the phase to be imported in the import dialog box.
4. Under the Superphase tab, select the operation in which the phase will terminate.

NOTE: Phases within the first operation (operation 0) of a unit procedure must terminate in the first operation.

5. Click OK.

7.2.4.14Import Unit Procedure


To import a copy of a unit procedure from the export directory, change the name to match the current unit procedure, and
delete the current unit procedure from the master recipe editor:
1. In the master recipe window, expand the unit procedure structure of the unit procedure that will be replaced by
the imported unit procedure.
2. Right-click the name of the unit procedure.
3. Select Import....
4. Select the name of the unit procedure to be imported in the import dialog box.
5. Click OK.

7.2.4.15Insert Operation

Using Edit Menu


To insert a new operation into the current unit procedure from the menu bar of the master recipe editor window:
1. Verify the unit procedure receiving the operation is expanded.
2. Select Edit > Insert Operation.
3. Enter the name of the inserted operation under the Operation tab of the insert operation dialog box.
Operation names are forced into uppercase, are not case sensitive, and can not begin with an underscore. A
maximum of 32 characters can be used. Valid characters include letters A through Z, numbers one through nine,
and underscores.
4. Specify the placement of the operation by selecting an operation and a modifier (before or after).

NOTE: Operations can not be inserted before the first operation (operation 0) of a unit procedure.

2VAA001872-660 7-7
Edit 7. Master Recipes and Control Recipes

5. Enter any comments under the Comment tab.


6. Click OK.

Using Right-Click Option


To insert a new operation into the current unit procedure from the master recipe window of the master recipe editor:
1. Verify the unit procedure receiving the operation is expanded.
2. Right-click an existing operation name or the name of the unit procedure that will receive the inserted operation.
3. Select Insert Operation....
4. Enter the name of the inserted operation under the Operations tab of the insert operation dialog box.
Operation names are forced into uppercase, are not case sensitive, and can not begin with an underscore. A
maximum of 32 characters can be used. Valid characters include letters A through Z, numbers one through nine,
and underscores.
5. Specify the placement of the operation by selecting an operation and a modifier (before or after).

NOTE: Operations can not be inserted before the first operation (operation 0) of a unit procedure.

6. Enter any comments under the Comment tab.


7. Click OK.

7.2.4.16Insert Segment

Using Edit Menu


To insert a new segment into the current master recipe from the menu bar of the master recipe editor:
1. Verify the master recipe window is the active window.
2. Select Edit > Insert Segment.
3. Enter the name of the inserted segment in the insert segment dialog box.
Segment names are forced into uppercase, are not case sensitive, and can not begin with an underscore. A
maximum of 32 characters can be used. Valid characters include letters A through Z, numbers one through nine,
and underscores.
4. Specify the placement of the segment by selecting a segment and a modifier (before or after).
5. Click OK.

Using Right-Click Option


To insert a new segment into the current master recipe from the master recipe window of the master recipe editor:
1. Right-click an existing segment name or the name of the master recipe that will receive the inserted segment.
2. Select Insert Segment....
3. Enter the name of the inserted segment under the Segment tab of the insert segment dialog box.
Segment names are forced into uppercase, are not case sensitive, and can not begin with an underscore. A
maximum of 32 characters can be used. Valid characters include letters A through Z, numbers one through nine,
and underscores.
4. Specify the placement of the segment by selecting a segment and a modifier (before or after).
5. Enter any comments under the Comment tab.
6. Click OK.

7.2.4.17Insert Unit Procedure

From Edit Menu


To insert a new unit procedure into the current master recipe from the menu bar of the master recipe editor:
1. Verify the master recipe window is active.
2. Select Edit > Insert Unit Procedure.
3. Enter the name of the inserted unit procedure under the Unit Procedure tab of the add unit procedure dialog box.

7-8 2VAA001872-660
7. Master Recipes and Control Recipes Edit

Unit procedure names are forced into uppercase, not case sensitive, and can not begin with an underscore. A
maximum of eight characters can be used. Valid characters include letters A through Z, numbers one through
nine, and underscores.
4. Specify the class to be associated with this unit procedure from the list provided.
5. Specify the placement of the unit procedure by selecting a unit procedure and a modifier (before or after).
6. Enter any comments under the Comment tab.
7. Enter description information under the Description tab.
8. Click OK.

Using Right-Click Option


To insert a new unit procedure into the current master recipe from the master recipe window of the master recipe editor:
1. Right-click the name of the master recipe (one segment used) or segment (multiple segments used) that will
receive the inserted unit procedure.
2. Select Insert Unit Procedure.
3. Enter the name of the inserted unit procedure under the Unit Procedure tab of the add unit procedure dialog box.
Unit procedure names are forced into uppercase, not case sensitive, and can not begin with an underscore. A
maximum of eight characters can be used. Valid characters include letters A through Z, numbers one through
nine, and underscores.
4. Specify the class to be associated with this unit procedure from the list provided.
5. Specify the placement of the unit procedure by selecting a unit procedure and a modifier (before or after).
6. Enter any comments under the Comment tab.
7. Enter description information under the Description tab.
8. Click OK.

7.2.4.18Refresh Class Library


To update the RAM memory image of the class library, select Tasks > Refresh Class Library from the master recipe editor
window. This is needed when a class referenced in a master recipe is compiled while the master recipe is open.

7.2.4.19Rename Operation
To give an operation a new name from the master recipe editor:
1. In the master recipe window, right-click the name of the operation receiving the new name.
2. Select Rename....
3. Enter the new name in the rename operation dialog box.
Operation names are forced into uppercase, are not case sensitive, and can not begin with an underscore. A
maximum of 32 characters can be used. Valid characters include letters A through Z, numbers one through nine,
and underscores.
4. Click OK.

7.2.4.20Rename Segment
To give a segment a new name from the master recipe editor:
1. In the master recipe window, right-click the name of the segment receiving the new name.
2. Select Rename....
3. Enter the new name in the rename segment dialog box.
Segment names are forced into uppercase, are not case sensitive, and can not begin with an underscore. A
maximum of 32 characters can be used. Valid characters include letters A through Z, numbers one through nine,
and underscores.
4. Click OK.

7.2.4.21Rename Train

From Overview Window


To give a train a new name from the master recipe editor:
1. In the overview window, right-click the current train name.

2VAA001872-660 7-9
Print 7. Master Recipes and Control Recipes

2. Select Rename....
3. Enter the new name in the rename train dialog box.
4. Click OK.

From Master Recipes Window


To give a train a new name from the master recipes window:
1. Right-click the current train name.
2. Select Rename....
3. Enter the new name in the rename train dialog box.
4. Click OK.

7.2.4.22Search
To search for a specific segment, operation, phase, or argument from the master recipe editor:
1. Verify the master recipe window is the active window.
2. Select Segment, Unit Procedure, Operation, or Phase from the search menu.
3. In the search dialog box, specify where to search and the name of the segment, unit procedure, operation, or
phase.
4. Click OK.
A box will appear around the found operation, phase, or argument.
5. Click OK to exit the search dialog box.

7.2.4.23Terminate
To change the operation in which a phase will terminate from the master recipe editor:
1. In the master recipe window, right-click the phase name.
2. Select Terminate....
3. Select the operation in which the phase will terminate in the terminate phase dialog box.

NOTE: Phases within the first operation (operation 0) of a unit procedure must terminate in the first operation.

4. Click OK.

7.2.4.24Write Protect
When created, a master recipe can be edited by any user with the appropriate access privileges. At any time, any user can
change the master recipe to read-only status and become the owner of it. No user can edit the master recipe until the owner
changes the write protect status to the default state. The name of the user who enabled the read-only state will be displayed
in the properties dialog box for as long as the read-only state is enabled.
To change the write protect status from the master recipe editor:
1. In the master recipe window, right-click the master recipe name.
2. Select Write Protect.

7.2.5 Print
To print all or part of a master recipe:
1. In the master recipe window of the master recipe editor, select a part of the master recipe (the whole master
recipe, a segment, a unit procedure, an operation, or a phase).
2. Select File > Print....
The master recipe print options dialog box will appear.
3. Specify under the General tab if the entire master recipe, just the selected item, or a select number of items
residing below the selected item are to be printed.
4. Specify if the selected items will be printed or sent to a specified file location as a .txt file.
5. Under the Segments tab, specify if segments are to be printed.
6. Specify how many spaces to indent the printout of segments.
7. Under the Unit Procedures tab, specify if the unit procedures, comments, and unit parameters are to be printed.
When printing unit parameters, specify if default values and recipe values are to be printed.
8. Specify how many spaces to indent the printout of unit procedures, comments, and unit parameters.

7-10 2VAA001872-660
7. Master Recipes and Control Recipes Properties

9. Under the Operations tab, specify if the operations and operation comments are to be printed.
10. Specify how many spaces to indent the printout of operations and operation comments.
11. Under the Phases tab, specify if phases and phase comments are to be printed.
12. Specify how many spaces to indent the printout of phases and phase comments.
13. Under the Arguments tab, specify if argument default values, recipe values, and types are to be printed.
14. Specify how many spaces to indent the printout of arguments, default values, recipe values, and type.
15. Under the Print Profiles tab, specify if the print profile just configured is to be saved or an existing print profile is
to be loaded. When saving a new print profile, enter a print profile name. When loading an existing print profile,
select the print profile name from the list.
16. Click OK.
17. Specify the printer, print range, and copies settings in the print dialog box if the item is to be printed.
18. Click OK if the item is to be printed.
19. In the printing stats dialog box, click OK to confirm the number of bytes and total page count sent to the printer or
the specified file location.

7.2.6 Properties
The master recipe, segment, operation, phase, master recipe editor, and train property displays are available from the
master recipes and master recipe editor windows.

7.2.6.1 Master Recipe


The properties of a master recipe include:
• Type.
• Location and name.
• Date the master recipe was created.
• Size (in bytes).
• Number of trains and control recipes associated with this master recipe.
• Date the master recipe was last compiled.
• Type of master recipe ID used.
• Write protection status.
• Compiled status.
• Notification if the master recipe is currently opened.
• Comment.
• Description.

From Master Recipes Window


To view or edit the properties of a master recipe from the master recipes window:
1. Right-click the master recipe name.
2. Select Properties.
3. View or edit (if the current user has access) the desired properties in the properties dialog box.
4. Click OK.

From Overview Window


To view or edit the properties of a master recipe from the overview window of the master recipe editor:
1. Right-click the master recipe name.
2. Select Properties....
3. View or edit (if the current user has access) the desired properties in the properties dialog box.
4. Click OK.

2VAA001872-660 7-11
Properties 7. Master Recipes and Control Recipes

From Master Recipe Window


To view or edit the properties of a master recipe from the master recipe window of the master recipe editor:
1. Right-click the master recipe name.
2. Select Properties....
3. View or edit (if the current user has access) the desired properties in the properties dialog box.
4. Click OK.

7.2.6.2 Master Recipe Editor


The properties of the master recipe editor include:
• Color of all objects used.
• Choice of displaying property name, number, or both.
• Option to change font size when object size changes.
• Width and height of objects.
To view or edit the properties of the master recipe editor:
1. Select Edit > Properties or right-click any empty space in the master recipe window.
2. View or edit the desired properties in the properties dialog box.
3. Click OK.

7.2.6.3 Operation
The properties of an operation include:
• Type.
• Location.
• Number of phases contained in this operation.
• Comment.
To view or edit the properties of an operation from the master recipe window of the master recipe editor:
1. Right-click the operation name.
2. Select Properties.
3. View or edit (if the current user has access) the desired properties in the properties dialog box.
4. Click OK.

7.2.6.4 Phase
The properties of a phase include:
• Type.
• Location.
• Number of arguments used.
• Comment.
To view or edit the properties of a phase from the master recipe window of the master recipe editor:
1. Right-click the phase name.
2. Select Properties.
3. View or edit (if the current user has access) the desired properties in the properties dialog box.
4. Click OK.

7.2.6.5 Segment
The properties of a segment include:
• Type.
• Location and name.
• Date the segment was created.

7-12 2VAA001872-660
7. Master Recipes and Control Recipes Properties

• Size (in bytes).


• Date the segment was last compiled.
• Type of segment ID used.
• Notification if the segment is currently opened.
To view or edit the properties of a segment from the master recipe window of the master recipe editor:
1. Right-click the segment name.
2. Select Properties....
3. View or edit (if the current user has access) the desired properties in the properties dialog box.
4. Click OK.

7.2.6.6 Train
The properties of a train include:
• Type.
• Name of the master recipe that contains this train.
• Number of control recipes contained.
• Validity.
• Comment.
• Description.

From Master Recipes Window


To view or edit the properties of a train from the master recipes window:
1. Right-click the train name.
2. Select Properties.
3. View or edit (if the current user has access) the desired properties in the properties dialog box.
4. Click OK.

From Master Recipe Editor


To view or edit the properties of a train from the master recipe editor:
1. In the overview window, right-click the train name.
2. Select Properties.
3. View or edit (if the current user has access) the desired properties in the properties dialog box.
4. Click OK.

7.2.6.7 Unit Procedure


The properties of a unit procedure include:
• Type.
• Location and name.
• Date the unit procedure was created.
• Size (in bytes).
• Date the unit procedure was last compiled.
• Type of unit procedure ID used.
• Notification if the unit procedure is currently opened.
• Name of the class associated with this unit procedure.
• Date the batch program for the class was last compiled.
• Name of the class library containing the class used by this unit procedure.
• Unit relative status.

2VAA001872-660 7-13
Rename 7. Master Recipes and Control Recipes

• Firmware revision number of the controller containing the unit recipe.


To view or edit the properties of a unit procedure from the master recipe window of the master recipe editor:
1. Right-click the unit procedure name.
2. Select Properties....
3. View or edit (if the current user has access) the desired properties in the properties dialog box.
4. Click OK.

7.2.7 Rename
To give a master recipe a new name:
1. In the master recipes window, right-click the master recipe name.
2. Select Rename....
3. Enter the new name of the master recipe in the rename master recipe dialog box.
4. Click OK.

7.2.8 Save
To save a master recipe (by overwriting the current revision), select File > Save from the master recipe editor window.
To save the current master recipe under a new name or revision level:
1. Select File > Save As.
2. Enable the creation of a new revision, overwriting of the current revision, or creation of a new master recipe in
the save dialog box. When creating a new master recipe, enter a new name.
3. Click OK.

7.3 Control Recipes


After the master recipe is edited, a control recipe must be created by compiling the master recipe and train. It is also
possible to edit, copy, rename, and delete a control recipe.

7.3.1 Add

From Master Recipe Window


To generate a control recipe from the menu bar of the master recipe editor:
1. Verify the master recipe window is the active window.
2. Select File > Add Control Recipe.
3. Enter a name (for new control recipes) or select one from the list provided (for overwriting existing control
recipes) under the Control Recipe tab of the add control recipe dialog box.
Control recipe names can be alphabetic or numeric. Alphabetic unit names are forced into uppercase, not case
sensitive, and can not begin with an underscore. A maximum of 16 characters can be used. Valid characters
include letters A through Z, numbers one through nine, and underscores. Valid numbers for numeric control
recipe names are 101 through 65,536.
4. Select the train to be used when compiling.
5. Enter any comments under the Comment tab.
6. Enter description information under the Description tab.
7. Click OK.

From Master Recipe Window


To generate a control recipe from the master recipe window of the master recipe editor:
1. In the master recipe window, right-click the name of the master recipe that will be used to create the control
recipe.
2. Select Add Control Recipe....
3. Enter a name (for new control recipes) or select one from the list provided (for overwriting existing control
recipes) under the Control Recipe tab of the add control recipe dialog box.
Control recipe names can be alphabetic or numeric. Alphabetic unit names are forced into uppercase, not case
sensitive, and can not begin with an underscore. A maximum of 16 characters can be used. Valid characters

7-14 2VAA001872-660
7. Master Recipes and Control Recipes Copy

include letters A through Z, numbers one through nine, and underscores. Valid numbers for numeric control
recipe names are 101 through 65,536.
4. Select the train to be used when compiling.
5. Enter any comments under the Comment tab.
6. Enter description information under the Description tab.
7. Click OK.

From Overview Window


To generate a control recipe and add it to the master recipe from the overview window of the master recipe editor:
1. In the overview window, right-click the name of the train or master recipe that will be used to create the control
recipe.
2. Select Add Control Recipe....
3. Enter a name (for new control recipes) or select one from the list provided (for overwriting existing control
recipes) under the Control Recipe tab of the add control recipe dialog box.
Control recipe names can be alphabetic or numeric. Alphabetic unit names are forced into uppercase, not case
sensitive, and can not begin with an underscore. A maximum of 16 characters can be used. Valid characters
include letters A through Z, numbers one through nine, and underscores. Valid numbers for numeric control
recipe names are 101 through 65,536.
4. Select the train to be used when compiling.
5. Enter any comments under the Comment tab.
6. Enter description information under the Description tab.
7. Click OK.

7.3.2 Copy

From Master Recipes Window


To make a copy of a control recipe in the same project directory and give it a new name from the master recipes window:
1. Right-click the control recipe name.
2. Select Copy....
3. Enter the new control recipe name in the copy control recipe dialog box.
Control recipe names can be alphabetic or numeric. Alphabetic unit names are forced into uppercase, not case
sensitive, and can not begin with an underscore. A maximum of 16 characters can be used. Valid characters
include letters A through Z, numbers one through nine, and underscores. Valid numbers for numeric control
recipe names are one through 65,536.
4. Click OK.

From Master Recipe Editor


To make a copy of a control recipe in the same project directory and give it a new name from the master recipe editor:
1. Verify the overview window is the active window.
2. Right-click the control recipe name.
3. Select Copy....
4. Enter the new control recipe name in the copy control recipe dialog box.
Control recipe names can be alphabetic or numeric. Alphabetic unit names are forced into uppercase, not case
sensitive, and can not begin with an underscore. A maximum of 16 characters can be used. Valid characters
include letters A through Z, numbers one through nine, and underscores. Valid numbers for numeric control
recipe names are one through 65,536.
5. Click OK.

7.3.3 Delete

From Master Recipes Window


To delete a control recipe from the master recipes window:
1. Verify the control recipe to be deleted is not being edited.

2VAA001872-660 7-15
Edit 7. Master Recipes and Control Recipes

2. Right-click the control recipe name.


3. Select Delete....
4. Click OK in the delete control recipe dialog box.

From Master Recipe Editor


To delete a control recipe from the master recipe editor:
1. Verify the overview window is the active window.
2. Right-click the control recipe name.
3. Select Delete....
4. Click OK in the delete control recipe dialog box.

From Master Recipe Editor


To delete one or more control recipes associated with a train from the master recipe editor:
1. Verify the control recipe to be deleted is not being edited.
2. Verify the overview window is the active window.
3. Right-click the train name.
4. Select Delete Selected....
5. Select the control recipes to be deleted in the delete control recipe dialog box.
6. Click OK.

7.3.4 Edit

From Master Recipes Window


To edit a control recipe from the master recipes window:
1. Right-click the control recipe name.
2. Select Edit....
The master recipe editor window containing the control recipe, overview, and output windows will appear. The
control recipe window shows the master recipe structure on top and a listing of the arguments associated with
selected control recipe on the bottom. The overview window displays the structure of the master recipe after it
has been compiled to create a control recipe. The output window displays general output messages.
3. Edit the control recipe as required.
4. Select File > Save.
5. Select File > Exit.

From Master Recipe Editor


To edit a control recipe from the master recipe editor:
1. Verify that the overview window is the active menu.
2. Right-click the control recipe name.
3. Select Edit....
The master recipe editor window containing the control recipe, overview, and output windows will appear.
4. Edit the control recipe as required.
5. Select File > Save.
6. Select File > Exit.

From Master Recipe Editor


The only editing function available in the control recipe is the editing of unit procedure and phase arguments. To edit
arguments:
1. In the control recipe window of the master recipe editor, click the unit procedure or phase containing the
argument.
2. Double-click the argument.
3. Edit the argument as necessary in the edit dialog box.

7-16 2VAA001872-660
7. Master Recipes and Control Recipes Print

4. Click OK.

7.3.5 Print
To print all or part of a control recipe:
1. In the control recipe window of the master recipe editor, select a part of the control recipe (the whole control
recipe, a segment, a unit procedure, an operation, or a phase).
2. Select File > Print....
The master recipe print options dialog box will appear.
3. Specify under the General tab if the entire control recipe, just the selected item, or a select number of items
residing below the selected item are to be printed.
4. Specify if the selected items will be printed or sent to a specified file location as a .txt file.
5. Under the Segments tab, specify if segments are to be printed.
6. Specify how many spaces to indent the printout of segments.
7. Under the Unit Procedures tab, specify if the unit procedures, comments, and unit parameters are to be printed.
When printing unit parameters, specify if default values and recipe values are to be printed.
8. Specify how many spaces to indent the printout of unit procedures, comments, and unit parameters.
9. Under the Operations tab, specify if the operations and operation comments are to be printed.
10. Specify how many spaces to indent the printout of operations and operation comments.
11. Under the Phases tab, specify if phases and phase comments are to be printed.
12. Specify how many spaces to indent the printout of phases and phase comments.
13. Under the Arguments tab, specify if argument default values, recipe values, and types are to be printed.
14. Specify how many spaces to indent the printout of arguments, default values, recipe values, and type.
15. Under the Print Profiles tab, specify if the print profile just configured is to be saved or an existing print profile is
to be loaded. When saving a new print profile, enter a print profile name. When loading an existing print profile,
select the print profile name from the list.
16. Click OK.
17. Specify the printer, print range, and copies settings in the print dialog box if the item is to be printed.
18. Click OK if the item is to be printed.
19. In the printing stats dialog box, click OK to confirm the number of bytes and total page count sent to the printer or
the specified file location.

7.3.6 Properties
The properties of a control recipe include:
• Type.
• Name of the master recipe and train that contain this control recipe.
• Date first compiled.
• Size (in bytes).
• Number of segments and unit recipes contained in this control recipe.
• ID type (numeric or alphanumeric).
• Comment.
• Description.

From Master Recipes Window


To view or edit the properties of a control recipe from the master recipes window:
1. Right-click the control recipe name.
2. Select Properties.
3. View or edit (if the current user has access) the desired properties in the properties dialog box.
4. Click OK.

2VAA001872-660 7-17
Rename 7. Master Recipes and Control Recipes

From Master Recipe Editor


To view or edit the properties of a control recipe from the master recipe editor:
1. In the overview window, right-click the control recipe name.
2. Select Properties.
3. View or edit (if the current user has access) the desired properties in the properties dialog box.
4. Click OK.

7.3.7 Rename

From Master Recipes Window


To rename a control recipe from the master recipes window:
1. Verify the control recipe to be renamed is not being edited.
2. Right-click the control recipe name.
3. Select Rename....
4. Enter the new control recipe name in the rename control recipe dialog box.
Control recipe names can be alphabetic or numeric. Alphabetic unit names are forced into uppercase, not case
sensitive, and can not begin with an underscore. A maximum of 16 characters can be used. Valid characters
include letters A through Z, numbers one through nine, and underscores. Valid numbers for numeric control
recipe names are one through 65,536.
5. Click OK.

From Master Recipe Editor


To rename a control recipe from the master recipe editor:
1. Verify the control recipe to be renamed is not being edited.
2. Verify the overview window is the active window.
3. Right-click the control recipe name.
4. Select Rename....
5. Enter the new control recipe name in the rename control recipe dialog box.
Control recipe names can be alphabetic or numeric. Alphabetic unit names are forced into uppercase, not case
sensitive, and can not begin with an underscore. A maximum of 16 characters can be used. Valid characters
include letters A through Z, numbers one through nine, and underscores. Valid numbers for numeric control
recipe names are one through 65,536.
6. Click OK.

7-18 2VAA001872-660
8. Information Download Introduction

8. Information Download
8.1 Introduction
After creating the necessary control recipes, unit recipes, batch programs, or UDF programs, they must be downloaded into
the controller. This section describes how to download (refer Figure 8-1) the required files to and delete them from a
controller. How to compare the files in a controller to the same files on the hard disk drive of a workstation is also described
in this section.

NOTE: Control and unit recipes are used in BSEQ batch projects only.

Figure 8-1: Batch Downloader Utility Window

8.2 Download
The controller must be formatted before any files are downloaded (refer to Controller Utilities).
The files that must be downloaded to the controller for a master recipe to execute are:
• Batch 90 program file for every class used by the unit procedures that comprise the master recipe.
• Units (unit definition files) used by the unit procedures that comprise the master recipe.
• Control recipes generated by compiling unit procedures and units.
The files that must be downloaded to the controller for a unit procedure to execute are:
• Batch 90 program file for the class used by the unit procedure.
• Units (unit definition files) used by the unit procedure.
• Unit recipes generated by compiling the unit procedure and units.
The files that must be downloaded to the controller for a PHASEX batch program to execute are:
• Batch 90 program file for every class used with recipes created by the Symphony batch management software.
• Units (unit definition files) used with the Batch 90 program files.
Only one file, the program file, must be downloaded to the controller for a UDF program to execute.

2VAA001872-660 8-1
Batch 90 Program Files 8. Information Download

8.2.1 Batch 90 Program Files


To download a batch program that is associated with a class to a controller:
1. In the class library window, right-click the class associated with the batch program.
2. Select Download....
3. Select the unit or the address (loop, PCU, and controller) of the controller that will receive the batch program.
4. Click OK.

8.2.2 Control Recipes


To download a control recipe to a controller:
1. In the master recipes window, right-click the control recipe name.
2. Select Download....
3. Specify the parts of the control recipe (entire control recipe, segment, unit, unit recipe) to download.
4. Click OK.

When a control recipe is downloaded the files created in the controller are as follows:
• Segment 1 of the control recipe will have the ID of the control recipe.
• The unique identifier of the unit recipes contained in Segment 1 is the block address.
• Unit recipes contained in Segment 2 through N will have the ID of the (N-1) + control recipe ID where N is the
segment number. If the control recipe is alpha the segment number is appended to the name.

8.2.3 UDF Program Files


To download a UDF program that is associated with a project to a controller:
1. In the UDF window, right-click the program.
2. Select Download.
3. Specify the address (loop, PCU, and controller) of the controller that will receive the UDF program.
4. Click OK.

8.2.4 Unit Recipes

One Unit Recipe


To download a unit recipe to a controller:
1. In the unit procedures window, right-click the unit recipe name.
2. Select Download.

Multiple Unit Recipes


To download one or more unit recipes to a controller:
1. In the unit procedures window, right-click the unit name.
2. Select Download Selected....
3. Select the unit recipe or unit recipes in the download unit recipes dialog box.
4. Click OK.

8.2.5 Units

One Unit
To download a unit (unit definition file) that is associated with a class to a controller:
1. In the class library window, right-click the unit name.
2. Select Download.

Multiple Units
To download one or more units (unit definition files) associated with a class to a controller:

8-2 2VAA001872-660
8. Information Download Verify

1. In the class library window, right-click the class name.


2. Select Download Selected....
3. Select the unit or units to be downloaded.
4. Click OK.

8.3 Verify
It is possible to compare files residing on a workstation hard disk drive to files of the same name residing in a controller. This
capability can be used to insure the controller contains the most recent files.

8.3.1 Batch 90 Program Files


To verify a Batch 90 program in a controller is identical to the associated Batch 90 program identified by the class definition
on the workstation:
1. In the class library window, right-click the class associated with the batch program.
2. Select Verify In Controller.
3. Select the unit or address (loop, PCU, and controller) associated with the batch program from the Batch 90
program verify dialog box.
4. Click OK.
5. Click OK in the BDU dialog box.

8.3.2 Control Recipes


To verify the control recipe that resides in a controller is identical to the control recipe that resides in the workstation:
1. In the master recipes window, right-click the control recipe name.
2. Select Verify In Controller.
3. Specify the parts of the control recipe (entire control recipe, segment, unit, unit recipe) to verify.
4. Click OK.

8.3.3 UDF Program Files


To verify the UDF program that is associated with a project that resides in a controller is identical to the UDF program that is
associated with the same project that resides in the workstation:
1. In the UDF window, right-click the program name.
2. Select Verify In Controller.
3. Enter or select from a list in the controller address.
4. Click OK.
5. Click OK in the BDU dialog box.

8.3.4 Unit Recipes


To verify the unit recipe that resides in a controller is identical to the unit recipe that resides in the workstation:
1. In the unit procedures window, right-click the unit recipe name.
2. Select Verify In Controller.
3. Click OK in the BDU dialog box.

8.3.5 Units
To verify the unit (unit definition file) that resides in a controller is identical to the unit that resides in the workstation:
1. In the class library window, right-click the unit name.
2. Select Verify In Controller.
3. Click OK in the BDU dialog box.

8.4 Delete
At times it may be necessary to delete certain files from a controller. The Batch Data Manager provides the capability of
deleting individual program, unit, unit recipe, and control recipe files.

2VAA001872-660 8-3
Batch 90 Program Files 8. Information Download

8.4.1 Batch 90 Program Files


To delete the class batch program associated with a unit from a controller:
1. In the class library window, right-click the class associated with the batch program.
2. Select Delete from Controller.
3. In the Batch 90 program delete dialog box, select the unit or address (loop, PCU, and controller) associated with
the class batch program that will be deleted.
4. Click OK.

8.4.2 Control Recipes


To delete a control recipe from a controller:
1. In the master recipes window, right-click the control recipe name.
2. Select Delete from Controller.
3. Specify the parts of the control recipe (entire control recipe, segment, unit, and unit recipe) to delete from the
controller.
4. Click OK.

8.4.3 UDF Program Files


To delete a UDF program that is associated with a project from a controller:
1. In the UDF window, right-click the program name.
2. Select Delete from Controller.
3. Enter or select the controller address from a list.
4. Click OK.

8.4.4 Unit Recipes


To delete a unit recipe from a controller:
1. In the unit procedures window, right-click the unit recipe name.
2. Select Delete from Controller.

8.4.5 Units
To delete a unit (unit definition file) that is associated with a class from a controller:
1. In the class library window, right-click the unit name.
2. Select Delete from Controller.

8.5 Print
All Messages
To print all the messages saved by the download utility from the batch download utility window:
1. Right-click in the window (except on the messages) and select Print All... or select Trace > Print.
2. Select print options as necessary, in the printer dialog box.
3. Click OK.

One Message
To print one message from the batch download utility window:
1. Right-click the log message to be printed.
2. Select Print.
3. Select print options as necessary, in the printer dialog box.
4. Click OK.

Multiple Messages
To print multiple messages from the batch download utility window:
1. Select the log messages to be printed using CTRL and left-click.
2. Right-click on one of the selected log messages.

8-4 2VAA001872-660
8. Information Download Properties

3. Select Print Selected.


4. Select print options as necessary, in the printer dialog box.
5. Click OK.

8.6 Properties
The properties of a message include:
• Date logged.
• Time logged.
• Message level (type).
• User and computer name.
• Description of the message.
To view the properties of a message from the batch download utility window:
1. Right-click the level (type) of the message.
2. Select Properties.
3. View the properties in the event detail dialog box.
4. Click Next (view details of next newer message), Previous (view details of previous older message), or Close.

8.7 Size
To set the maximum number of messages the download utility file will hold from the batch download utility window:
1. Select Trace > Size.
2. Enter the maximum number of messages to save in the trace size dialog box.
3. Click OK.

8.8 Controller Utilities


The controller utilities dialog box shown in Figure 8-2 (within the batch download utility) allows the formatting, changing
modes of, and reading file directories from controllers. Searching for controllers and the changing of controller

2VAA001872-660 8-5
Format 8. Information Download

communication parameters are also supported. The utility also lists (in the window) any messages generated by the utility.
This list or parts of it can be printed, sorted, and deleted.

Figure 8-2: Controller Utilities Menu Dialog Box

8.8.1 Format
The controller must be formatted before any files are downloaded. To format the controller from the Batch Data Manager
window:
1. Select Applications > Downloader. The batch download utility window will appear.
2. Select Tools > Controller Utilities. The controller utilities dialog box will appear.

NOTES: Formatting a controller erases the stored function block configuration. Replace the configuration after
the format operation is complete.
3. Under the Format tab, select the type of format to be performed.
a. If Mini (only deletes existing programs and function code logic) is selected, click Format to complete the
format operation.
b. If Standard (grays out options) or Expanded (allows access to all options) is selected, proceed to the next
step.
4. Specify the type of controller being formatted. Auto Detect inspects the controller at the specified address when
Read Controller is clicked.

NOTES: The controller address is set from the Change Mode tab. The controller type and mode are displayed
after clicking Read Controller.
5. Specify the number of batch files (total number of B90, UDF, unit definitions and recipes the controller can
accept).
6. Specify the address for the base batch file.

NOTES: The default is 100. This value can be changed to avoid conflict with foreign device interface C
program data files.
7. Enter the amount of NVRAM memory assigned to function code logic. The minimum value to execute function
blocks is from the CAD logic drawing compile - EEPROM value. Total is the amount for the module type
selected. Allocated is the amount reserved for program files. If standard format was selected, click Format to
complete the format operation. If expanded format was selected, proceed to the next step.

8-6 2VAA001872-660
8. Information Download Change Controller Mode

8. Specify the number of other (nonbatch) files desired. This is the number of C data files allowed in the controller.
The total number of files is the number of batch files plus the number of other files. This total is the same as the
number of data files set in CUP.
9. Specify the number and size of the MBFIO and check point buffers desired (use of the default values is
recommended).
10. Click Format.

Refer to 8.8.3- Communication Settings for more information about setting communication standards. Refer to 8.8.2-
Change Controller Mode for more information about selecting controllers and changing controller modes under the
Controller tab.

8.8.2 Change Controller Mode


To change the mode of a controller from the controller utilities dialog box:
1. Select the Change Mode tab.
2. Enter the loop, PCU, and controller address of the controller whose mode is being changed.
3. Confirm the current controller mode by clicking Inspect and reading the Current Mode field of the tab.
4. Click Configure, or Execute to specify the new mode or click Reset to initialize and restart the module.

Refer to 8.8.3- Communication Settings for more information about setting communication parameters under the NIU
Settings tab.

8.8.3 Communication Settings


To view or edit the communication settings used between the network interface unit and the workstation:
1. In the controller utilities dialog box, select the NIU Settings tab.
2. Select the appropriate NIU device number.
3. Click Configure NIU.
4. Select the number of the logical computer interface module (actually a path) being used by the Batch Data
Manager in the Harmony API application logical ICI definition dialog box.
5. Enter a brief description of the connection.
6. Enter the name/address of the node Batch Data Manager will communicate with.
7. Select the protocol (TCP/IP) used to communicate between Batch Data Manager and the node.
8. Enter the name or number of the node computer communication port (physical ICI device) through which the
Batch Data Manager will communicate.
9. Click Save.
10. Click Quit.
11. Click Connect to communicate using the new parameters.
12. If satisfied with the new parameters, click Restart NIU to save the new parameters and restart the interface unit.

8.8.4 Read Controller Directories

All Files
To view a directory of all files in a controller from the controller utilities dialog box:
1. Select the Module Files tab.
The controller address, type, and mode of the last controller downloaded to are displayed on the Controller
Directory tab. Also displayed are the number of used files, total memory space available to programs, and the
amount of unused NVRAM memory. These files are displayed on the bottom of the tab after the build utility is
used. They can be sorted by name, size, and attributes. To sort the files click Name, Size, or Attributes.
2. Click Build.
Refer to 8.8.3- Communication Settings for more information about setting the communication parameters.
Refer to 8.8.2- Change Controller Mode for more information about selecting controllers and changing controller
modes.

Batch/UDF Files
To view a directory of the batch and UDF program files in a controller from the controller utilities dialog box:

2VAA001872-660 8-7
Print Controller Directories 8. Information Download

1. Select the Batch/UDF Files tab.


The controller address, type, and firmware revision of the last controller downloaded to are displayed. Also
displayed are the number of used and free files. The files are displayed on the bottom of the tab after the build
utility is used. These files can be sorted by type, program name, program ID, function block address for the file,
file name, and (if expanded program option is selected) description, length, and time-stamp. Sort the files by
clicking Type, File, ID, Block, Name, Description, Length, or Timestamp.
2. Click Build.
Refer to 8.8.3- Communication Settings for more information about setting the communication parameters.
Refer to 8.8.2- Change Controller Mode for more information about selecting controllers and changing controller
modes.

8.8.5 Print Controller Directories

To a Printer
To print a Batch/UDF file listing to a printer:
1. Under the Batch/UDF File tab build the file. Refer to 8.8.4- Read Controller Directories.
2. Click Print.
3. Select Printer from the print options dialog box. Refer to Figure 8-3.
4. Click OK to open the printer dialog box.
5. Select print options as necessary.
6. Click OK.

To a File
To print a Batch/UDF file listing to a file:
1. Under the Batch/UDF File tab build the file. Refer to 8.8.4- Read Controller Directories.
2. Click Print.
3. Select File from the print options dialog box. Refer to Figure 8-3.
4. Specify a file name and location.
5. Click OK.

NOTES: An ASCII text file is produced. Select Excel compatible print out to generate an ASCII text comma
delimited file.

Figure 8-3: Print Options Window

8.9 Search for Controllers


To search for a controller from the controller utilities dialog box:
1. Select the Search For Modules tab.

8-8 2VAA001872-660
8. Information Download Search for Controllers

2. Specify the loop, PCU, and controller address of the controller to be searched for. A wild card character (?) can
be used.
3. Click Search Now.

The loop, PCU, and controller address of the searched for controller or controllers will be displayed on the bottom of the
dialog box. Also displayed will be the type, revision, and current mode of the controller. The displayed controller information
can be sorted by clicking Loop, PCU, Controller, Type, Revision, and Mode.

2VAA001872-660 8-9
Search for Controllers 8. Information Download

8-10 2VAA001872-660
9. Dynamic Debugger Utility Introduction

9. Dynamic Debugger Utility


9.1 Introduction
The next step after creating and downloading a unit recipe, control recipe, batch program, or UDF program is to verify that it
executes correctly. Use the control system to execute the logic and watch for any logic errors. If any errors are generated,
debug the appropriate unit recipe, control recipe, or program.
The batch debugger window consists of two windows and a status bar across the bottom. Refer to Figure 9-1 for an
example batch debugger window. One window displays the program code for the class and a watch box at the bottom. The
watch box displays the values of variables put on watch. The second window (not present when debugging UDF programs
or PHASEX batch programs) displays a graphical representation of the unit or control recipe and a box showing the
parameters associated with the selected phase or unit recipe.

NOTE: Control and unit recipes are used in BSEQ batch projects only.

Figure 9-1: Batch Debugger Window (BSEQ Batch Project)

Unit Recipe
To debug a unit recipe (BSEQ batch project only):
1. In the unit procedures window, right-click the unit recipe name.
2. Select Debug.
The batch debugger window appears.
3. Find any run-time fault codes reported by the debugger (refer to Section 13) using the debugger capabilities
discussed later in this section.
4. Select File > Exit.
5. Edit the unit procedure to correct the errors.
6. Generate a unit recipe of the same name.
7. Download the unit recipe to the controller.
8. Execute the unit recipe and watch for any logic errors.
9. Repeat Steps 1 through 8 until no errors are found.

Control Recipe
To debug a control recipe (BSEQ batch project only):
1. In the master recipes window, right-click the control recipe name.
2. Select Debug....
3. Select the segment and unit procedure name associated with the control recipe.

2VAA001872-660 9-1
Debugger Capabilities 9. Dynamic Debugger Utility

The batch debugger window appears.


4. Find any errors using the debugger capabilities discussed later in this section.
5. Select File > Exit.
6. Edit the necessary unit procedures to correct the errors.
7. Generate a control recipe of the same name.
8. Download the control recipe to the controller.
9. Execute the control recipe and watch for any logic errors.
10. Repeat Steps 1 through 9 until no errors are found.

Batch Program
To debug a batch program (BSEQ and PHASEX batch projects):
1. In the class library window, right-click the class (batch program) or unit name.
2. Select Debug....
3. Select the unit containing the program to be debugged (if a unit relative class was selected in Step 1).
4. Select a lead or linked PHASEX function block (PHASEX batch projects only).
The batch debugger window appears.
5. Find any errors using the debugger capabilities discussed later in this section.
6. Edit the batch program to correct the errors.
7. Download the batch program to the controller.
8. Execute the batch program and watch for any logic errors.
9. Repeat Steps Step 1 through Step 8 until no errors are found.

PHASEX batch programs can also be debugged from a Operate IT Process Portal workstation if the configuration server
path is specified when the program is downloaded. To specify the configuration server path:
1. Select Set Config. Svr. Directory Path... from the Batch Data Manager window options menu.
2. Enable the Export to Config Svr option in the set configuration server path dialog box.
3. Specify the configuration server path.
4. Click OK.

UDF Program
To debug a UDF program:
1. In the UDF window, right-click the UDF program name.
2. Select Debug....
3. Enter the loop, PCU, controller, and UDF block address for the UDF program.

The batch debugger window appears.


1. Find any errors using the debugger capabilities discussed later in this section.
2. Edit the UDF program to correct the errors.
3. Download the UDF program to the controller.
4. Execute the UDF program and watch for any logic errors.
5. Repeat Steps 1 through 7 until no errors are found.

9.2 Debugger Capabilities


The batch debugger allows the execution of the program to be controlled. By executing the program in pieces or even one
step at a time, progress can be closely monitored allowing the causes of errors to be more easily found. The values of
program and built-in variables can be viewed. Program variables can be put on watch and monitored while the program
executes. Program variables can be changed when program execution is stopped.

9.2.1 Breakpoints
Breakpoints are pointers that stop program execution. They are useful when debugging because they allow programs to be
executed in user defined pieces. The dynamic debugger allows two individual breakpoints to be active at one time.

NOTE: The user must have program debug privileges.

9-2 2VAA001872-660
9. Dynamic Debugger Utility Change Operation

Using Debug Menu


To set or edit breakpoints from the batch debugger:
1. Verify the program window is the active window.
2. Select Debug > Breakpoint....
3. Enter a new first breakpoint (source code line number).
4. If desired, enter a new second breakpoint.
5. Click OK.

Using Right-Click Option


To set or edit breakpoints from the program window of the batch debugger:
1. Verify the program window is the active window.
2. Right-click a variable name appearing in the program code.
3. Select Breakpoints....
4. Enter a new first breakpoint (source code line number).
5. If desired, enter a new second breakpoint.
6. Click OK.
To clear both breakpoints at the same time, click Clear All. To jump to a line of source code containing the
breakpoint, click Go To below the line number field.

9.2.2 Change Operation


To change the operation being executed from the batch debugger:

NOTES:
1. The user must have program debug privileges.

2. When using single phase execution mode for a PHASEX batch program, changing the operation transi-
tions the active phase to the complete state.

1. Verify the program window is the active window.


2. Select Debug > Change Operation....
3. Click Next, Previous, or enter the number of the desired operation.
4. Click OK.

9.2.3 Change Phase Debugged


To change to a parallel phase whose source code is being debugged from the batch debugger:

NOTES:
1. The user must have program debug privileges.

2. There are no parallel phases running in a PHASEX function block.

1. Verify the program window is the active window.


2. Select Debug > View Phase....
3. Click Next, Previous, or select the phase to be viewed from the list of phases.
4. Click OK.

9.2.4 Escape Loop


Use this functionality to exit a loop when it is not practical to wait for the loop to process or if an infinite loop is encountered.
To escape a loop, select Debug > Escape Loop from the batch debugger window.

NOTE: The user must have program debug privileges.

9.2.5 Find Specific Text


To find specific text in the batch debugger:
1. Verify the program window is the active window.
2. Select Search > Find....

2VAA001872-660 9-3
Go To Specific Line 9. Dynamic Debugger Utility

3. Enter the text to be searched for.


4. Select the case matching option and the search direction.
5. Click Find Next.
The cursor will indicate the line of code containing the specified text.

9.2.6 Go To Specific Line

Directly
To go to the first, last, or a specific line of the source code:
1. Verify the program window is the active window.
2. Select Search > Go To Line....
3. In the go to line dialog box, enter the desired line number and click OK (specified line), Home (first line), or End
(last line).

Execute Up To Line
To go to the first, last, or a specific line of the source code and continue execution from the program window of the batch
debugger:
1. Right-click a variable name appearing in the program code.
2. Select Go To Line....
3. In the go to line dialog box, enter the desired line number and click OK (specified line), Home (first line), or End
(last line).

Variable Definition
To go to the line of code that defines a variable from the program window of the batch debugger:
1. Right-click a variable name appearing in the program code.
2. Select Go To Definition....

9.2.7 Line Tracking


To highlight the active line of code in the batch debugger:

NOTE: The last debugger session setting is the default setting for the next session.

1. Verify the program window is the active window.


2. Select Debug > Line Tracking.

9.2.8 Properties
The properties of the debug session include:
• Program name, creation date and time, and size.
• BSEQ, PHASEX, or UDF function block status.
• Program status.
• Debug status.
• Indication of the disable program fault or hold logic state.
• Fault information.
• Recipe name, creation data and time, size, and ID (BSEQ batch programs only).
• The operation and phase being executed (BSEQ batch programs only).
• Unit name, creation date and time, and size (unit relative batch programs only).
• Loop, PCU, controller, and function block address of the program (unit relative batch programs only).
To view or edit the properties of a debug session from the batch debugger:
1. Verify the program window is the active window.
2. Select Debug > Properties....
3. Edit or view (if the current user has access) the desired properties.

9-4 2VAA001872-660
9. Dynamic Debugger Utility Remove Variables from Watch

4. Click OK.

9.2.9 Remove Variables from Watch


To remove a variable from the watch box of the batch debugger window:
1. Click the name of the variable in the watch box.
2. Select Debug > Remove Watch or press DELETE.

9.2.10 Start Execution


To start the execution of a program in a controller from the batch debugger:

NOTE: The user must have program debug privileges.

1. Verify the program window is the active window.


2. Select Debug > Go.

9.2.11 Step Execution


It is possible to execute programs one statement at a time (after stopping the program) using the Step Section, Step Level,
and Step Same functions under the debug menu.

NOTE: The user must have program debug privileges.

Step Section
To execute the current statement and stop from the batch debugger window, select Debug > Step Section.

NOTE: If the statement is a monitor or function subroutine call, the entire subroutine is executed normally.

The next executable statement (regardless of section boundaries) will be highlighted.

Step Level
To execute the first statement of a monitor or function subroutine from the batch debugger window, select Debug > Step
Level.
If the next statement to be executed is a function or monitor subroutine, the step level function will cause the debugger to
execute the next executable statement within the monitor or function subroutine. From within a subroutine, the step level
function executes exactly like the step same function.

Step Same
To execute the current statement and stop at the next executable statement within the current program section (function
calls, monitor calls, continuous logic, sequential logic, etc.), select Debug > Step Same from the batch debugger window.
The next executable statement within the program section will be highlighted. The step same function will not execute out
of program section. Execution of statements will stop after the last statement.

9.2.12 Stop Execution


To stop the execution of a program in a controller from the batch debugger:

NOTE: The user must have program debug privileges.

1. Verify the program window is the active window.


2. Select Debug > Stop.

9.2.13 View and Watch Variables


It is possible to view or edit the value of program and built-in variables. It is also possible to put program variables (except
constant and constant string variables) in a watch box so they can be monitored during program execution.

NOTE: The user must have program debug privileges.

9.2.13.1View Program Variable


To view the value of a program variable from the batch debugger:
1. Verify the program window is the active window.
2. Right-click the variable name in the program code.

2VAA001872-660 9-5
Online Recipe Parameter Editing 9. Dynamic Debugger Utility

3. Select Inspect....
4. View the current value.
5. Click OK.

9.2.13.2Edit Program Variable


To edit the value of a program variable from the batch debugger:
1. Verify the program window is the active window.
2. Select Debug > Stop.
3. Right-click the variable name in the program code.
4. Select Inspect....
5. Enter a new value and click Change in the dialog box.

9.2.13.3Watch Program Variable


To put a program variable into the watch box from the batch debugger:
1. Verify the program window is the active window.
2. Right-click the variable name in the program code.
3. Select Inspect....
4. Click Add Watch in the dialog box.
5. Click Close.

9.2.13.4View Built-In Variable


To view the value of a built-in variable from the batch debugger:
1. Verify the program window is the active window.
2. Select Debug > Stop.
3. Select Debug > Builtin Variables.
4. Select the desired variable from the list.
5. View the current value or enter (depending on variable type) a new value and click Change in the dialog box.
6. Click OK.
7. Click Close.

9.3 Online Recipe Parameter Editing


The batch debugger supports the editing of ANY and string type phase parameters. Unit parameters can not be modified.
All changes to the parameters in a recipe are displayed in the active debug session. The executing program must be placed
in the held state to allow the modified parameters to be downloaded to the controller. New parameter values can be
downloaded to any phase in the recipe.
Pending parameters are those that have been modified in the current debug session but have not been downloaded to the
controller and are not active. Pending parameters are not retained or viewable after exiting the debug session. Active
parameters are those contained in the controller and are in use by the active recipe. Master parameters are those contained
in the recipe file located in the controller and in the recipe file located within the Batch Data Manager. Parameters revert to
the master parameter values defined in the recipe file when the active recipe transitions to the complete state.

NOTES:
1. The user must have parameter edit privileges.

2. Online recipe editing is used with BSEQ batch programs only.

9.3.1 Batch Debugger Window


When input focus is on a phase in the recipe window of the batch debugger, active parameters not identical to the master
parameters are highlighted in green. Active parameters identical to the master parameters are not highlighted. Pending
parameters are highlighted in yellow.
The status bar at the bottom of the batch debugger window displays the number of active (in green) and pending (in yellow)
parameter changes. If there are no changes, the number zero is displayed with no highlighting.
To change the default colors for active and pending parameter changes:
1. Right-click in the recipe window.
2. Edit the active and pending parameter change colors in the properties dialog box.
3. Click OK.

9-6 2VAA001872-660
9. Dynamic Debugger Utility Batch Debugger Window

9.3.1.1 Modify ANY Type Parameter


To enter a pending value for an ANY type parameter:
1. Select a phase in the recipe window.
2. Select (double-click) a parameter.
3. Enter the new value in the pending value dialog box.
4. Click OK.

9.3.1.2 Modify String Type Parameter


To enter a pending string type parameter:
1. Select a phase in the recipe window.
2. Select (double-click) a parameter.
3. Enter the new string in the pending string dialog box.
4. Click OK.

9.3.1.3 Download New Parameters


To download pending parameters:
1. Place the running recipe in the held state (specification three of BSEQ function code).
2. Select Debug > Download Parameters....
3. Click OK.
The loading of pending parameters is recorded as an event in the batch archive log.

9.3.1.4 Upload Parameters


Every time a debug session is started parameters are uploaded from the controller. It is possible to manually upload
parameters by selecting Debug > Upload Parameters.... This function is useful when multiple debug sessions are occurring
in parallel (not recommended) and it is important that all active parameters are current.

9.3.1.5 View Parameter Changes Summary


To view the parameter changes summary, select Debug > View Active Changes... or Debug > View Pending Changes....
Additionally, parameter changes can be edited by double-clicking a parameter in the listing.

2VAA001872-660 9-7
Batch Debugger Window 9. Dynamic Debugger Utility

9-8 2VAA001872-660
10. Batch Archive Log Introduction

10. Batch Archive Log


10.1 Introduction
The batch archive log saves the information messages generated by the Batch Data Manager into a log file. The types of
messages that can be saved consist of fatal, warning, information, and diagnostic messages generated by the:
• Batch and UDF compilers.
• Batch Data Manager.
• Batch download utility.
• Dynamic debugger.
• Master recipe editor.
• Unit procedure editor.
The SYSTEM user for the project configures the write filter of the log to archive the desired information. Only the SYSTEM
user can set the log write filter, delete a log, delete a log entry, or change number of messages to be stored. However, any
user can set the log display filter, print a log or log entry, view and sort the log contents displayed. Changes made by anyone
other than the SYSTEM user will only effect the display of the log contents and not the actual condition of the archive log
file. Figure 10-1 shows an example batch archive log window.

Figure 10-1: Batch Archive Log Window

10.2 Delete
The ability to delete some or all log file entries from a log file is reserved for the person with SYSTEM access only.

10.2.1 All Messages

Using Trace Menu


To delete all contents of a log from the batch archive log window:

2VAA001872-660 10-1
One Message 10. Batch Archive Log

1. Select Trace > Delete all.


2. Click OK in the clear dialog box.

Using Right-Click Option


To delete all contents of a log from the batch archive log window:
1. Right-click anywhere (except on the level of a message) in the window.
2. Select Delete All.
3. Click OK in the delete dialog box.

10.2.2 One Message


To delete one displayed log entry from the batch archive log window:
1. Right-click the log entry to be deleted.
2. Select Delete.
3. Click OK in the delete dialog box.

10.2.3 Multiple Messages


To delete multiple displayed log entries from the batch archive log window:
1. Select the log entries to be deleted.
2. Right-click in the level column of one of the selected log entries.
3. Select Delete Selected.
4. Click OK in the delete dialog box.

10.3 Filters
There are two filters in the batch archive log. The display filter controls what log entries are to be displayed and can be
manipulated by anyone with access to the batch archive log. The write filter controls which messages from which utility are
logged into the log file and is configurable by the person with SYSTEM access only.

10.3.1 Display Filter


To configure the batch archive log display filter from the batch archive log window:
1. Select Trace > Collection Filter....
The event trace filter dialog box will appear.
2. On the Display Filter tab, select which previously logged messages (fatal, warning, information, and parameter
change) from each of the Batch Data Manager, unit procedure editor, batch and UDF compiler, master recipe
editor, batch debugger, and batch downloader utilities are to be displayed.
3. Click OK.

10.3.2 Write Filter


To configure the batch archive log write filter from the batch archive log window:
1. Select Trace > Collection Filter....
The event trace filter dialog box will appear.
2. On the Write Filter tab, select which messages (fatal, warning, information, and parameter change) are to be
logged from each of the Batch Data Manager, unit procedure editor, batch and UDF compiler, master recipe
editor, batch debugger, and batch downloader utilities.
3. Click OK.

10.4 Log Size


The maximum number of log entries the log file will hold is configurable by the person with SYSTEM access only. To set the
maximum number of log entries the log file will hold from the batch archive log window:
1. Select Trace > Size....
2. Enter the number of log entries to save in the number of events dialog box.
3. Click OK.
The maximum number of log entries to be saved directly effects the maximum log file size.

10-2 2VAA001872-660
10. Batch Archive Log Pause

10.5 Pause
To pause the input of messages into the displayed log contents, select Trace > Pause from the batch archive log window.

10.6 Print
The user may send a complete log, one message or multiple messages to a printer or file.

10.6.1 Complete Log

To a Printer
To print a complete log from the batch archive log window:
1. Right-click in the window (except on the messages) and select Print All... or select Trace > Print.
2. Select Printer from the print options dialog box. Refer to Figure 10-2.
3. Click OK to open the printer dialog box.
4. Select print options as necessary.
5. Click OK.

To a File
To print a complete log from the batch archive log window:
1. Right-click in the window (except on the messages) and select Print All... or select Trace > Print.
2. Select File from the print options dialog box. Refer to Figure 10-2.
3. Specify a file name and location.
4. Click OK.

NOTES: An ASCII text file is produced. Select Excel compatible print out to generate an ASCII text comma
delimited file.

Figure 10-2: Print Options Window

10.6.2 One Message

To a Printer
To print one displayed log message from the batch archive log window:
1. Right-click the log message to be printed.
2. Select Print.
3. Select Printer from the print options dialog box. Refer to Figure 10-2.
4. Click OK to open the printer dialog box.
5. Select print options as necessary.
6. Click OK.

2VAA001872-660 10-3
Multiple Messages 10. Batch Archive Log

To a File
To print one displayed log message from the batch archive log window:
1. Right-click the log message to be printed.
2. Select Print.
3. Select File from the print options dialog box. Refer to Figure 10-2.
4. Specify a file name and location.
5. Click OK.

NOTES: An ASCII text file is produced. Select Excel compatible print out to generate an ASCII text comma
delimited file.

10.6.3 Multiple Messages

To a Printer
To print multiple displayed log messages from the batch archive log window:
1. Select the log messages to be printed using CTRL and left-click.
2. Right-click on one of the selected log messages.
3. Click Print Selected.
4. Select Printer from the print options dialog box. Refer to Figure 10-2.
5. Click OK to open the printer dialog box.
6. Select print options as necessary.
7. Click OK.

To a File
To print multiple displayed log messages from the batch archive log window:
1. Select the log messages to be printed using CTRL and left-click.
2. Right-click on one of the selected log messages.
3. Select Print Selected.
4. Select File from the print options dialog box. Refer to Figure 10-2.
5. Specify a file name and location.
6. Click OK.
NOTES: An ASCII text file is produced. Select Excel compatible print out to generate an ASCII text comma
delimited file.

10.7 Properties
The properties of a message include:
• Date logged.
• Time logged.
• User and computer name.
• Name of the utility that generated the message.
• Message level (type).
• Description of the message.
To view the properties of a message from the batch archive log window:
1. Right-click the level (type) of the message.
2. Select Properties.
3. View the properties in the event detail dialog box.
4. Click Next (view details of next newer log entry), Previous (view details of previous older log entry), Delete, or
Close.

10-4 2VAA001872-660
10. Batch Archive Log Resume

10.8 Resume
To resume the input of messages into the displayed log contents, select Trace > Resume from the batch archive log
window.

10.9 Sort
The displayed log contents can be sorted according to message type (level), date and time the message was generated
(time-stamp), utility that generated the message (source), first letter of the message (description), and the name of the
computer and user that caused the message to be generated (user name). To sort the displayed log contents, click Level,
Timestamp, Source, Description, or User Name in the batch archive log window.

10.10View
To view the contents of the archive log, select Applications > Archive Log from the Batch Data Manager window. The batch
archive log window will appear.

NOTE: The batch archive log window is opened when the project is opened and not closed until the project is closed.

2VAA001872-660 10-5
View 10. Batch Archive Log

10-6 2VAA001872-660
11. Script Language Introduction

11. Script Language


11.1 Introduction
The Batch Data Manager software allows the use of a script language to perform certain actions unattended. The primary
benefits of using this feature are unattended operation and guaranteed repeatability. Script files are passed as command
line variables, which allows multiple script files to be executed from a DOS batch file.
The following tasks can be executed through scripts:

Compiling Batch 90/UDF Programs


• Batch 90 program (class).
• UDF program.

Compiling Recipes and Trains


• Compile a unit recipe for a unit relative unit procedure.
• Compile a unit recipe for non-unit relative unit procedures.
• Create a master recipe train.
• Compile a control recipe for a master recipe.

Deleting Files from the Controller


• Unit recipe of a unit relative unit procedure.
• Unit recipe of a non-unit relative unit procedure.
• Unit recipe of a control recipe.
• All unit recipes in a unit of a unit relative unit procedure.
• All unit recipes for all units of unit relative unit procedure.
• All unit recipes in a non-unit relative unit procedure.
• Batch 90 program for a unit relative class.
• Batch 90 program for a non-unit relative class.
• Control recipe.
• Segment of a control recipe.
• Unit of a control recipe.
• UDF program.
• Unit definition file.

Downloading Files to the Controller


• All unit recipes in a unit of a unit relative unit procedure.
• All unit recipes for all units of unit relative unit procedure.
• All unit recipes in a non-unit relative unit procedure.
• Batch 90 program for a unit relative class.
• Batch 90 program for a non-unit relative class.
• Control recipe.
• Segment of a control recipe.
• Unit of a control recipe.
• Unit recipe of a unit relative unit procedure.
• Unit recipe of a non-unit relative unit procedure.
• Unit recipe of a control recipe.
• UDF program.
• Unit definition file.

Importing Unit Procedures and Master Recipes


• Master recipe embedded within an ASCII project script.

2VAA001872-660 11-1
Script File 11. Script Language

• Master recipe from an ASCII file other than the ASCII project script.
• Unit procedure embedded within an ASCII project script.
• Unit procedure from an ASCII file other than the ASCII project script.

11.2 Script File


Each script file executes operations within a single project. Script files are divided into sections. The exact number of
sections in a script file depends on its purpose. The first section is always the project log-in section. The remaining sections
are optional and direct the Batch Data Manager (or other application) to perform specific tasks.
Script files can be executed individually from the command line, individually from a batch file, and in groups from a batch
file.

11.2.1 Script Command Line Syntax


There are two ways to utilize script files. One way is to execute the file from the DOS command line. The following code
provides the syntax required.

bdm script:script_file_name pw:user_password


where:
script_file_name Full DOS path to the script file.
user_password Password of the user name in the script file.
Example:
bdm script:script1.dat pw:bws
The other way is to start the script file from within a batch file. The following code provides the syntax required:

start /w[ait] bdm script:script_file_name pw:user_password


where:
script_file_name Full DOS path to the script file.
user_password Password of the user name in the script file.
Example:
start /w[ait] bdm script:script1.dat pw:bws
The wait option forces the batch file to wait until the script file completes execution before proceeding to the next line.

11.2.2 Script File Outline


The following portion of code represents the layout of a script file.
project <project_name>, user = user_name
application_name
options
option_key_word = option_value
option_key_word = option_value
.
.
.
option_key_word = option_value
end
task_name
object_key_word = object_name_x
end
end
end
where:
project Indicates the beginning of the project section.
project_name Name of the Batch Data Manager project.
user Indicates the start of a user name.
user_name Name of the person whose access characteristics
are used when executing this script.
application_name Name of the application (compiler, downloader,
etc.).
options Indicates the beginning of an options section.
option_key_word Name of the option (bcode, crossref, hexdump,
etc.).

11-2 2VAA001872-660
11. Script Language Compile Batch 90 Program

option_value Varies with the type of option.


end Indicates the end of a section.
task_name Name of the task (b90, delete, mre, etc.).
object_key_word Modifier to the task.
object_name_x Object of the task.

11.2.3 Compile Batch 90 Program


The following portion of code provides the scripting syntax for compiling Batch 90 programs:
compiler
options
bcode = bcode_setting
crossref = crossref_setting
hexdump = hexdump_setting
sp88_terminology = sp88_setting
nowarn = nowarn_setting
stack = stack_setting
symbol = symbol_setting
abort_script = abort_script_setting
version = version_number
end
b90
class = class_name
end
end
where:
bcode_setting Bcode is displayed in the listing file (enable or
disable).
crossref_setting A cross-reference table is generated in the listing
file (enable or disable).
hexdump_setting A hexadecimal dump is generated in the listing file
(enable or disable).
sp88_setting SP88 terminology is used (enable or disable).
nowarn_setting Disables displaying of warnings in the listing file
(enable or disable).
stack_setting Disables stack usage in the listing file (enable or
disable).
symbol_setting The symbol table is generated (enable or disable).
abort_script_setting The remainder of the script is executed if the task
fails (yes or no).
version_number Controller firmware version to use (6, 7, or 8).
class_name Name of the class.
Example:
project <d:\scripts>, user = "SYSTEM"
compiler
// Compile the alphas class program and all its units
// Use SP88 terminology and firmware version 7 so alpha
// recipe IDS can be used
options
sp88_terminology = enabled
version = 7
end
b90
class = alphas
end
end

// Compile the "ALL_ON" class program and all its units


// This sample uses all the flags the compiler supports
compiler
options
crossref = enable

2VAA001872-660 11-3
Compile UDF Program 11. Script Language

bcode = enable
stack = enable
hexdump = enable
nowarn = enable
symbol = enable
sp88_terminology = enable
abort_script = yes
version = 7
end
b90
class = all_on
end
end

// Compile the "defaults" class program and all its units


// This sample shows the default values for the compiler flags.
// If no flags are specified, the compiler will use the values
// of the flags as they appear in this example.
compiler
options
crossref = disable
bcode = disable
stack = disable
hexdump = disable
nowarn = disable
symbol = disable
sp88_terminology = disable
abort_script = no
version = 7
end
b90
class = defaults
end
end
end // end project

NOTE: The Batch 90 program and all units found in the class will be compiled.

11.2.4 Compile UDF Program


The following portion of code provides the scripting syntax for compiling UDF programs:
udfcompiler
options
bcode = bcode_setting
crossref = crossref_setting
hexdump = hexdump_setting
nowarn = nowarn_setting
stack = stack_setting
symbol = symbol_setting
version = version_number
abort_script = abort_script_setting
end
udf
udf = udf_name
end
end
where:
bcode_setting Bcode is displayed in the listing file (enable or
disable).
crossref_setting A cross-reference table is generated in the listing
file (enable or disable).
hexdump_setting A hexadecimal dump is generated in the listing
file (enable or disable).

11-4 2VAA001872-660
11. Script Language Compile Unit Recipe

nowarn_setting Disables displaying of warnings in the listing file


(enable or disable).
stack_setting Disables stack usage in the listing file (enable or
disable).
symbol_setting The symbol table is generated (enable or
disable).
version_number Controller firmware version to use (6 or 7).
abort_script_setting The remainder of the script is executed if the task
fails (yes or no).
udf_name Name (no path or extension) of the UDF
program.
Example:
project <D:\UDF>, user="SYSTEM"
udfcompiler
// Compile the udf1 program
// This sample uses all the flags the compiler supports
options
bcode = enable
version = 7
stack = enable
hexdump = enable
nowarn = enable
symbol = enable
abort_script = yes
end
udf
udf = udf1
end
end

udfcompiler
// Compile the udf2 program
// This sample shows the default values for the compiler flags.
// If no flags are specified, the compiler will use the values
// of the flags as they appear in this example.
options
bcode = disable
version = 7
stack = disable
hexdump = disable
nowarn = disable
symbol = disable
abort_script = no
end
udf
udf = udf2
end
end
end // end project

11.2.5 Compile Unit Recipe

For Unit Relative Unit Procedure


The following portion of code provides the scripting syntax for compiling a unit recipe for a unit relative unit procedure:
upe
options
abort_script = yes
end
upe_compile
unit_procedure = ur_up_name
unit = class_unit_name
unit_recipe = ur_name

2VAA001872-660 11-5
Compile Unit Recipe 11. Script Language

end
end
where:
ur_up_name Name of the unit relative unit procedure.
class_unit_name Name of the class unit (unit relative classes only).
ur_name Name of the unit relative unit recipe.
Example:
project <d:\ddrive>, user = <SYSTEM>
// Numeric ID, unit relative
upe
upe_compile
unit_procedure = ANYS.U01
unit = unit1
unit_recipe = 100
end
end

// Alpha ID, unit relative


upe
upe_compile
unit_procedure = alpha.u01
unit = unit1
unit_recipe = AlphaName
end
end
end

For Non-Unit Relative Unit Procedure


The following portion of code provides the scripting syntax for compiling a unit recipe for a non-unit relative unit procedure:
upe
options
abort_script = yes
end
upe_compile
unit_procedure = nur_up_name
loop = loop_number
pcu = pcu_number
module = module_number
block = block_number
unit_recipe = ur_name
end
end
where:
nur_up_name Name of the non-unit relative unit procedure.
loop_number Number of the loop.
pcu_number Number of the process control unit.
module_number Number of the controller.
block_number Number of the function block.
ur_name Name of the unit relative unit recipe.
Example:
project <d:\ddrive>, user = <SYSTEM>
// Alpha ID, non-unit relative
upe
upe_compile
unit_procedure = alphanur.U01
loop = 1
pcu = 59
module = 5
block = 250
unit_recipe = ALPHA100
end

11-6 2VAA001872-660
11. Script Language Create Master Recipe Train

end

// Numeric ID, non-unit relative


upe
upe_compile
unit_procedure = nur1595.u01
loop = 1
pcu = 61
module = 9
block = 2500
unit_recipe = 100
end
end
end

11.2.6 Create Master Recipe Train


The following portion of code provides the scripting syntax for creating a master recipe train:
mre
options
abort_script = yes
end
mre_compile
master_recipe = mr_name
train = train_name
// The following unit procedure assignments are required only for
// unit relative classes
unit_procedure = ur_up_name_1, unit = unit_1
unit_procedure = ur_up_name _2, unit = unit_2
.
.
.
unit_procedure = ur_up_name_n, unit = unit_n
// The following unit procedure assignments are required only for
// non-unit relative classes
unit_procedure = nur_up_name_1
unit_procedure = nur_up_name_2
.
.
.
unit_procedure = nur_up_name_n
end
end
where:
mr_name Name of the master recipe.
train_name Name of the train.
ur_up_name_x Name of the unit relative unit procedure.
unit_x Name of the class unit (unit relative classes only).
nur_up_name_x Name of the non-unit relative unit procedure.
Example:
project <d:\ddrive>, user = <SYSTEM>
// Numeric Recipe ID with unit relative classes
mre
// Create a train for a master recipe
mre_compile
master_recipe = goodsoup.m02
train = soup_train
// Assign unit procedure to class units
unit_procedure = weighing, unit = Weighing_5
unit_procedure = mixing, unit = Mixing_1
unit_procedure = filtering, unit = Filter_3
end
end // mre section

2VAA001872-660 11-7
Compile Control Recipe 11. Script Language

end // project section

11.2.7 Compile Control Recipe


The following portion of code provides the scripting syntax for compiling a control recipe for a master recipe:
mre
options
abort_script = yes
end
mre_compile
master_recipe = mr_name
train = train_name
control_recipe = cr_name
end
end
where:
mr_name Name of the master recipe.
train_name Name of the train.
cr_name Name of the control recipe.
Examples:
project <d:\ddrive>, user = <SYSTEM>
// Numeric Recipe ID with unit relative classes
mre
options
abort_script = yes
end

// Create a control recipe


mre_compile
master_recipe = GOODSOUP.M02
train = soup_train
control_recipe = 100
end

// Create another control recipe


mre_compile
master_recipe = GOODSOUP.M02
train = soup_train
control_recipe = 500
end
end
end

project <d:\ddrive>, user = <SYSTEM>


// Alpha Recipe ID with non-unit relative classes
mre
options
abort_script = yes
end

// Create a control recipe


mre_compile
master_recipe = MORESOUP.M02
train = another_soup_train
control_recipe = BEST_SOUP
end

// Create another control recipe


mre_compile
master_recipe = MORESOUP.M02
train = another_soup_train
control_recipe = SECOND_BEST
end
end

11-8 2VAA001872-660
11. Script Language Delete Unit Recipe

end

11.2.8 Delete Unit Recipe

From Unit Relative Unit Procedure


The following portion of code provides the scripting syntax for deleting a single unit recipe from a unit relative unit
procedure:
delete unit_recipe = ur_name
unit_procedure = up_name
unit = unit_name
end
where:
ur_name Name of the unit recipe.
up_name Name of the unit procedure.
unit_name Name of the unit.
Example:
project <d:\ddrive>, user = "SYSTEM"
downloader
// Delete a single unit recipe of a unit relative unit procedure
// Alpha ID
// Don’t abort the remainder of the script if this task fails
options
abort_script = no
end
delete unit_recipe = ALPHA100
unit_procedure = alpha.u01
unit = unit1
end
end

downloader
// Delete a single unit recipe of a unit relative unit procedure
// Numeric ID
// Don’t abort the remainder of the script if this task fails
options
abort_script = no
end
delete unit_recipe = 100
unit_procedure = anys.u01
unit = unit1
end
end
end

From Non-Unit Relative Unit Procedure


The following portion of code provides the scripting syntax for deleting a unit recipe from a non-unit relative unit procedure:
delete
unit_recipe = ur_name
unit_procedure = up_name
end
where:
ur_name Name of the unit recipe.
up_name Name of the unit procedure.
Example:
project <d:\ddrive>, user = "SYSTEM"
downloader
// Delete a non-unit relative unit recipe
// Numeric ID
// Don’t abort the remainder of the script if this task fails
options

2VAA001872-660 11-9
Delete All Unit Recipes 11. Script Language

abort_script = no
end
delete unit_recipe = 800
unit_procedure = nur1595.u01
end
end
end

From Control Recipe


The following portion of code provides the scripting syntax for deleting a single unit recipe of a control recipe:
delete master_recipe = mr_name
train = train_name
segment = segment_name
control_recipe = cr_name
unit_procedure = up_name
end
where:
mr_name Name of the master recipe.
train_name Name of the train.
segment_name Name of the segment.
cr_name Name of the control recipe.
up_name Name of the unit procedure.
Example:
project <d:\ddrive>, user = "SYSTEM"
downloader
// Delete a single unit recipe of a control recipe
// Numeric ID
// Abort the remainder of the script if this task fails
options
abort_script = yes
end
delete master_recipe = mr1.m01
train = TR1
segment = segment1
control_recipe = 100
unit_procedure = nur1
end
end
end

11.2.9 Delete All Unit Recipes

From a Unit
The following portion of code provides the scripting syntax for deleting all unit recipes in a unit of a unit relative unit
procedure:
delete unit_recipe = *
unit_procedure = up_name
unit = unit_name
end
where:
up_name Name of the unit procedure.
unit_name Name of the unit.
Example:
project <d:\ddrive>, user = "SYSTEM"
downloader
// Delete all unit recipes in a unit of a unit relative unit procedure
// Numeric ID
// Don’t abort the remainder of the script if this task fails
options

11-10 2VAA001872-660
11. Script Language Delete Batch 90 Program

abort_script = no
end
delete unit_recipe = *
unit_procedure = anys.u01
unit = unit1
end
end
end

From All Units


The following portion of code deletes all unit recipes in all units of a unit relative unit:
delete unit_recipe = *
unit_procedure = up_name
unit = *
end
where:
up_name Name of the unit procedure.
Example:
project <d:\ddrive>, user = "SYSTEM"
downloader
// Delete all unit recipes for all units of a unit relative unit procedure
// Numeric ID
// Don’t abort the remainder of the script if this task fails
options
abort_script = no
end
delete unit_recipe = *
unit_procedure = anys.u02
unit = *
end
end
end

From Non-Unit Relative Unit Procedure


The following portion of code deletes all unit recipes in a non-unit relative unit procedure:
delete unit_recipe = *
unit_procedure = up_name
end
where:
up_name Name of the unit procedure.
Example:
project <d:\ddrive>, user = "SYSTEM"
downloader
// Delete all unit recipes in a non-unit relative unit procedure
// Don’t abort the remainder of the script if this task fails
options
abort_script = no
end
delete unit_recipe = *
unit_procedure = nur1595.u02
end
end
end

11.2.10Delete Batch 90 Program

From Unit Relative Class


The following portion of code provides the scripting syntax for deleting the Batch 90 program for a unit relative class:
delete class = class_name

2VAA001872-660 11-11
Delete Control Recipe 11. Script Language

unit = unit_name
end
where:
class_name Name of the class.
unit_name Name of the unit.
Example:
project <d:\ddrive>, user = "SYSTEM"
downloader
// Delete the Batch 90 program for a unit relative class
// Don’t abort the remainder of the script if this task fails
options
abort_script = no
end
delete class = ALPHAS
unit = unit1
end
end
end

From Non-Unit Relative Class


The following portion of code provides the scripting syntax for deleting the Batch 90 program for a non-unit relative class:
delete class = class_name
loop = loop_number
pcu = pcu_number
module = module_number
end
where:
class_name Name of the class.
loop_number Number of the loop.
pcu_number Number of the process control unit.
module_number Number of the controller.
Example:
project <d:\ddrive>, user = "SYSTEM"
downloader
// Delete the Batch 90 program for a non-unit relative class
delete class = NURANYS
loop = 1
pcu = 59
module = 5
end
end
end

11.2.11Delete Control Recipe


The following portion of code provides the scripting syntax for deleting an entire control recipe:
delete master_recipe = mr_name
train = train_name
control_recipe = cr_name
unit_procedure = up_name
end
where:
mr_name Name of the master recipe.
train_name Name of the train.
cr_name Name of the control recipe.
up_name Name of unit procedure.
Example:
project <d:\ddrive>, user = "SYSTEM"

11-12 2VAA001872-660
11. Script Language Delete Segment

downloader
// Delete an entire control recipe
// Numeric ID
// Don’t abort the remainder of the script if this task fails
options
abort_script = no
end
delete master_recipe = mr1.m01
train = TR1
control_recipe = 100
unit_procedure = anys1
end
end
end

11.2.12Delete Segment
The following portion of code provides the scripting syntax for deleting an entire segment of a control recipe:
delete master_recipe = mr_name
train = train_name
control_recipe = cr_name
segment = segment_name
end
where:
mr_name Name of the master recipe.
train_name Name of the train.
cr_name Name of the control recipe.
segment_name Name of the segment.
Example:
project <d:\ddrive>, user = "SYSTEM"
downloader
// Delete an entire segment of a control recipe
// Numeric ID
// Don’t abort the remainder of the script if this task fails
options
abort_script = no
end
delete master_recipe = mr1.m01
train = TR1
control_recipe = 100
segment = seg2
end
end
end

11.2.13Delete Unit
The following portion of code provides the scripting syntax for deleting an entire unit of a control recipe:
delete master_recipe = mr_name
train = train_name
control_recipe = cr_name
unit_procedure = up_name
end
where:
mr_name Name of the master recipe.
train_name Name of the train.
cr_name Name of the control recipe.
segment_name Name of the segment.
Example:
project <d:\ddrive>, user = "SYSTEM"
downloader

2VAA001872-660 11-13
Delete UDF Program 11. Script Language

// Delete an entire unit of a control recipe


// Numeric ID
// Don’t abort the remainder of the script if this task fails
options
abort_script = no
end
delete master_recipe = mr1.m01
train = TR1
control_recipe = 100
unit_procedure = anys1
end
end
end

11.2.14Delete UDF Program


The following portion of code provides the scripting syntax for deleting a UDF program:
delete
udf = udf_name
loop = loop_number
pcu = pcu_number
module = module_number
end
where:
udf_name Name of the UDF program.
loop_number Number of the loop.
pcu_number Number of the process control unit.
module_number Number of the controller.
Example:
project <d:\udf>, user = "SYSTEM"
downloader
/* Delete a UDF program */
options
abort_script = yes
end
delete udf = TESTUDF
loop = 1
pcu = 59
module = 5
end
end
end

11.2.15Delete Unit Definition File


The following portion of code provides the scripting syntax for deleting a unit definition file:
delete unit = unit_name
class = class_name
end
where:
unit_name Name of the unit.
class_name Name of the class.
Example:
project <d:\ddrive>, user = "SYSTEM"
downloader
// Delete a unit definition file
delete unit = unit1
class = ALPHAS
end
end
end

11-14 2VAA001872-660
11. Script Language Download All Unit Recipes

11.2.16Download All Unit Recipes

For Unit
The following portion of code provides scripting syntax for downloading all unit recipes in a unit of a unit relative unit
procedure:
download unit_recipe = *
unit_procedure = up_name
unit = unit_name
end
where:
up_name Name of the unit procedure.
unit_name Name of the unit.
Example:
project <d:\ddrive>, user = "SYSTEM"
downloader
// Download all unit recipes in a unit of a unit relative unit procedure
// Don’t download if the unit recipe preexists in controller
// Don’t abort the remainder of the script if this task fails
options
abort_script = no
overwrite_if_exists = no
end
download unit_recipe = *
unit_procedure = anys.u01
unit = unit1
end
end
end

NOTE: Use the overwrite_if_exists option when downloading files. This option controls what is done if the files being
downloaded already exist in the controller. Valid settings for this option are yes, no, and prompt.

For All Units


The following portion of code provides the scripting syntax for downloading all unit recipes for all units of a unit relative unit
procedure:
download unit_recipe = *
unit_procedure = up_name
unit = *
end
where:
up_name Name of the unit procedure.
Example:
project <d:\ddrive>, user = "SYSTEM"
downloader
// Download all unit recipes for all units of a unit relative
// unit procedure
// Don’t download if the unit recipe preexists in controller
// Abort the remainder of the script if this task fails
options
abort_script = no
overwrite_if_exists = no
end
download unit_recipe = *
unit_procedure = anys.u02
unit = *
end
end
end

2VAA001872-660 11-15
Download Batch 90 Program 11. Script Language

For Non-Unit Relative Unit Procedure


The following portion of code provides the scripting syntax for downloading all unit recipes in a non-unit relative unit
procedure:
download unit_recipe = *
unit_procedure = up_name
end
where:
up_name Name of the unit procedure.
Example:
project <d:\ddrive>, user = "SYSTEM"
downloader
// Download all unit recipes in a non-unit relative unit procedure
// Prompt if the unit recipe preexists in controller
options
overwrite_if_exists = prompt
end
download
unit_recipe = *
unit_procedure = nur1595.u02
end
end
end

11.2.17Download Batch 90 Program

For Unit Relative Class


The following portion of code provides the scripting syntax for downloading the Batch 90 program for a unit relative class:
download class = class_name
unit = unit_name
end
where:
class_name Name of the class.
unit_name Name of the unit.
Example:
project <d:\ddrive>, user = "SYSTEM"
downloader
// Download the B90 program for a unit relative class
// Don’t download if the unit recipe preexists in controller
// Don’t abort the remainder of the script if this task fails
options
abort_script = no
overwrite_if_exists = no
end
download class = ALPHAS
unit = unit1
end
end
end

11.2.18For Non-Unit Relative Class


The following portion of code provides the scripting syntax for downloading the Batch 90 program for a non-unit relative
class:
download class = class_name
loop = loop_number
pcu = pcu_number
module = module_number
end

11-16 2VAA001872-660
11. Script Language Download Control Recipe

where:
class_name Name of the class.
loop_number Number of the loop.
pcu_number Number of the process control unit.
module_number Number of the controller.
Example:
project <d:\ddrive>, user = "SYSTEM"
downloader
// Download the Batch 90 program for a non-unit relative class
// Don’t download if the unit recipe preexists in controller
// Don’t abort the remainder of the script if this task fails
options
abort_script = no
overwrite_if_exists = no
end
download class = NURANYS
loop = 1
pcu = 59
module = 5
end
end
end

11.2.19Download Control Recipe


The following portion of code provides the scripting syntax for downloading an entire control recipe:
download master_recipe = mr_name
train = train_name
control_recipe = cr_name
end
where:
mr_name Name of the master recipe.
train_name Name of the train.
cr_name Name of the control recipe.
Example:
project <d:\ddrive>, user = "SYSTEM"
downloader
// Download an entire control recipe
// Numeric ID
// Don’t download if the unit recipe preexists in controller
// Don’t abort the remainder of the script if this task fails
options
abort_script = no
overwrite_if_exists = no
end
download master_recipe = mr1.m01
train = TR1
control_recipe = 100
end
end
end

11.2.20Download Segment
The following portion of code provides the scripting syntax for downloading an entire segment of a control recipe:
download master_recipe = mr_name
train = train_name
control_recipe = cr_name
segment = segment_name
end

2VAA001872-660 11-17
Download Unit 11. Script Language

where:
mr_name Name of the master recipe.
train_name Name of the train.
cr_name Name of the control recipe.
segment_name Name of the segment.
Example:
project <d:\ddrive>, user = "SYSTEM"
downloader
// Download an entire segment of a control recipe
// Numeric ID
// Don’t download if the unit recipe preexists in controller
// Don’t abort the remainder of the script if this task fails
options
abort_script = no
overwrite_if_exists = no
end
download master_recipe = mr1.m01
train = TR1
control_recipe = 100
segment = seg2
end
end
end

11.2.21Download Unit
The following portion of code provides the scripting syntax for downloading an entire unit of a control recipe:
download master_recipe = mr_name
train = train_name
control_recipe = cr_name
unit_procedure = up_name
end
where:
mr_name Name of the master recipe.
train_name Name of the train.
cr_name Name of the control recipe.
up_name Name of the unit procedure.
Example:
project <d:\ddrive>, user = "SYSTEM"
downloader
// Download an entire unit of a control recipe
// Numeric ID
// Don’t abort the remainder of the script if this task fails
// Overwrite the unit recipe without prompting if it preexists in controller
options
abort_script = no
overwrite_if_exists = yes
end
download master_recipe = mr1.m01
train = TR1
control_recipe = 100
unit_procedure = anys1
end
end
end

11.2.22Download Unit Recipe

For Unit Relative Unit Procedure


The following portion of code provides the scripting syntax for downloading a single unit recipe of a unit relative unit
procedure:

11-18 2VAA001872-660
11. Script Language Download Unit Recipe

download unit_recipe = ur_name


unit_procedure = up_name
unit = unit_name
end
where:
ur_name Name of the unit recipe.
up_name Name of the unit procedure.
unit_name Name of the unit.
Example:
project <d:\ddrive>, user = "SYSTEM"
downloader
// Download a single unit recipe of a unit relative unit procedure
// Numeric ID type
// Prompt user if the unit recipe preexists in controller
// Don’t abort the remainder of the script if this task fails
options
abort_script = no
overwrite_if_exists = prompt
end
download unit_recipe = 100
unit_procedure = anys.u01
unit = unit1
end
end

downloader
// Download a single unit recipe of a unit relative unit procedure
// Alpha ID type
// Don’t download if the unit recipe preexists in controller
// Don’t abort the remainder of the script if this task fails
options
abort_script = no
overwrite_if_exists = no
end
download unit_recipe = ALPHA100
unit_procedure = alpha.u01
unit = unit1
end
end
end

For Non-Unit Relative Unit Procedure


The following portion of code provides the scripting syntax for downloading a non-unit relative unit recipe for a non-unit
relative unit procedure:
download unit_recipe = ur_name
unit_procedure = up_name
end
where:
ur_name Name of the unit recipe.
up_name Name of the unit procedure.
Example:
project <d:\ddrive>, user = "SYSTEM"
downloader
// Download a non-unit relative unit recipe
// Don’t download if the unit recipe preexists in controller
// Numeric ID
// Don’t abort the remainder of the script if this task fails
options
abort_script = no
overwrite_if_exists = no
end

2VAA001872-660 11-19
Download UDF Program 11. Script Language

download
unit_recipe = 800
unit_procedure = nur1595.u01
end
end
end

For a Control Recipe


The following portion of code provides the scripting syntax for downloading a single unit recipe of a control recipe:
download master_recipe = mr_name
train = train_name
segment = segment_name
control_recipe = cr_name
unit_procedure = up_name
end
where:
mr_name Name of the master recipe.
train_name Name of the train.
segment_name Name of the segment.
cr_name Name of the control recipe.
up_name Name of the unit procedure.
Example:
project <d:\ddrive>, user = "SYSTEM"
downloader
// Download a single unit recipe of a control recipe
// Numeric ID
// Don’t download if the unit recipe preexists in controller
// Don’t abort the remainder of the script if this task fails
options
abort_script = no
overwrite_if_exists = no
end
download master_recipe = mr1.m01
train = TR1
segment = segment1
control_recipe = 100
unit_procedure = nur1
end
end
end

11.2.23Download UDF Program


The following portion of code provides the scripting syntax for downloading a UDF program:
download udf = udf_name
loop = loop_number
pcu = pcu_number
module = module_number
end
where:
udf_name Name of the UDF program.
loop_number Number of the loop.
pcu_number Number of the process control unit.
module_number Number of the controller.
Example:
project <d:\udf>, user="SYSTEM"
downloader
/* Download a UDF program */
options
abort_script = no

11-20 2VAA001872-660
11. Script Language Download Unit Definition File

end
download udf = TESTUDF
loop = 1
pcu = 59
module = 5
end
end
end

11.2.24Download Unit Definition File


The following portion of code provides the scripting syntax for downloading a unit definition file:
download unit = unit_name
class = class_name
end
where:
unit_name Name of the unit.
class_name Name of the class.
Example:
project <d:\ddrive>, user = "SYSTEM"
downloader
// Download a unit definition file
download unit = unit1
class = ALPHAS
end
end
end

11.2.25Import Master Recipe

From ASCII Project Script


The following portion of code provides the scripting syntax for importing (and converting) a master recipe embedded within
an ASCII project script into the Batch Data Manager:
options
abort_script = yes
end
ascii_master_recipe
(Refer to ASCII Master Recipe Script for more information.)
end

From Other ASCII File


The following portion of code provides the scripting syntax for importing (and converting) a master recipe from an ASCII file
other than the ASCII project script into the Batch Data Manager:
bdm
options
abort_script = yes
end
import master_recipe
file = <file_name>
end_import or end
end
where:
file_name Valid path and name of the ASCII file to import. This file
should contain an ASCII master recipe only.
Example:
project <d:\ddrive>, user = "SYSTEM"
// Abort the remainder of the script if it fails
bdm
options
abort_script = yes

2VAA001872-660 11-21
Import Unit Procedure 11. Script Language

end
// Import the file d:\scripts\recipe1.txt into a master recipe database
import master_recipe
file = <d:\scripts\recipe1.txt>
end
end
// Import the file d:\scripts\recipe2.txt into a master recipe database
bdm
import master_recipe
file = <d:\scripts\recipe2.txt>
end
end
end

11.2.26Import Unit Procedure

From ASCII Project Script


The following portion of code provides the scripting syntax for importing (and converting) a unit procedure embedded within
an ASCII project script into the Batch Data Manager:
options
abort_script = yes
end
ascii_recipe
(Refer to ASCII Unit Procedure Script for more information.)
end

From Other ASCII File


The following portion of code imports (and converts) a unit procedure from an ASCII file other than the ASCII project script
into the Batch Data Manager:
bdm
options
abort_script = yes
end
import
file = <file_name>
end_import or end
end
where:
file_name Valid path and name of the ASCII file to import.
This file should contain an ASCII unit procedure
only.
Example:
project <d:\ddrive>, user = "SYSTEM"
// Import the file d:\scripts\recipe1.txt into a unit procedure database
// Abort the remainder of the script if it fails
bdm
options
abort_script = yes
end // end of options
import
file = <d:\scripts\recipe1.txt>
end // end of import
end // end of bdm
// Import the file d:\scripts\recipe2.txt into a unit procedure database
bdm
import
file = <d:\scripts\recipe2.txt>
end // end of import
end // end of bdm
end // end of project

11-22 2VAA001872-660
11. Script Language ASCII Unit Procedure Script

11.3 ASCII Unit Procedure Script


The Batch Data Manager software supplies an ASCII unit procedure file conversion utility. A single ASCII file will be the
input to this utility. A unit procedure database is created and an event is sent to the batch archive log after a successful
conversion. A script_file_name.ERR file is created in the event an error is found during the conversion. This .ERR file will
indicate any syntactical errors. A text editor is automatically invoked when an error occurs permitting the viewing of the
.ERR file contents.
During conversion, any missing arguments are given default values in the resulting database. The order of the arguments is
not important as arguments are matched by name. Operation and phase numbering will be sequential based on order in the
file.

11.3.1 Keywords
Table 11-1 lists and explains the important words that appear in unit procedure scripts.

Table 11-1: Unit Procedure Script Keywords

Keyword Description

ascii_recipe Indicates the beginning of a master recipe script.

class Indicates a class name follows.

comment Indicates the beginning of a bracketed comment.

description Indicates the recipe description.

end Indicates the end of the current section of code.

operation Indicates an operation name follows.

phase Indicates a phase name follows.

super_phase Indicates a super phase name follows.

unit_param Indicates the beginning of a unit parameters section.

unit_procedure Indicates a unit procedure name follows.

11.3.2 Comments
Two comment styles are supported:
// Remainder of line is a comment
/* */, { } Enclosed characters are comments
Nested comments are not supported.

11.3.3 Unit Procedure Section


The following code provides the scripting syntax of a unit procedure section:
unit procedure = up_name, class = class_name
comment = {comment_text}
description
text = “Recipe Description”
end
unit_param
...
end
operation = operation_name
...
end
.
.
.
end
where:
up_name Name of the unit procedure.

2VAA001872-660 11-23
Unit Parameters Section 11. Script Language

class_name Name of the class of unit procedure. Class must


already exist in class library.
Recipe Description Recipe description assigned to the unit procedure
and recipe file in the controller.
comment_text Unit procedure comment text. If this text is not
found before the unit_param word, the default
comment from the Batch 90 program will be used
as the unit procedure comment.
operation_name Name or number of the operation.

11.3.4 Unit Parameters Section


Nested within the unit parameters section are the unit parameter names (arguments) and values to be used. The names
must be unique and must match the name of a unit parameter in the symbol table database. The corresponding value must
be of an appropriate argument type and within the valid range of values for the type and argument. The range of a value
may depend on a selection list or a limit (high and/or low) imposed when the Batch 90 program was written. Full error
checking will be done. The valid types for use in the unit parameters section are:
ANYargument_name = (lo < value < hi)
- or -
ANYargument_name = selection_list_item
where:
argument_name Name of the argument.
lo Low limit (optional).
value Initial value (optional).
hi Hi limit (optional).
selection_list_item Item from the provided selection list that is valid.
STRINGargument_name = "string_value"
- or -
STRINGargument_name = selection_list_item
where:
argument_name Name of the argument.
string_value Explicit text value.
selection_list_item Item from the provided selection list that is valid.
CSEQargument_name = class_name, unit_name
- or -
CSEQargument_name = block_name
where:
argument_name Name of the argument.
class_name Name of the class of the unit. The class must exist
in the class library and be valid.
unit_name Name of the unit. The unit must exist in the class
(not necessary for non-unit relative classes).
block_name Name of the CSEQ function block specified in the
CSEQ list file or in a selection list specified for the
argument.

11.3.5 Operation Section


The operation section defines the name of the operation. The operation will be numbered based on the position in the ASCII
file. The number of phases contained in an operation section can range from zero to the MAX_PARALLEL value.
The following code provides the scripting syntax of an operation section:
operation = operation_name
comment = {comment_text}
.
.
.

11-24 2VAA001872-660
11. Script Language Phase Section

end
where:
operation_name Name of the operation.
comment_text Phase comment text. The last comment found
before the end is reached overwrites the default
comment. If this text is not found, the default
comment from the class will be used.

11.3.6 Phase Section


The phase section defines the phase and any or all of its parameters. Phases are numbered sequentially based on the
order in which they occur in the operation. A NULL phase can be used as a placeholder to support super phases.
Phases are inserted into the unit procedures with all default values and default comment. Arguments must overridden to
change their value to something other than default values. The Batch Data Manager scans for these override statements
which may appear in any order. Any, all, or none of the arguments may be overridden.
The following code provides the scripting syntax of a phase section:
phase = phase_name
comment = {comment_text}
.
.
.
end
where:
phase_name Name of the phase. Phase must already exist in
symbol table. NULL can used as a placeholder to
support super phases.
comment_text Phase comment text. The last comment found
before the end is reached overwrites the default
comment. If this text is not found, the default
comment from the class will be used.
The valid types of arguments for use in phase sections are:
ANYargument_name = (lo < value < hi)
- or -
ANYargument_name = selection_list_item
where:
argument_name Name of the argument.
lo Low limit (optional).
value Initial value (optional).
hi Hi limit (optional).
selection_list_item Item from the provided selection list that is valid.

STRINGargument_name = "string_value"
- or -
STRINGargument_name = selection_list_item
where:
argument_name Name of the argument.
string_value Explicit text value.
selection_list_item Item from the provided selection list that is valid.

CSEQargument_name = argument_value
where:
argument_name Name of the argument.
argument_value Name of any CSEQ function block that is valid for
this argument.

BLOCKSargument_name = argument_value
where:
argument_name Name of the argument.

2VAA001872-660 11-25
Super Phase Section 11. Script Language

argument_value Name of any function block that is valid for this


argument.

11.3.7 Super Phase Section


The super phase section identifies a phase as being a super phase. A super phase declaration must appear in all
operations it will use in the recipe. A modifier must always be used in a super phase declaration. The modifier indicates
whether this is the starting, continuation, or stopping operation.
Arguments may only appear in the starting operation of a super phase. The argument and comment rules are the same for
a normal phase.
The following code provides the scripting syntax of a super phase section:
super_phase = phase_name, modifier
comment = {comment_text}
end
where:
phase_name Name of the super phase.
modifier start, continued, or stop.
comment_text Super phase comment text.

11.3.8 Example
/* Example script for ASCII unit procedure feature */
project "d:\test_prj", user = ADAMS
/* Start of the ASCII unit procedure section */
ascii_recipe
options
abort_script = yes
end

unit procedure = T_script, class = example // example.b90 is the class


comment = {Unit Procedure comment from the ASCII script}

description
text = “T_script example”
end

unit_param
up_index00_cseq_list_all = example, unit4
//
// The following value comes from the file cseq list which was
// created to hold the list of valid cseq values
//
up_index01_cseq_listfile = listfile_data_cseq_blk_02
up_index02_cseq_list_of_1 = example, unit1
//
// nur is a Non-Unit Relative class therefore no Unit is needed
//
up_index03_cseq_no_value = nur
up_index04_cseq_a_few_classes = example, unit2
up_index05_any_no_values_entered = ( < 3 < )
up_index06_anyhihi_lolo_only = ( < 6 < 7)
up_index07_anyhihi_lo_only = ( < 6 < 7)
up_index08_anyhihi_val_only = (.5 < .6 < )
up_index09_anyhihi_hi_only = (12 < 13 < 14)
up_index10_anyhihi_hihi_only = (-9 < -8 < -7)
up_index11_any_single_pick_list = ( < 1 < )
up_index12_any_pick_list = batch_data_const_02
up_index13_string_no_value = " A Test Value"
up_index14_string_21long_default = "New String Value"
up_index15_string_1nullpick = batch_data_const_string03
up_index16_string_picklist____80 = batch_data_const_string04
end

operation = ESTOP

11-26 2VAA001872-660
11. Script Language Example

phase = pick_list_test
comment = {
This will appear as the comment for this phase
notice the comment = format does not nest.
}
end // phase end
end // Operation

operation = operation_1
phase = pick_list_test
comment = {This will show how you insert a phase without
changing a thing}
end // phase end

// This is the format for a super phase


//
super_phase = no_defaults_test, start
comment = {Super phase of no_defaults_test, no parameters entered}
end

phase = pick_list_test
end // phase no_default_test

phase = pick_list_test
comment = {Skip a number of the parameters and change the
order around this is legal in the script. The default value
will be entered for each of the parameters not
assigned here}
arg_15_rbuf = batch_data_rbuf_blk_00
arg_04_block = batch_data_block_rdemux_00_out4
arg_01_any = (< -123 < -12.3)
arg_06_cseq = unit_data_cseq_blk_00
arg_09_string = "Test value instead of the Default"
arg_07_remset = batch_data_remset_blk_00
arg_10_text = unit_data_text_blk_00 // Use the same value
arg_13_block = unit_data_block_blk_01
arg_11_any = batch_data_const_03
arg_14_cseq = unit_data_cseq_blk_01
end // phase
end // Operation

operation = operation_2
phase = pick_list_test
end // phase

// This is the format for a super phase continue, notice that you
// must maintain the same phase orientation (Second phase
// in operation)
super_phase = no_defaults_test, continue
// A comment = {} here will overwrite the comment with start
end
end // Operation

operation = operation_3
phase = NULL
// Place holder for the super phase
end

// This is the format for the end of a super phase


//
super_phase = no_defaults_test, stop
// Terminate our super phase here notice it is the second
// phase again
end

phase = no_defaults_test

2VAA001872-660 11-27
ASCII Master Recipe Script 11. Script Language

arg_00_cseq = batch_data_cseq_blk_00
arg_01_any = (-9876 < 123 < 9876)
arg_02_aol = unit_data_aol_blk_01
arg_03_apid = unit_data_apid_blk_00
arg_04_bbuf = unit_data_bbuf_01_out2
arg_05_block = unit_data_block_rdemux_00_out3
arg_06_cs = batch_data_cs_blk_00
arg_07_cseq = unit_data_cseq_blk_01
arg_08_dataexpt = unit_data_dataexpt_blk_01
arg_09_dd = batch_data_dd_blk_00
arg_10_dol = batch_data_dol_blk_00
arg_11_msdd = batch_data_msdd_blk_00
arg_12_rbuf = unit_data_rbuf_blk_01_out2
arg_13_rcm = unit_data_rcm_blk_01
arg_14_remset = unit_data_remset_blk_00
arg_15_rmc = unit_data_rmc_blk_01
arg_16_smith = batch_data_smith_blk_00
arg_17_string = "String default for this now"
arg_18_text = batch_data_text_blk_00
end // phase

end // Operation
end // Unit procedure
end // ASCII unit recipe script
end // project

11.4 ASCII Master Recipe Script


The Batch Data Manager software supplies an ASCII file master recipe import utility. A master recipe database is created
and an event is sent to the batch archive log after a successful conversion. A script_file_name.ERR file is created in the
event an error is found during the conversion. This .ERR file will indicate any syntactical errors. A text editor is automatically
invoked when an error occurs permitting the viewing of the .ERR file contents.
During conversion, any missing arguments are given default value in the resulting database. The order of the arguments is
not important as arguments are matched by name. Unit procedure, operation, and phase numbering will be sequential,
based on order in the file.

11.4.1 Keywords
Table 11-2 lists and explains the important words that appear in master recipe scripts.

Table 11-2: Master Recipe Script Keywords

Keyword Description

ascii_master_recipe Indicates the beginning of a master recipe script.

class Indicates a class name follows.

comment Indicates the beginning of a bracketed comment.

description Indicates the recipe description.

end Indicates the end of the current section of code.

operation Indicates an operation name follows.

phase Indicates a phase name follows.

segment Indicates a segment name follows.

super_phase Indicates a super phase name follows.

unit_param Indicates the beginning of a unit parameters section.

unit_procedure Indicates a unit procedure name follows.

11.4.2 Comments
Two comment styles are supported:

11-28 2VAA001872-660
11. Script Language Segment Section

// Remainder of line is a comment.


/* */, { } Enclosed characters are comments.
Nested comments are not supported.

11.4.3 Segment Section


The following code provides the scripting syntax of a segment section:
description
text = “Recipe Description”
end
segment = segment_name
.
.
.
end
where:
Recipe Description Recipe description assigned to the master
procedure and recipe file in the controller.
segment_name Name of the segment.

11.4.4 Unit Procedure Section


The following code provides the scripting syntax of a unit procedure section:
unit procedure = up_name, class = class_name
comment = {comment_text}
description
text = “Recipe Description”
end

unit_param
...
end
operation = operation_name
...
end
.
.
.
end
where:
up_name Name of the unit procedure.
class_name Name of the class of unit procedure. Class must
already exist in class library.
comment_text Unit procedure comment text. If this text is not
found before the unit_param word, the default
comment from the Batch 90 program will be used
as the unit procedure comment.
Recipe Description Recipe description assigned to the master
procedure and recipe file in the controller.
operation_name Name or number of the operation.

11.4.5 Unit Parameters Section


Nested within the unit parameters section are the unit parameter names (arguments) and values to be used. The names
must be unique and must match the name of a unit parameter in the symbol table database. The corresponding value must
be of an appropriate argument type and within the valid range of values for the type and argument. The range of a value
may depend on a selection list or a limit (high and/or low) imposed when the Batch 90 program was written. Full error
checking will be done. The valid types for use in the unit parameters section are:
ANYargument_name = (lo < value < hi)
- or -
ANYargument_name = selection_list_item

2VAA001872-660 11-29
Operation Section 11. Script Language

where:
argument_name Name of the argument.
lo Low limit (optional).
value Initial value (optional).
hi Hi limit (optional).
selection_list_item Item from the provided selection list
that is valid.
STRINGargument_name = "string_value"
- or -
STRINGargument_name = selection_list_item
where:
argument_name Name of the argument.
string_value Explicit text value.
selection_list_item Item from the provided selection list
that is valid.
CSEQargument_name = class_name, unit_name
- or -
CSEQargument_name = block_name
where:
argument_name Name of the argument.
class_name Name of the class of the unit. The class must exist
in the class library and be valid.
unit_name Name of the unit. The unit must exist in the class
(not necessary for non-unit relative classes).
block_name Name of the CSEQ function block specified in the
CSEQ list file or in a selection list specified for the
argument.

11.4.6 Operation Section


The operation section defines the name of the operation. The operation will be numbered based on the position in the ASCII
file. The number of phases contained in an operation section can range from zero to the MAX_PARALLEL value.
The following code provides the scripting syntax of an operation section:
operation = operation_name
comment = {comment_text}
.
.
.
end
where:
operation_name Name of the operation.
comment_text Phase comment text. The last comment found
before the end is reached overwrites the default
comment. If this text is not found, the default
comment from the class will be used.

11.4.7 Phase Section


The phase section defines the phase and any or all of its parameters. The phases are numbered sequentially based on
order in which they occur in the operation. A NULL phase can be used as a placeholder to support super phases.
Phases are inserted into the unit procedures with all default values and default comment. Arguments must be overridden to
change their value to something other than default values. The Batch Data Manager scans for these override statements
which may appear in any order. Any, all, or none of the arguments may be overridden.
The following code provides the scripting syntax of a phase section:
phase = phase_name
comment = {comment_text}

11-30 2VAA001872-660
11. Script Language Super Phase Section

.
.
.
end
where:
phase_name Name of the phase. Phase must already exist in
symbol table. NULL can be used as a placeholder
to support super phases.
comment_text Phase comment text. The last comment found
before the end is reached overwrites the default
comment. If this text is not found, the default
comment from the class will be used.
The valid types of arguments for use in phase sections are:
ANYargument_name = (lo < value < hi)
- or -
ANYargument_name = selection_list_item
where:
argument_name Name of the argument.
lo Low limit (optional).
value Initial value (optional).
hi Hi limit (optional).
selection_list_item Item from the provided selection list that is valid.
STRINGargument_name = "string_value"
- or -
STRINGargument_name = selection_list_item
where:
argument_name Name of the argument.
string_value Explicit text value.
selection_list_item Item from the provided selection list that is valid.
CSEQargument_name = argument_value
where:
argument_name Name of the argument.
argument_value Name of any CSEQ function block that is valid for
this argument.
BLOCKSargument_name = argument_value
where:
argument_name Name of the argument.
argument_value Name of any function block that is valid for this
argument.

11.4.8 Super Phase Section


The super phase section identifies a phase as being a super phase. A super phase declaration must appear in all
operations it will use in the recipe. A modifier must always be used in a super phase declaration. The modifier indicates
whether this is the starting, continuation, or stopping operation.
Arguments may only appear in the starting operation of a super phase. The argument and comment rules are the same for
a normal phase.
The following code provides the scripting syntax of a super phase section:
super_phase = phase_name, modifier
comment = {comment_text}
end
where:
phase_name Name of the super phase.
modifier start, continued, or stop.
comment_text Super phase comment text.

2VAA001872-660 11-31
Example 11. Script Language

11.4.9 Example
// Sample of ASCII master recipe with two segments with two unit procedures
project "d:\test_prj", user = ADAMS
/* Start of the ASCII master recipe section */
ascii_master_recipe
options
abort_script = yes
end
// Assign a name to the master recipe
master_recipe = MR_Test
description
text = “T_script example”
end

// Start of first segment


segment = SEGMENT_NAME_1
// Start of first unit procedure in segment one
unit procedure = UP_NAME_1, class = CL_NAME_1
description
text = “T_script example”
end

comment = {Unit Procedure comment from the ASCII script}


unit_param
// Insert Unit Parameter Data Here
end

operation = ESTOP
phase = PHASE_NAME_1
comment = {Comment for PHASE_NAME_1}
end // Phase
end // Operation

operation = OP_NAME_1
phase = PHASE_NAME_2
comment = {Comment for PHASE_NAME_2}
end // Phase

phase = PHASE_NAME_3
comment = {Comment for PHASE_NAME_3}
end // Phase
end // Operation

operation = OP_NAME_2
phase = PHASE_NAME_4
comment = {Comment for PHASE_NAME_4}
end // Phase

phase = PHASE_NAME_5
comment = {Comment for PHASE_NAME_5}
end // Phase

phase = PHASE_NAME_6
comment = {Comment for PHASE_NAME_6}
end // Phase
end // Operation
end // End of first unit procedure in segment one

// Start of second unit procedure in segment one


unit procedure = UP_NAME_2, class = CL_NAME_2
comment = {Unit Procedure comment from the ASCII script}
unit_param
(Insert Unit Parameter Data Here)
end
operation = ESTOP

11-32 2VAA001872-660
11. Script Language Example

phase = PHASE_NAME_1
comment = {Comment for PHASE_NAME_1}
end // Phase
end // Operation

operation = OP_NAME_1
phase = PHASE_NAME_2
comment = {Comment for PHASE_NAME_2}
end // Phase
phase = PHASE_NAME_3
comment = {Comment for PHASE_NAME_3}
end // Phase
phase = PHASE_NAME_4
comment = {Comment for PHASE_NAME_4}
end // Phase
end // Operation
end // End of second unit procedure in segment one
end // End of first segment

// Start of second segment


segment = SEGMENT_NAME_2

// Start of first unit procedure in segment two


unit procedure = UP_NAME_1, class = CL_NAME_1
comment = {Unit Procedure comment from the ASCII script}
unit_param
(Insert Unit Parameter Data Here)
end

operation = ESTOP
phase = PHASE_NAME_1
comment = {Comment for PHASE_NAME_1}
end // Phase
end // Operation

operation = OP_NAME_1
phase = PHASE_NAME_2
comment = {Comment for PHASE_NAME_2}
end // Phase
end // Operation

operation = OP_NAME_2
phase = PHASE_NAME_3
comment = {Comment for PHASE_NAME_3}
end // Phase
end // Operation

operation = OP_NAME_3
phase = PHASE_NAME_4
comment = {Comment for PHASE_NAME_4}
end // Phase
end // Operation
end // end of first unit procedure in segment two

// Start of second unit procedure in segment two


unit procedure = UP_NAME_2, class = CL_NAME_2
comment = {Unit Procedure comment from the ASCII script}
unit_param
(Insert Unit Parameter Data Here)
end

operation = ESTOP
phase = PHASE_NAME_1
comment = {Comment for PHASE_NAME_1}
end // Phase
end // Operation

2VAA001872-660 11-33
Example 11. Script Language

operation = OP_NAME_1
phase = PHASE_NAME_2
comment = {Comment for PHASE_NAME_2}
end // Phase
phase = PHASE_NAME_3
comment = {Comment for PHASE_NAME_3}
end // Phase
end // Operation

operation = OP_NAME_2
phase = PHASE_NAME_3
comment = {Comment for PHASE_NAME_3}
end // Phase
phase = PHASE_NAME_4
comment = {Comment for PHASE_NAME_4}
end // Phase
end // Operation
end // End of second unit procedure in segment two
end // End of second segment
end // ASCII master recipe script
end // project
Although the structure and data within the unit procedures can vary between segments, the unit procedure names and their
associated classes cannot. For example, assume segment one has unit procedures proc1, proc2 and proc3 associated with
class1, class2 and class3, respectively. By necessity segment two must also have proc1, proc2 and proc3 and associated
classes class1, class2, and class3. This rule must be enforced manually.
On the other hand, proc1 in segment one may have four operations with two phases each and proc1 in segment two can
have five operations with one phase each.

11-34 2VAA001872-660
12. Recipe Conversion and Project Upgrades Introduction

12. Recipe Conversion and Project Upgrades


12.1 Introduction
Batch recipes created with DOS-based batch recipe editor tools EDT and batch recipe manager (BRM) can be used by the
Batch Data Manager, but they must first be converted and imported into a Batch Data Manager BSEQ batch project.
Information about converting recipes and Batch Data Manager 6.1 project upgrades follows.

12.2 EDT Recipe Conversion


A Batch Data Manager utility converts EDT style recipes into standard Batch Data Manager recipes where they can be
edited and compiled. Conditions that must be met before starting a recipe conversion are:
• The EDT style ASCII representation of the recipes (.REC) must be located in a class within the class library of a
BSEQ batch project.
• The Batch 90 program and unit definition files (unit relative classes only) of the class must be compiled within the
Batch Data Manager.
• The ability to edit unit procedures must be enabled.
To convert EDT style recipes to Batch Data Manager recipes:
1. Select Recipe Conversion > EDT Recipe from the applications menu of the Batch Data Manager window.
2. In the EDT recipe conversion dialog box (refer Figure 12-1), select the class containing the EDT style recipes to
be converted.

Figure 12-1: EDT Recipe Conversion Dialog Box

3. If the class is unit relative, select the unit definition file or files containing the recipes to be converted. If the class
is non-unit relative, verify the displayed addresses (loop, process control unit, controller, and BSEQ function
block) are correct. If necessary, click Modify... and select the address of the controller that will use the recipe. An
option is provided to select all the units.
4. Select the recipe or recipes (.REC) to be converted. An option is provided to select all the recipes.
5. Click Convert.

The output pane of the dialog box details the progress of the conversion process.
As a result of the conversion process:

2VAA001872-660 12-1
Batch Recipe Manager Recipe Conversion 12. Recipe Conversion and Project Upgrades

• The original recipe files remain unchanged.


• A Batch Data Manager script file (.SCR) is created and given the same name as the selected class.
• A Batch Data Manager unit procedure (.Uxx) is created and given the EDT recipe number but with an R prefix.
• A Batch Data Manager recipe file (.RCP) is created and given the EDT recipe number. This recipe can be viewed
from within the unit procedure window after refresh is performed. The recipe number can be found under the unit
name in the case of unit relative unit procedures.
• An error log (.ERR) is created for each recipe converted and is given the EDT recipe name. This log identifies any
invalid syntax found and the line number on which it was found.
• A log file (.LOG) is created to provide a history of the recipe conversions and is given the selected class name.
• An output file (.OUT) is created during the passing of the .REC file.

12.3 Batch Recipe Manager Recipe Conversion


A Batch Data Manager utility converts batch recipe manager (BRM) master recipes into standard Batch Data Manager
master recipes where they can be edited and compiled. Conditions that must be met before starting a recipe conversion
are:
• The BSEQ batch project includes all the class libraries required by the batch recipe manager master recipe being
converted.

NOTE: The symbol table file (.SYP) created under the batch recipe manager for the class must be present.

• The Batch 90 program and unit definition files (unit relative classes only) for all classes associated with the master
recipe must be compiled under the Batch Data Manager before starting the conversion process.
• The ability to edit master recipes must be enabled.
To convert batch recipe manager master recipes to Batch Data Manager master recipes:
1. Select Recipe Conversion > BRM Recipe from the applications menu of the Batch Data Manager window.
2. In the BRM recipe conversion dialog box (refer Figure 12-2), select individual recipes from the equipment list or
select the list to convert all the recipes in that list.

NOTE: The equipment list can be found by expanding the drive and batch recipe manager project items.

Figure 12-2: BRM Recipe Conversion Dialog Box

12-2 2VAA001872-660
12. Recipe Conversion and Project Upgrades Batch Data Manager 6.1 Project Upgrade

3. Click Convert.

The output pane of the dialog box details the progress of the conversion process.
As a result of the conversion process:
• The original recipe files remain unchanged.
• A Batch Data Manager script file (.SCR) is created and given the same name as the master recipe being converted.
This file is placed in the BSEQ batch project directory.
• A Batch Data Manager master recipe file (.RCP) is created and given the batch recipe manager master recipe
name. This file is placed in the master recipe subdirectory of the BSEQ batch project directory.
• An error log (.ERR) is created for each recipe converted and is given the master recipe name. This log identifies
any invalid syntax found and the line number on which it as found. This file is placed in the BSEQ batch project
directory.
• A log file (.LOG) is created to provide a history of the recipe conversions and is given the selected master recipe
name. This file is placed in the BSEQ batch project directory.

12.4 Batch Data Manager 6.1 Project Upgrade


Batch Data Manager version 6.0 and earlier project files must be upgraded on a project basis. Refer to Upgrade Project on
page 7.

2VAA001872-660 12-3
Batch Data Manager 6.1 Project Upgrade 12. Recipe Conversion and Project Upgrades

12-4 2VAA001872-660
13. Error Messages and Recovery Compiler Error Codes

13. Error Messages and Recovery


This topic discusses the compiler error codes and run-time fault code that may be encountered.

13.1 Compiler Error Codes


Table 13-1 provides a complete list of the compiler error numbers and the corresponding error messages.

Table 13-1: Compiler Error Messages

Number Message

0 Operator not yet implemented

1 Invalid statement

2 Operator not allowed below base level

3 Duplicate definition

4 Invalid definition

5 Syntax error

6 Premature EOF

7 Undefined name

8 Undefined structure member

9 Constant left of equals sign

10 Constant expected

11 Invalid data type

12 Invalid compiler directive

13 Return not allowed outside function

14 Invalid time units

15 Unmatched END WHILE statement

16 Missing END WHILE statement

17 Unmatched UNTIL statement

18 Missing UNTIL statement

19 Declaration statements not allowed

20 Unmatched THEN statement

21 Unmatched ELSE statement

22 Missing ENDIF statement

23 Not allowed in fault logic

24 Invalid in Continuous Mode

25 Only one batch data area allowed

26 Not allowed outside of loops

27 Not allowed inside monitor

28 Invalid return for function type

29 Invalid call of nonfunction

30 Invalid function routine call

31 Incorrect number of arguments

32 Invalid argument type

2VAA001872-660 13-1
Compiler Error Codes 13. Error Messages and Recovery

Table 13-1: Compiler Error Messages (Continued)

Number Message
33 Invalid nonfunctional routine call

34 Invalid recursive function call

35 Invalid operator

36 Operator not allowed at base level

37 Not allowed outside step subroutine

38 Invalid structure reference

39 Invalid restart point

40 Not allowed outside of normal logic

41 Not allowed outside restart logic

42 Undefined label

43 Call by value item left of equals

44 Invalid input type

45 Batch data must precede step subroutines

46 Expression expected

47 Too many arguments

48 Invalid LC

49 Invalid block type

50 Invalid block number

51 Must have at least 1 case

52 Missing END CASE

53 Unexpected declaration statement

54 Illegal use of reserved word

55 Step subroutine name too long

56 Subscript out of range

57 Invalid usage

58 One and only one programmable block required

59 Block type not allocated

60 Not allowed outside of fault logic

61 Overlapping case range

62 Missing END CASE

63 List elements must be unique

64 Too many list elements

65

66 Not used

67

68 Value out of range

69 Function not referenced

70 Monitor not referenced

13-2 2VAA001872-660
13. Error Messages and Recovery Compiler Error Codes

Table 13-1: Compiler Error Messages (Continued)

Number Message
71 Invalid lower bound

72 Invalid upper bound

73 Array too large

74 Name mismatch on END SUBR line

75 Array subscript out of bounds

76 Array dimensions incompatible

77 Too many dimensions

78 Missing subscript

79 Too many subscripts

80 Unmatched END FOR statement

81 Missing END FOR statement

82 Source line too long

83 Missing name

84 Only one descriptor allowed

85 Duplicate block number

86 Unterminated comment exists

87 Include files nested too deep

88 Missing terminator

89 Duplicate include file

90 Missing END SUBR statement

91 Missing <

92 Missing >

93 Missing ,

94 Missing =

95 Missing :

96 Missing .

97 Program too complex - Internal stack overflow

98 Function contains WAIT statements

99 Value too large

100 Undefined constant operation

101 Missing normal logic section

102 Local data value not used

103 Argument not used

104 Batch data value not used

105 Data value not initialized

106 Program too large for available space

107 Too many recipe arguments for one step subroutine

108 System constant file B90CONST.INC not used

2VAA001872-660 13-3
Run-Time Fault Codes 13. Error Messages and Recovery

Table 13-1: Compiler Error Messages (Continued)

Number Message

109 Value too small

110 FOR LOOP index already in use in outer loop

111 Name mismatch on END FOR line

112 Complete address must be specified

13.2 Run-Time Fault Codes


BSEQ
The batch sequence (BSEQ) function block executes a series of diagnostic tests that detect errors that cannot be detected
by the compiler. The fault codes can be seen using the batch debugger or by viewing the BSEQ block output (N+7). The
errors are only detectable while the controller is in execution and are, therefore, called run-time errors. Table 13-2 lists the
possible error codes and an explanation of each.

Table 13-2: BSEQ Run-Time Fault Codes

Fault Codes Explanation

Any positive number This number (any positive number) is assigned by the user in the batch
language program and is used to indicate what type of fault has occurred.
There is no limit to the number of fault codes the user may assign.

-1.0 Hold command The batch sequence is in hold, through either the BSEQ function block or a
command in the batch language. Going to hold suspends normal logic and
starts execution of hold logic.

-3.0 Stack overflow Contact ABB Technical Support Center.

-4.0 Error reading No batch program exists in the NVRAM memory that matches the number
object file indicated in specification S9 of the BSEQ function block. Normally this
means that the batch object file has not been downloaded to the controller
or specification S9 of the BSEQ function block references an undefined
program number.

-5.0 Object file The batch program size exceeds the amount of controller volatile memory
exceeds memory specified by specification S11 of the BSEQ function block. Correct this
allocation problem by increasing specification S11.

-7.0 Phase data size The amount of data used by a step/phase exceeds the amount of memory
exceeds memory specified by specification S12 of the BSEQ function block. To correct,
allocation increase the value of S12 in the BSEQ function block.

-8.0 Recipe refers to The unit recipe contains a phase subroutine name that is not contained
undefined phase within the batch program. This situation can happen when a batch program
subroutine is edited so that a phase subroutine is removed, but the corresponding
recipes are not changed. To correct, add the undefined phase subroutine or
remove the called (undefined) phase subroutine from the unit recipe.

-9.0 Batch directory Format controller and reload necessary programs, recipes, and data files.
error

-10.0 Recipe error The execution of a unit recipe that does not exist within the NVRAM
memory of the controller was attempted. To correct, create or download a
unit recipe to the controller or input a valid recipe ID and then restart the
sequence.

-12.0 Illegal There is an argument data type conflict between the unit recipe and the
parameter type batch program. To correct, recompile the batch program and the recipe.
Then, download both the recompiled batch program and unit recipe.

-13.0 ESTOP/ The emergency input to the BSEQ function block (specification S5) is on.
Aborting from block This drives the batch program unconditionally to operation 0 of the current
input unit recipe. To correct, find out why the emergency shut down input is being
set to on and correct it.

13-4 2VAA001872-660
13. Error Messages and Recovery Run-Time Fault Codes

Table 13-2: BSEQ Run-Time Fault Codes (Continued)

Fault Codes Explanation


-15.0 Invalid The starting of a batch sequence at an operation number not defined within
operation number the unit recipe being run was attempted. Create a unit recipe with an
operation number that matches the one to be executed or change the
operation number.

-16.0 Bad function In the batch data declaration sections of the batch language, the program is
block reference trying to reference a function block that does not exist or one whose type
does not match the function code type in the declaration. The batch
debugger will provide the function block number within the batch data
section that is making the reference. To correct, change the function block
number to a valid one, erase the reference from the program, or correct the
type to match the function block in the controller.

-17.0 Array error An array subscript is out of bounds. Normal logic is suspended and
execution of fault logic begins. It is possible to inspect the value of the fault
code to detect when this fault has occurred.

-18.0 BCODE The batch program was compiled using firmware that does not match the
revision mismatch firmware in the controller. Recompile the batch program with the compiler
that matches the firmware within the controller.

-19.0 Recipe The execution of a recipe that contains more parallel phase subroutines
requires too many than are allowed in the target program was attempted. To correct, edit and
parallel phases recompile the unit recipe to contain less parallel phase subroutines or edit
the #MAXPARALLEL statement.

-20.0 Invalid number The unit recipe contains the wrong number of recipe parameters as
of parameters in compared to the target program. To correct, fix the recipe or the program
phase data (normally the recipe).

-21.0 Invalid online The attempted execution of a new program that differs from the previous
program change one because of a change in the batch data area or the local declaration
section of the active phase subroutine. Such online changes are not
permitted.

-22.0 Batch The batch and lot number in the BHIST function block are not unique to the
descriptor not unique batch historian. Change the batch and/or lot number and restart the
program.

-23.0 Wait for batch The batch historian is busy and the program may not proceed until it is
historian available. No corrective action is required.

-24.0 Batch historian The batch historian is offline and the program may not proceed until the
offline batch historian is online and the program is restarted.

-25.0 Bad block The unit recipe used contains a reference to an incorrect or nonexistent
reference in phase block. Correct the block number in the unit recipe.
data

-26.0 Bad data A data entry in the unit recipe does not match the program. This most
reference in recipe commonly happens when a unit recipe argument value was selected from a
selection list and the program was changed to no longer include that
selection. Resolve any discrepancies and recompile the unit recipe with the
batch program.

-27.0 Bad block A function block declaration in the unit data file does not match the
reference in Unit controller configuration (either the function block address or the function
Data code type are in error). Resolve any discrepancies and recompile the unit
data file against the batch program.

-28.0 Bad CSEQ A CSEQ reference in the unit data file does not match the program. Resolve
reference in Unit any discrepancies and recompile the unit data file against the batch
Data program.

2VAA001872-660 13-5
Run-Time Fault Codes 13. Error Messages and Recovery

Table 13-2: BSEQ Run-Time Fault Codes (Continued)

Fault Codes Explanation

-29.0 Unit Data does The unit data file does not match the batch program structurally (the number
not match B90 or type declarations do not match). Resolve any discrepancies and
program recompile the unit data file against the batch program.

-30.0 Error reading No unit data file exists in the NVRAM memory that matches the number
UNIT.DEF file indicated by specification S9 of the BSEQ function block. Normally this
means that the unit data object file has not been downloaded to the
controller.

-31 ID type The recipe ID type connected to the BSEQ function block is not the same as
mismatch the program file type selected by BSEQ specification S9. This error is
caused by the BSEQ input specification S1 connected to a DATAEXPT
(FC144) and the program referenced by specification S9 being Numeric or
specification S1 connected to a read and the program referenced is #alpha.

-32 String subscript The string position specified in the program is negative or larger than the
error maximum size of the string. This error occurs during program execution and
transfers the program to fault logic.

-33 Restart error, Hold-to-run command was received but ignored, due to a historian queue
Historian queue full full condition with a good historian status. This state is a continuation of the
hold command state (see fault code -1). Even though the run input may still
be active, a new hold-to-run transition must be initiated to attempt another
restart; the program will not restart unless the queue full condition was
rectified prior to the hold-to-run transition request (regardless of the setting
in FC220, specification 9). If and when the historian is marked bad, the
queue is cleared.

PHASEX
The phase execution (PHASEX) function block executes a series of diagnostic tests that detect errors that cannot be
detected by the compiler. The fault codes can be seen using the batch debugger or by viewing the PHASEX block output
(N+2). The errors are only detectable while the controller is in execution and are, therefore, called run-time errors. Table 13-
3 lists the possible error codes and an explanation of each.

Table 13-3: PHASEX Run-Time Fault Codes

Fault Codes Explanation

Any positive number This number (any positive number) is assigned by the user in the batch
language program and is used to indicate what type of fault has occurred.
There is no limit to the number of fault codes the user may assign.
-3.0 Stack overflow Contact ABB Technical Support Center.

-4.0 Error reading No batch program exists in the NVRAM memory that matches the number
object file indicated in specification S9 of the PHASEX function block. Normally this
means that the batch object file has not been downloaded to the controller
or specification S9 of the PHASEX function block references an undefined
program number.

-5.0 Object file The batch program size exceeds the amount of controller volatile memory
exceeds memory specified by specification S11 of the PHASEX function block. Correct this
allocation problem by increasing specification S11.

-6.0 Phase data The send phase data message can not fit in the memory allocated by
message exceeds specification S12 of the PHASEX function block. Correct this problem by
memory allocation increasing specification S12 and resending the phase data.

13-6 2VAA001872-660
13. Error Messages and Recovery Run-Time Fault Codes

Table 13-3: PHASEX Run-Time Fault Codes (Continued)

Fault Codes Explanation


-7.0 Phase data size The amount of data used by a phase exceeds the amount of memory
exceeds memory specified by specification S12 of the PHASEX function block. To correct,
allocation increase the value of specification S12 in the PHASEX function block.
Fault data - The block number of the lead PHASEX function block with the
problem.

-8.0 Recipe refers to The recipe contains a phase subroutine name that is not contained within
undefined phase the batch program. This situation can happen when a batch program is
subroutine edited so that a phase subroutine is removed, but the corresponding recipes
are not changed. To correct, add the undefined phase subroutine or remove
the called (undefined) phase subroutine from the recipe.
Fault data:
0 = no phase data message was received.
1 = message received.

-9.0 Batch directory Format controller and reload necessary programs, recipes, and data files.
error

-10.0 Recipe error Contact ABB Technical Support Center.

-12.0 Illegal There is an argument data type conflict between the recipe and the batch
parameter type program. To correct, recompile the batch program and/or fix the recipe.
Then, download the recompiled batch program and rerun the phase.
Fault data - The position (starting with I) of the illegal parameter in the
recipe.

-13.0 ESTOP/ The abort phase was triggered by the specification 5 input of the PHASEX
Aborting from block function block. The fault is triggered when the abort phase is activated.
input Clear the fault by issuing a reset when the PHASEX function block is in the
aborted state.

-16.0 Bad function In the batch data declaration sections of the batch language, the program is
block reference trying to reference a function block that does not exist or one whose type
does not match the function code type in the declaration. The batch
debugger will provide the function block number within the batch data
section that is making the reference. To correct, change the function block
number to a valid one, erase the reference from the program, or correct the
type to match the function block in the controller.

-17.0 Array error An array subscript is out of bounds. Normal logic is suspended and
execution of fault logic begins. It is possible to inspect the value of the fault
code to detect when this fault has occurred.

-18.0 BCODE The batch program was compiled using firmware that does not match the
revision mismatch firmware in the controller. Recompile the batch program with the compiler
that matches the firmware within the controller.

-20.0 Invalid number The recipe contains the wrong number of phase parameters as compared to
of parameters in the target program. To correct, fix the recipe or the program (normally the
phase data recipe).

-21.0 Invalid online The attempted execution of a new program that differs from the previous
program change one because of a change in the batch data area or the local declaration
section of the active phase subroutine. Such online changes are not
permitted.

-25.0 Bad block The recipe used contains a reference to an incorrect or nonexistent block.
reference in phase Correct the block number in the recipe.
data Fault data - The position (starting with I) of the bad function block reference
in the recipe.

-27.0 Bad block A function block declaration in the unit data file does not match the
reference in Unit controller configuration (either the function block address or the function
Data code type are in error). Resolve any discrepancies and recompile the unit
data file against the batch program.

2VAA001872-660 13-7
Run-Time Fault Codes 13. Error Messages and Recovery

Table 13-3: PHASEX Run-Time Fault Codes (Continued)

Fault Codes Explanation


-28.0 Bad CSEQ A CSEQ reference in the unit data file does not match the program. Resolve
reference in Unit any discrepancies and recompile the unit data file against the batch
Data program.

-29.0 Unit Data does The unit data file does not match the batch program structurally (the number
not match B90 or type declarations do not match). Resolve any discrepancies and
program recompile the unit data file against the batch program.

-30.0 Error reading No unit data file exists in the NVRAM memory that matches the number
UNIT.DEF file indicated by specification S9 of the PHASEX function block. Normally this
means that the unit data object file has not been downloaded to the
controller.

-32.0 String The string position specified in the program is negative or larger than the
subscript error maximum size of the string. This error occurs during program execution and
transfers the program to fault logic.

-35.0 Illegal The recipe parameter name does not match the parameter name of the
parameter name selected phase in the program file. Check the recipe and program file and
edit the names to match.
Fault data - The position (starting with I) of the illegal parameter in the
recipe.

-36.0 Abort phase The batch program file does not contain a phase named Abort. Edit the
not defined batch program to contain the Abort phase, recompile, and download the
program file.

-37.0 Phase data Phase data as received by the PHASEX function block is out of order. Send
receipt error the phase data again.

-38.0 Program not The command was accepted as an allowable command for the present
active state but the program was not active. The command could not be executed
successfully by the PHASEX function block. Activate (initialize or acquire)
the program and issue the command again.

13-8 2VAA001872-660
INDEX

INDEX
Class library 2
A Control recipe 15
Add Master recipe 2
Batch program 1 Project 3
Class 3 UDF program 8
Class library 1 Unit procedure 2
Control recipe 14 Unit recipe 10
Master recipe 1 Debug
Operation 6, 7 Control recipe 1
Phase 4 UDF program 2
Project 1 Unit recipe 1
Segment 8 Delete
Source file 4, 9 All unit recipes 11
Train 4 B90 program file 4
UDF program 6 Batch program 3
Unit 5 Class 4
Unit procedure 1, 8 Class library 2
Unit recipe 9 Control recipe 15, 4
User name 8 Master recipe 2
Archive log Project 3
Delete entries 1 UDF program 8
Filters 2 UDF program file 4
Pause 3 Unit 4
Resume 5 Unit procedure 2
Size 2 Unit recipe 11, 4
Sort 5 Description 1
View 5 Download
B90 program file 2
Control recipe 2
B UDF program file 2
Batch archive log
Unit 2
Configure
Unit recipe 2
Display filter 2
Drive properties 5
Log size 2
Edit
Write filter 2
Batch program 3
Delete log messages 1
Control recipe 16
Message properties 4
Master recipe 2
Pause input 3
UDF program 9
Print log 3
Unit procedure 2
Resume input 5
Unit recipe 11
Sort contents 5
Master recipe properties 11
Batch Data Manager
Open project 3
Add
Project properties 5
Batch include file 4
Remove class library reference 2
Batch program 1
Rename
Class 3
Batch program 4
Class library 1
Class 5
Master recipe 1
Class library 2
Project 1
Control recipe 18
UDF program 6
Master recipe 14
UDF source file 9
Project 6
Unit procedure 1
UDF program 9
Change
Unit procedure 9
Class program 3
Unit recipe 13
Password 2
Train properties 13
Class library properties 2
Unit procedure properties 8
Class properties 4
Unit properties 6
Close project 3
Unit recipe properties 13
Control recipe properties 17
Verify
Convert recipes 1
B90 program file 3
Copy
Control recipe 3
Batch program 3
UDF program file 3
Class 3
Unit 3

2VAA001872-660 1
INDEX

Unit recipe 3 Print


View batch archive log 5 Batch program 4
Batch download utility UDF program 9
Change controller mode 7 Unit 5
Communication settings 7 Rebuild batch programs/units 4
Message properties 5 Compiler errors 1
Print messages 4 Control recipe
Read directories 7 Add 14
Search for controller 8 Copy 15
Size 5 Debug 1
Batch process description 1 Delete 15, 4
Batch program Download 2
Add 1 Edit 16
Add source file 4 Print 17
Compile 1 Properties 17
Copy 3 Rename 18
Delete 3, 4 Verify 3
Download 2 Controller directories 7
Edit 3 Controller mode 7
Print 4 Converting recipes
Verify 3 Batch recipe manager 2
Batch project description EDT 1
BSEQ 1 Copy
PHASEX 6 Batch program 3
Batch recipe description 1 Class 3
Class library 2
C Control recipe 15
Change class program 3 Master recipe 2
Class Project 3
Add 3 Train 5
Change program 3 UDF program 8
Copy 3 Unit procedure 2
Delete 4 Unit recipe 10
Properties 4
Rename 5 D
Class library Debug 1
Add 1 Delete
Copy 2 Batch program 3, 4
Delete 2 Class 4
Properties 2 Class library 2
Refresh 6, 9 Control recipe 15, 4
Remove reference 2 Master recipe 2
Rename 2 Operation 4, 6
Compile Phase 4, 6
Batch program 1 Project 3
UDF program 7 Segment 6
Unit 5 Train 6
Compiler editor UDF program 8, 4
Add Unit 5, 4
Batch include file 4 Unit procedure 2, 6
Batch program 1 Unit recipe 11, 4
UDF source file 9 User name 9
Unit 5 Description
Class properties 4 Batch data manager 1
Compile Batch process 1
Batch program 2 Batch recipe 1
UDF program 8 BSEQ batch project 1
Delete unit 5 Directory structure 8
Edit Files 8
Batch program 3 Online program changes 8
Batch settings 1 PHASEX batch project 6
UDF program 9 UDF project 7
UDF settings 7 Directory structure 8
Unit procedure 2 Download

2 2VAA001872-660
INDEX

Batch program 2 M
Control recipe 2 Master recipe
Information 1 Add 1
UDF program 2 Copy 2
Unit 2 Delete 2
Unit recipe 2 Edit 2
Drive properties 5 Print 10
Dynamic debugger Properties 11
Change Rename 14
Operation 3 Save 14
Phase 3 Master recipe editor
Debug Add 4
Control recipe 1 Control recipe 14
UDF program 2 Train 4
Unit recipe 1 Contract/expand 5
Dynamic debugger properties 4 Control recipe properties 18
Edit program variable 6 Copy
Escape loop 3 Control recipe 15
Find text 3 Train 5
Go to line 4 Delete
Line tracking 4 Control recipe 16
Remove watch variables 5 Operation 6
Start execution 5 Phase 6
Step level 5 Segment 6
Step same 5 Train 6
Step section 5 Unit procedure 6
Stop execution 5 Edit
Use breakpoints 2 Control recipe 16
View built-in variable 6 Master recipe 2
View program variables 5 Train 6
Watch program variable 6 Exit 6
Export
E Operation 6
Edit Phase 6
Batch program 3 Unit procedure 6
Control recipe 16 Import
Master recipe 2 Operation 7
Train 6 Phase 7
UDF program 9 Unit procedure 7
Unit procedure 2 Insert
Unit recipe 11 Operation 7
Users list 8 Segment 8
Errors 1 Unit procedure 8
Export Master recipe editor properties 12
Operation 5, 6 Master recipe properties 11
Phase 5, 6 Operation properties 12
Unit procedure 5, 6 Phase properties 12
Print control recipe 17
F Print master recipe 10
Fault codes 4 Refresh class library 9
Files 8 Rename
Format controller 6 Control recipe 18
Operation 9
Segment 9
H Train 9
How to use this instruction 2 Search 10
Segment properties 12
I Terminate phase 10
Import Train properties 13
Operation 5, 7 Unit procedure properties 13
Phase 5, 7 Write protect master recipe 10
Unit procedure 6, 7 Master recipe editor properties 12
Instruction content 1 Modify user privileges 9
Intended user 1

2VAA001872-660 3
INDEX

O Users list 9
Online program changes 8 Remove class library reference 2
Operation Rename
Add 6, 7 Class 5
Delete 4, 6 Class library 2
Export 5, 6 Control recipe 18
Import 5, 7 Master recipe 14
Properties 7, 12 Operation 6, 9
Rename 6, 9 Project 6
Segment 9
Train 9
P UDF program 4, 9
Phase 4
Unit procedure 9
Add 4
Unit recipe 13
Delete 4, 6
Reset user password 9
Export 5, 6
Restore
Import 5, 7
Project 6
Properties 8, 12
Terminate 7, 10
Print S
Batch program 4 Save
Control recipe 17 Master recipe 14
Master recipe 10 Unit procedure 9
UDF program 9 Script language
Unit 5 ASCII master recipe script 28
Unit procedure 7 ASCII unit procedure script 23
Unit recipe 12 Compiling Batch 90 programs 3
Project Compiling UDF programs 4
Add 1 Introduction 1
Close 3 Script file 2
Copy 3 Search 6, 10, 8
Delete 3 Security 7
Open 3 Segment
Properties 5 Add 8
Rename 6 Delete 6
Restore 6 Properties 12
Security 7 Rename 9
Upgrade 7
Properties T
Class 4 Terminate phase 7, 10
Class library 2 Train
Control recipe 17, 4 Add 4
Debug session 4 Copy 5
Drive 5 Delete 6
Master recipe 11 Edit 6
Master recipe editor 12 Properties 13
Message 5 Rename 9
Operation 7, 12
Phase 8, 12 U
Project 5 UDF program
Segment 12 Add 6
Train 13 Add source file 9
Unit 6 Compile 7
Unit procedure 8, 13 Copy 8
Unit procedure editor 9 Debug 2
Unit recipe 12 Delete 8, 4
Users list 6 Download 2
Edit 9
R Print 9
Rebuild 4 Rename 4, 9
Recipe conversion Verify 3
Batch recipe manager 2 UDF project description 7
EDT 1 Unit
Refresh Add 5
Class library 6, 9 Compile 5

4 2VAA001872-660
INDEX

Delete 5, 4 User interface manager 10


Download 2 User qualifications 1
Print 5 Users list
Properties 6 Add name 8
Verify 3 Add user 8
Unit procedure Delete all users 9
Add 1, 8 Delete name 9
Copy 2 Delete one user 9
Delete 2, 6 Delete user 9
Edit 2 Edit 8
Export 5, 6 Modify privileges 9
Import 6, 7 Modify user privileges 9
Print 7 Properties 6
Properties 8, 13 Refresh 9
Rename 9 Reset password 9
Save 9 Reset user password 9
Unit procedure editor
Add V
Phase 4 Verify
Unit recipe 9 Batch program 3
Contract/expand 4 Control recipe 3
Copy unit recipe 10 Information 3
Delete UDF program 3
All unit recipes 11 Unit 3
Phase 4 Unit recipe 3
Unit recipe 11 Version control 5, 9, 6, 14
Edit
Unit recipe 11
Exit 5
Export
Operation 5
Phase 5
Unit procedure 5
Import
Operation 5
Phase 5
Unit procedure 6
Insert operation 6
Operation properties 7
Phase properties 8
Print 7, 12
Refresh class library 6
Rename
Operation 6
Unit recipe 13
Search 6
Terminate phase 7
Unit procedure editor properties 9
Unit procedure properties 9
Unit properties 6
Unit recipe properties 13
Write protect 7
Unit procedure editor properties 9
Unit recipe
Add 9
Copy 10
Debug 1
Delete 11, 4
Download 2
Edit 11
Print 12
Properties 12
Rename 13
Verify 3
Upgrade Project 7

2VAA001872-660 5
INDEX

6 2VAA001872-660
ABB Ltd. Notice

Document Number: 2VAA001872-660


The information in this document is subject to change
Business Unit Power Generation without notice and should not be construed as a
P.O. BOX 8131 commitment by ABB. ABB assumes no responsibility
8050 Zürich for any errors that may appear in this document.
In no event shall ABB be liable for direct, indirect,
SWITZERLAND special, incidental or consequential damages of any
Phone: +41 (0) 43 317-5380 nature or kind arising from the use of this document, nor
Fax: +41 (0) 43 317-5382 shall ABB be liable for incidental or consequential
damages arising from use of any software or hardware
www.abb.com/powergeneration described in this document.
This document and parts thereof must not be
reproduced or copied without written permission from
ABB, and the contents thereof must not be imparted to
ABB Inc. a third party nor used for any unauthorized purpose.
Power Generation The software or hardware described in this document is
furnished under a license and may be used, copied, or
Wickliffe, Ohio, USA disclosed only in accordance with the terms of such
E-Mail: powergeneration@us.abb.com license.
www.abb.com/controlsystems This product meets the requirements specified in EMC
Directive 2004/108/EC and in Low Voltage Directive
2006/95/EC.

Copyright © 2013 by ABB.


All rights reserved.
Release: July 2013

Potrebbero piacerti anche