AdvaBuild®

TCL Builder User Guide

Version 3.7

Power and productivity

TM
for a better world
 AdvaBuild®
TCL Builder User Guide

Version 3.7
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 intel-
lectual 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 hard-
ware described in this document.

This document and parts thereof must not be reproduced or copied without written per-
mission 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/EEC and in Low
Voltage Directive 2006/95/EEC.

TRADEMARKS
All rights to copyrights, registered trademarks, and trademarks reside with their respec-
tive owners.

Copyright © 2001-2013 by ABB.

All rights reserved.

Release: June 2013

Document number: 3BUR002117R3701
 TABLE OF CONTENTS

About This Book

General ..............................................................................................................................9
Use of Warning, Caution, Information, and Tip ................................................................9
Document Conventions ...................................................................................................10
Terminology.....................................................................................................................11
Related Documentation ...................................................................................................12

Section 1 - Introduction
Product Overview ............................................................................................................15
TCL Builder Workspace.......................................................................................16
Managing TCL Sequence and Recipe Files .........................................................17
Editing Sequence and Recipe Files ......................................................................17
Using the Revision Control System .....................................................................17
Compiling and Linking ........................................................................................17
Printing .............................................................................................................17
Equipment Requirements ................................................................................................18
Database Configuration Requirements ............................................................................18
Considerations for Using filesys Statements ...................................................................18

Section 2 - Installation
General Information ........................................................................................................19
Product Verification .........................................................................................................19

Section 3 - Configuration/Application Building

Before You Start ..............................................................................................................21
Getting Started.................................................................................................................21

3BUR002117R3701 5
Table of Contents

TCL Builder Interface ..................................................................................................... 22

Client Window ..................................................................................................... 23
Server Library Window........................................................................................ 25
Server RCS Window ............................................................................................ 26
TCL Sequence Window ....................................................................................... 28
TCL Sequence Listing Window........................................................................... 29
TCL Sequence Source and Listing Window........................................................ 30
TCL Recipe Window ........................................................................................... 31
Revision and Differences Log Windows.............................................................. 32
TCL Builder Workspace Controls ....................................................................... 32
Dialog Boxes ...................................................................................... 32
Menu Bar ...................................................................................... 33
Window Menu..................................................................................... 33
Tool Bar ...................................................................................... 34
Status Bar ...................................................................................... 35
Mouse Operation.................................................................................................. 36
Left Mouse Button .............................................................................. 36
Drag and Drop .................................................................................... 40
Right Mouse Button............................................................................ 43
Cursor Positioning via the Keyboard ................................................................... 44
Adjusting the User Interface ................................................................................ 45
Arranging Windows ............................................................................ 45
Resizing Windows .............................................................................. 45
Using the Tree View............................................................................ 45
Using the List View ............................................................................ 46
Refreshing Contents of Client and Server Windows .......................... 47
How to Obtain Help ............................................................................................. 47
Application Start-up ........................................................................................................ 49
Starting the Client ................................................................................................ 49
From the Windows Start Menu ........................................................... 49
From the Desktop................................................................................ 50
Selecting a Sequence or Recipe File in Windows Explorer................ 50

6 3BUR002117R3701
 Table of Contents

Connecting to the Server ......................................................................................52

Application Procedures ...................................................................................................54
Managing Directories and Files.......................................................................................54
Creating a Folder..................................................................................................56
Creating a New File..............................................................................................58
Opening One or More Files..................................................................................59
Saving a File.........................................................................................................63
Moving Folders or Files Within the Client Window ............................................67
Renaming a Folder or File....................................................................................67
Deleting Folders and Files....................................................................................67
Displaying Folder or File Properties ....................................................................68
Using the Editor...............................................................................................................68
How to Use the Basic Editing Functions .............................................................68
Cutting Text from a TCL Sequence or Recipe File.............................69
Copying Text from a TCL Sequence or Recipe File ...........................69
Pasting Copied or Cut Text into a TCL Sequence or Recipe ..............70
Searching a TCL Recipe, Sequence or Sequence Listing File............70
Replacing a Text String in a TCL Sequence or Recipe File................72
Marking Revisions ...............................................................................................73
Checking Syntax..............................................................................................................76
Running Syntax Check from Client Window.......................................................78
Running Syntax Check from TCL Sequence Window.........................................81
Using Revision Control ...................................................................................................81
Organizing RCS Files...........................................................................................82
Checking In a File ................................................................................................82
How Revision Numbers are Generated ................................................................85
Checking Out a File .............................................................................................86
Checking Out a File Locked................................................................86
Checking Out a File Unlocked ............................................................89
Keyword Substitution for Revision Markers.......................................90
Viewing the Revision Log....................................................................................90
Showing Differences ............................................................................................91

3BUR002117R3701 7
Table of Contents

Unlocking a Locked File...................................................................................... 93

Locking an Unlocked File.................................................................................... 93
Get Revision......................................................................................................... 93
Running GetRevision.......................................................................... 93
Viewing GetRevision Output File....................................................... 94
Compiling and Linking Files .......................................................................................... 95
Downloading Files from Revision to On-line Storage......................................... 95
Scheduling Compiles/Links ................................................................................. 97
Viewing Compiler/Linker Listing File................................................................. 98
Removing Sequence or Recipe from On-line Storage....................................... 100
TCL Recipe Decompile................................................................................................. 100
Remove Recipe Source ................................................................................................. 101
Convert to ASCII........................................................................................................... 101
TCL Recipe Tuning Procedure...................................................................................... 101
Printing .......................................................................................................................... 102
Exiting the TCL Builder................................................................................................ 103

Chapter 4 - Runtime Operation

Operating Instructions ................................................................................................... 105

Chapter 5 - Maintenance
Preventive Maintenance ................................................................................................ 107
Hardware Indicators ...................................................................................................... 107
Error Messages.............................................................................................................. 107
Fault Finding and User Repair ...................................................................................... 107
Backup/Restore Procedures .......................................................................................... 108

INDEX

8 3BUR002117R3701
 About This Book

General
This book describes the AdvaBuild® TCL Builder. The TCL Builder is a
development package that lets you:
• edit sequence and recipe (source) files.
• check syntax and view both the source and listing files in the same window.
• manage the files in a revision control system (RCS).
• compile and link sequence files.
• compile recipe files
This book is not intended to be the sole source of instruction for TCL Builder
software. It is recommended that people involved in sequence/recipe development
attend the applicable system engineering courses offered by ABB Inc.
Use this section as a guide to the conventions and terminology used throughout this
book. For related information, see Related Documentation on page 12.

Use of Warning, Caution, Information, and Tip

This publication includes Warning, Caution, and Information where appropriate
to point out safety related or other important information. It also includes Tip to
point out useful hints to the reader. The corresponding symbols should be
interpreted as follows:
Electrical warning indicates the presence of a hazard which could result in
electrical shock.

Warning indicates the presence of a hazard which could result in personal injury.

3BUR002117R3701 9
Document Conventions About This Book

Caution indicates important information or warning related to the concept

discussed in the text. It might indicate the presence of a hazard which could result
in corruption of software or damage to equipment/property.

Information alerts the reader to pertinent facts and conditions.

Tip indicates advice on, for example, how to design your project or how to use a
certain function.
Although Warning hazards are related to personal injury, and Caution hazards are
associated with equipment or property damage, it should be understood that
operation of damaged equipment could, under certain operational conditions, result
in degraded process performance leading to personal injury or death. Therefore,
comply fully with all Warning and Caution notices.

Document Conventions
The following conventions are used for the presentation of material:
• The words in names of screen elements (for example, the title in the title bar of
a window, the label for a field of a dialog box) are initially capitalized.
• Capital letters are used for the name of a keyboard key if it is labeled on the
keyboard. For example, press the ENTER key.
• Lowercase letters are used for the name of a keyboard key that is not labeled on
the keyboard. For example, the space bar, comma key, and so on.
• Press CTRL+C indicates that you must hold down the CTRL key while
pressing the C key (to copy a selected object in this case).
• The names of push and toggle buttons are boldfaced. For example, click OK.
• The names of menus and menu items are boldfaced. For example, the File
menu.
– The following convention is used for menu operations: MenuName >
MenuItem > CascadedMenuItem. For example: choose File > New >
Type.

10 3BUR002117R3701
About This Book Terminology

– The Start menu name always refers to the Start menu on the Windows
Task Bar.
• System prompts/messages are shown in the Courier font, and user
responses/input are in the boldfaced Courier font. For example, if you enter a
value out of range, the following message is displayed:
Entered value is not valid. The value must be 0 to30.
You may be told to enter the string TIC132 in a field. The string is shown as
follows in the procedure:
TIC132
Variables are shown using lowercase letters.
sequence name

Terminology
The following is a list of terms associated with object-oriented database
configuration and the TCL Builder that you should be familiar with. The list
contains terms and abbreviations that are unique to ABB or have a usage or
definition that is different from standard industry usage.

Term Description
Engineering Station The computer loaded with AdvaBuild software.
FMS File Management Services
MDI Multiple Document Interface
RCS Revision Control System
RTAB Real-time Accelerator Board. The RTAB is used with
System Services and is required in the PC if you are
using it as a client/server and connecting to the Advant
OCS Control Network (MOD 300 DCN). This reference
is also used for the external RTA unit.

3BUR002117R3701 11
Related Documentation About This Book

Term Description
TCL Taylor Control Language. The TCL Builder is a
development tool for creating sequence and recipe files,
managing sequence and recipe files, compiling and
linking TCL sequences, and compiling recipes.
TLL Taylor Ladder Logic. The TLL Builder is a development
tool for creating, managing, and compiling ladder logic
segment files.
Windows Microsoft Windows operating system

Related Documentation
A listing of documentation related to the TCL Builder is provided in Table 1.

Table 1. Related Documentation

Category Title Description

System AdvaBuild Administrator’s Guide Installation and project administration for
Administration AdvaBuild suite of software products.
AdvaBuild Release Notes Information regarding upgrades and
changes that are not described in this
book.
Software Taylor Control Language (TCL) User’s This book provides format and syntax
Guide rules, and other reference information
for TCL. This book also provides
instructions for using the TCL Catalog
display to compile and link TCL
sequences.
AdvaBuild Engineering Methods User’s Provides a complete description of
Guide database requirements.
AdvaBuild Control Builder User’s Guide Provides instructions on how to insert a
database object in a project database.

12 3BUR002117R3701
About This Book Related Documentation

After you install the AdvaBuild documentation, you can access it from the Windows
task bar by choosing Start > Programs > ABB Industrial IT > Control IT >
AdvaBuild > Documentation > Document.

3BUR002117R3701 13
Related Documentation About This Book

14 3BUR002117R3701
 Section 1 Introduction

Product Overview
AdvaBuild software consists of a family of modules called Builders that are
integrated in a framework. The TCL Builder is part of the AdvaBuild framework as
shown in Figure 1. The framework consists of the basic components (shaded in
Figure 1): Common database, Control Builder as main user interface, Templet
Builder, and On-line Builder. Other builders (for example, TCL Builder and TLL
Builder) are connected in the frame as required.

Control Builder

Templet On-line TCL TLL External

Builder Builder Builder Builder DCS Tools

Load ATF
External
Engineering Database database
Save ATF

Figure 1. AdvaBuild Software Frame Architecture

The TCL Builder is a development tool for creating sequence and recipe files,
managing sequence and recipe files, compiling and linking TCL sequences, and
compiling recipes. This tool uses a client/server architecture. The server supports

3BUR002117R3701 15
TCL Builder Workspace Section 1 Introduction

the Revision Control System (RCS) and compile/link status information for
sequences and recipes. TCL Builder clients connect to the server to check sequence
and recipe files in and out of the RCS for editing.

TCL Builder Workspace

The TCL Builder is a Multiple Document Interface (MDI) workspace comprised of
a Client window, Server Library window, and Server RCS window, all of which are
framed within the TCL Builder window, Figure 2. The Client and Server windows
are similar to the Windows Explorer in that they are split vertically down the
middle, dividing it into two areas. The portion on the left is known as the tree view,
and the portion on the right is known as the list view. Navigation within the Client,
Server Library and Server RCS windows is via menu items and mouse actions as
described in Section 3, Configuration/Application Building.

Figure 2. TCL Builder Window with Server and Client Windows Opened

16 3BUR002117R3701
Section 1 Introduction Managing TCL Sequence and Recipe Files

Managing TCL Sequence and Recipe Files

You are responsible for managing the directory structure where TCL sequence and
recipe files are stored. On the client machine, the My TCL folder under My
Documents is used to store and manage the TCL files. This involves creating new
folders and files, and deleting old ones.

Editing Sequence and Recipe Files

Sequences and recipes are created as text files. The TCL Builder Client provides a
text editor for editing these files. You can also use a text editor that is independent of
the TCL Builder (for example, Notepad) to edit these files if you prefer.
When you edit a sequence or recipe file, you can enter revision markers that
automatically update revision information when files are checked out of the
Revision Control System. The TCL Builder Client also supports syntax checking.

Using the Revision Control System

Sequence and recipe files must be checked into the Revision Control System (RCS)
when an editing session is finished, and then checked out and locked for subsequent
editing. The check in and check out of files is accomplished via Revision menu
items or dragging and dropping files between the Client and Server RCS windows.
The RCS lets you generate revision logs to show a file’s revision history. You can
also show differences between two revisions.
Folders are now supported to organize the RCS files.

Compiling and Linking

Compiling and linking of sequence files and compiling recipe files is supported by
the Server Library window.

Printing
You can print sequence and recipe source files, sequence listing files,
compiler/linker listing files, revision logs, and difference logs.

3BUR002117R3701 17
Equipment Requirements Section 1 Introduction

Equipment Requirements
See the AdvaBuild Administrator’s Guide for the hardware and memory
requirements of the AdvaBuild TCL Builder software.

Database Configuration Requirements

In order to support TCL Builder functionality on an Windows-based Engineering
Station, the GENERICD database object representing the node must have a
TCL_DEV object inserted as a child under it. Refer to the AdvaBuild Engineering
Methods User’s Guide for a complete description of database requirements. Refer to
the AdvaBuild Control Builder User’s Guide for instructions on how to insert a
database object in a project database.

Before you can Set Active Revision, the database containing the TCL_DEV
object must be compiled and installed via the corresponding AdvaBuild Control
Builder functions, and the Windows-based Engineering Station must be rebooted.
Failure to do this will result in system diagnostics.

When using multiple CDPs, if a sequence already exists, do not create the same
sequence name on another CDP; it will not download. To determine if the
sequence or recipe already exists in another CDP view the Compile Link Status
view using TCL Builder. Don’t create sequences on more than one CDP.

Considerations for Using filesys Statements

If you need to use filesys statements in a program that you create via the TCL
Builder, you can use either the editor provided by the TCL Builder or a text editor
that is independent of the TCL Builder (for example, Notepad) to edit the
filesys_incl.tcl file located in:
C:\Program Files\ABB Industrial IT\AdvaBuild\bin
See Using the Editor on page 68 for information about how to use the editor
provided by the TCL Builder.

18 3BUR002117R3701
 Section 2 Installation

General Information
The TCL Builder software is a part of the AdvaBuild® suite of software products for
the Window platform and is provided on the CD for AdvaBuild Version 3.7
software. All AdvaBuild software products are installed according to instructions in
the AdvaBuild Administrator’s Guide.
You can install just client software or client/server software on the Windows-based
Engineering Station. Windows-based Engineering Stations used as a TCL Builder
server require a PCI Real-time Accelerator Board (RTAB) or the external RTA unit.

Product Verification
To verify that the correct TCL Builder software is installed on your Windows-based
Engineering Station, choose Help >About TCL Builder… from the menu bar of
the TCL Builder window. This opens a dialog with such information as software
version and licensing. To close the dialog, click on OK.

3BUR002117R3701 19
Product Verification Section 2 Installation

20 3BUR002117R3701
1

Section 3 Configuration/Application Building

Before You Start

You must first understand the user interface before you can create TCL recipe and
segment files, maintain the files under revision control, and compile and link the
files. See TCL Builder Interface on page 22.

Getting Started
To create a TCL recipe or sequence with the TCL Builder,
1. Start the TCL Builder Client application and then connect to the Server. See
Application Start-up on page 49.
2. Open an existing TCL recipe or sequence file as described in Opening One or
More Files on page 59, or create a new TCL recipe or sequence file as
described in Creating a New File on page 58.
3. Use the text editor of the TCL Builder client to edit the TCL recipe or sequence
file. See Using the Editor on page 68.

When you edit a sequence or recipe file, you can enter revision markers that
automatically update revision information when files are checked out of the
Revision Control System. See Marking Revisions on page 73.
4. Save the TCL recipe or sequence file. See Saving a File on page 63.
5. Check the syntax of the TCL recipe or Sequence file. See Checking Syntax on
page 76.
6. Check the TCL recipe or sequence file into the Revision Control System
(RCS). See Using Revision Control on page 81.

3BUR002117R3701 21
TCL Builder Interface Section 3 Configuration/Application Building

7. Compile and link the sequence file or compile the recipe file. See Compiling
and Linking Files on page 95.

TCL Builder Interface

The TCL Builder is an Windows-based Multiple Document Interface (MDI) that
runs as a client or client/server application. The user interface to the TCL Builder
application is via the TCL Builder window that contains title, menu and tool bars at
the top, a workspace (MDI), and a status bar at the bottom, Figure 3.

Figure 3. TCL Builder Window with Server and Client Windows Opened

22 3BUR002117R3701
Section 3 Configuration/Application Building Client Window

Initially, the TCL Builder application is started as a client and only the Client
window is open in the workspace. To start the TCL Builder application as a
client/server, you must connect (log on) to the server. Once you connect to the
server, the Server windows are opened in the workspace. The Client and Server
windows have a look and feel that is similar to the Windows Explorer.
Within the TCL Builder window workspace, you may display one Client window,
one Server Library window, one Server RCS window, multiple Sequence, Sequence
Listing, Recipe, Revision Log and Differences Log windows, and many dialog
boxes for manipulating the data (for example, Open dialog and Save dialog). All
these window types are described below and have the following characteristics:
• They are associated with a single project.
• They are children of the TCL Builder window and therefore displayed within
that window structure.
• They have the standard control buttons to minimize, maximize or close and
resize them within the TCL Builder window workspace.
• Even though multiple windows may be open at the same time, only one is
active. The title bar of the active window is highlighted, and the title bar of any
other open window is dimmed to indicate that it is inactive. The menu and tool
bars are context sensitive and only show options valid for the active window.
• The tree view window on the left shows the hierarchical file system in a tree-
like structure.
• The list view (right window) shows detailed information for the folders and/or
files (sequence, sequence listing, and recipe) in the currently selected drive or
folder in the tree view. This information includes the folder/file name, size,
type, and modification date.

Client Window
Whenever you open the TCL Builder, the Client window is opened, Figure 4. There
can be only one client open at a time in the TCL Builder; therefore, there can be
only one Client window open at a time in the TCL Builder window.

3BUR002117R3701 23
Client Window Section 3 Configuration/Application Building

Figure 4. Client Window

The Client window is similar to the Windows Explorer in that it is split vertically
down the middle, dividing it into two areas. The portion on the left is known as the
tree view and shows the file system for the client PC. The files displayed are limited
to drives, folders, TCL sequences, TCL sequence listings, and TCL recipes. The
portion on the right is known as the list view. Navigation within the window is via
scroll bars and mouse actions as described in Menu Bar on page 33 and Mouse
Operation on page 36 with the following exceptions:
• You cannot select objects in the tree and list views simultaneously. Also, you
cannot select contiguous items by selecting the first item, and then pressing the
SHIFT key while selecting the last item.
• Double clicking on a sequence or recipe object in the list view opens the
appropriate TCL Sequence or Recipe window for that object.
• Double-clicking on a sequence listing file in the list view of the Client window
opens the TCL Sequence Listing window for viewing that file.
The tree view for the Client shows the hierarchical file system for the client PC. The
default root for TCL files is: My Documents/My TCL.
The list view shows detailed information for the folders and/or files (sequence,
sequence listing, and recipe) in the currently selected drive or folder in the tree view.
This information includes the folder/file name, size, type, and modification date.

24 3BUR002117R3701
Section 3 Configuration/Application Building Server Library Window

Server Library Window

Whenever you connect to a TCL server via the TCL Builder window, the Server
Library window is opened, Figure 5 and Figure 6. There can be only one server
open at a time in the TCL Builder; therefore, there can be only one Server Library
window open at a time in the TCL Builder window.

Figure 5. Server Library Window—Compile/Link Status View for Sequences Folder

Figure 6. Server Library Window—Compile Status View for Recipes Folder

The Server Library window is split vertically down the middle with the tree view on
the left and the list view on the right. Navigation within the window is via menu
items and mouse actions as described in Menu Bar on page 33 and Mouse Operation
on page 36 with the following exceptions:
• You cannot select objects in the tree and list views simultaneously. Also, you
cannot select contiguous items by selecting the first item, and then pressing the
SHIFT key while selecting the last item.
• Double-clicking on a sequence or recipe object in the tree view opens a
read-only view of the latest revision.

3BUR002117R3701 25
Server RCS Window Section 3 Configuration/Application Building

• Double-clicking on on a sequence or recipe object in the list view opens a read-

only view of the selected revision.
The tree view for the Server Library shows the server name as the root, the project
one level under the server, Sequences and Recipes folders one level under the
project, TCL sequences under the Sequences folder, and TCL recipes under the
Recipes folder for the current project.
The list view shows compile/link status information for the currently selected folder
or file in the tree view.
• The Sequences folder includes the file name, compile/link status (Compiled,
Not Compiled, Compile Errors, Linked, or Link Errors), time stamp, sequence
type (Procedure, Schedule, Subroutine, or Operation) for each sequence file in
the Sequences folder as shown in Figure 5.
• The Recipes folder includes the recipe name, number of items, description,
load status (Not Compiled or Compiled), and time stamp for each recipe file in
the Recipes folder as shown in Figure 6.

Server RCS Window

Whenever you connect to a TCL server via the TCL Builder window, the Server
RCS window is opened, Figure 7 and Figure 8. There can be only one server open at
a time in the TCL Builder; therefore, there can be only one Server RCS window
open at a time in the TCL Builder window.
The Server RCS Library window is split vertically down the middle with the tree
view on the left and the list view on the right. Navigation within the window is via
menu items and mouse actions as described in Menu Bar on page 33 and Mouse
Operation on page 36 with the following exceptions:
• You cannot select objects in the tree and list views simultaneously. Also, you
cannot select contiguous items by selecting the first item, and then pressing the
SHIFT key while selecting the last item.
• Double-clicking on a sequence or recipe object in the tree view opens a
read-only view of the latest revision.
• Double-clicking on an object in the list view opens a read-only view of the
selected revision.

26 3BUR002117R3701
Section 3 Configuration/Application Building Server RCS Window

The tree view for the Server RCS shows the server name as the root, the project one
level under the server, Sequences and Recipes folders one level under the project,
TCL sequences under the Sequences folder, and TCL recipes under the Recipes
folder for the current project.

Figure 7. Server RCS Window—Revision Status View for Sequences Folder

Figure 8. Server RCS Window—Revision Status View for Individual Sequence

The list view shows revision status for the currently selected folder or file in the tree
view.
• The Sequences or Recipes folders includes the file name, the most current
revision level, modification (check in) date, author, and the user who locked the
file (if any) for all files in the selected folder as shown in Figure 7.
• Individual sequence or recipe files include the symbolic name (revision),
modification (check in) date, author, state (if any), and the user who locked the
revision (if any) for all revisions of the selected sequence or recipe as shown in
Figure 8.
Locked revisions are indicated in the list view by a lock icon, and unlocked
revisions are indicated by a text file icon.

3BUR002117R3701 27
TCL Sequence Window Section 3 Configuration/Application Building

Folder creation in the Server RCS window is supported as described in

Organizing RCS Files on page 82.

TCL Sequence Window

The TCL Sequence window, Figure 9, has a title bar at the top that contains the
sequence file’s name with its .tcl extension and a scrollable workspace where you
can define or edit a TCL sequence. If you opened the TCL Sequence window by
double-clicking on the TCL sequence file in the list view of the Server RCS
window, you can only view the file in the scroll area. If you opened the TCL
Sequence window by double-clicking on the TCL sequence file in the list view of
the Client window, you can edit the file in the scroll area.

Figure 9. Example of TCL Sequence Window

28 3BUR002117R3701
Section 3 Configuration/Application Building TCL Sequence Listing Window

TCL Sequence Listing Window

The TCL Sequence Listing window, Figure 10, has a title bar at the top that contains
the sequence listing file’s name with its .lis extension and a scrollable workspace
where you can view information generated by a Syntax Checker or Compiler/Linker
function.

Figure 10. Example of TCL Sequence Listing Window

3BUR002117R3701 29
TCL Sequence Source and Listing Window Section 3 Configuration/Application Building

TCL Sequence Source and Listing Window

When you perform a syntax check on a TCL sequence the TCL Sequence window is
divided into two panes as shown in Figure 11. The upper pane contains the TCL
sequence source file and the lower pane contains the sequence listing file. You can
resize the panes as described under the heading Drag and Drop on page 40. Use the
Next Error button on the tool bar to find errors in the listing.

Figure 11. Example, Source and Listing Files Displayed in TCL Sequence Window

30 3BUR002117R3701
Section 3 Configuration/Application Building TCL Recipe Window

TCL Recipe Window

The TCL Recipe window, Figure 12, has a title bar at the top that contains the recipe
file’s name with its .rcp extension and a scrollable workspace where you can define
or edit a TCL recipe. If you opened the TCL Recipe window by double-clicking on
the TCL recipe file in the list view of the Server RCS window, you can only view
the file in the scroll area. If you opened the TCL Recipe window by double-clicking
on the TCL recipe file in the list view of the Client window, you can edit the file in
the scroll area.

Figure 12. Example of TCL Recipe Window

3BUR002117R3701 31
Revision and Differences Log Windows Section 3 Configuration/Application Building

Revision and Differences Log Windows

The Revision Log and Differences Log windows are similar in appearance to the
TCL Sequence, Sequence Listing and Recipe windows in that they include a title
bar at the top identifying the log you are viewing and a scrollable workspace where
you view the contents of the log. The only difference is the content of the data
shown. The Revision Log window contains the revision history for the selected
sequence or recipe, and the Differences Log window shows the differences between
two files or two versions of a file.

TCL Builder Workspace Controls

Dialog Boxes
When you initiate a function, a dialog box may open for you to input information or
confirm/acknowledge the function. Figure 13 shows the Open dialog (choose File >
Open from the menu bar or click on the Open button in the tool bar).

Figure 13. Example of a Dialog Box

Most dialog boxes have one or two of the following three buttons:
• <function> (Open in Figure 13) is used to activate the function once any
necessary input has been entered in the fields and close the dialog box.

32 3BUR002117R3701
Section 3 Configuration/Application Building TCL Builder Workspace Controls

• OK is used to confirm processing or completion of the function.

• Cancel is used to terminate the function before execution.

Menu Bar
The menu bar, Figure 3, at the top of the TCL Builder window contains items for
TCL Builder activities. Any operations performed through the menu options are
based on the object(s) selected in the Client or Server Library and RCS windows.
The menu items are sensitive to the object(s) selected and are not available for
selection (dimmed) if the option does not apply to the selected object or all of the
selected objects. The menu items are also not available for selection if the privileges
for the current user do not allow them to perform that function. Detailed
descriptions of the menu items are provided in later sections of this chapter. Since
the items on the Window menu pertain to the user interface, they are described
below.

Window Menu
The Window menu contains options that allow you to control the arrangement of
windows opened by other menu items in the TCL Builder window workspace.

Menu Bar Description

Window > Cascade Cascades all windows opened within the TCL Builder
window workspace. Or use Cascade on the Tool Bar.
Window > Tile Arranges all windows opened in the TCL Builder window
Horizontal workspace in a horizontal manner. Or use Tile
Horizontal on the Tool Bar.
Window > Tile Vertical Arranges all windows opened in the TCL Builder window
workspace in a vertical manner. Or use Tile Vertical on
the Tool Bar.
Window > Arrange Arranges icons in the TCL Builder window.
Icons
Window > Minimize All Minimize all windows opened in the TCL Builder window
Windows workspace.

3BUR002117R3701 33
TCL Builder Workspace Controls Section 3 Configuration/Application Building

Menu Bar Description

Window > Maximize Maximize all or selected minimized windows opened in
All Windows the TCL Builder window workspace. To maximize a
selected minimized window, use the standard control
Maximize button for that window.
Window > Restore All Restore all windows opened in the TCL Builder window
Windows workspace.

Any additional items on the Window menu identify the windows currently open in
the TCL Builder window workspace. In the workspace, the title bar of the active
window is highlighted, and the title bar of any other open window is dimmed to
indicate that it is inactive. In the Window menu, the item for the currently active
window has a check mark to the left of its name. To make another open window
active, choose its name from the Window menu.

Tool Bar
The tool bar below the menu bar, Figure 14, contains buttons that provide shortcuts
to frequently used TCL Builder menu operations. These operations include:
• open
• save
• save all
• print
• cut
• copy
• paste
• find
• check in
• check out
• revision log
• show differences
• lock revision
• unlock revision
• next error
• cascade
• tile horizontal

34 3BUR002117R3701
Section 3 Configuration/Application Building TCL Builder Workspace Controls

• tile vertical
The tool bar is displayed upon starting the TCL Builder by default; however, you
can toggle whether it is displayed during the TCL Builder session by choosing
View > Toolbar from the menu bar. When the tool bar is displayed, there is a check
mark (✓) to the left of the Toolbar item on the View menu.

Check Show Tile

Save Print Copy Find Out Differences Unlock Cascade Vertical

Open Save All Cut Paste Check Revision Lock Next Horizontal
In Log Error Tile

Figure 14. Tool Bar of TCL Builder Window

When you move the cursor over a button in the tool bar with the mouse and keep it
over that button, ToolTipText describing the operation initiated by that button is
momentarily displayed. Figure 15 shows an example of such ToolTipText.

Figure 15. Example of ToolTipText for a Tool Bar Button

Status Bar
The status bar, Figure 16, shows the following information about the current TCL
Builder session:
• name of server the TCL Builder application is running on
• current project name, if connected

3BUR002117R3701 35
Mouse Operation Section 3 Configuration/Application Building

• current user name, if connected

• whether insert, caps lock, num lock, or scroll modes are active
By default, the status bar is displayed at the bottom of the TCL Builder window
upon starting the TCL Builder. You can toggle whether it is displayed during the
TCL Builder session by choosing View > Status Bar from the menu bar. When the
status bar is displayed, there is a check mark (✓) to the left of the Status Bar item
on the View menu.

User Name
Project Name
Server Name

Figure 16. Status Bar of TCL Builder Window

Mouse Operation
The Windows-based Engineering Station has a two button mouse. The mouse is
used to move the cursor and provide tool tips, and its two buttons are used to
increase productivity by providing a fast way to initiate certain functions as
described below.

Left Mouse Button

The left mouse button is used for:
• menu item selection
To select a menu item, move the cursor over the item and click the left mouse
button. If the selected menu item toggles a display feature, for example View >
Toolbar, a check mark (✓) is displayed to the left of the menu item to indicate
that the feature is enabled or displayed.
• tool bar button selection
To select a tool bar button, move the cursor over the button and click the left
mouse button. When selected, the button is momentarily depressed and the
function represented by the button is initiated.

36 3BUR002117R3701
Section 3 Configuration/Application Building Mouse Operation

• window selection
To select a window, move the cursor over the title bar at the top and click the
left mouse button. This highlights the windows title bar and makes it the active
window.
• minimize, maximize and close windows with standard control buttons
There are three standard control buttons in the upper right corner of most
windows that allow you to minimize, maximize or close the window,
Figure 17. Message boxes usually only have the Close button. To select a
standard control button, move the cursor over it and click the left mouse button.
Clicking on the Minimize button reduces the window to a small title bar in the
lower left of the workspace or screen with control buttons. Use the control
buttons on the minimized window to maximize or close it. Clicking on the
Maximize button expands the window to fill the workspace or screen. Clicking
on the Close button closes the window.

Close
Maximize
Minimize

Figure 17. Standard Control Buttons of Windows

3BUR002117R3701 37
Mouse Operation Section 3 Configuration/Application Building

• object selection
You can select a single object or multiple objects at one time. In the
descriptions that follow, the term object means:
– sequence, recipe, or listing object when used in the context of the tree and
list views. You can only select one sequence or recipe object at a time in
the tree view.
– display element when used in the context of the subtree button of the tree
view, the editable fields and buttons of dialog boxes, and resizing targets
To select a single object (for example, sequence or recipe object name or
subtree button in the tree view, sequence or recipe object name in the list view,
field or button on a dialog box), move the cursor over the object and click the
left mouse button. The selected object is then highlighted to indicate that it is
selected and has focus.
To select multiple objects (for example, sequence and recipe object names in
the list view) within a range, move the cursor over the first object, click the left
mouse button to select that object, move the cursor to the last object in the
range, press and hold down the SHIFT key while clicking the left mouse
button to select the last object in the range, and release the SHIFT key. This
selects the first, last and all objects between and highlights them to indicate that
they are selected and have focus.
To select multiple discontinuous objects (for example, sequence and recipe
object names in the list view), move the cursor over the first object, click the
left mouse button to select that object, move the cursor over the next object,
press and hold down the CTRL key while clicking the left mouse button to
select it. Continue to hold down the CTRL key as you select additional objects.
Once the last object is selected, release the CTRL key. This selects only those
objects clicked on and highlights them to indicate that they are selected and
have focus.

38 3BUR002117R3701
Section 3 Configuration/Application Building Mouse Operation

• expand/collapse branches within tree structure

If an object in the tree view has descendants, it has a subtree button to left of its
name that contains either a plus (+) or minus (-) sign. A plus sign indicates that
the object has children on the next level below it in the tree structure that are
not displayed; and a minus sign indicates that all children on the next level
below the object in the tree structure are displayed. The subtree button allows
you to expand or collapse that branch in the tree structure.
To expand a branch in the tree view, move the cursor over the plus subtree
button and click the left mouse button. This refreshes the window to show the
object names for immediate descendants of the selected parent object in the
tree view and the detailed information for the immediate descendants in the list
view. After a branch is expanded, the plus sign on the subtree button to the left
of the selected parent object changes to a minus sign.
To collapse a branch in the tree view, move the cursor over the minus subtree
button and click the left mouse button. The collapse refreshes the window to
hide the immediate descendants of the selected parent object in the tree view
and removes the detailed information for the immediate descendants from the
list view. After a branch is collapsed, the minus sign on the subtree button to
the left of the selected parent object changes to a plus sign.
• initiate object rename function
To rename a single folder in the tree or list view of the Client window, move the
cursor over the folder name, click the left mouse button to select the folder
name, and click the left mouse button again. This places the text cursor at the
end of the selected folder’s name. Use the keyboard to change the folder name
as desired. If the rename operation fails, and error message is displayed.
To rename a single file in the list view of the Client window, move the cursor
over the file name, click the left mouse button to select the file name, and click
the left mouse button again. This places the text cursor at the end of the
selected file’s name. Use the keyboard to change the file name as desired. If the
rename operation fails, and error message is displayed.

Renaming a TCL sequence or recipe file does not affect the contents of the file.
Therefore, if you want to change the sequence or recipe name in a file to reflect
its renamed file, you must edit that file separately from the rename operation.

3BUR002117R3701 39
Mouse Operation Section 3 Configuration/Application Building

Drag and Drop

The Windows drag and drop feature is used within the tree and list views of the TCL
Builder Client window to move and/or copy folders or files via mouse operations
instead of menu items. The drag and drop feature is used between the Client and
Server windows for the check in or check out of sequence or recipe files within the
RCS via mouse operations instead of menu items.
As you drag the selected object(s) over an invalid parent a circle with a slash
through it is displayed, indicating that it is not a valid parent for the object(s) being
dragged. If the parent is valid, an attempt is then made to move/copy the selected
object(s) beneath the parent object where the selected object(s) was (were) dropped.
If an error occurs during the move/copy operation, an error message box is
displayed and the move/copy is aborted.
• move folder(s)/file(s) within Client window
To move one or more folders or files in the Client window using drag and drop,
a. For folders, in the tree or list view of the Client window, select the
folder(s) you want to move and hold down the left mouse button.
or
For files, in the list view of the Client window, select the file(s) you want
to move and hold down the left mouse button.
b. Drag the selected folder(s)/file(s) to the desired location within the tree
structure or folder in the list view of the Client window.
c. Drop the selected folder(s)/file(s).
When you move files in the Client window, only the selected files are moved to
the specified location. When you move folders, all subfolders and files within
the selected folder(s) are moved to the specified location.
• copy folder(s)/file(s) within Client window
To copy one or more folders or files in the Client window using drag and drop,
a. For folders, in the tree or list view of the Client window, select the
folder(s) you want to move, hold down the left mouse button, and press
and hold down the CTRL key.
or

40 3BUR002117R3701
Section 3 Configuration/Application Building Mouse Operation

For files, in the list view of the Client window, select the file(s) you want
to move, hold down the left mouse button, and press and hold down the
CTRL key.
b. Drag the selected folder(s)/file(s) (move the cursor while continuing to
hold down the left mouse button and CTRL key) to the desired location
within the tree structure of the Client window.
c. Drop the selected folder(s)/file(s) (release the left mouse button and
CTRL key).
When you copy files in the Client window, only the selected files are copied to
the specified location. When you copy folders, all subfolders and files within
the selected folder(s) are copied to the specified location.
• check in folder(s)/file(s) from Client window to RCS of Server RCS
window
To check in one or more folders/files from the Client window to the RCS of the
Server RCS window using drag and drop,
a. For folders, in the tree or list view of the Client window, select the
folder(s) you want to check in to the RCS and hold down the left mouse
button.
or
For files, in the list view of the Client window, select the file(s) you want
to check in to the RCS and hold down the left mouse button.
b. Drag the selected folder(s)/file(s) to the desired location within the tree
structure of the Server RCS window.
c. Drop the selected folder(s)/file(s).
When you check in files from the Client window, only the selected files are
checked into the RCS on the Server. When you check in folder, all subfolders
and files within the selected folder(s) are checked into the RCS on the Server.
The checked in folder(s)/file(s) are unlocked by default. You will be prompted
for comments via the Check-In dialog.

3BUR002117R3701 41
Mouse Operation Section 3 Configuration/Application Building

• check out folder(s)/file(s) from RCS of Server RCS window to Client

window
To check out one or more folders/files from the RCS of the Server RCS
window and move them to the Client window using drag and drop,
a. For the folders, in the tree or list view of the Server RCS window, select
the Sequences and/or Recipes folder(s) you want to check out of the RCS
and hold down the left mouse button.
or
For selected files, in the list view of the Server RCS window, select the
file(s) you want to check out of the RCS and hold down the left mouse
button.
or
For all sequence and recipe files, in the tree or list view of the Server RCS
window, select the project object for which you want to check out all
sequences and recipes from the RCS and hold down the left mouse button.
b. Drag the selected folder(s)/file(s) to the desired folder in the tree view or
anywhere in the list view of the Client window.
c. Drop the selected folder(s)/file(s) to move the selected folder(s)/file(s) to
the Client window without locking them.
or
Press the ALT key and drop the selected folder(s)/file(s) to move the
selected folder(s)/file(s) to the Client window and lock them.
When you check out selected files from the RCS of the Server RCS window,
only the selected files are moved to the Client window. When you check out all
files from the RCS of the Server RCS window, all of the sequence and recipe
files on the server are moved to the Client window. When you check out the
Sequences and/or Recipes folder(s) from the RCS of Server RCS window, all
sequence and/or recipe files within the selected folder(s) of the Server are
moved to the Client window. By default, the checked out folder(s)/file(s)
moved to the Client window are the latest revision, unlocked, and have no state
or symbolic name specified.
All files checked out locked or unlocked are read-write on the client.

42 3BUR002117R3701
Section 3 Configuration/Application Building Mouse Operation

• reposition open windows, resizing open windows, and resizing panes of

windows
You can also use the drag and drop feature to reposition open windows, resize
open windows, and resize panes of windows within the workspace of the TCL
Builder window in the same manner you perform these functions for Microsoft
Windows applications.

Right Mouse Button

Clicking the right mouse button in the tree or list view to select an object in the
Client or Server and Library RCS windows, opens a context menu, Figure 18, of
frequently used items from the File, Edit, Revision, and View menus. The context
menu items are sensitive to the object selected and are dimmed (not available) for
selection if the option does not apply to the selected object.

TCL Client TCL Server TCL Library Open TCL Files

Figure 18. Context Menus

3BUR002117R3701 43
Cursor Positioning via the Keyboard Section 3 Configuration/Application Building

Cursor Positioning via the Keyboard

In addition to the mouse, you can use the TAB, SHIFT+TAB, RETURN, and up,
down, left and right arrow keys on the keyboard to position the cursor. These keys
are referred to as the cursor positioning keys.
The cursor positioning keys allow you navigate between fields and buttons on
dialogs as follows.
• TAB moves the cursor forward through the editable fields and buttons on
dialog boxes row by row from left to right and then top to bottom. If the last
editable field on a dialog box is selected when you press TAB, focus is moved
to the first editable field at the top of that dialog box. If there is no button to the
right of the currently selected button on a dialog box when you press TAB,
focus is moved to the first button on the dialog box.
• SHIFT+TAB moves the cursor backward through the editable fields and
buttons on dialog boxes row by row from right to left and then bottom to top. If
the first editable field on a dialog box is selected when you press SHIFT+TAB,
focus is moved to the last editable field at the bottom of that dialog box. If there
is no button to the left of the currently selected button on a dialog box when
you press SHIFT+TAB, focus is moved to the last button on the dialog box.
• On dialog boxes, if you press RETURN when focus is on a button, the
function associated with that button is initiated.
• The left and right arrow keys are used to move the cursor within editable fields
on dialog boxes.
• On dialog boxes, the up arrow key moves the cursor to editable field above the
currently selected field, if any. The down arrow key moves the cursor to the
editable field below the currently selected field, if any.

44 3BUR002117R3701
Section 3 Configuration/Application Building Adjusting the User Interface

Adjusting the User Interface

To make it easier to view data, you can arrange and resize windows within the
workspace of the TCL Builder window, expand and collapse the tree structure in the
Client and Server windows, refresh the contents of the Client and Server windows.
The procedures to do so follow.

Arranging Windows
You can arrange the Client window, Server Library and RCS windows, TCL
Sequence and Recipe windows and so on within the TCL Builder window in any
one of the following ways:
• cascade
• tile horizontally
• tile vertically
To do so, use the corresponding tool bar buttons or Window menu items described
under the headings Tool Bar on page 34 and Window Menu on page 33. You can
move the windows within the workspace as desired via dragging and dropping as
described under the heading Drag and Drop on page 40. You can also minimize and
maximize the windows using the standard window control buttons in the upper left
corner of the window or via Window menu items. Refer to the description under the
heading Left Mouse Button on page 36 for information about minimizing and
maximizing windows via the standard window control buttons.

Resizing Windows
You can resize the windows within the workspace of the TCL Builder window by
dragging and dropping the window borders or resize target as described under the
heading Drag and Drop on page 40.

Using the Tree View

The different levels within the tree view hierarchy can be compressed and expanded
via subtree buttons in the tree structure. The entire area of the tree view is scrollable.
Navigation in the tree view is via the scroll bar.

3BUR002117R3701 45
Adjusting the User Interface Section 3 Configuration/Application Building

Only one object at a time can be selected in the tree view. When an object is
selected, operations can be performed on the object via the menu bar or mouse
actions (for example, drag and drop and context menu). Any operations performed
through the menu options (of both the menu bar and context menu) are based on the
object selected in the tree view. The menu items are sensitive to the object selected
and are not available for selection if the option does not apply to the selected object.
You can expand or collapse the tree structure in the tree view of the Client and
Server windows to show as much or as little data as desired using the subtree
buttons. A subtree button (+ or -) is provided to the left of each parent object that
has descendant objects (children) inserted under them, Figure 19. Select the +
subtree button to expand or the - subtree button to collapse branches within the tree
structure.

Subtree button

Figure 19. Subtree Button

Using the List View

The columns in the list view of the Client and Server windows can be resized to
enlarge or hide the data shown. You navigate the data shown in the list view via the
scroll bars.

46 3BUR002117R3701
Section 3 Configuration/Application Building How to Obtain Help

Initially, the order of folders and the order of files within the folders in the list view
is alphabetical. The list view objects can be sorted by object name, size, type, and
modification date by clicking on the column heading. Successive selection of the
column heading reverses the sort order. The columns showing this information can
be resized to enlarge or hide the data shown. You navigate the data shown in the list
view via the scroll bar.
Multiple objects can be selected at one time in the list view. When an object or
objects are selected, operations can be performed on the object(s) via the menu bar
or mouse actions. Any operations performed through the menu options (of both the
menu bar and context sensitive menu) are based on the object(s) selected in the list
view. The menu items are sensitive to the object(s) selected and are not available for
selection (dimmed) if the option does not apply to the selected object or all of the
selected objects.

Refreshing Contents of Client and Server Windows

By default, the Server Library and RCS windows are automatically refreshed when
changes are made to RCS or On-line sequences and recipes. If the Server Window
Auto Refresh item of the View menu is not checked, there is no automatic refresh
of the Server Library and RCS window when changes are made to RCS or On-line
sequences and recipes.
The Client window is always automatically refreshed by default.
To demand a refresh of the Server Library or RCS window (when automatic refresh
is not checked) or the Client window, choose View > Refresh from the menu bar of
the TCL Builder window or press F5.
If the Client window is refreshed, the files in the current folder are updated with
current information that reflects any new and/or deleted files. If the Server Library
or RCS window is refreshed, the revisions in the current project are updated with
current information that reflects any new and/or deleted files.

How to Obtain Help

Within the TCL Builder, there are two kinds of help: About and Tool Tip. The
About help displays information pertaining to the current release of the TCL
Builder. Tool Tip help displays the function initiated by a tool bar button as you use

3BUR002117R3701 47
How to Obtain Help Section 3 Configuration/Application Building

the mouse to move the cursor over that button. Figure 20 shows an example of
ToolTipText for a button in the tool bar.

Figure 20. Example of ToolTipText for a Tool Bar Button

To display information pertaining to the current release of the TCL Builder, choose
Help > About TCL Builder… from the menu bar. This opens the About TCL
Builder window. Click on the OK button to close the About TCL Builder window.

48 3BUR002117R3701
Section 3 Configuration/Application Building Application Start-up

Application Start-up
There are two parts to starting up the TCL Builder application:
• Starting the Client
• Connecting to the Server
Having started the TCL Builder application, you adjust the arrangement of the
windows within the TCL Builder window. See Adjusting the User Interface on page
45.

Starting the Client

You can start the TCL Builder Client using either of the following methods:
• From the Windows Start Menu
• From the Desktop
• Selecting a Sequence or Recipe File in Windows Explorer

From the Windows Start Menu

To launch the TCL Builder from the Windows Start menu, choose
Start > Programs > ABB Industrial IT > Control IT > AdvaBuild > TCL
Builder.
This opens the Client window inside the TCL Builder window, Figure 21.

3BUR002117R3701 49
Starting the Client Section 3 Configuration/Application Building

Figure 21. Client Window Opened

From the Desktop

If you have a shortcut icon for the TCL Builder defined on your desktop,
double-click on the icon. This opens the Client window inside the TCL Builder
window, Figure 21.

Selecting a Sequence or Recipe File in Windows Explorer

As an alternative, you can launch the TCL Builder Client directly from Windows
Explorer. To do this:
1. In Explorer, browse to a folder that contains TCL sequence files with .tcl
extensions, and/or TCL recipe files with .rcp extensions.
2. Select one or more files.
3. Open the selected file(s) using one of the following methods:

50 3BUR002117R3701
Section 3 Configuration/Application Building Starting the Client

– Choose File > Open from the menu bar of the Windows Explorer window
– Right-click on a selected file, and choose either Open or Edit from the
context menu.
– Double-click on a selected file.
This opens the appropriate TCL Sequence or Recipe window for each of the
selected files as well as the TCL Builder Client window, Figure 22.

Figure 22. Starting the TCL Builder Client From Windows Explorer

3BUR002117R3701 51
Connecting to the Server Section 3 Configuration/Application Building

Connecting to the Server

To connect the Client to the TCL Builder Server:
1. Choose File > Connect from the TCL Builder menu bar. This displays the TCL
Builder Logon dialog, Figure 23.

Figure 23. TCL Builder Logon Dialog

2. By default, the name of the last server you successfully logged into is displayed
in the Server field. To open a project whose data is stored on a server other than
the one displayed in the Server field, select the desired server from the pick list
or type the desired server name in the Server field.
3. The pick list for the Project Name field contains a list of all projects located on
the specified server. Select the project you want to open from the pick list in the
Project Name field.
4. The pick list for the User Name field contains a list of all users defined for the
selected project. Select your user name for the project you want to open from
the pick list in the User Name field.
5. Enter your password in the Password field.

52 3BUR002117R3701
Section 3 Configuration/Application Building Connecting to the Server

6. Click on Logon to open the TCL Builder view of the project.

If you specified valid parameters, the Server Library and RCS windows for the
specified project are opened within the workspace of the TCL Builder window,
Figure 24.

Figure 24. TCL Builder Client, Server Library, and Server RCS Windows

3BUR002117R3701 53
Application Procedures Section 3 Configuration/Application Building

Application Procedures
The remainder of this section describes the following functions of the TCL Builder:
• Managing Directories and Files
• Using the Editor
• Checking Syntax
• Using Revision Control
• Compiling and Linking Files
• TCL Recipe Decompile
• Remove Recipe Source
• Convert to ASCII
• TCL Recipe Tuning Procedure
• Printing
• Exiting the TCL Builder
The above functions you can perform depend on your user type.
When a project is created, a default configuration user is assigned automatically.
The default configuration user (project_name_CFG) has unrestricted access to all
project data and read-only access to journal data. In addition to the default
configuration user, other users of the three types with the privileges shown in
Table 2 can be defined for the project.

Table 3 identifies the TCL Builder functions each user type can perform.

Managing Directories and Files

You are responsible for creating and managing the directory structure where TCL
sequence and recipe files are stored. This involves creating new folders and files,
and deleting old ones. This functionality is supported by the TCL Builder Client
window.
The default root is My Documents/My TCL.

54 3BUR002117R3701
Section 3 Configuration/Application Building Managing Directories and Files

Table 2. Project User Types and Their Privileges

User Type Privilege

CONFIG The CONFIG user has full write access to all project data, read-only
access to journal data, as well as the ability to do On-line Builder
functions such as compile, install, and download.
WRITER The WRITER user has full write access to all project data, but
read-only access to journal data. This allows the user to select, insert,
delete, and update project data. The WRITER user usually does most
of the actual database configuration work.
READER The READER user has read only access to all project and journal
data.

Table 3. Functions Available for Each Project User Type

Function CONFIG WRITER READER

Check In Yes Yes No
Syntax Check Yes Yes Yes
Check Out Yes Yes Yes
Check Out Locked Yes Yes No
Revision Log Yes Yes Yes
Show Differences Yes Yes Yes
Lock/Unlock Yes Yes No
Set Active Revision Yes No No
View Compiler Listing Yes Yes Yes
Compile Yes No No
Link Yes No No
Compile and Link Yes No No
Remove Yes No No

3BUR002117R3701 55
Creating a Folder Section 3 Configuration/Application Building

Table 3. Functions Available for Each Project User Type (Continued)

Function CONFIG WRITER READER

Decompile Yes No No
Remove Recipe Source Yes No No
Convert to ACSII Yes No No

Creating a Folder
Create a directory structure for organizing your TCL sequence and recipe files. To
create a folder:
1. In the Client window, select the parent folder that you want to create the new
folder under, Figure 25.
or
In the Server RCS window, select the Project object in the tree view.

Figure 25. Selecting the Parent Folder

2. Choose File > New > Folder from the TCL Builder menu bar, Figure 26.

56 3BUR002117R3701
Section 3 Configuration/Application Building Creating a Folder

Figure 26. File > New Cascade Menu

This creates the new folder under the folder you selected in Step 1, Figure 27
with its name highlighted for renaming.

Figure 27. New Folder

3. Type the name for the new folder and press ENTER, Figure 28.

Figure 28. Renaming the Folder

3BUR002117R3701 57
Creating a New File Section 3 Configuration/Application Building

Creating a New File

There are two file types: TCL Sequence and TCL Recipe. The procedure is basically
the same for both file types, and is very similar to Creating a Folder. To create a new
file:
1. In the Client window, select the folder where you want to create the new file.
2. Choose File > New > Sequence to create a sequence file.
or
Choose File > New > Recipe to create a recipe file.
This opens the TCL Editor with the default version of the selected file type.
The default recipe file is shown in Figure 29. The default sequence file is
shown in Figure 30.

Figure 29. TCL Editor Opened for New Recipe File

Figure 30. TCL Editor Opened for New TCL Sequence File

58 3BUR002117R3701
Section 3 Configuration/Application Building Opening One or More Files

The default sequence file provides the following pre-defined structures:

• the file header with:
– PROC is the default sequence type. Refer to the TCL User’s Guide for
further details regarding TCL sequence types.
– $Header$ is a header marker. This marker causes updated revision control
information to be inserted into the file whenever it is checked out. Header
markers are described in detail in Marking Revisions on page 73.
– $Revision$ is the revision number of the checked out file.
• STEP/END STEP structure.
Use the editor provided by the TCL Builder to define/edit the syntax of the new
TCL sequence or recipe file. See Using the Editor on page 68 for information about
how to use the editor provided by the TCL Builder.
You can also use a text editor that is independent of the TCL Builder (for example,
Notepad) to edit TCL sequence and recipe files, if you prefer.
For information regarding file syntax for TCL sequences and recipes, refer to the
TCL User’s Guide. See Checking Syntax on page 76 for information on how to
check the syntax.

Opening One or More Files

Files opened from the Server RCS window are read-only and cannot be edited. To
edit such files, they must be checked out of the RCS on the server, edited on the
client, and then checked back into the RCS on the server.
If you selected one or more files in the tree view of the Server RCS window to
open, the appropriate TCL Sequence or Recipe window for only the latest
revision is opened for each selected file. If you selected one or more files in the
list view of the Server RCS window to open, an appropriate TCL Sequence or
Recipe window for only the selected revision is opened for each selected file.

To open one or more files by selecting the desired file(s) in the tree or list view of
the Client or Server RCS window, use any of the following five methods:

3BUR002117R3701 59
Opening One or More Files Section 3 Configuration/Application Building

• Double-click the file name.

• Right-click on the file name and choose Open from the context menu.
• Choose File > Open from the TCL Builder menu bar.
• Click on the Open button in the tool bar.
• Press CTRL+O.
An appropriate TCL Sequence or Recipe window is then opened for each selected
file.
To open one or more files without selecting the desired file(s) in the Client or Server
RCS window,
1. Choose either File > Open from the menu bar of the TCL Builder window or
Open from the context menu.
This displays the Open dialog, Figure 31.

Figure 31. Open Dialog

2. In the Look in field, enter the directory location where the sequence and/or
recipe file(s) you want to open reside or select it from the pick list displayed

60 3BUR002117R3701
Section 3 Configuration/Application Building Opening One or More Files

when you click on the down arrow button to the right of the field. You can also
use the Up One Level button (the file folder with an up arrow) to specify the
directory location or the Create New folder button to create a new directory.
3. The Open dialog has filters for TCL sequence files (.tcl), TCL recipe files
(.rcp), TCL sequence listing files (.lis), and all file types (*.*) as shown in
Figure 32. Select the appropriate file type for the file(s) you want to open from
the pick list displayed when you click on the down arrow button to the right of
the Files of type field.
All files of the specified type that reside in the specified directory are displayed
in the scroll area below the Look in field.

Figure 32. File Type Filters of Open Dialog

4. Select the file(s) you want to open in the scroll area below the Look in field.
5. Click on the Open button to close the Open dialog and open an appropriate
TCL Sequence, Sequence Listing or Recipe window for each selected file.
Figure 33 shows an example of a TCL Sequence window, Figure 34 shows an
example of TCL Sequence Listing window, and Figure 35 shows an example of
a TCL Recipe window.
The File menu also lists up to 10 of the most recently edited files. Selecting a file in
this list opens the appropriate sequence, sequence listing, or recipe window for that
file.

3BUR002117R3701 61
Opening One or More Files Section 3 Configuration/Application Building

Figure 33. Example of TCL Sequence Window

Figure 34. Example of TCL Sequence Listing Window

62 3BUR002117R3701
Section 3 Configuration/Application Building Saving a File

Figure 35. Example of TCL Recipe Window

Use the editor provided by the TCL Builder to define/edit the syntax in the open
TCL Sequence or Recipe window. See Using the Editor on page 68 for information
about how to use the editor provided by the TCL Builder.
You can also use a text editor that is independent of the TCL Builder (for example,
Notepad) to edit TCL sequence and recipe files, if you prefer.
For information regarding file syntax for TCL sequences and recipes, refer to the
TCL User’s Guide. See Checking Syntax on page 76 for information on how to
check the syntax of TCL sequence and recipe files.

Saving a File
Editing TCL sequences and recipes involves opening a TCL Sequence or Recipe
window and then using the editor to make changes to the file. When you work in
TCL Sequence or Recipe window, you are actually working in a temporary
workspace. To record your work permanently in the file, you must save it (by
choosing File > Save, File > Save As… or File > Save All from the menu bar,
choosing Save from the context menu, or clicking on the Save button (floppy disk)
of the tool bar). This arrangement minimizes the likelihood of mistakes. You can

3BUR002117R3701 63
Saving a File Section 3 Configuration/Application Building

make a change in the TCL Sequence or Recipe window and then discard the change
by exiting the editor before saving the change. (To exit the TCL Sequence or Recipe
window, click on the Close button (X) in the window’s upper right corner or choose
Close from the context menu.) If changes are discarded, the sequence or recipe file
on the client disk is not affected.
To save your work on the client under the same name in the current folder, use one
of the following four methods:
• Choose File > Save from the TCL Builder menu bar.
• Choose Save from the context menu.
• Click on the Save button in the tool bar.
• Press CTRL+S.
If the TCL sequence or recipe was not previously saved, the Save As dialog is
opened, Figure 36. The Save in field contains the name of the currently
selected folder in the Client window, and the Save as type field contains the
type appropriate for the file you were editing. All files of the specified type that
reside in the specified folder are displayed in the scroll area below the Save in
field.
To proceed to save the edited file in the current folder,
a. Enter the desired file name in the File name field.
The file name can be up to 12 alphanumeric characters, including the
underscore. To avoid problems with other software applications, do not
use a hyphen in the file name. The first eight characters of the file name
must be unique within the current project. Do not include the suffix. The
appropriate suffix (based on the selected file type) is appended
automatically.
b. Click on the Save button to close the Save As dialog and save the file on
the client under the specified name.

64 3BUR002117R3701
Section 3 Configuration/Application Building Saving a File

Figure 36. Save As Dialog

To save your work on the client under a different name in the current or a different
folder,
1. Choose File > Save As… from the TCL Builder menu bar.
This opens the Save As dialog, Figure 36. The Save in field contains the name
of the currently selected folder in the Client window, the File Name field
contains the file’s current name, and the Save as type field contains the type
appropriate for the file you were editing. All files of the specified type that
reside in the specified folder are displayed in the scroll area below the Save in
field.
2. If you want to save the file in a different folder, in the Save in field, enter the
directory location where you want to store the file or select it from the pick list
displayed when you click on the down arrow button to the right of the field.
You can also use the Up One Level button to specify the directory location or
the Create New folder button to create a new directory.
3. Enter the desired file name in the File name field.

3BUR002117R3701 65
Saving a File Section 3 Configuration/Application Building

The sequence or recipe name can be up to 12 alphanumeric characters,

including the underscore. To avoid problems with other software applications,
do not use a hyphen in the file name. The first eight characters of the file name
must be unique within the current project. Do not include the suffix. The
appropriate suffix (based on the selected file type) is appended automatically.
4. Click on the Save button to close the Save As dialog and save the file as
specified.
If a file with the same name already exists in the directory specified, a dialog,
Figure 37, opens asking whether to overwrite the existing file. Click on the Yes
button to close the dialog and overwrite the existing file, or click on the No button to
close the dialog and return to the Save As dialog where you can specify a different
file name or destination for the file.

Figure 37. File Already Exists Warning for Save

If you specify an invalid location where the file should be saved, a warning message
box is displayed, Figure 38. Click on the OK button to close the message box and
return the Save As dialog where you can specify a different destination for the file.

Figure 38. Invalid Path Warning for Save

66 3BUR002117R3701
Section 3 Configuration/Application Building Moving Folders or Files Within the Client Window

To save all open files in their current directories, choose File > Save All from the
menu bar or click on the Save All button (multiple diskettes) in the tool bar of the
TCL Builder window.

Moving Folders or Files Within the Client Window

To move one or more folders or files within the Client window, use the drag and
drop function as described under the heading Drag and Drop on page 40. You will
be prompted for confirmation before overwriting any existing folders or files.

Renaming a Folder or File

To rename a folder or file in the Client window, select the folder or file you want to
rename, then choose File > Rename from the menu bar, choose Rename from the
context menu, or use the mouse as in the description of how to initiate the object
rename function under the heading Left Mouse Button on page 36. Either method
places the text cursor at the end of the selected folder’s or file’s name. Use the
keyboard to change the name as desired. If the rename operation fails, an error
message is displayed.

Deleting Folders and Files

To delete one or more folders or files in the Client window, select the folder(s) or
file(s) you want to delete, then choose File > Delete from the menu bar or choose
Delete from the context menu. This opens a confirmation dialog for each folder or
file selected that asks whether you want to delete the selected folder or file,
Figure 39. Click on Yes to close the dialog and delete the selected folder or file.
Click on No to close the dialog without deleting the selected folder or file.

Figure 39. Confirm Deletion Dialog

3BUR002117R3701 67
Displaying Folder or File Properties Section 3 Configuration/Application Building

Displaying Folder or File Properties

To display the properties for a folder or file in the Client window, select the folder or
file for which you want to display its properties and then choose Properties from
the context menu. This opens the Properties dialog for the selected folder or file.
Use this dialog to change the properties as desired. Use the Apply button to make
the changes and leave the dialog open. Click on the OK button to close the dialog.

Using the Editor

TCL sequences and recipes are created as text files. The TCL Builder Client
provides an editor for editing TCL sequence and recipe files. Basic editing functions
such as cut, copy, paste, and search/replace are provided via the TCL Builder Edit
menu items and tool bar buttons. This section describes how to use the basic editing
functions and how to use revision markers in sequence and recipe files.
You can also use a text editor that is independent of the TCL Builder (for example,
Notepad) to edit TCL sequence and recipe files, if you prefer.
For information regarding file syntax for TCL sequences and recipes, refer to the
TCL User’s Guide. See Checking Syntax on page 76 for information on how to
check the syntax.

Recipes are defined in TCL and they have a Recipe ID and also a Description.
The description is created when editing/creating the TCL recipe source code.
There is no option to change the recipe description except by editing source. The
TCL Recipe Editor cannot change the Recipe Description. To change the Recipe
Description, you must Decompile the recipe, edit the source and then Re-
compile.

How to Use the Basic Editing Functions

Only the Copy and Select All functions are available from the context menu
when viewing a TCL Sequence Listing.

68 3BUR002117R3701
Section 3 Configuration/Application Building How to Use the Basic Editing Functions

Cutting Text from a TCL Sequence or Recipe File

To cut or delete text from a TCL sequence or recipe file and copy it to the clipboard
for future pasting, either:
1. In the appropriate TCL Sequence or Recipe window, select the text you want to
cut from the file. To select all text in the file, choose
– Edit > Select All from the menu bar of the TCL Builder window,
– choose Select All from the context menu, or
– press CTRL+A.
To deselect all selected text, choose Edit > Deselect All from the menu bar of
the TCL Builder window.
2. To delete the text only, press Delete. to delete the text and place it in the paste
buffer, choose
– Edit > Cut from the menu bar or
– choose Cut from the context menu or
– Click on the Cut button (scissors) in the tool bar or
– Press CTRL+X.
The selected text is then deleted from the TCL Sequence or Recipe window and
copied to the clipboard for future pasting. Note that the contents of the clipboard are
replaced by the selected text of the next cut or copy operation.

Copying Text from a TCL Sequence or Recipe File

To copy text from a TCL sequence or recipe file to the clipboard for future pasting,
either:
1. In the appropriate TCL Sequence or Recipe window, select the text you want to
copy. To select all text in the file, choose
– Edit > Select All from the menu bar of the TCL Builder window,
– choose Select All from the context menu, or
– press CTRL+A.
To deselect all selected text, choose Edit > Deselect All from the menu bar of
the TCL Builder window.
2. Choose Edit > Copy from the menu bar or
– choose Copy from the context menu or
– Click on the Copy button (duplicate pages) in the tool bar or

3BUR002117R3701 69
How to Use the Basic Editing Functions Section 3 Configuration/Application Building

– Press CTRL+C.
The selected text is then copied to the clipboard for future pasting. Note that the
contents of the clipboard are replaced by the selected text of the next cut or copy
operation.

Pasting Copied or Cut Text into a TCL Sequence or Recipe

To paste the selected text on the clipboard (from either a previous cut or copy
operation) into a TCL sequence or recipe,
1. Place the cursor at the desired location within the appropriate TCL Sequence or
Recipe window.
2. Choose Edit > Paste from the menu bar or
– choose Paste from the context menu or
– Click on the Paste button (clipboard) in the tool bar or
– Press CTRL+V.
Regardless of which method above you use, the cut or copied text on the clipboard
is inserted in the TCL sequence or recipe before the cursor. If you selected all or a
portion of text in the current TCL Sequence or Recipe window before you initiated
the paste operation, the selected text is replaced by the text on the clipboard.

Searching a TCL Recipe, Sequence or Sequence Listing File

To search a TCL recipe, sequence or sequence listing file for a specific text string
(for example, a templet name),
1. In the appropriate open TCL Sequence or Recipe window or TCL Sequence
Listing window, choose
– Edit > Find from the menu bar of the TCL Builder window or
– Click on the Find button (binoculars) in the tool bar of the TCL Builder
window or
– Press CTRL+F.
This opens a Find dialog, Figure 40.

70 3BUR002117R3701
Section 3 Configuration/Application Building How to Use the Basic Editing Functions

Figure 40. Find Dialog

2. If you selected a text string prior to opening the Find dialog, that text string is
displayed in the Find What field; otherwise, the Find What field is empty. Enter
the text string you want to find in the Find What field.
By default, the search looks for all instances of the specified text string,
regardless of whether it contains the same upper- and lower-case letters as
specified in the Find What field or whether it is only part of a larger word.
3. If you want to limit the search to only those instances that exactly match the
upper- and lower-case letters of the text string as specified in the Find What
field, select the Match Case check box. When selected, the Match Case check
box contains a check mark.
4. If you want to limit the search to only those instances that are not part of a
larger word, select the Find Whole Word Only check box. When selected, the
check box contains a check mark.
5. Select the desired search direction (All, Down, or Up) from the pick list for the
Direction field.
6. Click on the Find button to start searching the recipe, sequence or sequence
listing file for the specified text string.
If an instance of the specified text string is found in the recipe, sequence or sequence
listing file, it is highlighted and the label on the Find button changes to Find Next.
Click on the Find Next button to continue finding instances of the specified text
string in the recipe, sequence or sequence listing file. If the specified text string is
not found in the recipe, sequence or sequence listing file, a message box indicating

3BUR002117R3701 71
How to Use the Basic Editing Functions Section 3 Configuration/Application Building

so is opened. Click on the OK button to acknowledge the message and close the
message box.

Replacing a Text String in a TCL Sequence or Recipe File

To replace a specific text string in a TCL sequence or recipe file,
1. In the appropriate open TCL Sequence or Recipe window, choose
– Edit > Replace from the menu bar of the TCL Builder window or
– Press CTRL+R.
This opens a Replace dialog, Figure 41.

Figure 41. Replace Dialog

2. If you selected a text string prior to opening the Find dialog, that text string is
displayed in the Find What field; otherwise, the Find What field is empty. Enter
the text string you want to find in the Find What field.
By default, the search looks for all instances of the specified text string,
regardless of whether it contains the same upper- and lower-case letters as
specified in the Find What field or whether it is only part of a larger word.
3. If you want to limit the search to only those instances that exactly match the
upper- and lower-case letters of the text string as specified in the Find What
field, select the Match Case check box. When selected, the Match Case check
box contains a check mark.

72 3BUR002117R3701
Section 3 Configuration/Application Building Marking Revisions

4. If you want to limit the search to only those instances that are not part of a
larger word, select the Find Whole Word Only check box. When selected, the
check box contains a check mark.
5. Enter the text string you want to replace in the Replace With field.
6. Select the desired search direction (All, Down, or Up) from the pick list for the
Direction field.
7. Click on the Find button to start searching the sequence or recipe file for the
specified text string.
If an instance of the specified text string is found in the sequence or recipe file,
it is highlighted and the label on the Find button changes to Find Next.
8. Click on the Replace button to replace the highlighted instance with the text
string entered in the Replace With field.
or
Click on the Replace All button to replace all instances of the found search
string with the text string entered in the Replace With field.
or
Click on the Find Next button to continue finding instances of the specified
text string in the sequence or recipe file.
If the specified text string is not found in the sequence or recipe file, a message box
indicating so is opened. Click on the OK button to acknowledge the message and
close the message box.

Marking Revisions
Markers are used individually or in combination to mark sequence and recipe files
with revision information. Table 4 shows the available revision marker types.

Table 4. Available Revision Marker Types

Keyword Description
$Author$ author name (the name you use to log on to the client).
$Date$ date and time file was last checked into the RCS.

3BUR002117R3701 73
Marking Revisions Section 3 Configuration/Application Building

Table 4. Available Revision Marker Types (Continued)

Keyword Description
$Locker$ name of user that locked the revision. To edit a file, it must be
checked out of the RCS locked. This prevents having more than
one author editing at the same time. Since more than one author
can be using the TCL Builder at any time, the locker may be
someone other than the original author.
$Revision$ revision number that is automatically generated when you check in
the file to RCS. See Checking In a File on page 82.
$Source$ full path name of RCS file (location where revision resides).
$State$ parameter that you can define when you check a file in to the RCS.
For this release, state is pre-defined as Exp.
$Header$ marker that combines the $Source$, $Revision$, $Date$,
$Author$, $State$, and $Locker$ markers. Thus, it can be used as
a shorthand method for entering all of these markers.
$Id$ same as $Header$ except that the $Source$ is replaced by
$RCSfile$
$Log$ list of revisions with the following information for each revision:
RCS file name, revision number, author, date/time of last check in,
and log message.
Existing log messages are not replaced. Instead, the new log
message is inserted after $Log…$. This is useful for accumulating
a complete change log in a source file. Each inserted line is
prefixed by the string that prefixes the $Log$ line. For example, if
the $Log$ line is // $Log$: tan.cc $, RCS prefixes each line of the
log with //
$Name$ symbolic name used to check out the revision, if any.
$RCSfile$ name of RCS file without a path

To use a marker, insert the marker as a comment or variable in the TCL source code,
and then check in the file to the RCS. The next time you check out the revision, the
information associated with that marker is displayed in the file header. This feature
is very helpful for keeping track of revisions as you edit sequence and recipe files.

74 3BUR002117R3701
Section 3 Configuration/Application Building Marking Revisions

You are not required to update the marker information each time you edit the file.
The system updates this information automatically when you check a revision in,
and the updated information is automatically displayed when you check out the file.
Figure 42 and Figure 43 illustrate the operation of the $Author$, $Date$, $Locker$,
and $Revision$ markers. These markers are inserted as a comment in the file header,
which is then checked in to the RCS. Subsequently, when the file is checked out and
opened, the header displays up-to-date revision information as shown in Figure 43.

Markers Shown
Inserted in
Sequence File

Figure 42. Header Markers Inserted in Sequence File

Revision Information Displayed

in Source File After Check Out

Figure 43. Example, Markers Providing Revision Information After Check Out

Markers are only applicable when you check a file in to the RCS. If the file is not
checked in, the revision information will not be updated, and displayed when you
open the file.
The rules for using markers are as follows:

3BUR002117R3701 75
Checking Syntax Section 3 Configuration/Application Building

• Markers are always bounded by dollar signs ($), for example: $Author$. Even
when a series of markers are used in combination, each instance must be
bounded by dollar signs, for example: $Author$ $Date$.
• Do not enter space between the dollar signs and marker name. For example,
$Revision$ is OK, $ Revision $ is wrong.
• Always use an initial capital letter, followed by lower case letters in the marker
name. For example, $Source$ is OK, $SOURCE$, and $source$ are wrong.
• When used in combination, there must be a space between each marker
instance. For example, $Author$ $Date$ is OK, $Author$$Date$ is wrong.
• Markers must always be inserted either as a comment, or as a variable.
• Use just the marker keyword in the comment (for example, $Revision$). DO
NOT enter raw data (for example, Rev 1.2). This data is updated and inserted in
the file when the file is checked in.
• When using markers in combination in variable declarations, if the resulting
text string exceeds 39 characters, any characters beyond 39 will be truncated
when the file is compiled.
The following examples in Table 5 and Table 6 show how to enter a marker as a
comment or string variable, and what the resulting output will be when you check
out a revision
.

Checking Syntax
Prior to checking in a file to the TCL Builder RCS, it is recommended that you run
the Syntax Checker. This eliminates the majority of errors prior to compiling the file
and may save you from having to redownload the file later. You can run the Syntax
Checker from the Client window or directly from the TCL Sequence window as
described in the sections that follow. In both cases, the results are included in a
sequence listing file; however, the sequence listing file is only saved on the client if
the Syntax Checker is run from the Client window.

76 3BUR002117R3701
Section 3 Configuration/Application Building Checking Syntax

Table 5. Examples of Markers in Comments

Marker Entry Comment at Next Check Out

/*$Header$*/ /*$Header: C:\ \Program\040Files\ \Abb\ \Advant\ \Data\
\AdvantES\ \Project\ \HUGO\ \tcl\ \RCS\ \BADBIGSUBR.tcl,
v1.5 2000-05-04 15:03:36-04 tar228 Exp tar228$*/
/*$Log$*/ /*$Log: BADBIGSUBR.tcl, v$
Revision 1.5 2000-05-04 15:03:36-04 tar228
Check In
Revision 1.4 2000-05-04 14:25:21-04 tar228
Check In
Revision 1.3 2000-05-04 9:30:09-04 tar228
Check In$*/
/*$Revision$ $Author$ $State$*/ /*$Revision: 1.5$ $Author: tar228$ $State: Exp$*/
/*$Date$*/ /*$Date: 2000-05-04 15:03:36-04$*/
/*$Locker$*/ /*$Locker: tar228$*/
/*$Source$*/ /*$Source: C:\ \Program\040Files\ \Abb\ \Advant\ \Data\
\AdvantES\ \Project\ \HUGO\ \tcl\ \RCS\ \BADBIGSUBR.tcl,
v$*/

Table 6. An Example of a Marker in a Variable

Marker as Variable Information in Variable Section at Next Check Out

VAR RCSID: STRING; RCSID:= “$Revision: 1.5$ $Author: tar228$
RCSID:=”$Revision$ $Author$”;

3BUR002117R3701 77
Running Syntax Check from Client Window Section 3 Configuration/Application Building

If your program includes filesys statements, you must edit the FILE_FCBSIZ
constant in the filesys_incl.tcl file before you run the syntax checker.
Change the FILE_FCBSIZ constant from 48 to 50. You can use either the editor
provided by the TCL Builder or a text editor that is independent of the TCL
Builder (for example, Notepad) to edit the filesys_incl.tcl file located in:
C:\Program Files\ABB Industrial IT\AdvaBuild\bin
The larger size is only required in the TCL Builder. When you download and
compile the program on the PCI RTAB, the original file having
FILE_FCBSIZ=48 will be used. DO NOT change the FILE_FCBSIZ via the TCL
catalog, nor download the changed filesys_incl.tcl file, as this will change
the RTAB version of the filesys_incl file.
See Using the Editor on page 68 for information about how to use the editor
provided by the TCL Builder.

Running Syntax Check from Client Window

To run the syntax checker from the TCL Builder Client window, first select the
sequence file(s) in the list view whose syntax you want to check, and then choose
File > Syntax Check from menu bar. This menu item is only active when the
selected file is compilable. Optionally, you can open the file and use the context
menu and select Syntax Check.
If the TCL sequence has changed since the last save, the Syntax Checker prompts
you to save the sequence.
When the syntax check is complete, the TCL Sequence window is opened with the
source file in the upper pane, and the listing file in the lower pane, Figure 44. You
can use the window sizing target and/or horizontal separator between the two panes
to adjust the relative size of the upper and lower panes as described under the
heading Drag and Drop on page 40.
To view the next error in the sequence source and listing files, click on the Next
Error button (bug) in the tool bar of the TCL Builder menu. This highlights the next
error in the sequence listing file (lower pane) and the corresponding line in the
source file (upper pane).

78 3BUR002117R3701
Section 3 Configuration/Application Building Running Syntax Check from Client Window

Figure 44. Example, Source and Listing Files Displayed in TCL Sequence Window

In addition, the listing file is created in the same folder as the source file in the
Client window, Figure 45.

3BUR002117R3701 79
Running Syntax Check from Client Window Section 3 Configuration/Application Building

Figure 45. List File Created When You Run Syntax Check from Client Window

To view the contents of the listing file, Figure 46, open the file as described in
Opening One or More Files on page 59. You can also print the listing file as
described in Printing on page 102.

Figure 46. Example, Displaying Just the List File

80 3BUR002117R3701
Section 3 Configuration/Application Building Running Syntax Check from TCL Sequence Window

Running Syntax Check from TCL Sequence Window

To run the syntax checker from the TCL Sequence window, right click inside the
TCL Sequence window and choose Syntax Check from the context menu.
If the TCL sequence has changed since the last save, the Syntax Checker prompts
you to save the sequence.
When the syntax check is complete, the sequence listing file is displayed in the
lower pane of the TCL Sequence window, Figure 44. This listing file is not saved on
the client when you close the window.
To view the next error in the sequence source and listing files, click on the Next
Error button (bug) in the tool bar of the TCL Builder menu. This highlights the next
error in the sequence listing file (lower pane) and the corresponding line in the
source file (upper pane).

Using Revision Control

Use of the Revision Control System (RCS) is required. Sequence and recipe files
must be checked into the Revision Control System (RCS) when an editing session is
finished, and then checked out for subsequent editing. This system is maintained on
the TCL Builder Server application.
In addition to the check in and check out of files, the RCS provides a means for
organizing the RCS files, locking and unlocking files, viewing the revision history
(log) for a file, and comparing two TCL sequence and recipe files or revisions as
described in the sections that follow.

A file should not be edited unless it has been locked.

A tree structure such as the one shown in Figure 47 is maintained for each file stored
in the RCS. Base versions (1.1, 1.2, 1.3, and so on) form the trunk of the tree. The
latest base version is at the top or head of the trunk with prior versions in reverse
order below it. The initial base version is at the bottom of the trunk. Revisions
branch off from the trunk. A revision may have one or more levels of branches.

3BUR002117R3701 81
Organizing RCS Files Section 3 Configuration/Application Building

Head 1.2.2.2
1.2.2.1.1.1
1.3
1.2.1.1 1.2.2.1

1.2
Branch
Trunk
1.1

Figure 47. Revision Control Tree Structure

Organizing RCS Files

Folders are now supported to organize the RCS files. You create a folder in the
Server RCS window in same manner you create a folder in Windows.
To create a folder from the Server RCS window,
1. Select the Project object in the tree view.
2. Choose File > New > Folder from the menu bar.
3. Enter the name for the new folder.

Checking In a File
To place a new revision for a sequence or recipe file under RCS, you must first
connect to the server as described in Connecting to the Server on page 52. Unless it
is the first time you are checking the file in, the file must be locked. You are not
permitted to check in a file that was checked out unlocked. If a file is unlocked and
you want to check it in, you must first lock the file as described in Locking an
Unlocked File on page 93. When you lock a revision, no other user is permitted to
check out the revision locked. Other users are permitted to check out the revision
unlocked for viewing or syntax checking; however, they are not permitted to edit
and check in a new revision. Only one version of a file can be locked at a time, and
only the user who checked out a file may check the file back in to the RCS.

82 3BUR002117R3701
Section 3 Configuration/Application Building Checking In a File

.
Always save your work prior to checking in a file. See Saving a File on page 63.
If you don’t save your work in the editor, any changes made during the current
editing session will not be recorded when you check in the file.
To check in a file from the Client window,
1. Select one or more files you want to check in. To select all files shown in the
list view of the Client window, choose Edit > Select All from the menu bar of
the TCL Builder window, choose Select All from the context menu, or press
CTRL+A. To deselect all selected files, choose Edit > Deselect All from the
menu bar of the TCL Builder window.
2. Use one of the following methods to invoke the check in function:
– Drag and drop the file from the Client window to the Server RCS window
(Revision Status View).
or
– Choose Revision > Check In from the menu bar.
or
– Right-click on the file and choose Check In from the context menu.
or
– Click the Check In button on the tool bar.
When you check in files from the Client window, only the selected files are
checked in to the RCS on the Server. When you check in folders, all subfolders
and files within the selected folders are checked into the RCS on the Server.
The checked in folder(s)/file(s) are unlocked by default.
This opens the Select Check-In Sub Project dialog, Figure 48.

3BUR002117R3701 83
Checking In a File Section 3 Configuration/Application Building

Figure 48. Select Check-In Sub Project Dialog

3. In the Sub Project field, enter the name of the folder under which you want to
check in the sequence or recipe file.
4. Click on the OK button.
This opens the Check In dialog, Figure 49.

Figure 49. Create Initial Revisions Dialog Box

5. In the Comments scroll area of the Check In dialog, record a check-in message
for each revision. The message should be a brief summary of changes made
during the current editing session. The comments are retrieved when you
display the Revision Log as described in Viewing the Revision Log on page 90.
Comments can be up to 2048 characters.
6. Click OK when you are finished.

84 3BUR002117R3701
Section 3 Configuration/Application Building How Revision Numbers are Generated

The file is now under revision control. You can find it in the applicable folder
(Sequences or Recipes) in the Server RCS window, Figure 50.

Figure 50. Revision Status View

When you check in a file, the file remains on the Client. You may either delete the
file from the Client, or overwrite the file the next time you check the file out of
RCS.

How Revision Numbers are Generated

When you check in a file, the system automatically records a revision number,
author, date/time, and changes made (even if no changes were made) during the
current editing session.
If you check out the latest (most current) revision in a branch, when you check the
file back in, the revision number is incremented as shown in CASE 1 in Figure 51.
If you check out an earlier revision, when you check the file back in, a new branch is
started at the original (checked out) revision number. This is illustrated in CASE 2
in Figure 51.

3BUR002117R3701 85
Checking Out a File Section 3 Configuration/Application Building

1.3 1.3
1.2.1.1

1.2 1.2

1.1 1.1

CASE 1 CASE 3
Revision 1.2 is head of branch Revision 1.3 is head of the branch.
and is checked out locked. Revision 1.2 is checked out locked.
When you check it back in, the When you check it back in, a new
new head becomes revision 1.3. branch is started at 1.2. The head
of the branch becomes 1.2.1.1.

Figure 51. How Revision Numbers are Generated

Checking Out a File

You must check out a file locked from the RCS when you want to edit the file. To
check a file out of RCS, you must first connect to the Server as described in
Connecting to the Server on page 52.
You can check out a file locked, or unlocked. Check the file out locked if you intend
to edit the file. Unlocked files cannot be checked back in to the RCS. Check out the
file unlocked if you only intend to view the file.

If you check out a file unlocked, and then decide that you want to edit it, you can
lock the file after it has been checked out. See Locking an Unlocked File on page
93.

Checking Out a File Locked

To check out one or more files locked, from the Server RCS window,
1. Select the file(s) or revision(s) you want to check out. If you select a sequence
or recipe file in the list view of the Server RCS window, the latest revision is
checked out. If you select a specific revision of a sequence or recipe file from
the list view of the Server RCS window, only that revision of the sequence or
recipe is checked out. To select all files or revisions shown in the list view of
the Server RCS window, choose Edit > Select All from the menu bar of the

86 3BUR002117R3701
Section 3 Configuration/Application Building Checking Out a File

TCL Builder window, choose Select All from the context menu, or press
CTRL+A. To deselect all selected files or revisions, choose Edit > Deselect
All from the menu bar of the TCL Builder window.
2. Use one of the following methods to invoke the check out locked function.
• Drag and drop the file from the Server RCS window to the Client window
while holding down the ALT key.
or
• Choose Revision > Check Out Locked from the menu bar of the TCL Builder
window.
or
• Right-click on the selected file in the Server RCS window and choose Check
Out Locked from the context menu.
If a copy of the selected file already exists on the client, you will be prompted to
confirm whether or not to overwrite (replace) the existing file. Figure 52 shows an
example of the Confirm File Replace dialog opened when checking out multiple
files and a copy of more than one of the files already exists on the client. Click on
Yes to confirm replacement of the existing file, click on Yes to All to confirm
replacement of all existing files, click on No to not replace the existing file and
continue checking out one or more selected files, or click on Cancel to cancel
checking out any remaining selected files.

3BUR002117R3701 87
Checking Out a File Section 3 Configuration/Application Building

Figure 52. Confirm File Replace Dialog for Multiple Files

If you are checking out only one file and a copy already exists on the client, a
simpler Confirm File Replace dialog is opened, Figure 53. Click on Yes to confirm
or No to cancel.

Figure 53. Confirm File Replace Dialog for a Single File

88 3BUR002117R3701
Section 3 Configuration/Application Building Checking Out a File

When you check out a file locked, the locked file is marked with a lock symbol in
the Server RCS window, Figure 54. This window also indicates the user that locked
the file.

Lock Symbol Locked By Indication

Figure 54. Check Out Locked Indication in Server Window

Checking Out a File Unlocked

To check out a file unlocked, from within the Server RCS window,
1. Select the file(s) or revision(s) you want to check out in the same manner as for
checking out a file locked.
2. Use one of the following methods to invoke the check out unlocked function.
• Drag and drop the file from the Server RCS window to the Client window.
or
• Choose Revision > Check Out from the menu bar.
or
• Right-click on the file and choose Check Out from the context menu.
or
• Click the Check Out button on the tool bar.

3BUR002117R3701 89
Viewing the Revision Log Section 3 Configuration/Application Building

From this point the procedure is the same as for checking out a file locked, except
that the lock symbol is not displayed next to the file name in the Server RCS
window.

Keyword Substitution for Revision Markers

Keyword substitution is always performed on files checked out locked and unlocked
if revision markers with strings of the form $keyword$ or $keyword:…$ are
embedded in literal strings or in revision comments.
Initially, you enter marker strings in the form $keyword$. On check out, the marker
strings are replaced with strings of the form $keyword:value$. If a revision
containing strings of the form $keyword:value$ are checked back in to RCS, the
values are replaced during the next check out. Thus, the keyword values are
automatically updated on check out. See Marking Revisions on page 73.

Viewing the Revision Log

View the revision log to display a file’s revision history. To do this, select one or
more files (tree view) or revisions (list view) in the Server RCS window, then
choose Revision > Revision Log from the menu bar or click on the Revision Log
button (stopwatch) in the tool bar of the TCL Builder window.
This displays the Revision Log window, Figure 55. The log provides both file-level
and revision-level read-only information. For each file, the following information is
provided: RCS path name, working path name, head (number of latest revision on
the trunk), default branch, access list, locks, symbolic names, value for keyword
substitution, total number of revisions, number of revisions selected for printing,
and descriptive text. This is followed by information for the selected revisions in
reverse chronological order fro each branch. For each revision, the following
information is provided: revision number, author, check in date/time, state, number
of lines added/deleted with respect to the previous revision, name of user who
locked the revision (if locked), and comments (log-in message). If the revision has
any branches, the branches are indicated as well.
You can resize the Revision Log window as described under the heading Drag and
Drop on page 40. Use the scroll bars in the Revision Log window to view additional
information not shown within the scroll area. When you have finished viewing the
revision log, click the Close button in the upper right corner to close the window.

90 3BUR002117R3701
Section 3 Configuration/Application Building Showing Differences

File-level Information

Revision-level Information

Figure 55. Revision Log

Showing Differences
You can show the differences between two revisions in the Server RCS window, or
between one revision in the Client window and one revision in the Server RCS
window. To show differences, select the two revisions, and then choose Revision >
Differences from the menu bar of the TCL Builder window. This opens a
Differences Log window showing the differences between the two selected files. An
example is shown in Figure 56.
The first two lines of the differences log identify the two files selected for
comparison. One is identified by asterisks, while the other is identified by a line of
dashes.

3BUR002117R3701 91
Showing Differences Section 3 Configuration/Application Building

Three lines of context are shown before and after any changed lines in the log.
Changed lines are marked with an exclamation point (!). Deletions are indicated
with a minus sign (-), and additions are indicated with a plus sign (+).

Files selected for comparison

identified by asterisks and
dashes respectively

Indicates lines of context

Exclamation points
mark lines that differ
between the two revisions

Figure 56. Differences Log Window

You can resize the Differences Log window by clicking on a corner and dragging.
Use the scroll bars in the Differences Log window to view additional information
not shown within the scroll area. When you have finished viewing the differences
log, click the Close button in the upper right corner to close the window.

92 3BUR002117R3701
Section 3 Configuration/Application Building Unlocking a Locked File

Unlocking a Locked File

You can unlock a file that has been checked out locked. (A locked file is indicated
by a lock icon.) To do so from the Server RCS window,
1. Select the locked file(s) you want to unlock.
2. Choose Revision > Unlock from the menu bar of the TCL Builder window.
or
Click on the Unlock button in the tool bar.

Locking an Unlocked File

You can lock a file that has been checked out unlocked. (An unlocked file is
indicated by a text icon.) To do so from the Server RCS window,
1. Select the unlocked file(s) you want to lock.
2. Choose Revision > Lock from the menu bar of the TCL Builder window.
or
Click the Lock button in the tool bar.

Get Revision
The GetRevision executable is used to get RCS information from FMS files and
output the results to a file where you can verify what versions of files are actually
executing at runtime.

Running GetRevision
To run this program, open a Command Prompt window from the Windows task bar
by choosing Start > Programs > Command Prompt (as appropriate) and change
to the drive letter and path where AdvaBuild is installed (AdvaBuild_Bin is the
install path variable) as follows:
cd %AdvaBuild_Bin%
For TCL Sequence(s), use either of the following commands (use * to do all files or
specify a file name to do one file):
GetRevision seq *

3BUR002117R3701 93
Get Revision Section 3 Configuration/Application Building

GetRevision seq <seq name>

For TCL Recipe(s), use either of the following commands (use * to do all files or
specify a file name to do one file):
GetRevision rec *
GetRevision rec <rec name>

Viewing GetRevision Output File

All output files will be located in the Temp directory. The output file name uses
"List" when * is used;, otherwise, the file name is used as follows:
SeqList_<date>.log (for example SeqList_30May02.log)
<seq name>_<date>.log
RecList_<date>.log
<rec name>_<date>.log
The output format is as follows:
Filename, Status, FMS Date, incString, RCS ver, RCS Date
12 chars., 17chars., 19 chars., 12 chars., 6 chars., %19chars.
PL_1000, Linked, 2002/07/09 11:09:36, , 1.1, 2002-05-10 16:11:13
PL_1001C, Linked, 2002/07/09 11:09:45, , 1.1, 2002-05-10 15:13:55

94 3BUR002117R3701
Section 3 Configuration/Application Building Compiling and Linking Files

Compiling and Linking Files

To compile and link sequence files and compile recipes file maintained in the RCS,
they must first be downloaded to on-line storage on the PCI RTAB in the local TCL
development node as described below. Included are descriptions of how to schedule
compile and/or link operations and view the listing files generated by those
operations.

Downloading Files from Revision to On-line Storage

Before you can Set Active Revision, the database containing the TCL_DEV
object must be compiled and installed via the corresponding AdvaBuild Control
Builder functions, and the Windows-based Engineering Station must be rebooted.
Failure to do this will result in system diagnostics and problems trying to use that
sequence name.

When using multiple CDPs, if a sequence already exists, do not create the same sequence
name on another CDP; it will not download. To determine if the sequence or recipe
already exists in another CDP view the Compile Link Status view using TCL Builder.
Don’t create sequences on more than one CDP.
In the Server RCS window, downloading files from the TCL Builder RCS to the PCI
RTAB in the local TCL development node is called Set Active Revision. This is
required to schedule compile and link tasks for downloaded files.
The Set Active Revision can be used when the computer where your TCL Builder
software runs is equipped with a PCI Real-Time Accelerator Board (RTAB)
(connected to a control network). This transfers the files from the TCL Builder’s
Revision Control System to the local PCI RTAB where the files can be compiled
and linked. When you execute Set Active Revision, you can also specify that the
file(s) be compiled and linked when the download is finished. Otherwise, you
execute the compile and link for the selected file(s) in the Server Library window.
You can also remove an entry from the Server Library window. All of these
functions are provided via the On-line menu.

3BUR002117R3701 95
Downloading Files from Revision to On-line Storage Section 3 Configuration/Application Building

To download files from the TCL Builder RCS to the PCI RTAB in the local TCL
development node:
1. Select the Server RCS window, Figure 57.

Figure 57. Server RCS Window Revision Status View

2. In the Server RCS window, select the files to be downloaded.

3. Choose On-line > Set Active Revision from the menu bar of the TCL Builder
window. This displays the Set Active Revision dialog, Figure 58.

Figure 58. Set Active Revision Dialog

4. Select one of the compile/link options.

If you do not want to compile or link after the revision has been made active,
choose the Don’t Compile or Link option. If you want to compile or compile
and link after the revision has been made active, choose the Compile or
Compile and Link option. During the Set Active Revision process, a progress
window is displayed. Depending on the size and number of the files, these

96 3BUR002117R3701
Section 3 Configuration/Application Building Scheduling Compiles/Links

functions may complete very quickly, in which case the progress window will
appear briefly and then close.

This uses the RTAB and may affect Control Builder functions such as installs.
You will not be able to link TCL sequences while database, area, or node level
installs are in progress.
For recipes, the Compile and Link option is not available for selection.
5. Click on the OK button to close the Set Active Revision dialog and download
the selected file(s) from the TCL Builder RCS to the PCI RTAB in the local
TCL development node.
To check the status of the compile and/or link function, change to the Compile/Link
Status view as shown in Figure 59 by choosing View > Compile/Link Status from
the menu bar of the TCL Builder window.

Figure 59. Compile/Link Status View

Scheduling Compiles/Links
It is only necessary to schedule compiles/links from the Compile/Link Status view
of the Server RCS window when you choose not to compile and/or link after setting
the active revision. To do so,
1. Select the file(s) you want to compile and/or link.

3BUR002117R3701 97
Viewing Compiler/Linker Listing File Section 3 Configuration/Application Building

Do not select multiple versions of the same file and attempt to compile and link.

2. Choose one of the following from the menu bar:

On-line > Compile to schedule a compile on the selected TCL sequence(s) or
recipe(s) stored in the on-line storage area of the server.
or
On-line > Link to schedule a link on the selected TCL sequence(s) stored in
the on-line storage area of the server.
or
On-line > Compile and Link to schedule a compile and link of the selected
TCL sequence(s) stored in the on-line storage area of the server.

If one or more recipes are selected, only the Compile option is available for
selection. If multiple sequences are selected and one of them has a “Not
Compiled” or “Compile Errors” status, the Link option is not available for
selection.
Once you initiate a compile or link a progress dialog is opened. To cancel the
compile or link operation, click on the Cancel button. This dialog closes when the
operation is complete.

Viewing Compiler/Linker Listing File

Listing files generated by the compiler/linker may be viewed by selecting one or
more files whose listing files you want to view in the Server RCS window and then
doing one of the following:
• For single or multiple files, choose On-line > View Compiler Listing from the
menu bar of the TCL Builder window.
• For single or multiple files, right-click on the selected file(s) and choose Open
from the context menu.
• For a single file, double-click on the desired file’s name.
This opens a Compiler Listing window for each selected file, Figure 60

98 3BUR002117R3701
Section 3 Configuration/Application Building Viewing Compiler/Linker Listing File

Figure 60. Compiler Listing Window

3BUR002117R3701 99
Removing Sequence or Recipe from On-line Storage Section 3 Configuration/Application Building

Removing Sequence or Recipe from On-line Storage

To remove a TCL sequence or recipe from the on-line storage area of the server,
1. From the Compile/Link Status view of the Server RCS window, select the TCL
sequence or recipe you want to remove from the on-line storage area.
2. Choose On-line > Remove… from the menu bar of the TCL Builder window.
This opens a confirmation dialog, Figure 61, asking whether you really want to
delete the selected file.

Figure 61. Remove File Confirmation Dialog

3. Click on Yes to close the confirmation dialog and delete the selected TCL
sequence or recipe file from the on-line storage area on the server.
If removed, the selected file is only deleted from the on-line storage area. It is not
deleted from the RCS.

TCL Recipe Decompile

The Decompile operation, On-line > Decompile, is used to create a source version
of a compiled recipe file that is in the READY state. The source version can be
modified using a text editor. It is the source version that is held in RCS. A
decompile does not retain the original source file format such as comment lines.
Decompile supports the RECORD statement for recipes. The RECORD statement
for recipes updates the disk resident object code for a recipe by writing the value of
the loaded recipe item to the object code. See TCL Recipe Tuning Procedure on
page 101.

100 3BUR002117R3701
Section 3 Configuration/Application Building Remove Recipe Source

Remove Recipe Source

This operation, On-line > Remove Recipe Source, is used to make a recipe file
‘Ready’ by deleting the recipe source file. The compiled file has TCL editor source
comments and the format removed. If these items are important to you, use the
previously stored RCS file to add the comments back in.

Convert to ASCII
This operation, On-line > Convert to ASCII, converts an FMS source file to an
ASCII text file. It can be used on all TCL Sequences and on any TCL Recipe that is
not in the READY state. The resulting ASCII file is placed into the current client
directory with a .rcp or a .tcl file extension.
The default directory is:
C:\Documents and Settings\username\My Documents\My TCL.

TCL Recipe Tuning Procedure

To make tuning changes to TCL Recipes via the RECORD statement, which
modifies the compiled recipe file (.RR), do the following.
1. Select a Recipe, from the Server Library window, that has been tuned and
whose Load Status is Ready. See Remove Recipe Source menu command on
the TCL Library context menu, Figure 18, if status is not Ready.
2. Activate the TCL Sequence that has the RECORD Statement.
3. Select the Decompile menu command from the TCL Library context menu,
Figure 18.
4. Check Out Locked the RCS version of the Recipe .rcp file from the TCL
Server context menu, Figure 18.
5. Select Convert to ASCII to migrate the file to the current Client directory.
6. Optionally, add comments back into the recipe .rcp file.
7. Check In the recipe .rcp file to RCS using the TCL Client context menu.
8. Set Active Revision with Compile option enabled.

3BUR002117R3701 101
Printing Section 3 Configuration/Application Building

Printing
To print all pages of a TCL sequence or recipe, sequence listing file, compiler/linker
listing file, revision log, or differences log file,
1. Open the file you want to print.
2. Choose File > Print or press CTRL+P or use teh print icon on the toolbar to
display the standard Windows Print dialog.
3. Using the fields and buttons of the standard Windows Print dialog, define the
desired printing parameters.
4. Once you have specified the desired printing parameters, click on the OK
button to close the Print dialog and start printing the data.

102 3BUR002117R3701
Section 3 Configuration/Application Building Exiting the TCL Builder

Exiting the TCL Builder

To exit the TCL Builder, choose File > Exit from the menu bar. This closes all
opened windows, including the Client and Server windows and any TCL Sequence
and Recipe windows. When closing TCL Sequence and Recipe windows that
contain modified data, a Save File dialog opens. Figure 62 shows the dialog opened
for an unsaved sequence, and Figure 63 shows the dialog opened for an unsaved
recipe.

Figure 62. Save File Dialog—TCL Sequence

Figure 63. Save File Dialog—TCL Recipe

To save the changes made to the sequence or recipe file, close the Unsaved Data
dialog, and proceed to exit the TCL Builder, click on the Yes button. To close the
Unsaved Data dialog, and proceed to exit the TCL Builder without saving the
changes made to the sequence or recipe, click on the No button. To close the
Unsaved Data dialog and cancel exiting the TCL Builder, click on the Cancel
button.

3BUR002117R3701 103
Exiting the TCL Builder Section 3 Configuration/Application Building

104 3BUR002117R3701
 Chapter 4 Runtime Operation

Operating Instructions
For instructions regarding the operation of TCL runtime displays, refer to Operate
IT Process Portal B MOD 300 Connect Operation, 800xA for MOD 300 Operation
or MOD 300 Engineering Displays.

3BUR002117R3701 105
Operating Instructions Chapter 4 Runtime Operation

106 3BUR002117R3701
 Chapter 5 Maintenance

Preventive Maintenance
This product does not require any preventive maintenance.
Refer to the PC manufacturer´s documentation for detailed information on the
preventive maintenance for the PC hardware.

Hardware Indicators
The RTA board does not have any hardware indicators. Refer to the PC
manufacturer´s documentation for information regarding any hardware indicators
for the PC.

Error Messages
The AdvaBuild suite of software contains several components and options. Each
component and option may send error messages to the Windows-based Engineering
Station user. These error messages provide the user with detailed information so
they can resolve the errors. Therefore, further explanation of the error messages in
this section is not necessary.

Fault Finding and User Repair

All software products from ABB Inc. include the following:
• Reporting errors to ABB Inc.
If you find a problem with the software, you can report it to ABB Inc. All
reported problems are investigated, and you will get an investigation report. All

3BUR002117R3701 107
Backup/Restore Procedures Chapter 5 Maintenance

reported problems are tracked until the problem is solved: fixed or a

workaround is available.
• Delivery of new or improved software
Software problems may be fixed in several ways:
– Product patch - to fix a specific problem.
– Product Service pack - to update the product (contains several patches).
– New product version - to upgrade the product (contains new functions).
Product patches, Service packs, and New versions are installed in the PC in the
same way as the base software.
Installation of new versions normally require that you uninstall the existing version.
Patches, Service packs, and new versions all come with an Installation Guide
(distributed as a separate file or on paper).

Backup/Restore Procedures
Use the Windows standard backup/restore functionality.

108 3BUR002117R3701
 INDEX

A window 82 to 83
About help 47 file out of revision control system 17
About TCL Builder… item of Help menu 19, 48 file out of revision control system from Server
active window 23 window 86
adjusting user interface 45 file out of revision control system locked from
ALT key, Server window 86
see checking files or revisions out of revision file out of revision control system unlocked
control system locked via drag and drop from Server window 89
see moving folders or files to Client window files or revisions out of revision control system
and locking them locked via drag and drop 87
application start-up 49 files or revisions out of revision control system
Arrange Icons item of Window menu 33 unlocked via drag and drop 89
arranging windows 45 folders/files in to revision control system via
automatically refreshing contents of Client and drag and drop 41, 83
Server windows 47 folders/files out of revision control system via
drag and drop 42, 87
B syntax 21, 76
backup 108 children 39, 46
Client window 16, 23, 51
checking file in to revision control system 82
C
to 83
Cascade button of tool bar 33
deleting folder(s) or file(s) 67
Cascade item of Window menu 33
displaying properties for folder or file 68
Check In button of tool bar 83
list view 23 to 24
Check In dialog 84
moving folder(s) or file(s) 67
Check In item of context menu 83
renaming folder or file 67
Check In item of Revision menu 83
running Syntax Checker 78
Check Out button of tool bar 89
selecting all files in list view 83
Check Out item of context menu 89
tree view 23
Check Out item of Revision menu 89
Close item of context menu 64
Check Out Locked item of Revision menu 87
Close standard control button 37, 64
checking
collapsing branch of tree structure 39, 46
file in to revision control system 17, 82
comment 74
file in to revision control system from Client

3BUR002117R3701 109
Index

Compile and Link item of On-line menu 98 creating

Compile and Link option 96 directory structure for sequence and recipe
Compile item of On-line menu 98 files 56
Compile option 96 folder 56
compile/link options 96 recipe file 21, 58
Compile 96 sequence file 21, 58
Compile and Link 96 CTRL key,
Don’t Compile or Link 96 see copying folders or files via drag and drop
compile/link status 26 see selecting discontinuous objects
Compile/Link Status item of View menu 97 CTRL+A key combination
Compiler Listing window 98 see selecting all files in list view of Client
compiler/linker listing files 98 window
compiling see selecting all files or revisions in list view of
recipe files 17, 95, 98 Server window
sequence files 17, 95, 98 CTRL+C key combination, see copying text from
compiling and linking sequence files 17, 95, 98 sequence or recipe file
Connect item of File menu 52 CTRL+F key combination, see searching recipe,
connecting to server 52 sequence, or sequence listing file for text string
Context menu CTRL+O key combination, see opening sequence
Check In 83 or recipe file(s)
Check Out 89 CTRL+P key combination, see printing
Close 64 CTRL+R key combination, see replacing text string
Copy 69 of sequence or recipe file
Delete 67 CTRL+S key combination, see saving sequence or
Open 98 recipe on client under same name in current
Paste 70 folder
Properties 68 CTRL+V key combination, see pasting selected text
Rename 67 into sequence or recipe file
Save 63 to 64 CTRL+X key combination, see cutting text from
Select All 83, 87 sequence or recipe file
Syntax Check 81 cursor movement
Control Builder 15 backward through fields 44
Convert to ASCII item of On-line menu 101 forward through fields 44
Copy button of tool bar 69 via left and right arrow keys 44
Copy item of context menu 69 via up and down arrow keys 44
Copy item of Edit menu 69 cursor positioning 44
copying cutting
folders or files via drag and drop 40 text from recipe file 69
text from recipe file 69 text from sequence file 69
text from sequence file 69

110 3BUR002117R3701
 Index

D checking files or revisions out of revision

Decompile item of On-line menu 100 control system locked 87
default recipe file 58 checking files or revisions out of revision
default sequence file 59 control system unlocked 89
Delete item of context menu 67 checking folders/files in to revision control
Delete item of File men 67 system 41, 83
deleting checking folders/files out of revision control
folder(s) or file(s) within Client window 67 system 42
text from recipe file 69 copying folders or files 40
text from sequence file 69 moving folders or files 40
demanding refresh of Server window 47
descendant objects 39, 46 E
Deselect All item of Edit menu 87 Edit menu
deselecting Copy 69
all selected files or revisions in list view of Deselect All 87
Server window 87 Find 70
dialog Paste 70
Check In 84 Replace 72
Find 70 Select All 83, 86
Open 60 editing
Replace 72 recipe files 17, 21
Save As 64 sequence files 17, 21
Set Active Revision 96 error messages 107
TCL Builder Logon 52 Exit item of File menu 103
dialog boxes 32 exiting TCL Builder 103
Differences item of Revision menu 91 expanding branch of tree structure 39, 46
differences log file
printing 17, 102 F
viewing 91 F5 key, see demanding refresh of Server window
Differences Log window 32, 91 File menu
Direction field Connect 52
Find dialog 71 Delete 67
Replace dialog 73 Exit 103
discontinuous object selection 38 New > Folder 56
displaying properties for folder or file in Client New > Recipe 58
window 68 New > Sequence 58
Don’t Compile or Link option 96 Open 60
downloading files from revision control system to Print 102
on-line storage 95 to 96 Rename 67
drag and drop 40 Save 63 to 64

3BUR002117R3701 111
Index

Save All 63, 67 I

Save As… 63, 65 inserting
Syntax Check 78 revision markers as comments 74
File name field revision markers as string variables 74
Save As dialog 65
filesys statements 18 K
Find button keyword substitution for revision markers 90
Find dialog 71
Replace dialog 73
L
tool bar 70
left and right arrow keys 44
Find dialog 70
left mouse button operation 36
Direction field 71
Link item of On-line menu 98
Find button 71
linking sequence files 17, 95, 98
Find Next button 71
list view
Find What field 71
Client window 23 to 24
Find Whole Word Only check box 71
Server window 26 to 27
Match Case check box 71
Lock button of tool bar 93
Find item of Edit menu 70
Lock item of Revision menu 93
Find Next button
locking file from Server window 93
Find dialog 71
Replace dialog 73
Find What field M
Find dialog 71 maintenance 107
Replace dialog 72 managing
Find Whole Word Only check box recipe files 17
Find dialog 71 sequence files 17
Replace dialog 73 markers 73
folder creation 56 marking
recipe file with revision information 21, 73
sequence file with revision information 21, 73
G
Match Case check box
GENERICD object 18
Find dialog 71
Replace dialog 72
H Maximize All Windows item of Window menu 34
help Maximize standard control button 37
About 47 menu bar 33
Tool Tip 47 menu item selection 36
Help menu Minimize All Windows item of Window menu 33
About TCL Builder… 19, 48 Minimize standard control button 37
mouse operation 36
moving

112 3BUR002117R3701
 Index

cursor backward through fields 44 selection(s) 21, 59

cursor forward through fields 44 operating
folder(s) or file(s) within Client window 67 left mouse button 36
folders or files to Client window and locking mouse 36
them 42 right mouse button 43
folders or files via drag and drop 40
multiple object selection 38 P
parent object 39, 46
N Paste button of tool bar 70
New > Folder item of File menu 56 Paste item of context menu 70
New > Recipe item of File menu 58 Paste item of Edit menu 70
New > Sequence item of File menu 58 pasting
Next Error button of tool bar 78, 81 selected text into recipe file 70
selected text into sequence file 70
O Print item of File menu 102
object renaming 39 printing
On-line Builder 15 compiler/linker listing file 17, 102
On-line menu differences log file 17, 102
Compile 98 recipe file 17, 102
Compile and Link 98 revision log file 17, 102
Convert to ASCII 101 sequence file 17, 102
Decompile 100 sequence listing file 17, 102
Link 98 product verification 19
Remove Recipe Source 101 project user types and privileges 55
Remove… 100 Properties item of context menu 68
Set Active Revision 96
View Compiler Listing 98 R
Open button of tool bar 60 range of objects selection 38
Open dialog 60 RCS, see revision control system
Files of type field 61 recipe file
Look in field 60 compiling 17, 95, 98
Open button 61 copying text 69
Open item of context menu 98 creation 58
Open item of File menu 60 cutting text 69
opening deleting text 69
sequence or recipe file(s) 21, 59 editing 21
sequence or recipe file(s) via Open dialog 60 management 17
sequence or recipe file(s) via selection from list marking with revision file information 21, 73
of recently edited files on File menu 61 opening 21, 59
sequence or recipe file(s) via tree or list view pasting selected text 70

3BUR002117R3701 113
Index

printing 17, 102 revision log file

removing from on-line storage 100 printing 17, 102
replacing text string 72 viewing 90
saving 21, 63 to 65, 67 Revision Log item of Revision menu 90
searching for text string 70 Revision Log window 32, 90
selecting all text 69 revision marker types 73
Refresh item of View menu 47 revision markers 73
Remove Recipe Source item of On-line menu 101 inserting as comments 74
Remove… item of On-line menu 100 inserting as string variables 74
removing sequence or recipe file from on-line keyword substitution 90
storage 100 using 75
Rename item of context menu 67 Revision menu
Rename item of File menu 67 Check In 83
renaming Check Out 89
folder or file within Client window 67 Check Out Locked 87
object 39 Differences 91
Replace All button of Replace dialog 73 Lock 93
Replace button of Replace dialog 73 Revision Log 90
Replace dialog 72 Unlock 93
Direction field 73 revision number generation 85
Find button 73 revision status 27
Find Next button 73 right mouse button operation 43
Find What field 72
Find Whole Word Only check box 73 S
Match Case check box 72 Save All button of tool bar 67
Replace All button 73 Save All item of File menu 63, 67
Replace button 73 Save As dialog 64
Replace With field 73 File name field 65
Replace item of Edit menu 72 Save button 64, 66
Replace With field of Replace dialog 73 Save in field 65
replacing Save As… item of File menu 63, 65
text string in recipe file 72 Save button
text string in sequence file 72 Save As dialog 66
resizing open windows 45 tool bar 63 to 64
restore 108 Save item of context menu 63 to 64
Restore All Windows item of Window menu 34 Save item of File menu 63 to 64
revision control system 9, 11, 16 to 17, 21, 81 saving
checking file in 82 all open sequence and/or recipe files in current
checking file out 86 directories 67
Revision Log button of tool bar 90 sequence and recipe files 63

114 3BUR002117R3701
 Index

sequence or recipe file under different name in searching for text string 70
current or different folder 65 selecting all text 69
sequence or recipe on client under same name sequence listing file
in current folder 21, 64 printing 17, 102
searching searching for text string 70
recipe file for text string 70 server connection 52
sequence file for text string 70 Server Library window 25 to 26
sequence listing file for text string 70 Server window 16, 23, 53
Select All item of context menu 83, 87 checking file out of revision control system 86
Select All item of Edit menu 83, 86 checking file out of revision control system
selecting locked 86
all files in list view of Client window 83 checking file out of revision control system
all files or revisions in list view of Server unlocked 89
window 86 compiling and linking sequence files from
all text in recipe file 69 Compile/Link Status view 98
all text in sequence file 69 compiling sequence and recipe files from
discontinuous objects 38 Compile/Link Status view 98
menu item 36 deselecting all selected files or revisions in list
multiple objects 38 view 87
range of objects 38 linking sequence files from Compile/Link
single object 38 Status view 98
tool bar button 36 list view 26 to 27
window 37 locking file 93
sequence file scheduling compiles/links from Compile/Link
compiling 17, 95, 98 Status view 97
compiling and linking 17, 95, 98 selecting all files or revisions in list view 86
copying text 69 setting Compile/Link Status view 97
creation 58 tree view 23
cutting text 69 unlocking file 93
deleting text 69 Server Window Auto Refresh item of View
editing 21 menu 47
linking 17, 98 Set Active Revision 18
management 17 Set Active Revision dialog 96
marking with revision information 21, 73 Set Active Revision item of On-line menu 96
opening 21, 59 to 61 setting
pasting selected text 70 active revision 95
printing 17, 102 automatic refresh of Client and Server
removing from on-line storage 100 windows 47
replacing text string 72 Compile/Link Status view of Server
saving 21, 63 to 65, 67 window 97

3BUR002117R3701 115
Index

SHIFT key, see range of objects selection TCL_DEV object 18

SHIFT+TAB key combination, see cursor Templet Builder 15
movement backward through fields text editor 17, 21
showing differences between two revisions 91 Tile Horizontal button of tool bar 33
single object selection 38 Tile Horizontal item of Window menu 33
standard control buttons 23, 37 Tile Vertical button of tool bar 33
Close 37, 64 Tile Vertical item of Window menu 33
Maximize 37 tool bar 34
Minimize 37 Cascade button 33
starting TCL Builder Client 49 Check In button 83
starting up application 49 Check Out button 89
starting up TCL Builder Copy button 69
via desktop icon 50 Find button 70
via Windows Explorer 50 Lock button 93
via Windows Start menu 49 Next Error button 78, 81
status bar 35 Open button 60
Status Bar item of View menu 36 Paste button 70
subtree button 39, 46 Revision Log button 90
Syntax Check item of context menu 81 Save All button 67
Syntax Check item of File menu 78 Save button 63 to 64
Syntax Checker 76 Tile Horizontal button 33
running from Client window 78 Tile Vertical button 33
running from TCL Sequence window 81 Unlock button 93
syntax checking 21, 76 tool bar button selection 36
Tool Tip help 47
T Toolbar item of View menu 35
TAB key, see cursor movement forward through tree structure
fields collapsing branch 39, 46
TCL Builder 9, 15, 19 expanding branch 39, 46
application start-up 21 tree view
exiting 103 Client window 23
user interface 22 Server window 23
TCL Builder Client start-up 49
TCL Builder Logon dialog 52 U
TCL Builder window 16, 22 Unlock button of tool bar 93
TCL Editor 58 Unlock item of Revision menu 93
TCL Recipe window 31, 63 unlocking file from Server window 93
TCL Sequence Listing window 29, 62 up and down arrow keys 44
TCL Sequence Source and Listing window 30, 79 user interface 22
TCL Sequence window 28, 62, 81 using revision markers 75

116 3BUR002117R3701
 Index

V Maximize All Windows 34

variable 74 Minimize All Windows 33
View Compiler Listing item of On-line menu 98 Restore All Windows 34
View menu Tile Horizontal 33
Compile/Link Status 97 Tile Vertical 33
Refresh 47
Server Window Auto Refresh 47
Status Bar 36
Toolbar 35
viewing
compiler/linker listing files 98
differences between two revisions 91
revision log file 90

W
window
active 23
arrange icons 33
cascade 33
Client 23, 51
Compiler Listing 98
Differences Log 32, 91
maximize all open 34
minimize all open 33
resizing via drag and drop 45
restoring all open 34
Revision Log 32, 90
selection 37
Server 16, 23, 53
Server Library 25 to 26
TCL Builder 16, 22
TCL Recipe 31, 63
TCL Sequence 28, 62
TCL Sequence Listing 29, 62
TCL Sequence Source and Listing 30, 79
tile horizontal 33
tile vertical 33
Window menu 33
Arrange Icons 33
Cascade 33

3BUR002117R3701 117
Index

118 3BUR002117R3701
Contact us

ABB AB ABB Automation LLC

Control Technologies Control Technologies
Västerås, Sweden Abu Dhabi, United Arab Emirates
Phone: +46 (0) 21 32 50 00 Phone: +971 (0) 2 4938 000
e-mail: processautomation@se.abb.com e-mail: processautomation@ae.abb.com

3BUR002117R3701
www.abb.com/controlsystems www.abb.com/controlsystems

ABB Automation GmbH ABB China Ltd

Control Technologies Control Technologies
Mannheim, Germany Beijing, China
Phone: +49 1805 26 67 76 Phone: +86 (0) 10 84566688-2193
e-mail: marketing.control-proucts@de.abb.com www.abb.com/controlsystems
www.abb.de/controlsystems

ABB S.P.A. Copyright © 2001-2013 by ABB.

Control Technologies All rights reserved.
Sesto San Giovanni (MI), Italy
Phone: +39 02 24147 555
e-mail: controlsystems@it.abb.com
www.abb.it/controlsystems

ABB Inc.
Control Technologies
Wickliffe, Ohio, USA
Phone: +1 440 585 8500
e-mail: industrialitsolutions@us.abb.com
www.abb.com/controlsystems

ABB Pte Ltd

Control Technologies
Singapore
Phone: +65 6776 5711
e-mail: processautomation@sg.abb.com
www.abb.com/controlsystems

Power and productivity

for a better worldTM