BluePhoenix AppBuilder 2.1.0.

Scripting Tools Reference Guide

BluePhoenix AppBuilder 2.1.0. Scripting Tools Reference Guide April, 2003 Corporate Headquarters BluePhoenix Solutions Vlierwerf 7B 4704 SB Roosendaal The Netherlands +31 (0) 165 399 401 +31 (0) 165 396 308 fax USA Headquarters BluePhoenix Solutions USA, Inc. 8000 Regency Parkway Cary, NC 27511 United States +1 919.380.5100 +1 919.380.5111 fax www.bluephoenixsolutions.com

1992-2003 BluePhoenix Solutions All rights reserved. BluePhoenix is a trademark of BluePhoenix Solutions. All other product and company names mentioned herein are for identification purposes only and are the property of, and may be trademarks of, their respective owners. Portions of this product may be covered by U.S. Patent Numbers 5,495,222 and 5,495,610 and various other non-U.S. patents. The software supplied with this document is the property of BluePhoenix Solutions, and is furnished under a license agreement. Neither the software nor this document may be copied or transferred by any means, electronic or mechanical, except as provided in the licensing agreement. BluePhoenix Solutions has made every effort to ensure that the information contained in this document is accurate; however, there are no representations or warranties regarding this information, including warranties of merchantability or fitness for a particular purpose. BluePhoenix Solutions assumes no responsibility for errors or omissions that may occur in this document. The information in this document is subject to change without prior notice and does not represent a commitment by BluePhoenix Solutions or its representatives.

TABLE OF CONTENTS

AppBuilder 2.1.0 Scripting Tools Reference Guide

Table of Contents

1 TurboScripter Object Model Reference. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-1

TurboScripter Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-1 TurboScripter Object Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-2 Repository Object Implements IRepo. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-2 Entity Object Implements ITSEnt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-4 Relation Object Implements ITSRel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-6 Trace Object Implements Itrace . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-7 Host Object - Implements IScriptUtils . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-8 Child Script Object - Implements IScript . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-8 TurboHost Implements ITurboHost . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-9 CoDraw Object. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-10 CoPanel Object. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-11 Valid Domain Types and Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-14 CoCtrl Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-17 Attribute Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-19 FAQs for Scripting Tools. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-19

2 Using TurboCycler Default Templates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-1

Starting TurboCycler . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-1 Selecting Generation Templates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-2 Setting Up Generation Templates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-3 Generating Your Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-3 Using Default Templates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-4 Understanding Default Templates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-4 Developing the Application. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-5 CRUD Rules Template . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-6 GUI Rules/Windows Template. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-8 Utilities Template. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-10 Rename Views, Fields and Rules Template . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-11 Rename Verify Template . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-11 Hierarchy Cloner Template. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-11 TurboCycler Tutorial . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-14 Reviewing Forward Engineering and Transforming. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-14 Generating with TurboCycler . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-17

AppBuilder 2.1.0 Scripting Tools Reference Guide

3 Using the TurboCycler Developer Kit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-1

Creating a Generation Template . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-1 Understanding the Generation Template . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-1 Customizing the Generation Template . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-2 Editing and Compiling a Template . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-3 Understanding the Environment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-3 Using the Command Line Compiler . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-3 Using the Template Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-4 Template Manager Tools . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-4 Template Manager Work Area . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-9

4 TurboCycler Template Language

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-1

Flow Diagrams Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-1 Using Conventions and Symbols . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-2 Reading a Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-2 Inserting Multiple-line and Single-line Comments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-3 Template Language Statements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-3 TEMPLATE Statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-3 USAGES Block . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-5 HIERARCHY Block . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-6 RULE Block . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-9 WINDOW Block . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-12 Other Blocks. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-16 COMPONENT Block . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-16 FLATFILE Block. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-16 KEYWORDS Block . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-17 TEXT Block . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-17 USE ANY Block . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-17 DIALOG Block. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-17 Template Block Features. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-21 Declaring Local Variables from Any Block . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-21 Making Any Block a Callable Procedure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-21 Other Statements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-23 CALL Statement. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-23 CALL SERVICE Statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-24 SELECT Statement. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-24 APPEND and REMOVE Statements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-25 TRAVERSE Statement. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-25 UPDATE MESSAGE Statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-27 SHOWMESSAGE Statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-27 SET Statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-28 Supporting Statements and Expressions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-28 Common Statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-29 Conditional Expression (conditional_expr) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-31 Integer Expression (int_expr). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-34 List Expression (list_expr) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-36 Object Expression (object_expr) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-38 String Expression (string_expr) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-43

ii

AppBuilder 2.1.0 Scripting Tools Reference Guide

Processing Symbols on an Open Drawing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-45 Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-48 Get and File Functions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-48 String Manipulation Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-50 Superseded Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-52 Template Samples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-52 SQL Delete Rule Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-53 Detail Display Rule and Window Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-55

5 TurboCycler Repository Types and Properties . . . . . . . . . . . . . . . . . . . . . . . . . 5-1

Repository Object Type Query Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-1 Template Language Statement Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-2 Object Types and Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-3 Relationship Types and Properties. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-12 Property Domains . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-23

6 TurboCycler Window Controls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-1

Creating Controls. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-1 Window Statement Control Types. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-2 Window Control Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-12 A. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-12 B . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-12 C-D-E . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-13 F . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-14 G-H . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-16 I-J-K-L . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-17 M-N-O . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-18 R. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-21 S through Z . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-22 Property Types and Property Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-23 Window Properties Matrix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-26

Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . i

Table of Contents

iii

iv

AppBuilder 2.1.0 Scripting Tools Reference Guide

CHAPTER

TURBOSCRIPTER OBJECT MODEL REFERENCE

AppBuilder 2.1.0 Scripting Tools Reference Guide

TurboScripter provides a scriptable repository interface that can be accessed from the AppBuilder Construction Workbench or from other tools through COM. VBScript (VisualBasic) or JScript (Java) provide the required language functionality to access the properties and methods of these objects. This guide contains information on using the scripting tools available in AppBuilder TurboScripter and TurboCycler. It begins with a discussion of TurboScripter and includes the necessary reference information for using it. Because of the similarity to VisualBasic (VB) scripting, it does not include detailed procedures. The rest of the guide involves the use of the TurboCycler scripting tool. It begins with instructions on using the TurboCycler Standard Edition default templates, followed by a description of the TurboCycler Developers Kit, which you use to create your own templates. Use of this guide assumes user familiarity with a scripting language.

Note

If you are making a call to an Excel spreadsheet object, Excel must be running or you will get an error.

To learn the details of the TurboScripter object model, read the TurboScripter Object Reference.

TurboScripter Overview
TurboScripter provides you with a mechanism to write scripts in VBScript or JavaScript that can access the repository, manipulate repository objects, and access other applications that function through automation, such as Microsoft Word. Tools within the Construction Workbench have menu options to invoke TurboScripter and pass repository objects to it. The tools you use to build applications using TurboScripter are documented throughout this manual. Topics in this section include: TurboScripter Object Reference Valid Domain Types and Values FAQs for Scripting Tools

Note

Installation of TurboScripter includes the installation of a number of sample scripts. When a particular object is used in one of the sample scripts, that script is identified below.

AppBuilder 2.1.0 Scripting Tools Reference Guide

1-1

TurboScripter Object Reference

TurboScripter Object Reference

The TurboScripter objects include: Repository Object Implements IRepo Entity Object Implements ITSEnt Relation Object Implements ITSRel Trace Object Implements Itrace Host Object - Implements IScriptUtils Child Script Object - Implements IScript TurboHost Implements ITurboHost CoDraw Object CoPanel Object CoCtrl Object Attribute Object

Repository Object Implements IRepo

Query(String ObjectType, String PropName, String Pattern)
Queries the repository for Objects of type ObjectType with the property PropName that have the value Pattern. Returns a Dictionary object containing a list of TSEnt objects returned by the repository. This list is keyed by the index of the elements in the list starting from 0. Pattern can contain * as wildcard. If the Property name is a Domained value, the Display Value in the repository model should be used. Example: REM *** Following query returns a Dictionary of TSEnt objects of type REM *** VIEW that have names beginning with HPS Set myViews = Repo.Query(VIEW, Name, HPS) REM *** Following query returns a Dictionary of TSEnt objects of type REM *** FIELD that have their Field_Type property set to 8 REM *** Field_Type is a Domain and Date is the Display Value Set myDateFields = Repo.Query(FIELD, Field_Type, Date) Sample: Query.vbs

Find(String ObjectType, String PropName, String Value)

Returns the corresponding TSEnt Object. If more than one object matches the criteria, the first object is returned. If the Property name is a Domained value, the Display Value in the repository model should be used. This is typically used to find a specific object whose unique property value is known. Sample: Query.vbs

1-2

TurboScripter Object Model Reference

TurboScripter Object Reference

Get(String Type, String Name)

Returns the TSEnt object with the given Type and Name. Sample: Query.vbs

Create(String Type, String Name, (optional)Dictionary Properties)

Returns the created object. If the TSEnt object already exists, the existing object is retrieved and returned. Display values can be used for Domained properties. To set the properties when creating an object, fill in the Properties object with the Key as Property Name and Item as Property Value. Sample: Create.vbs

Delete(String Type, String Name)

Returns Nothing. Raises Error if the specified object is not found. Sample: Create.vbs

Commit()
The entire session is committed. When called from the WorkBench, changes done by the other tools are also committed. Sample: Create.vbs

Warning

The script author should take care to ensure that objects that have been deleted before are not accessed after the commit. This could destabilize the workbench.

Rollback()
The entire session is rolled back. When called from the WorkBench, changes done by the other tools are also rolled back. Sample: Create.vbs

Warning

The script author should take care to ensure that objects that have been deleted before are not accessed after the rollback. This could destabilize the workbench. Rollback does not remove all unwanted objects after cloning by TurboCycler.

GetEntityTypes()
Returns a Dictionary object containing all the entity types in the repository as strings. This list is keyed by the index starting from 0. Sample: Model.vbs

AppBuilder 2.1.0 Scripting Tools Reference Guide

1-3

TurboScripter Object Reference

GetRelationTypes()
Returns a Dictionary object containing all the relation types in the repository as strings. This list is keyed by the index of the elements in the list starting from 0. Sample: Model.vbs

GetPropertyNames(String ObjectType)
Returns a Dictionary object containing all the property names for this object type. This list is keyed by the index of the elements in the list starting from 0. Sample: Model.vbs

GetPropertyType(String ObjectType, String PropName)

Returns the property type as a String. The value is one of STRING, LONG, UNSIGNED_INT, DOMAIN or INTERNAL Sample: Model.vbs

GetDomainValues(String ObjectType, String PropName)

Returns a Dictionary object containing all the valid Domain values for this property. This Dictionary Object contains the Storage Values of the domain elements as the Key and the Display Value (or User Value) as the item. Returns an error for properties that do not have a Domain associated. Sample: Model.vbs

Entity Object Implements ITSEnt

GetPropertyName(String PropName)
Returns the required property as a Variant object. The only variable type in VBScript. The PropName needs to be a valid property of this repository object type as published in the repository model. Sample: Query.vbs

SetProperty(String PropName, Variant PropValue)

Sets the property specified by PropName to the value in PropValue. Returns nothing. Raises an Error if the property is invalid or the value is invalid. For properties that have a domain associated with them, the Display value (or User Value) needs to be specified and NOT the storage value Sample: Hierarch.vbs

1-4

TurboScripter Object Model Reference

TurboScripter Object Reference

CreateChild(String Type, String Name, String RelationType, (optional) Dictionary Properties, (optional) Dictionary RelationProperties)
Creates a child object of the specified Type and Name. The Properties Dictionary can contain the properties of the child object while the RelationProperties Dictionary can contain the properties of the relation, for example, Sequence Number of the relation. If the specified object already exists in the repository, this method returns the retrieved object. Sample: Hierarch.vbs

GetChild(String Type, String Name, String RelationType)

Returns an Entity Object (TSEnt) that is a child of the calling object.

GetChildren(String Type, String RelationType, (optional) Dictionary RelationObjects)

Returns a Dictionary object containing the child objects (TSEnt) of the specified type. The indices for these objects are from 0 to (Count 1). If the RelationObjects is a valid Dictionary, then the Relation object (TSRel) for each of the corresponding child objects will be filled in.

GetParents(String Type, String RelationType, (optional) Dictionary RelationObjects)

Returns a Dictionary object containing the parent objects(TSEnt) of the specified type. The indices for these objects are from 0 to (Count 1). If the RelationObjects is a valid Dictionary, then the Relation object (TSRel) for each of the corresponding child objects will be filled into RelationObjects. Use the same key value to access the child object as well as the relation object for that child. Sample: Rename.vbs

GetType()
Returns the Object Type name of this object as a String. Sample: gettype.vbs

GetFile(Integer FileType)
Returns the File associated with this object. Valid values for File Type are given below. Example: If this is a Rule object, then GetFile(7) will return the source file for this rule as a string. 0(RepoText) is a valid file type for all Entity (TSEnt) and Relation (TSRel) objects. 1(RepoKeywords) is a valid file type for all TSEnt objects. Sample: Rename.vbs
Table 1-1 File Type Values RepoText = 1 ReportSection = 3

RepoKeywords = 0 WindowPanel = 2

AppBuilder 2.1.0 Scripting Tools Reference Guide

1-5

TurboScripter Object Reference

Table 1-1

File Type Values (Continued) DrawingFile = 5 RuleSource = 7 WindowHelp = 9 ServerOptions = 11 FormContents = 13 ClosureScope = 15 ComponentFolderFile = 17

PhysicalBitmap = 4 ReportFile = 6 ComponentSource = 8 DatabaseOptions = 10 MachineOptions = 12 MigrationFile = 14 ApplicationFolder = 16

SetFile(Integer FileType, String FileStr)

Sets the file associated with this object in the repository to FileStr. This can be used to create RuleSource (Value = 7) files from RULE objects and RepoText(0) and RepoKeywords(1) files from all Entity objects (TSEnt). Sample: Rename.vbs

DeleteChildRelation(String ChildType, String ChildName, (optional) String RelType)

Deletes the Relation between this Entity object (TSEnt) and the child object identified by ChildType and ChildName. If this object and the Child object are connected by more than one type of relation, then the RelType needs to be specified.

DeleteParentRelation(String ParentType, String ParentName, (optional) String RelType)

Deletes the Relation between this Entity object (TSEnt) and the parent object identified by ParentType and ParentName. If this object and the parent object are connected by more than one type of relation, then the RelType needs to be specified.

Properties implemented by TSEnt

TSEnt does not have any static properties of its own. It assumes all the valid properties of the repository object that it represents. Example: Get the Field_Type property of myField Set myField = Repo.Get(FIELD, RETURN_CODE) MyFieldType = myField.Field_Type

Relation Object Implements ITSRel

GetProperty(String PropName)
Returns the required property as a Variant object. The only variable type in VBScript. The PropName needs to be a valid property of this repository object type as published in the repository model. Sample: AddTo Folder.vbs

1-6

TurboScripter Object Model Reference

TurboScripter Object Reference

SetProperty(String PropName, Variant PropValue)

Sets the property specified by PropName to the value in propValue. Returns nothing. Raises an Error if the property is invalid or the value is invalid. For properties that have a domain associated with them, the Display value (or User Value) needs to be specified and NOT the storage value Sample: hierarch.vbs

GetType()
Returns the Relation Type name of this relation as a String. Sample : gettype.vbs

GetFile(Integer FileType)
Returns the File associated with this object. Sample : ExtraceFromFolder.vbs Example: If this is a COMPONENT_FOLDER_CONTENT object, then GetFile(17) will return the component folder file for this relation object as a string if it is a text file.

SetFile(Integer FileType, String FileStr)

Sets the file associated with this object in the repository to FileStr. This can be used to create ComponentFolderFile files from COMPONENT_FOLDER_CONTENT relation. When retrieving Component Folder files, only text files can be retrieved, binary files cannot be retrieved. Sample : rename.vbs

Trace Object Implements Itrace

OutFile
An integer constant that specifies the name of the file to which all trace outputs should be written to. If the file already exists, the existing file is deleted and a new file of the same name is opened. To save an existing trace file, get the OutFile property, create a FileSystemObject with this name and save it to another filename. The value of the OutFile property is initialized to the value of the key in the registry. HKEY_LOCAL_MACHINE\SOFTWARE\Level 8\Geneva AppBuilder\2.0\IDWB\ SCRIPTING\TURBO SCRIPTER\Trace_File If there is an invalid value in the registry, then the OutFile property is assigned to ts.out in the current directory.

Level
A integer property that specifies the severity of the messages that need to be written to the trace file. The valid values are:

AppBuilder 2.1.0 Scripting Tools Reference Guide

1-7

TurboScripter Object Reference

Table 1-2 Numeric Value 0 1 2

Trace Levels

Integer Constants TRACE_EXECUTION TRACE_DEBUG TRACE_ALL

Trace File Contents Trace errors Trace errors and informational messages Trace detailed error and information messages Note that this value significantly impacts performance.

TRACE_EXECUTION, TRACE_DEBUG, and TRACE_ALL are integer constants defined in the TSATL type library. Any other numeric value above 2 is the same as setting the value to 2.

Host Object - Implements IScriptUtils

CreateScript(String FileName, String Language)
Returns a Script object that is initialized to have the same environment as the calling script. This call is used to create a new script object that can be executed from inside this script. The new child script can be executed by calling the method Run() on the returned Script Object.

Child Script Object - Implements IScript

Run( )
Executes the Child Script object in the same environment as the parent script. This method raises an Error if the execution of the script fails. Sample: AddToFolder.vbs

AddInputObject(String Type, String Name)

Adds the repository object specified by Type and Name to the InputObject Dictionary of this child script object.

AddTypeLib(String TypelibID, Long MajorVersion, Long MinorVersion, (optional) Long Flags)

Adds the specified TypeLibrary to the scope of this script object. Any constants defined in the TypeLibrary can now be used within the script.

AddTopLevelObject(String Name, Object TopObject)

Adds the specified ActiveX Object to the list of Top Level objects for this script. The script can access the object using the Name parameter.

1-8

TurboScripter Object Model Reference

TurboScripter Object Reference

TurboHost Implements ITurboHost

The TurboHost object implements the functionality required to host the scripting engine and serves as the entry point to the Repo, Script and Trace Objects. The methods and properties of this object can be used from other applications like VB that support COM and are not for use from inside a script.

RepoInit(String RepositoryName, String UserName, String Password)

Connects to the specified repository and returns the repository object. This object is a must to either run scripts or work with any repository objects directly.

ScriptRun(String ScriptFileName, String Language, Dictionary InputObjects, Long WindowHandle, (optional) Dictionary TopLevelObjects)
Executes the specified script. Returns an error on failure. VBScript and JScript are the currently supported languages. The Window Handle can be 0 in which case, the handle of the currently active window will be used. The TopLevelObjects Dictionary contains ActiveX objects keyed by their name. These objects can be used from inside a script just like the default Top Level Objects like Trace or Repo.

ScriptletRun(String ScriptContents, String Language, Dictionary InputObjects, Long WindowHandle, (optional) Dictionary TopLevelObjects)
Works the same way as ScriptRun except that a string containing the script is passed instead of the file name. This is useful when scripts are generated on the fly by an application.

ScriptSelectAndRun(Dictionary InputObjects, Long WindowHandle)

This method brings up a dialog box containing the scripts in the directory specified in the registry. This dialog also shows the scripts present in the TScripts Component Folder. You can then select the script you want to be executed.

ScriptInit(String ScriptFileName, String Language)

This method returns the Script Object that is initialized to the file name and language specified. Once this object is obtained, methods to add input objects, to add top-level objects, and to execute the script can be called.

AppBuilder 2.1.0 Scripting Tools Reference Guide

1-9

TurboScripter Object Reference

Top-level objects added by TurboScripter to the scope of all scripts: Repository Object Implements IRepo Repository Object for querying, creating or deleting objects in the repository Trace Object Implements Itrace Trace Object to get and set the trace file and trace level Host Object - Implements IScriptUtils Host Object to enable creating a child script Input or Entity Object Implements ITSEnt Dictionary object that contains the input Entity objects (TSEnt). Sample:Rename.vbs.

CoDraw Object
The CoDraw Object provides access to Drawing Objects stored in the repository. Currently only read access is allowed. From VB or TurboScripts, Drawing Objects can be accessed by calling CreateObject(CoDrawFile.CoDrawFile). This returns the created ICoDrawfile object which can be used to perform read operations on the drawing.

Open(String DrawingName, String DrawingType)

Retrieves the specified drawing object and opens it for reading. The DrawingName is the name of the Drawing object. The DrawingType is the value in the Drawing_Type property of this object. Since the Drawing_Type property can only have values from the Drawing_Type domain, the Display value needs to be specified. Sample: Draw.vbs

GetAllRepoObjects()
Retrieves all the repository objects in the drawing and returns a Dictionary object that contains these as Entity objects (TSEnt). Sample: Draw.vbs

GetRepoObjects(String Type)
Retrieves the repository objects of the specified Type in the drawing and returns a Dictionary object that contains these as TSEnt objects. Sample: Draw.vbs

Note

The CoDraw object reflects the state of the Drawing Object as it is in the repository. If changes are made to the drawing file from the workbench, these changes need to be committed before the CoDraw Object is opened.

1-10

TurboScripter Object Model Reference

TurboScripter Object Reference

CoPanel Object
The CoPanel object provides COM/OLE Automation-based access to the various controls and their properties. It allows a TurboScript to create, read, update and delete the controls and their properties. They include: CoPanel Object Control Types CoPanel Object Colors CoPanel Object GUI Types
Table 1-3 CoPanel Object Control Types Constant ctrlChart ctrlCheckbox ctrlCombobox ctrlEditfield5 ctrlEllipse ctrlGroupbox ctrlHotspot ctrlListbox ctrlMultiLineEdit ctrlActiveX ctrlPushbutton ctrlRadiobutton ctrlRectangle ctrlMCLB ctrlStatictext ctrlBitmap ctrlMenu ctrlSubMenu ctrlMenuItem ctrlMenuSeparator ctrlCell ctrlCellField ctrlCellText ctrlXData ctrlYData ctrlFootingText ctrlLeftMarginText ctrlRightMarginText ctrlHeadingText

Control Type 1. 2. 3. 4. 5. 6. 7. 8. 9. 10. 11. 12. 13. 14. 15. 16. 17. 18. 19. 20. 21. 22. 23. 24. 25. 26. 27. 28. 29. CHARTWINDOW CHECKBOX COMBOBOX EDITFIELD ELLIPSE GROUPBOX HOTSPOT LISTBOX MULTILINEEDIT OLECONTROL PUSHBUTTON RADIOBUTTON RECTANGLE SPREADSHEET STATICTEXT BITMAP MENU SUBMENU MENUITEM SEPARATOR CELL CELLFIELD CELLTEXT XDATA YDATA FOOTINGTEXT LEFTMARGINTEXT RIGHTMARGINTEXT HEADINGTEXT

AppBuilder 2.1.0 Scripting Tools Reference Guide

1-11

TurboScripter Object Reference

Table 1-4

CoPanel Object Colors

Color 1. 2. 3. 4. 5. 6. 7. 9. 10. 11. 12. 13. 14. 15. 16. 17. 18. 19. 20. Default Black White DarkGray Gray LightGray DarkBlue DarkGreen Green DarkCyan Cyan DarkRed Red DarkMagenta Magenta DarkYellow Yellow Pink Brown CoPanel Object GUI Types

Table 1-5 GUI Type IBM_3270

Workstation HTML

Note

Some functions below have Language parameter. It is introduced for future use.

NewPanel(GUIType gui, String filename)

Creates a new panel of the specified type. The object is created in the repository only after Commit is called. This call needs to be called before adding any controls to the panel. Filename is an optional parameter used to initialize a panel from a template. Sample: pnl_crt.vbs

OpenPanel(String winName, String winLanguage, GUIType gui)

Opens an existing panel in the repository. The default value for language is . Sample: pnl_read.vbs

AddControl(ControlType control_type)
Adds a new control of the specified control_type to the panel and returns a Control Object.
1-12 TurboScripter Object Model Reference

TurboScripter Object Reference

Sample: pnl_crt.vbs

AddAttribute(String AttrbuteName)
Adds the specified attribute to the Panel object and returns the Attribute Object. This method is called when a new attribute that is not in the current Window Model needs to be added to the panel.

DeleteAttribute(String AttributeName)
Deletes the specified attribute from the Panel object. This can be done for attributes that are currently in the Window Model, as well as new ones added by the user.

GetAttribute(String AttributeName)
Returns the Attribute Object for the specified attribute. Sample: pnl_read.vbs

DeleteControl(Control ctrl)
Deletes the control specified by the ctrl object from the panel

Commit(String WindowName, String Language)

Saves the panel object in the repository. For new panels, if a panel with the same GUI and language exists under the WindowName, an error is returned. The panel is updated if an existing panel is opened, updated and committed. Sample: pnl_crt.vbs

GetAllAttributes()
Returns a Dictionary object containing a list of all the Attribute Objects for this panel.

Rollback()
Rolls back all changes made to the panel and returns it to the NewPanel or OpenPanel state.

GetAllControls()
Returns a Dictionary object with a list of all the controls in the panel.

SaveToFile(String PanelFileName, String HelpFileName)

Saves the panel to a file named PanelFileName and the help to HelpFileName.

GetDomainValues(String Type)
Given a Domain Type, this call returns a dictionary object containing all the values in the domain. Refer to the Valid Domain Types and Values.

AppBuilder 2.1.0 Scripting Tools Reference Guide

1-13

Valid Domain Types and Values

GetLanguage()
Retrieves that language property for the current panel object.

SetLanguage(String Language, Boolean overwrite)

Set the language property for the panel. If overwrite is TRUE, the panel will replace an existing panel of that language if it already exists.

Paste(VARIANT objects)
Adds objects, supplied in panel file format, to the panel. Returns a Dictionary object with a list of the controls that were added.

GetDomainTypes()
GetDomainTypes() returns a dictionary of domain type strings.

GetDomainValues()
GetDomainValues() returns a dictionary of values for a given domain type. These methods are used together to provide Window Painter the valid attribute values for a given attribute. These values are contained in the Window Painter model. Refer to the Valid Domain Types and Values.

Valid Domain Types and Values

Here is a list of the current domain types and values used in GetDomainTypes() and GetDomainValues(String Type). The supported values for each type is provided in the linked subtopic.
Table 1-6 COUNTRY COORDTYPE JUSTIFICATION FORMAT COLOR HSCROLL VSCROLL Domain Types and Values BORDER_TYPE FONT CHARTTYPE STYLE STYLE_3270 SELECTIONTYPE DRAWLINES

COUNTRY
Table 1-7 Country Values

SYSTEM ARGENTINA AUSTRIA

ALBANIA AUSTRALIA BELGIUM

1-14

TurboScripter Object Model Reference

Valid Domain Types and Values

Table 1-7

Country Values

BRAZIL CANADA_FRENCH CZECHOSLOVAKIA FINLAND GERMANY HUNGARY ITALY NETHERLANDS NORWAY PORTUGAL SOUTH_AFRICA SPAIN SWITZERLAND THAILAND TURKEY UNITED_STATES COORDTYPE CHAR JUSTIFICATION LEFT FORMAT CASEENTERED LOWER ALLFIRSTUPPER COLOR CUSTOM BLACK DARKGRAY LIGHTGRAY BLUE GREEN

CANADA_ENGLISH CHINA DENMARK FRANCE GREECE ICELAND JAPAN NEW_ZEALAND POLAND ROMANIA SOUTH_KOREA SWEDEN TAIWAN THAILAND_BUDDHIST UNITED_KINGDOM YUGOSLAVIA

PIXEL

RIGHT

UPPER FIRSTUPPER

DEFAULT_COLOR WHITE GRAY DARKBLUE DARKGREEN DARKCYAN

AppBuilder 2.1.0 Scripting Tools Reference Guide

1-15

Valid Domain Types and Values

CYAN RED MAGENTA YELLOW BROWN HSCROLL SHOW_ALWAYS SHOW_AS_NEEDED VSCROLL SHOW_ALWAYS SHOW_AS_NEEDED BORDER_TYPE BORDER_NONE BORDER_DIALOG FONT CUSTOM MODERN8 MODERN12 ROMAN10 ROMAN14 ROMAN24 SWISS10 SWISS14 SWISS24

DARKRED DARKMAGENTA DARKYELLOW PINK

SHOW_NEVER

SHOW_NEVER

BORDER_SIZEABLE

SYSTEMFONT8 MODERN10 ROMAN8 ROMAN12 ROMAN18 SWISS8 SWISS12 SWISS18

1-16

TurboScripter Object Model Reference

Valid Domain Types and Values

CHARTTYPE LINECHART2D PIECHART2D COLUMNCHART2D SCATTERCHART2D BARLINECHART2D CANDLE2D LINECHART3D PIECHART3D COLUMNCHART3D PERBARCHART3D STYLE DROPDOWN SIMPLE STYLE_3270 DROPDOWN SELECTIONTYPE SINGLE EXTENDED DRAWLINES NOLINES HLINES VLINES VHLINES MULTIPLE DROPDOWNLIST DROPDOWNLIST BARCHART2D STACKEDBARCHART2D SMOOTHLINECHART2D AREACHART2D HILOWCLOSE2D POINTANDFIG2D BARCHART3D STACKEDBARCHART3D AREACHART3D BARLINECHART3D

CoCtrl Object
GetAllAttributes()
Returns a Dictionary object containing a list of all the Attribute Objects for this control.

AddAttribute(String AttrbuteName)
Adds the specified attribute to the Panel object and returns the Attribute Object. This method is called when a new attribute that is not in the current Window Model needs to be added to the panel.

AppBuilder 2.1.0 Scripting Tools Reference Guide

1-17

Valid Domain Types and Values

GetAttribute(String AttributeName)
Returns the Attribute Object for the specified attribute. Sample: pnl_read.vbs

GetType()
Returns the ControlType constant (defined above) that specifies this controls type Sample: pnl_read

DeleteAttribute(String AttributeName)
Deletes the specified attribute from this control. This can be done for attributes that are curently in the Window Model as well as new ones added by the user.

GetContents()
Returns a Dictionary Object containing the controls that are embedded in this control. Fails if no controls are present.

AddControl(ControlType type)
A control of ControlType type is added to this control. Sample: pnl_crt.vbs

DeleteControl(Control ctrl)
Deletes the Control specified by ctrl from this control.

DeleteContents()
Deletes all embedded controls in this control.

ChangeParent(IcoCtrl * old, IcoCtrl * new)

Changes a control objects parent.

ChangeType()
Modifies the control type.

Copy()
Creates a SAFEARRAY of BYTEs that correspond to the panel file format for the control.

1-18

TurboScripter Object Model Reference

FAQs for Scripting Tools

Attribute Object
set_Value(VARIANT val)
Sets the Value of this attribute to that specified by val. All variables in VBScript are of type VARIANT which is a generic type for all other supported types. This method would be successful as long as the value is of the right type, for example, String, Integer etc. Sample: pnl_crt.vbs

get_Value()
Returns the value of the attribute. If the attribute is a compound attribute, like Font or Color, then this value would contain an object like Font or Color. Sample: pnl_crt.vbs

get_Name()
Returns the name of this attribute Sample: pnl_read.vbs

DeleteAttribute()
Removes this attribute from the parent control.

Font Object and Color Object

These are compound attributes and can be treated like a sub-control, since they contain the same methods that characterize a control object. They have attributes that can be accessed through GetAllAttributes or GetAttribute(String AttributeName).

FAQs for Scripting Tools

Frequently asked questions include: How does a VBScript or JavaScript access the repository? How can I access the properties of an entity or relation object? Can I invoke other scripts from a currently executing script? How do I manipulate or create windows and controls within the windows ? How do I access drawing files in the Freeway repository? Can I access the repository from VB? What is a Dictionary Object that is used ubiquitously in TurboScripter methods?

AppBuilder 2.1.0 Scripting Tools Reference Guide

1-19

FAQs for Scripting Tools

How do I obtain a relation object between two objects? How do I create or modify files under a Component_Folder? Where do I look for Trace information about a TurboScripter session?

How does a VBScript or JavaScript access the repository?

Scripts in TurboScripter access the repository through the Repo object. Repository objects can be queried (for example, Repo.Query(FIELD, RETURN_CODE) or created (for example,: Repo.Create(RULE, TS_SAMPLE) from a Repo object. These repository objects are returned as TSEnt objects for entities and TSRel objects for Relations.

Note

The Freeway Service Manager module, gresvcnt.exe, must be running before you can connect to a personal repository via TurboScripter.

How can I access the properties of an entity or relation object?

You can get and set properties of an object using GetProperty or SetProperty. For example, you could use myObj.GetProperty(Name)or myRel.SetProperty(Sequence_Number). The property names used in these methods need to be valid property names according to the Workgroup repository model. You can get a list of entities, relations and their property names by running the sample script Model.vbs shipped with TurboScripter. Or you can use the Object.Property notation to access the properties of an object. For example, objName = myObj.Name , myRel.Sequence_Number = n.

Note

The object and property names may differ from those in TurboCycler documentation. TurboScripter uses the exact names defined by the Workgroup repository.

Can I invoke other scripts from a currently executing script?

Yes. You call Host.CreateScript(ScriptFileName , Language). This creates a new script object and initializes it to the current environment. Once this is done, you can pass repository objects to the script by calling AddInputObject on the new script object. The new script is executed by calling the Run method.

How do I manipulate or create windows and controls within the windows ?

You can create, update, read and delete controls within a window through the CoPanel Object. The CoPanel Object exposes the controls and attributes of the window stored in a panel file. The sample scripts pnl_read.vbs , pnl_crt.vbs demonstrate access panel objects/files.

How do I access drawing files in the Freeway repository?

Currently, VBScripts or JScripts can read the repository objects stored within a drawing file. This is done through the CoDraw object. The sample script draw.vbs demonstrates how to access an Entity Relationship Drawing (ERD) and retrieve the repository objects within the drawing. Please note that the drawing file is retrieved from the repository and may not reflect uncommitted changes made to that file in the workbench.

1-20

TurboScripter Object Model Reference

FAQs for Scripting Tools

Can I access the repository from VB?

Yes, you can access the repository from VB or any other tool that supports COM. You need to create the TurboHost object either through the CreateObject method or by declaring a variable of type TurboHost. To declare a variable you first need to add the TSATL library to the references for the VB project. Once the TurboHost object has been successfully created, call RepoInit on this object to establish a repository session. This method returns the Repo object on success. Now, you can create or query objects from the repository and manipulate just as you would from a script. The sample project VB_TSRepo shipped with TurboScripter demonstrates this.

How do I access repository objects passed from the Construction Workbench?

You can access the InputObject Dictionary object that contains the list of repository objects passed by the Workbench. This Dictionary has a 0 based index as its key and TSEnt objects as the items.

Can I select a project for Construction Workbench from TurboScripter?

No, the FWY API does not support this action. From VB, you can access the currently active project only. Prior to accessing the repository from VB, you must select an active project from the Workbench or Freeway Explorer. Because a repository session is associated with a project, changing the active project requires closing and reopening the session.

What is a Dictionary Object that is used ubiquitously in TurboScripter methods?

The Dictionary Object is a container type created by Microsoft that contains a list of Key, Item pairs. In most cases, TurboScripter uses the Key as a zero based index and the item contains the actual value that is contained. Further information about the Dictionary object is available at the Microsoft Web site or in VBScript documentation. Example: REM ** Create a Dictionary object to set the properties of an object on creation Set myProps = CreateObject(Scripting.Dictionary) REM ** The property name is the KEY and the value is the ITEM MyProps.Add(Field_Type, Small Integer or Integer) MyProps.Add(Fld_Len, 15) Set myObj = Repo.Create(FIELD, TS_TEST, MyProps)

How do I obtain a relation object between two objects?

When calling GetChildren or GetParents, pass in an empty Dictionary Object as the third parameter which is optional. When the call returns, this object will contain the relations corresponding to the children for the same Key value. (The Relation for the first Child object in the returned Children object will be the first element in the Relations object, Relation for the second child will be the second element in the Relations object and so on.)

AppBuilder 2.1.0 Scripting Tools Reference Guide

1-21

FAQs for Scripting Tools

How do I create or modify files under a Component_Folder?

If the Component_Folder does not exist, create a Component_Folder object using Repo.Create. Now create a child of type WEAK_ENTITY via the relation COMPONENT_FOLDER_CONTENT. Set the PathName property of the COMPONENT_FOLDER_CONTENT relation to the full path name of the file you want to store in the repository. Now call SetFile method on the Relation object passing in the text string containing the file contents and the type which is 17(ComponentFolderFile).

Note

As of version 5.0 of VBScript and JScript, binary files are not supported. This restricts the use of TurboScripter to Text files.

Where do I look for Trace information about a TurboScripter session?

The Trace file name and path are determined by the Registry settings for Trace_File under the TurboScripter Key. You can also select Tools > TurboScripter (CTRL+ALT+B) and clicking Options in the Script Select window. A hierarchy object must be selected for the TurboScripter menu item to be available. By default it is set to ts.out in the AppBuilder\AD\TSCRIPTS directory. The amount of information in this file is dependent on the TRACE LEVEL settings in the Options dialog. If you are debugging a script, you can set this value to DEBUG, however, performance may be effected.

1-22

TurboScripter Object Model Reference

CHAPTER

USING TURBOCYCLER DEFAULT TEMPLATES

AppBuilder 2.1.0 Scripting Tools Reference Guide

The TurboCycler product is a productivity tool that generates repository objects from other objects in the repository. The TurboCycler process improves productivity by automating repetitive tasks in the software development lifecycle. TurboCycler Standard Edition, when combined with the TurboCycler Developers Kit, provides an open architecture that lets you generate objects suitable to any development platform and methodology. This topic explains the TurboCycler generation process as it applies to the AppBuilder development environment and illustrates this process through the functions of the Standard Edition default templates. This section describes: Starting TurboCycler how to access TurboCycler from tools in the Construction Workbench Using Default Templates how to use the predefined templates provided with the product TurboCycler Tutorial how to use a sample application using TurboCycler To better understand the generation possibilities of TurboCycler, refer to Chapter 3, Using the TurboCycler Developer Kit.

Starting TurboCycler
When TurboCycler is installed, you can access it from the following application development tools: Database Diagrammer Entity Relationship Diagrammer Matrix Builder Process Dependency Diagrammer State Transition Diagrammer Window Flow Diagrammer Select New or Open and choose the development tool. When the tool window opens, select Analysis>TurboCycler. From Construction Workbench, select an object in the hierarchy and select Tools>TurboCycler.

AppBuilder 2.1.0 Scripting Tools Reference Guide

2-1

Starting TurboCycler

Review the following sections for information about starting TurboCycler: Selecting Generation Templates Setting Up Generation Templates Generating Your Application

Selecting Generation Templates

Access TurboCycler from Construction Workbench using the following procedure. Procedure - Accessing TurboCycler from Construction Workbench 1. 2. Select Start > Programs > AppBuilder > Construction Workbench. Open a project and select an object within the project or query for an object. Select Tools > TurboCycler. The TurboCyclerSelect Generation Templates window opens (Figure 2-1).
You can also right-click the mouse to select TurboCycler. TurboCyclerSelect Generation Templates window

Note
Figure 2-1

3. 4.

The Selected Templates and Available Templates list boxes display templates you can use with the selected object type (in Figure 2-1, the object type is Function). Select the templates you want to use with the Add and Remove buttons.
Selecting a Template in TurboCycler

Figure 2-2

If you add additional templates, alter the default templates, or create new templates (using the TurboCycler Developers Kit), the objects you have created will be available through the query option. 5. Select Generate, Setup Templates, or Cancel. Generate starts the generation process. Setup Templates displays a window where you select the modules you want to generate (see Setting Up Generation Templates below). Cancel returns you to the previous window.

2-2

Using TurboCycler Default Templates

Starting TurboCycler

Setting Up Generation Templates

To set up your generation template follow the procedure outlined below. Procedure - Setting up Templates 1. Select Setup Templates . The TurboCycler Generation Template Setup window opens (Figure 2-3). This window lets you specify precisely what output you want TurboCycler to generate (for example, whether the application should perform an SQL update or an SQL insert, or both) These output choices are called modules.
Generation Template Setup Window

Figure 2-3

2.

The Object Type list box displays the repository object type and the Generation Templates list box lists templates for that object type (Figure 2-4). The text in the Template Description box describes the selected template. The Selected Modules and Available Modules list boxes identify the available modules for this object type/template combination. Select the modules you wish to generate with the Add and Remove buttons.
Generation Template Selection

Figure 2-4

Generating Your Application

After you select the appropriate modules, proceed with the generation as described in the following procedure.

AppBuilder 2.1.0 Scripting Tools Reference Guide

2-3

Using Default Templates

Procedure - Generating the Application 1. 2. Select the Generate button in the Select Generation Templates window to start the TurboCycler process. The Rename Object window opens (Figure 2-5).
Rename Object Window

Figure 2-5

During the generation process, a status window notifies you of the generations progress. 3. Select the Cancel button to stop TurboCycler between modules. You can review the results of the TurboCycler process after completion.
The TurboCycler process generates objects using names defined by the templates for the objects you select. If you run TurboCycler more than once, previously generated objects with modifications are replaced by newly generated objects. Because of this, you must carefully examine the objects created by a generation. To validate the generation results and make sure that no desired user modifications have been lost, examine the hierarchy, rule, and window objects. If you are not pleased with the results of a generation process, you can roll back the session changes from the Construction Workbench.

Caution

Using Default Templates

This topic includes: Understanding Default Templates Developing the Application And information about using these default templates: CRUD Rules Template GUI Rules/Windows Template Utilities Template Rename Views, Fields and Rules Template Rename Verify Template Hierarchy Cloner Template

Understanding Default Templates

TurboCycler software includes a set of six default templates. You can generate a fully functional reference table application using all of the six templates. The default templates specify part of the TurboCycler

2-4

Using TurboCycler Default Templates

Using Default Templates

output and make modifications easier. The default templates are designed for the single byte characters. For templates using 'String Manipulation function' in DBCS environment, you need to modify the default templates. CRUD Rules Template, includes SQL statements (Create, Read, Update, and Delete database access operations) GUI Rules/Windows Template, supplies graphical interface event-handling procedures Utilities Template, contains message-handling procedures used by generated objects Rename Views, Fields and Rules Template, modifies the source of any rules that refer to a renamed FIELD or VIEW object Rename Verify Template, shows the rules in the repository that need to be modified if the name of the selected object is changed Hierarchy Cloner Template, creates a new hierarchy of repository objects based on an existing hierarchy The TurboCycler process uses the default templates to create output objects with fully-coded rules including calls to system components as needed, painted windows with predefined styles, and view and field physical data structures. These objects are automatically related in a logical hierarchy in the repository.

Note

Two or more users should not run TurboCycler templates that create and update the same repository objects. This is true for objects that are sent through TurboCycler as well as other objects that the template may access to update or create. For example, the CRUD template uses common fields and views that are irrespective of the ERD on which it is applied. These fields and views are reused once they have been created. If two users run the CRUD template at the same time, the first user locks the common field and the other users cannot access it, leading to an error message Object exists in the repository in an Uncommitted State.

Using Default Templates describes how to use the default templates. It details the output objects the templates generate and defines the specific rules, windows, and hierarchies generated by each default template. The source code for each of these templates is included in the TurboCycler Developers Kit. Two source code samples are included in Template Samples on page 4-52 Using the default templates, you can generate a functional application, including complete function hierarchies, detail and list windows, database access rules, and standard utilities. You can write generation templates to automate an unlimited number of processes in the development lifecycle. You can also write templates to customize processes like forward engineering, transformation, reverse engineering, and any other process that generates objects in the repository from other repository objects.

Developing the Application

Before starting TurboCycler, perform the usual Construction Workbench modeling steps as follows: 1. 2. 3. Create an entity relationship diagram (ERD) Forward engineer the ERD into a database diagram (DBD) Transform the DBD into a hierarchy diagram (HD)

AppBuilder 2.1.0 Scripting Tools Reference Guide

2-5

Using Default Templates

Step 1 establishes the ERD as a logical model that consists of entities, relationships, properties, identifiers, and data types. In step 2, forward engineering creates a relational model containing tables, keys, and columns. Step 3 is the transformation to a structural model of files, views, and fields. These steps populate the repository with the information TurboCycler needs to generate a referencetable application. Without TurboCycler, developing applications using these objects requires you to write rules code yourself to reflect the model.

Encountering Errors
If TurboCycler encounters a repository error or other errors that are specific to an object, a message is displayed. If Error is encountered, TurboCycler will stop processing until the error is corrected.

CRUD Rules Template

You can generate CRUD rules (Create, Read, Update, Delete) for any existing file hierarchy in the repository. Because of the traceability information stored in the repository during forward engineering and transformation, four object types in the repository (files, tables, entities, and many-to-many relationships) can generate CRUD rules. If you want to generate CRUD rules from non-file objects, you must perform the appropriate forward engineering and transformation steps before the generation process, or an error message appears. The CRUD Rules template contains six modules: Clone Data View Module SQL Delete Rule Module SQL Fetch Rule Module SQL Insert Rule Module SQL Select Rule Module SQL Update Rule Module

Clone Data View Module

Clone Data View creates a view in the repository. The view name is the name of the file (for long file names, truncated to a maximum of 19 single-byte characters or 8 DBCS characters), plus the suffix _CDV. This view contains, as its children, all of the fields included in the file data view. Assorted CRUD rules and some GUI rules and windows use the cloned data view to avoid problems of hierarchy ambiguity. Figure 2-6 shows a generated clone data view and the corresponding file data view.

2-6

Using TurboCycler Default Templates

Using Default Templates

Figure 2-6

Generated Clone Data View with its Corresponding Data View

SQL Delete Rule Module

SQL Delete Rule creates a rule with appropriate input view, output view, and rules code that handles record deletion in the table specified by the file implementation name. It determines which file to delete the record from by the primary key view mapped to its input view. An SQL code is returned from the delete operation. Figure 2-7 shows an example of a delete rule hierarchy.
Figure 2-7 Delete Rule Hierarchy

SQL Fetch Rule Module

SQL Fetch Rule creates a rule with appropriate input view, output view, and rules code. This rule fetches records from the table specified by the file implementation name. The fetch rule is compatible with smooth scrolling techniques through the use of the NUMBER_OF_RECORDS field in the input view. For each fetch, 50 occurrences of records are fetched according to the parameters mapped to the primary key view, cloned data view, and FETCH_TYPE field in the rule input view. You can specify the FETCH_TYPE as blank (which defines a fetch for all records whose key is greater than or equal to the key mapped to the input view) or as D (which defines a fetch using a LIKE clause against all fields in the key). The fetch rule returns and maps the SQL code to the field RETURN_CODE if an SQL error occurs. The number of records fetched is returned to the NUMBER_OF_RECORDS field and all fetched records are returned to the occurring cloned data view in the output view.

SQL Insert Rule Module

SQL Insert Rule creates a rule with appropriate input view, output view, and rules code. This rule inserts a record in the table specified by the file implementation name. It inserts the record mapped to the cloned data view of its input view and returns the SQL code from the insert operation.

SQL Select Rule Module

SQL Select Rule creates a rule with appropriate input view, output view, and rules code. This rule selects a record by primary key from the table specified by the file implementation name. It uses the primary key mapped to its input view to select a single record in the database table and returns the contents of the record in the cloned data view of the output view. It returns the SQL code from the select operation.

AppBuilder 2.1.0 Scripting Tools Reference Guide

2-7

Using Default Templates

SQL Update Rule Module

SQL Update Rule creates a rule with appropriate input view, output view, and rules code. This rule handles updates to a database record selected by the primary key in the table specified by the file implementation name. It sets all fields of the record of the table to the values mapped to the cloned data view of the rule input view. It returns the SQL code from the update operation.

GUI Rules/Windows Template

You can generate GUI rules and windows for any forward engineered and transformed entity hierarchy in the repository. The GUI Rules/Windows template extracts information already defined in the logical, relational, and structural models of the repository. This template uses traceability information defined during forward engineering and transformation to generate GUI rules and windows from four object types in the repository (entities, many-to-many relations, tables, and files). If any object of these types does not have the required traceability information, you cannot use this template to generate GUI rules and windows for that object and an error message is displayed. The GUI Rules/Windows Template contains the following modules: Detail Display Module Display Driver Module Browse Display Module List Display Module Query Display Module Logical Driver Module

Detail Display Module

Detail Display creates both a rule and a window (with appropriate hierarchies that have references to sets and components) for each entity you specify. This rule and window display data details in your applications interface. They display information and allow standard record maintenance (create, read, update and delete). The detail display window usually allows end users to edit all fields in the data view. The hierarchy you generate for a kernel entity is different than the one for a non-kernel entity. The detail display for a kernel entity is an entry point (that is, a menu choice in the AppBuilder Application Execution menu) into the generated application; therefore, a function and process are generated for every kernel entity. Because the detail display rule for a kernel entity is the root rule for the generated process, it contains no input or output view. A kernel entity detail display also allows you to select an instance of the kernel entity using the Open choice in the File menu. Because the details of a non-kernel entity are meaningful only in the context of another entity, you can navigate to a non-kernel detail display only from another entity; it does not serve as an entry point into the application. For this reason, the detail display rule for a non-kernel entity contains an input and an output view. Also, you cannot open an instance directly from a non-kernel detail display, as it is necessary to clarify its context through navigation from another object. A generated detail display window always contains File, Edit, and Options menus. The File menu allows you to create a new object, save an object, delete an existing object, and exit the application. The Edit

2-8

Using TurboCycler Default Templates

Using Default Templates

menu provides undo and redo facilities. The Options menu lets you eliminate the status bar that appears at the top of the detail display. View or Query menu choices are available when the table implementing the entity contains referred-by keys (for the View menu) or foreign keys (for the Query menu). You can use View and Query menus to navigate from object to object (entity to entity) in the application. The status line, located under the menu bar, displays information about current actions.

Display Driver Module

Display Driver creates a rule (with appropriate hierarchies that have references to sets and components). This rule initializes window parameters and enables or disables objects on the detail window by interacting with the Detail Display rule. The display driver rule does not have an output view, so no return code is passed back to the calling rule.

Browse Display Module

Browse Display creates both a rule and a window (with appropriate hierarchies that have references to sets and components) for any kernel entity. This rule and window provide a way of looking at information for a kernel entity without updating the information. You can use this browsing technique for object-to-object navigation. Use it only for kernel entities as a non-kernel entitys detail display rule handles object-to-object navigation. Use the browse display also when navigating to a kernel entity to avoid recursion in the repository. The browse display window is very similar to a detail display window. However, the browse display offers only the Exit choice in the File menu. You can perform no other actions including object-to-object navigation. For that reason, there is no status line.

List Display Module

List Display creates both a rule and a window (with appropriate hierarchies that have references to sets and components) for the entity. You use this window to select an instance of this entity from the Query menu. The list display rule shows a list of entity instances that meet the criteria the primary key specifies. It supports smooth scrolling, so you query the table and select a single instance in the table implementing this entity. The list display rule takes as input the primary view of the entity which it uses as search criteria. The output of the list display rule is a single instance of the cloned data view. The list display window contains a multicolumn list box with one column for every field in the data view of the file corresponding to this entity. The top of the window has an edit field for every field in the primary view that you can use to specify selection criteria for a subset of entity. The menu contains a single choice for toggling the status line on and off. Use the push buttons at the bottom of the window to: Select a set of rows in the list box according to the criteria specified at the top of the window Select a single row from the list box Cancel from this window The status line, located under the menu bar, displays information about current actions.

AppBuilder 2.1.0 Scripting Tools Reference Guide

2-9

Using Default Templates

Query Display Module

Query Display creates both a rule and a window (with appropriate hierarchies that have references to sets and components) for the entity. Use this rule and window to navigate to this entity from another entity, usually through a View menu. The query display rule shows all entity instances that meet the criteria specified in the primary key. It supports smooth scrolling, so you can specify information to query the table and select a single instance in the table implementing this entity. If you select an instance of this entity either this entitys detail display (for a non-kernel entity) or browse display (for a kernel entity) is conversed. The query display rule takes as input the cloned data view of the entity which it uses as search criteria (if you specify any). The query display rule does not have any output because it is only for navigation and viewing. The query display window has a multicolumn list box with one column for every field in the data view of the file corresponding to this entity. Above the multicolumn list box there is an edit field for every field in the primary view. Use it to specify search criteria for a subset of entity instances. The menu contains a single choice for toggling the status line at the top of the window on and off. Use the push buttons at the bottom of the window to: Select a set of rows in the list box according to criteria at the top of the window Select a single row from the list box Cancel from this window The status line, located under the menu bar, displays information about current actions.

Logical Driver Module

Logical Driver creates a rule (with appropriate hierarchies that have references to sets and components) that acts as a layer between the detail display and browse display presentation rules and the SQL rules. Logical Driver performs all complex field-to-field mappings when making calls to SQL rules. It takes the action that is to be performed on the instance along with the entity instance (the cloned data view) in the input view. If errors occur, it automatically calls the messaging routine defined by the Message Display template.

Utilities Template
The Utilities template generates a message-handling rule and window for almost any modal message that a rule may need, such as an SQL failure. The only module included in this template is the Message Display Module.

Message Display Module

Message Display creates the HPS_MODAL_MESSAGE rule and window (with appropriate hierarchies that have references to sets and components) to display any four-line message to the end user. You can specify the push buttons to display through the HPS_MESSAGE_TYPES. The output view returns your response to the message.

2-10

Using TurboCycler Default Templates

Using Default Templates

Rename Views, Fields and Rules Template

Whenever you must change the name of an existing FIELD or VIEW object, use the Field and View Rename template to automatically modify the source of any rules that refer to the renamed object. This can save you hours of searching and editing. To change the source of rules that refer to a renamed object: 1. 2. 3. 4. 5. 6. 7. Go to Construction Workbench. Select a single FIELD or VIEW object to rename. Select Tools > TurboCycler and the Rename Views, Fields and Rules template. When the template displays the Rename window, type in the new name for the object. It automatically modifies the source of any rules that refer to the object to use the new name. Before finishing, the template shows a list of the rules it modified. The Status pane displays the generation process. You can stop TurboCycler generation by selecting Tools > Stop TurboCycler.
You can also right-click to select Stop TurboCycler.

Note

Rename Verify Template

The Rename Verify template does not modify any rules or change the name of the selected objectit only shows which rules in the repository need to be modified if the name of the selected object is changed. When you rename views that have a window parent, the window panel is not modified at all. The rule source change is a blind search and replace.

Hierarchy Cloner Template

The Hierarchy Cloner template creates a new hierarchy of repository objects based on an existing hierarchy. The new hierarchy consists of a mixture of both newly created objects and existing objects from the source hierarchy. Using this template involves: Understanding the Cloning Process Using the Hierarchy Cloner Setting Initialization Parameters For each object in the source hierarchy, cloner relies on pairs of search and replace strings to determine whether it should reuse the existing object or create a new object based on the existing object. The Hierarchy Cloner never modifies or has any effect on existing objects in the repository with one exception: while creating the new hierarchy, cloner may establish a parent/child repository relation between a newly created object and an existing object.

AppBuilder 2.1.0 Scripting Tools Reference Guide

2-11

Using Default Templates

Caution

When cloning hierarchies containing error, lookup, or define sets, the encoding and display attribute values is replaced blindly without error checking for value overflow and such. It is your responsibility to ensure that these values do not overflow and are valid

Understanding the Cloning Process

This section discusses how cloning works so you know what to expect from the cloning process. Each object that cloner examines must meet two conditions to be cloned: 1. 2. The name of the object must be changed after cloner does string replacement using the strings you supply. The type of the object must be in the user-specified list of types to clone.

If either of these conditions is not met, the object is reused and its child objects are not examined. If the object is to be cloned, cloner creates a new object of the same type with the cloned name and copies certain properties from the source object to the cloned object. The new object is attached to the new object hierarchy and cloning continues by examining children of the source object. If the cloned object already exists in the repository, it is reused and never modified. The properties copied are: Those that are available in TurboCycler Writable Not required to be unique by the repository Thus the template supplied is general purpose in nature and is not geared specifically to any one type of application hierarchy. If you have special requirements for cloning, customize the supplied template using the TurboCycler Developers Kit.

Note

Rollback does not remove all unwanted objects after cloning by TurboCycler.

Using the Hierarchy Cloner

Use the Hierarchy Cloner template from the Hierarchy Diagrammer to clone application hierarchies. Use it when you would like to make a copy of an existing hierarchy and you can identify one or more substrings contained in the names of the existing objects that can be used to guide the cloning process.

2-12

Using TurboCycler Default Templates

Using Default Templates

The following objects can be cloned: FUNCTION PROCESS RULE FILE VIEW FIELD SET VALUE COMPONENT WINDOW In addition to these, the cloner will reuse BITMAP objects but it will not clone them. Because cloner never modifies existing objects in the repository, subsequent regeneration of this template has no effect. Component source will not be cloned.

Note

Always select a single object and choose TurboCycler Selected from the Analysis menu. Cloner automatically examines all objects under the selected one. Do not pass multiple objects for cloning.

When cloner executes, a dialog is displayed. The controls and their meanings are listed in Table 2-1.
Table 2-1 Control Replace (entry field) With (entry field) Add (push-button) Delete (push-button) Move Up (push-button) Move Down (push-button) Objects to clone (listbox) Objects to reuse (listbox) Clone (push-button) Cloner Controls and Descriptions Description The substring to search for The replacement string to use Add the new pair of strings to the list Delete the selected pair of strings from the list Move the selected pair of strings up in the list Move the selected pair of strings down in the list Objects listed here are candidates for cloning Objects listed here will never be cloned Begins the cloning process

When cloner is finished, the new hierarchy is displayed. In this display, you can browse the new hierarchy and see the objects that were created.

Setting Initialization Parameters

Hierarchy Cloner uses the CLONER section in the TURBO.INI to record default settings for the dialog: [CLONER] REPLACE=EMPLOYEE COMPANY FIRM WITH=MANAGER ORGANIZATION COMPANY TEXT_AND_KEYWORDS=IGNORE SOURCE_FILES=YES REUSE=FIELD VALUE COMPONENT IMPLEMENTATION_NAMES=NO TRUNCATE_LONG_NAMES=NO

AppBuilder 2.1.0 Scripting Tools Reference Guide

2-13

TurboCycler Tutorial

The REPLACE entry contains a series of substrings to search for, separated by spaces. The WITH entry contains one replacement string for each substring in the REPLACE entry. TEXT_AND_KEYWORDS may be set to: IGNORE, indicating that created objects have no text or keywords COPY, indicating that created objects have the same text and keywords as the source object CLONE, indicating that created objects have the same text and keywords as the source object except modified by the name cloning procedure If SOURCE_FILES is NO then created objects have identical source files as the source object; if it is YES then source files are cloned. The REUSE entry contains a list of object types separated by a single space that are never to be cloned, regardless of their names. The IMPLEMENTATION_NAMES entry may be either YES or NO depending on whether implementation names and screen literals should be cloned. When cloner forms a name that is too long, it either automatically truncates the name or displays a dialog asking the user to provide a shorter name. This choice is controlled by the TRUNCATE_LONG_NAMES entry which may be either YES or NO. Typically, you do not need to look at this file since if you select Cloner and Generate, a dialog box displays and this window setting is written to TURBO.INI.

TurboCycler Tutorial
TurboCycler software complements and enhances the AppBuilder environment. Because of their compatibilities, the sample TurboCycler tutorial is an extension of the AppBuilder environment walkthroughs in the workstation Workbench reference. The tutorials summarize the automobile rental agency sample from AppBuilder training and show the results when you use the TurboCycler product with the same repository objects. The tutorial that follows assumes that you perform all of the steps for each tool. The steps are: Reviewing Forward Engineering and Transforming Generating with TurboCycler

Reviewing Forward Engineering and Transforming

The TurboCycler process begins after you forward engineer and transform a completed entity relationship diagram using the Construction Workbench. The following is a review of the building process. Refer to the AppBuilder documentation and online help for greater detail about building the models the TurboCycler walkthrough uses. Defining an Entity Relationship Diagram Forward Engineering an Entity Relationship Diagram Transforming a DBD

2-14

Using TurboCycler Default Templates

TurboCycler Tutorial

Defining an Entity Relationship Diagram

1. The first step in designing your application is to create an entity relationship diagram (ERD). Use the Entity Relationship Diagrammer to create the drawing shown in Figure 2-8.
Entity relationship diagram

Figure 2-8

2. 3. 4.

Choose Select All in the Edit menu, then choose Open as/Hierarchy in the Edit menu to open a constrained version of the hierarchy. Create the attributes, identifiers, and data types for the AGENT entity. As you create each data type, double-click its name to display the Edit Type window. Choose the data format corresponding to the data types name from the list box and then change the data length field if necessary. Create the hierarchies for the RESERVATION and VEHICLE entities shown in Figure 2-9.
RESERVATION and VEHICLE entity hierarchies

5.

Figure 2-9

6.

Create the hierarchies for the CUSTOMER and LOCATION entities shown in Figure 2-10.

AppBuilder 2.1.0 Scripting Tools Reference Guide

2-15

TurboCycler Tutorial

Figure 2-10

CUSTOMER and LOCATION entity hierarchies

7.

Create the hierarchies for the CORPORATE and INDIVIDUAL entities shown in Figure 2-11.
CORPORATE and INDIVIDUAL entity hierarchies

Figure 2-11

8.

Open the Construction Workbench window and select Commit Sessions changes in the Session menu. Name the entity relationship drawing RENTAL_ERD.

Forward Engineering an Entity Relationship Diagram

This section assumes you have created the entity relationship drawing and attributes described in Defining an Entity Relationship Diagram on page 2-15. 1. 2. 3. Select the Entity Relationship Diagrammer window. Verify each relationship has a cardinality symbol at each end. Make certain the cardinalities are as shown in Figure 2-12. Choose Hierarchy display in the Options menu to show the hierarchy for each entity in the drawing. Make sure each entity has the required attribute structures shown previously.
CORPORATE and INDIVIDUAL subtype entities do not need primary identifiers.

Note
4. 5.

Choose Forward engineer in the Analysis menu. This process should complete without error. Repeat the previous steps if you have errors. Create a new Database Diagram to view the created tables.

2-16

Using TurboCycler Default Templates

TurboCycler Tutorial

Figure 2-12

Tables and keys that forward engineering created

6.

Select File > Commit, or Ctrl+M or click on the Commit icon. If you have displayed the columns and keys in the Database Diagrammer, name and save the drawing.

Transforming a DBD
This section assumes you have created the ERD and attributes in an entity relationship diagram as described in Defining an Entity Relationship Diagram on page 2-15, and that you forward engineered as described in Forward Engineering an Entity Relationship Diagram on page 2-16. 1. 2. 3. 4. 5. Select File > New > Database Diagram to create a new database diagram. Select Insert > Table and query the following: AGENT, RESERVATION, VEHICLE, RESERVES, LOCATION, INDIVIDUAL, CORPORATE, CUSTOMER. . Select Transform in the Analysis menu. Right-click in the hierarchy to query the file entities created. Select Hierarchy in the Objects menu.

Generating with TurboCycler

The previous steps populate the repository with information TurboCycler needs to generate a referencetable application with views, rules, and windows needed for any application program. The following walkthrough shows how to complete the TurboCycler process using default templates. The steps are: Editing Screen Literals Selecting TurboCycler Windows Preparing the Application Procedure - Executing the Application

AppBuilder 2.1.0 Scripting Tools Reference Guide

2-17

TurboCycler Tutorial

Editing Screen Literals

Transformation generates, by default, screen literals that may be unappealing in an application. Since names are system generated or concatenated from labels you entered earlier, it is a good idea to rename screen literals before starting TurboCycler generation. Although you can edit the finished windows after generation, it is better to rename literals before generation so that the system uses appropriate and consistent literals. (If you do not edit literals once now, you will need to edit at least four windows later.) In addition, the windows generated by TurboCycler benefit from literals edited for brevity, conciseness, or appearance. For example, one name in the example is AGENT_NUMBER. Reword the entry to match your own requirements. Figure 2-13 shows how to change the screen literal from AGENT_NUMBER to Agent number:.
Figure 2-13 Properties Field window to alter screen literals

1.

Go through the fields of the data views of your files in Hierarchy Diagram. Review each field, and double-click its name to display the Properties Field window. Look to see the system-generated name in the Screen literallong field. Edit each literal as necessary to change it permanently. Select File > Commit to save session changes.

2.

Selecting TurboCycler Windows

This section assumes you have created the entity relationship drawing and attributes described in Defining an Entity Relationship Diagram on page 2-15 and have followed the rest of the procedures described up to this point. 1. 2. Select the Entity Relationship Diagrammer window. Select TurboCycler in the Analysis menu to access the TurboCycler windows. Make sure the templates selected in your window match Figure 2-14. Include all available templates (CRUD rules, GUI rules/windows, and utilities). Use the Add and Remove buttons to select the templates for generation. When you have selected the templates, select the Setup Templates push button in the Select Generation Templates window.

3.

2-18

Using TurboCycler Default Templates

TurboCycler Tutorial

Figure 2-14

TurboCyclerSelect Generation Templates window

This displays the TurboCyclerGeneration Template Setup window, which lists the modules available for each object type shown. 4. 5. Select Entity in the Object Type list box and CRUD Rules in the Generation Template list box. Then select modules for generation using the Add and Remove buttons. Check all generation templates to make sure you select all the available modules for every template.
TurboCyclerGeneration Template Setup window

Figure 2-15

6.

Select Close. If you have selected the appropriate entity templates and the modules that support it, select the Generate button to start generation. The message line shows the status of the process. If there are errors, repeat the process. Select File > Commit to save changes.

7.

Preparing the Application

After generating and committing your output, you can make any additional modifications and programming changes you want. Then continue the process as usual with the preparation from the Construction Workbench. 1. Perform the preparation steps in the following sequence: a. Select Generated files: (1) delete the inappropriate tables, (2) prepare files, (3) create appropriate tables

AppBuilder 2.1.0 Scripting Tools Reference Guide

2-19

TurboCycler Tutorial

b. Select Generated Sets: prepare sets c. Select Generated Windows: prepare windows d. Select Generated Rules: prepare rules e. Select Generated Functions: prepare functions These steps are performed in the Preparation Query window, discussed in the Deploying Applications Guide in the chapter on Preparation. 2. At each preparation step, you may encounter errors. It is important to correct errors using the appropriate application development tools before continuing with succeeding steps.

At this point, the preparation of the generated application is complete. Next, run the application (as described in Procedure - Executing the Application) to examine and test the output application, including the windows you prepared and painted in TurboCycler. Procedure - Executing the Application Follow the steps listed below to test the application TurboCycler generated. 1. 1. 2. Select Start > Programs > AppBuilder > Windows Client. To execute from within the Construction Workbench, select Run > Windows. Select Agent Maintenance in the Agent menu.
AGENT MAINTENANCE application menu

Figure 2-16

3. 4.

The Execution Workbench asks if you want to start RuleView. Select No. The Agent Detail Display window is displayed without any data as shown in Figure 2-17.
Agent Detail Display window without data

Figure 2-17

5. 6.

Enter test data in the following fields. Enter the Agent number, Agent last name, and Agent first name (Figure 2-18). Save this agent data by selecting Save in the File menu.
Agent Detail Display window with user data

Figure 2-18

2-20

Using TurboCycler Default Templates

TurboCycler Tutorial

7. 8.

Enter any name (for example, your own name) as additional test data in the Agent Detail Display window. Be sure to assign a different agent number. Save this data as you did in the previous step. Select Open in the File menu to see the Agent List Display window. Next select the Query push button to display both agents, as shown in Figure 2-19.
Agent List Display with user data

Figure 2-19

9.

Select Query and verify that both agent Smith and the other persons name appear in the Agent List Display window. (You can either query individual agents by their unique number or select the Query push button to see a list of all agents.)

10. To view the Agent Detail window for any agent, double-click the agents name. When you close the Agent Detail window, you return to the Agent Detail Display window. 11. Conclude this walkthrough by selecting Exit in the File menu.

AppBuilder 2.1.0 Scripting Tools Reference Guide

2-21

TurboCycler Tutorial

2-22

Using TurboCycler Default Templates

CHAPTER

USING THE TURBOCYCLER DEVELOPER KIT

AppBuilder 2.1.0 Scripting Tools Reference Guide

The TurboCycler Developer Kit (SDK) provides an open architecture for automatically generating repository objects suitable for any platform and methodology. TurboCycler Developer Kit is a complementary product to the TurboCycler Standard Edition. With the Developer Kit, you define generation procedures using templates to automate steps in the software development lifecycle. You can write these generation procedures to meet your requirements. To customize the template using the TurboCycler Developers Kit follow these general procedures: Creating a Generation Template Editing and Compiling a Template

Creating a Generation Template

TurboCycler generation templates are the procedures executed during a TurboCycler process. You use the TurboCycler template language to define a template and make generation decisions about what objects to generate in the repository. This involves: Understanding the Generation Template Customizing the Generation Template

Understanding the Generation Template

TurboCycler generation templates can access any object in the repository. For each object, the template can access all the object types editable properties. Chapter 5, TurboCycler Repository Types and Properties discusses the complete list of object types and properties TurboCycler supports in the Information Model. A generation template must navigate through the repository to retrieve the information it needs to make generation decisions. For example, a template defined to generate an SQL Delete Rule for a AppBuilder file object needs information about the file, including information about the fields in the primary view. The template traverses the file hierarchy to obtain all the information it needs to generate the SQL Delete Rule.

AppBuilder 2.1.0 Scripting Tools Reference Guide

3-1

Creating a Generation Template

A generation template can define object hierarchies, rules source code, and window panels, as shown in Figure 3-1. You can generate a completely functional application by using these templates in the AppBuilder environment.
Figure 3-1 Functionality of Generation Templates

Rule

*>------------------------------------------------<* *>- Rule: PRODUCT_SQL_DELETE -<* *>- SQL Delete Rule for the File: PRODUCT. -<* *>- Automatically Generated by AppBuilder*TurboCycler. -<* *>------------------------------------------------<* SQL ASIS DELETE FROM PRODUCT When building an object hierarchy, the generation template generates both the repository objects and the relationships between them, and sets their properties. Templates can generate any type of object hierarchy including AppBuilder file, rule, and window hierarchies. When defining rule source code, the generation template completely defines an AppBuilder rule. The source code associated with the rule can include any statement the AppBuilder environment supports and can conform to your indentation and naming standards. Window panels generated from a template can contain any type of control that the AppBuilder Window Painter supports. The template defines the position of the controls in the window and associates them with objects in the repository. Chapter 6, TurboCycler Window Controls discusses the types of controls for window panels and their properties.

Customizing the Generation Template

If an existing generation template does not generate objects, rules, or windows matching your requirements, you can create a new template or edit an existing template. If you decide to create a new template, identify the repository information you need to make generation decisions and then identify those objects, rules, and windows you are trying to generate. This information helps you design your new generation template efficiently.

3-2

Using the TurboCycler Developer Kit

Editing and Compiling a Template

If you change an existing template, you can change its object-naming standards, rules coding style and functionality, window presentation styles, and nearly anything else you want. Default templates packaged with TurboCycler are not read-only or otherwise protected. It is prudent to copy them before editing them. Also remember to compile the template before executing it.

Editing and Compiling a Template

Use the template editing environment to edit and compile templates. You can prepare templates by creating new ones or by changing existing ones. You must successfully compile templates before distributing them to the end users or executing them from the AppBuilder Construction Workbench. This involves: Understanding the Environment Using the Command Line Compiler Using the Template Manager In editing templates, the person who uses the results of your template programming is the user. The person who programs the output of your template is the developer.

Understanding the Environment

The TurboCycler editing environment provides an interface for using your editor to edit template source files and two ways to compile templates. TurboCycler keeps all the templates in a single directory. You designate which directory to use. Source files for templates must have a file extension of .SRC and compiled templates have .TC. TurboCycler Developers Kit provides two compilers: a DOS command line compiler and a template manager.

Using the Command Line Compiler

The only function available at the command line is the ability to compile specific files: a source file (.SRC) to a template compile output file (.TC). The command line compiler has the name TCC.EXE, and its syntax is: TCC <Source> [<source>]

where: <source> = template source file name without the .SRC extension. You specify only the file name because the .SRC file extension is assumed. All other functions described in the following sections are available only through the template manager.

AppBuilder 2.1.0 Scripting Tools Reference Guide

3-3

Editing and Compiling a Template

Using the Template Manager

The template manager allows you to edit and compile templates interactively. It has a multi-threaded compiler that compiles templates in the background while you perform other work. Procedure - Opening the template manager To open the template manager: 1. Select Start > Programs > AppBuilder > TurboCyclerSDK. The Template Manager window opens (Figure 3-2).
TurboCycler Template Manager Window

Figure 3-2

The main window for the template compiler contains a title bar identifying the template manager window, a menu bar, a tool bar, and a work area with template information.

Template Manager Tools

The following sections describe the menu options available for Template Manager: Actions Menu Selected Menu Windows Menu Options Menu View Menu Tool Bar Actions Menu The menu bar contains an Actions menu, shown in Figure 3-3.
Figure 3-3 Template manager Actions menu

3-4

Using the TurboCycler Developer Kit

Editing and Compiling a Template

Table 3-1 describes the Actions menu choices. Note that each Actions menu choice effects all listed templates, not just those currently selected.
Table 3-1 Actions Actions Menu Choices Description Displays the New Template window (Figure 3-4) that helps you prepare a new skeleton or outline template. You can define the file name, template title, and description; create hierarchy, rule, window, text, keywords, flat file, and/or component sections; and edit the template. You can also select this choice from the tool bar with the New push button. Compiles every template source file whose Last write time is later than its Last compile time. You can also select this choice from the tool bar with the Make push button. Clears the list of templates shown and rereads the template source directory. You can also select this choice from the tool bar with the Rescan push button. Removes any templates waiting for compilation from the compile queue. Compiling stops when the current template completes. You can also select this choice from the tool bar with the Stop push button. Exits the template manager. New Template window

New Template

Make

Rescan source directory

Stop compiling Exit Figure 3-4

Selected Menu The menu bar contains a Selected menu, as shown in Figure 3-5.

AppBuilder 2.1.0 Scripting Tools Reference Guide

3-5

Editing and Compiling a Template

Figure 3-5

Template Manager Selected menu

Table 3-2 describes the Selected menu items and descriptions. These menu choices effect only the selected templates.
Table 3-2 Menu Item Edit source Selected Menu Choices Description Opens the editor for the selected templates. (Depending on options set in the Set Editor window, you can open the editor once for each selected template or once for all selected templates.) You can also select this choice from the tool bar with the Edit push button. Queues the selected templates and compiles them in the order they appear in the window. You can also select this choice from the tool bar with the Compile push button. Opens the Copy Template window (Figure 3-6), which lets you copy each of the selected templates and give the copy a name and title. You can also select this choice from the tool bar with the Copy push button. Deletes the source and compiled files for all selected templates. You can also select this choice from the tool bar with the Delete push button. Rescans the source files of the selected templates to check whether the title or last-written times have changed. (Use this when you use the editor to make changes to a template.) You can also select this choice from the tool bar with the Update push button.

Compile source

Copy source

Delete template files

Update display

Figure 3-6

Copy Template window

3-6

Using the TurboCycler Developer Kit

Editing and Compiling a Template

Windows Menu The menu bar contains a Windows menu, as shown in Figure 3-7.
Figure 3-7 Template Manager Windows Menu

Table 3-3 describes the Windows menu choices.

Table 3-3 Windows Menu Choices Description Displays a window that shows template compilation and error messages. Menu Items Compiler messages

Options Menu The menu bar contains an Options menu, shown in Figure 3-8.
Figure 3-8 Template Manager Options Menu

Table 3-4 describes the Options menu choices and describes their behaviors.
Table 3-4 Options Menu Description Displays the Open Template Directory window (Figure 3-9) that specifies the directory where templates reside on the developers system. Specifies the action to be performed when you double-click on a template or press Enter. Your choices are Edit, Compile, Copy, Delete, or Update display. Opens the Set Editor window (Figure 3-10) in which you can specify your editor. The editor command field defines the executable path name, and the editor command line field specifies the command line arguments to pass to the editor. If your editor supports passing multiple file names on the command line, use the %a specifier. Otherwise, use the %f specifier to open the editor separately for each selected template. You can also specify any other options to pass to the editor. Menu Items Template directory Default action

Editor

AppBuilder 2.1.0 Scripting Tools Reference Guide

3-7

Editing and Compiling a Template

Figure 3-9

Open Template Directory window

Figure 3-10

Set Editor window

View Menu The View menu lets you choose whether to display the toolbar and the status bar while you are working in the template compiler window. To display either bar, click on the name of the bar in the drop-down list. A check mark appears. To hide either bar, click again to remove the check mark. Tool Bar For fast access to the Actions and Selected menu choices, use the tool bar at the bottom of the template manager window (Figure 3-11).
Figure 3-11 Template Manager Tool Bar

3-8

Using the TurboCycler Developer Kit

Editing and Compiling a Template

The Tool Bar presents the menu choices as push buttons (Table 3-5).
Table 3-5 Icon Tool Bar Push Buttons Push button Menu choice equivalent

Edit

Edit source choice in Selected menu

Compile

Compile source choice in Selected menu

Make

Make choice in Actions menu

Stop

Stop compiling choice in Actions menu

Copy

Copy source choice in Selected menu

New

New template choice in Actions menu

Delete

Delete template files choice in Selected menu

Update

Update display choice in Selected menu

Rescan

Rescan source directory choice in Actions menu

Template Manager Work Area

The work area has a row for every template in the template directory. Table 3-6 lists the information for each template.
Table 3-6 Template Compiler Work Area Descriptions Four icons indicate template status. Each template displays one icon indicating its status: Source Dialog columns Status icons

Compiled

AppBuilder 2.1.0 Scripting Tools Reference Guide

3-9

Editing and Compiling a Template

Table 3-6

Template Compiler Work Area (Continued) Descriptions Compilation in progress

Dialog columns

Queued for compilation Template title Filename Last write date Last write time Last compile date Last compile time The assigned title of the template. The file name of the template as stored in the designated directory. (Preassigned file extensions are .SRC for a source template and .TC for a compiled template.) The date of the last template writing. The time of the last template writing. The date of the last successful template compilation. The time of the last successful template compilation.

3-10

Using the TurboCycler Developer Kit

CHAPTER

TURBOCYCLER TEMPLATE LANGUAGE

AppBuilder 2.1.0 Scripting Tools Reference Guide

The TurboCycler Developers Kit provides an open architecture for automatically generating repository objects suitable for any platform and methodology. TurboCycler Developers Kit is a complementary product to the TurboCycler Standard Edition. With the Developers Kit, you define generation procedures using templates to automate steps in the software development lifecycle. You can write these generation procedures to meet your standards requirements and methodology needs. The TurboCycler template language defines how to generate repository objects from other repository objects. The logic of a template can include standard language statements (such as IFELSE and WHILE) and more specific TurboCycler statements. TurboCycler statements support repository navigation, queries, and generation. This section presents the important high-level concepts for developing templates, followed by the rudimentary statements. If you are not familiar with basic programming techniques, you may need to review those sections in the supporting statements and structures section before learning the template sections and concepts. You can find detailed information on language usage, syntax, and function of the AppBuilder Rules Language in the Rules Language Reference book.

Flow Diagrams Overview

Flow Diagrams define the syntax of the template language. The syntax is shown in flow diagrams that show how the parts of the template language relate and how to use each statement. Using Conventions and Symbols Reading a Diagram Inserting Multiple-line and Single-line Comments

Caution

Flow diagrams may not illustrate every condition and restriction of each statement. Read the description of each statement for complete information.

AppBuilder 2.1.0 Scripting Tools Reference Guide

4-1

Flow Diagrams Overview

Using Conventions and Symbols

The following conventions and symbols appear in the syntax flow diagrams: A WORD in all capital letters is a template language keyword A word not capitalized or italicized is defined in another flow diagram A word in quotations is a value from outside the template language that you must provide when you code the statement, such as the name of a field or a string literal
Table 4-1 Symbol Symbols Used in Syntax Flow Diagrams Description Flow of statement starts

Flow continues on next line or may include other path

Flow continued from previous line

Flow may branch in either direction

Flow of statement ends

Reading a Diagram
Follow these steps to understand the syntax of a diagram: 1. 2. Start at the double-headed arrow on the left side and go to the end of the diagram. Follow any one of the possible line paths from left to right. Any path that you can traverse from left to right results in valid syntax. In whichever line you follow, you must use all words or symbols that you move through on that line. You cannot go back to the left unless there is a loop, which is indicated by an arrow on its left end and appears above another line. You can go around a loop any number of times.

3.

Statement Sample This sample shows a simple flow diagram. It illustrates the basic approach that the TurboCycler flows follow:
comment_statement declarative_statement assignment_statement flow_of_control_statement transfer_of_control_statement file_access_statement asynchronous_processing_statement

4-2

TurboCycler Template Language

Template Language Statements

Inserting Multiple-line and Single-line Comments

To enter comments, use the // token that ends with a new line character.
// single_line_comment

Both the // token and the new line are discarded from the input. For example: USE FIELD(x) // Get the name of the field SET Y = QUERY NAME OF X ENDUSE

Template Language Statements

This section contains the flow diagrams for the TurboCycler template language statements. It has two parts: the first describes the template statements and the last describes supporting statements. Follow the flows as described above, and read the explanations for details and programming techniques. The template statements contain the language flows for the following: TEMPLATE Statement USAGES Block HIERARCHY Block RULE Block WINDOW Block There are also Other Blocks and Supporting Statements and Expressions.

TEMPLATE Statement
The TEMPLATE statement is the starting point of a TurboCycler template. It provides the template with a title and description, by which the user identifies the template during the TurboCycler Standard Editions generation process. A template contains only one TEMPLATE statement and has a unique name. A template also contains a usages block that determines the initiation process for this template. A template can contain multiple hierarchy, rule, and window blocks grouped in modules by a common module name. template_name A string constant that identifies this template. This is the title of the template the user sees during a TurboCycler Standard Edition generation. For example, the CRUD Rules default template is named CRUD Rules. DESCRIPTIONENDDESCRIPTION Keywords that surround the template description.

AppBuilder 2.1.0 Scripting Tools Reference Guide

4-3

Template Language Statements

template_description A string constant that describes this template. This is the only description for a template the user sees during a TurboCycler generation. For example, the default template named CRUD Rules has the description Generates the CRUD Rules for the specified Entity, Table or File object. The description can be as short or long as you want; it may include multiple lines. usages_block A template language statement that provides the entry point that TurboCycler uses to run the template. In most cases TurboCycler starts with a single repository object and proceeds to extract information about that object needed to generate hierarchies, rules, or windows. Entry points for the default templates are entity, a many-to-many relationship, table, and file. A usages block takes a single object and performs assorted repository queries. It sets up variables that other blocks depend on. Refer to USAGES Block on page 4-5 for details. hierarchy_block A template language statement that defines a hierarchy for any object type, such as rule hierarchy, window hierarchy, file hierarchy, and other hierarchies. The hierarchy block creates objects, sets their properties, creates relationships between objects, and sets properties for the relationships. Refer to HIERARCHY Block on page 4-6 for details. rule_block A template language statement that defines the source code (or rules source) for a specific rule. For example, the SQL Delete Rule in the CRUD Rules Template. Refer to RULE Block on page 4-9 for details. window_block A template language statement that paints a window panel for a specific window; for example, the Detail Display Window in the GUI Rules/Window Template. The window block places controls on the window and establishes links to appropriate repository objects. Refer to WINDOW Block on page 4-12 for details.

Special Notes
Different blocks can be strongly dependent on each other. For example, generated rule source depends on a rule hierarchy. You can force multiple blocks to be generated by giving them all the same module name, thus reinforcing their dependence. Another example of block interdependence is a rule conversing a window. To use a template to generate a rule conversing a window requires four heavily dependent blocks: Rule source block Window panel block Rule hierarchy block Window hierarchy block Reinforce this dependence by giving all the same module name. Figure 4-1 shows this relationship.

4-4

TurboCycler Template Language

Template Language Statements

Figure 4-1

Example of mutually dependent module blocks

The Detail Display Module is composed of: Detail Display Module (1) (3) (2) (4) where: (1) = Rules source block (2) = Window panel block (3) = Rule hierarchy block (4) = Window hierarchy block

The Detail Display Module illustrated graphically: (1) RULE converses (2) WINDOW

uses (3)

uses (4)

RULE

WINDOW

USAGES Block
The usages block accepts specified repository object types as valid entry points into the generation process that the template describes. It associates the current template with repository object(s) of the object types you specify. Control which objects are selected for generation with the USAGES statement. TurboCycler generates output objects only for the object types you specify in the usages block.
USAGES USE object_type (object_var) USE ALL use_statement: // common_statement // use_statement use_statement ENDUSE ENDUSE

ENDUSAGES

Thus, your selection influences the tools from which you can access this template. For example, if you define a template to accept entities as input, the template is available from only those tools supporting entities (such as Entity Relationship Diagrammer, Hierarchy Diagrammer, and Matrix Builder).

AppBuilder 2.1.0 Scripting Tools Reference Guide

4-5

Template Language Statements

USAGESENDUSAGES Keywords that surround the usages block. USEENDUSE Keywords that surround your specification of a valid object type, object variable, and use_statement. Each USEENDUSE set supports only one object_type specification. Repeat this set of keywords for each object type you want the template to support. object_type The object type you want this template to support generation from. Any object type in the Information Model is valid, such as RULE, WINDOW, VIEW, or FIELD. You can select more than one object type by using multiple USEENDUSE repetitions, as shown in the flow diagram. Refer to Object Types and Properties on page 5-3 for a list of object types. The object type can also be an open drawing. The USE type supports processing the symbols on an open drawing through a template. Refer to Processing Symbols on an Open Drawing on page 4-45 for details. (object_var) An object variable that stores a reference to the repository object passed into the template from a AppBuilder development tool. use_statement A sequence of statements that are part of the usages block. These statements insert the common statement services of use-dependent queries and variable initializations such as RETURN, DEBUG, IF, FOR, WHILE, and SET. See common_statement below. USE ALLENDUSE Keywords that surround your specification of all shared use statements in a usages block. The use statements contained in the USE ALLENDUSE set are applied to each USEENDUSE set. USE ALLENDUSE allows you to code any function that you want applied to all USEENDUSE invocations only once. The generation process then executes the complete set for each USEENDUSE set defined in the usages block. common_statement A sequence of statements common to several block statements including this one. The common statement provides common services for use-dependent queries and variable initializations such as RETURN, DEBUG, IF, FOR, WHILE, and SET. Refer to Common Statement on page 4-29 for details.

HIERARCHY Block
The hierarchy block defines a hierarchy for any object type such as a rule hierarchy, window hierarchy, or file hierarchy. The hierarchy block creates objects and sets properties for them, creates relationships between objects, and sets properties for those relationships.

4-6

TurboCycler Template Language

Template Language Statements

HIERARCHY

module_name

hierarchy_statement ENDHIERARCHY

hierarchy_statement: // -> object_type object_name [

, object_property_expr ] , //

->

object_type object_name

object_property_expr ] ,

VIA RELATION relation_type common_statement

[ relation_property_expr ]

The hierarchy block that TurboCycler generates closely resembles the hierarchy AppBuilder Hierarchy prepares in both content and form because both: Create repository objects Set properties for those objects Create relationships between objects Set properties of the relationships

Double Arrow in Hierarchy Block

If the first arrow statement in a hierarchy block consists of a single arrow and the object named already exists in the repository, TurboCycler deletes all existing relations to child objects. This feature allows the template to control precisely what objects the hierarchy contains. This feature can be undesirable, however, if the template is meant to update an existing object without disturbing existing child relations. In this case, you should begin the hierarchy with two arrows instead of one. After executing the following block, the rule named TEST is guaranteed to have only the view VIEW1 as a child: HIERARCHY Example RULE TEST VIEW VIEW1 VIA RELATION OWNS_VIEW ENDHIERARCHY Alternatively, the following block simply appends the view VIEW1 as a child of the rule TEST without disturbing any existing children. HIERARCHY Example RULE TEST VIEW VIEW1 VIA RELATION OWNS_VIEW ENDHIERARCHY Figure 4-2 compares a hierarchy diagram and TurboCycler, and shows their similarities.

AppBuilder 2.1.0 Scripting Tools Reference Guide

4-7

Template Language Statements

Figure 4-2

Comparison of AppBuilder and TurboCycler hierarchies

Sample of a hierarchy diagram

Essential elements of a hierarchy

RULE(1) ABC (4) (3) (3) (4) (3) (4) VIEW (3) (4) FLD FLD (1) (1) (1) ABC_F1 (2) ABC_F2 (2) VIEW (1) ABC_IV

(1) Create object (2) Set property (3) Create relationship (4) Set properties of relations

ABC_OV (1) RETURN_CODE

FLD

Sample of a hierarchy block, with defined elements

-> RULE "ABC" -> -> VIEW "ABC_IV" VIA RELATION OWNS_VIEW [SEQUENCE=10, USAGE="INPUT"] -> -> -> FIELD "ABC_F1" [TYPE="INTEGER", LENGTH=15] VIA RELATION VIEW_INCLUDES [SEQUENCE=10] -> -> -> FIELD "ABC_F2" [TYPE="INTEGER", LENGTH=15] HIERARCHYENDHIERARCHY Keywords that surround the hierarchy block. module_name A string constant that provides the name for the module to be generated. The name must be a unique phrase that accurately distinguishes this module from any other. The user of a template selects the module for generation using the TurboCycler Setup Generation Templates window. hierarchy_statement A sequence of statements that are part of the hierarchy block. These statements insert the unique hierarchical statements for creating entities and templates. The hierarchy_statement also inserts the common statement services of hierarchy-dependent queries and variable initializations such as RETURN, DEBUG, IF, FOR, WHILE, and SET. Refer to common_statement on page 4-9. -> A hierarchy symbol that establishes the generational level for the following definition of an object. object_type A parameter that defines the type of object being generated. Refer to Object Types and Properties on page 5-3 for a list of object types.

4-8

TurboCycler Template Language

Template Language Statements

object_name Either a string expression or an object expression that specifies the name of the object being generated. [] A set of brackets that encloses properties of the object that are to be set. , A punctuation mark (comma) that separates each property being set. Use a comma to separate each object property expression (see object_property_expr below). object_property_expr An object property expression that sets the property of the object to the specified value. Refer to Object Types and Properties on page 5-3 for a detailed list. The format for this statement is PROPERTY = string_expr or PROPERTY = int_expr. VIA RELATION A keyword that creates the relationship for the object and specifies how the child object is to be related to the parent object. relation_type A parameter that defines the type of relationship for the object. Refer to Relationship Types and Properties on page 5-12 for a detailed list. relation_property_expr A parameter that sets the properties of the relationship to the specified value. Refer to Relationship Types and Properties on page 5-12 for a detailed list. The format for this statement is PROPERTY = string_expr or PROPERTY = int_expr. common_statement A sequence of statements common to several block statements including this one. The common statement provides common services for hierarchy-dependent queries and variable initializations such as RETURN, DEBUG, IF, FOR, WHILE, and SET. Refer to Common Statement on page 4-29 for details.

RULE Block
The rule block defines the rules source code for a specific rule. An example of a rule block is the SQL Delete Rule in the CRUD Rules Template. Note that if the repository already has existing source code for a specified rule, any code you generate with an identical name overwrites the existing code.

AppBuilder 2.1.0 Scripting Tools Reference Guide

4-9

Template Language Statements

RULE

module_name

NAMED

rule_name

rule_statement

ENDRULE

rule_statement: // { rule_source $(substitution_macro) common_statement } //

The rule block creates rule source code as well as all common template statements for manipulating variables, looping and branching, returns, and debugging. You can recognize rule source by the curly braces that enclose it. Everything you write within the curly braces goes into the rule code, either directly as rule source code or indirectly by macro substitution. RULEENDRULE Keywords that surround the rule block. module_name A string constant that provides the name for the module to be generated. The name must be a unique phrase that accurately distinguishes this module from any other. The user of a template selects the module for generation using the TurboCycler Setup Generation Templates window. NAMED Keyword that specifies the rule that the rule_name parameter identifies. rule_name Either a string expression or object expression that identifies the rule to be generated in the repository. rule_statement A sequence of statements that are part of the rule block. These statements include the unique curly braces rules code and the common statement services of rule-dependent queries and variable initializations such as RETURN, DEBUG, IF, FOR, WHILE, and SET. Refer to common_statement below. {} Curly brace symbols indicate that the enclosed statements are rules code. Rules code can be a single statement or multiple statements. The source of rules code is either direct as a copy from the template (see rule_source below) or indirect from a substitution macro (see $(substitution_macro) below). rule_source Everything that is enclosed in braces, except the $(substitution_macro) format, is put directly into rules code. Code the Rules Language statement you want incorporated. See Special Notes below for more information.

4-10

TurboCycler Template Language

Template Language Statements

$(substitution_macro) Everything that is enclosed in the $() format becomes rules source code by macro substitution. Use this statement to place the value of template variables or expressions into the rules source. See Special Notes below for more information. common_statement A sequence of statements common to several block statements including this one. The common statement provides common services for rule-dependent queries and variable initializations such as RETURN, DEBUG, IF, FOR, WHILE, and SET. Refer to Common Statement on page 4-29.

Special Notes
The RULE and NAMED keywords identify the name of the module for the TurboCycler user and rule object to be added to the repository. For example, the statement: RULE SAMPLE NAMED B creates a module called SAMPLE, which generates rules source code for object B in the repository. If source code exists for object B, the new rule source overwrites the existing code. The AppBuilder environment does not allow more than 72 characters per line of rules source. If a template has more characters per line, TurboCycler breaks each line at the last blank space before the seventy-second character limit, making as many lines as needed. Create rules source code by coding inside the curly braces, including any macro substitutions. The position of curly braces determines the indentation of the rules source code. An example is provided below. (Refer to Template Samples on page 4-52 for a detailed sample of a real rule source generation). RULE Sample NAMED B SET V = GET VIEW NAMED V1 { *> Rule generated by TurboCycler <*) } SET FROM = 10 { DCL I INTEGER; ENDCL MAP $(FROM) TO I MAP $(FROM + 20) TO RETURN_CODE OF $(QUERY NAME OF V) } ENDRULE TurboCycler generates the following rules source code: *> Rule generated by TurboCycler <* DCL I INTEGER; ENDCL MAP 10 TO I MAP 30 TO RETURN_CODE OF V1

AppBuilder 2.1.0 Scripting Tools Reference Guide

4-11

Template Language Statements

Object Property Comparisons

All comparisons to object properties in the retrieval clause are case insensitive. For example, the following statement retrieves the VIEW object named V1: SET V = GET VIEW NAMED V1 Properties are not converted to upper case during reads and writes.

Property Value Expression Types

Property values are converted to the same expression type as the query value in HAVING and WITH clauses. For example, the following expression works as expected. SET X = CHILD FIELD OF VIEW HAVING [LENGTH = 33]

WINDOW Block
The window block paints a window panel for a specific window, such as the Detail Display Window in the GUI Rules/Window Template. The window block places controls on the window and links them to appropriate repository objects.
WINDOW module_name NAMED PLATFORM window_object

window_platform

window_statement window_statement:

ENDWINDOW ,

//

-> -> ->

MENUITEM menu_text SEPARATOR control_type LINKED TO

menu_property

] ,

//

MAKE

control_var link_object

HAVING [ OF

control_property_expr link_qualifier

ENDMAKE

CONTAIN

control_type

control_var

IN

parent_control , control_property_expr ]

HAVING [

LINKED TO

link_object

OF

link_qualifier

ENDCONTAIN

SIZE WINDOW

window_width left_corner

BY ,

window_height bottom_corner

POSITION WINDOW common_statement

4-12

TurboCycler Template Language

Template Language Statements

Building menus in a window is similar to making menu hierarchies with Window Painters menu editor. The statements in a window block specify window panels in a way that corresponds to the Window Painters graphic interface. For example, the window block MAKE statement corresponds to dropping controls in Window Painter. However, TurboCycler does not support creating or updating cascading menus from the template. The PLATFORM keyword and its parameter window_platform specify the GUI target of the window. This expression translates to a GUI domain value, defined in Property Domains on page 5-23. The default value is PWS_GENERIC. This lets you create 3270 or other types of window panels, but you must observe documented AppBuilder restrictions on those panels. The following example shows how to code a window block statement that constructs a menu. The example creates a menu for the File item, consisting of lines for New, Save, and Exit, each of which has a separator between them. REM --- Generate a sample window ---; WINDOW Sample Window NAMED MyDetailSample SET MyCDV = GET VIEW NAMED MyClonedDataView REM --- Make the Detail Sample Display ---; -> MENUITEM &File -> -> MENUITEM &New [HPSID=New] -> -> SEPARATOR -> -> MENUITEM &Save [HPSID=Save,GREYED=TRUE] -> -> SEPARATOR -> -> MENUITEM &Exit [HPSID=Exit] ENDWINDOW See Template Samples on page 4-52 for detailed coding of template windows. WINDOWENDWINDOW Keywords that surround the window block. module_name A string constant that provides the name for the module to be generated. The name must be a unique phrase that accurately distinguishes this module from any other. The user of a template selects the module for generation using the TurboCycler Setup Generation Templates window. NAMED Keyword that specifies the window that the window_name parameter identifies. window_name Either a string expression or object expression that names the window to be generated in the repository. window_statement A sequence of statements that are part of the window block. These statements include the window block-specific statements as well as the common statement services of window-dependent queries and variable initializations such as RETURN, DEBUG, IF, FOR, WHILE, and SET .Refer to common_statement on page 4-16.

AppBuilder 2.1.0 Scripting Tools Reference Guide

4-13

Template Language Statements

-> A menu hierarchy symbol that establishes the generational level for the menu item entry. MENUITEM A keyword that starts the text for a menu line and assigns its properties. menu_text The menu text (a string expression) that provides the text of a menu line. [] A set of brackets that enclose properties of the menu item to be set. menu_property Menu property sets the properties associated with a menu item. Refer to the following flow diagram for this variables parameters.
HPSID GREYED = = = string_expr TRUE FALSE

CHECK_MANDATORY_FIELDS CHECKED =

SEPARATOR A keyword that creates a horizontal divider in a list of menu lines. MAKEENDMAKE A set of keywords that makes a control on the window. You can also define the controls properties and link it to a repository object in the MAKE ENDMAKE statement. control_type A parameter that describes the kind of window control being generated. Refer to Window Statement Control Types on page 6-2 for details of control types. control_var A control variable that stores a reference to a window control and gives access to the control later; essentially it names the object being created by the MAKE. Use it with functions like LEFTOF or BOTTOMOF. HAVING A keyword that sets the properties for the window controls. Each control type has its own properties defined by the parameter following control_property_expr. control_property_expr A parameter that defines the properties for the window control. Refer to Window Control Properties on page 6-12 for the detailed parameter list of the properties of window controls. The format of this expression is PROPERTY = string or PROPERTY = integer.

4-14

TurboCycler Template Language

Template Language Statements

LINKED TO A keyword that connects the control being created to an existing repository object. You can link controls only to objects that are descendents of a window view. link_object An object expression that names the repository object associated with the made control object being created. OF A keyword required when the link to a control is a descendent that is not a direct child of the window view. Each level needed to link to a direct child of the window view requires an OF keyword. Use the OF statement multiple times to link to the appropriate level of the window view. link_qualifier An object expression that identifies the descendent of the window view for which the link is being made. CONTAINENDCONTAIN A set of keywords that, like the MAKEENDMAKE keywords, also define the type, name, and properties of a window control object. The CONTAIN statement makes a window control within a previously defined control. Use CONTAIN to make CELLS in a SPREADSHEET or to define the axes of a CHART. The format of these parameters is the same as the MAKE keywords. IN A keyword that identifies the parent control of the contained control. parent_control A control variable that names the parent control object of the contained control being defined. SIZE WINDOW A keyword that defines the dimensions of the window being generated. window_width An integer expression giving the width of the window in pixels. BY A keyword that indicates another window dimension follows. window_height An integer expression giving the height of the window in pixels. POSITION WINDOW A keyword that defines the location of the window being generated. left_corner An integer expression that locates the left side of the window being generated.

AppBuilder 2.1.0 Scripting Tools Reference Guide

4-15

Other Blocks

bottom_corner An integer expression that locates the bottom of the window being generated. common_statement A sequence of statements common to several block statements including this one. The common statement provides common services for window-dependent queries and variable initializations such as RETURN, DEBUG, IF, FOR, WHILE, and SET. Refer to Common Statement on page 4-29 for details.

Other Blocks
These include: COMPONENT Block FLATFILE Block KEYWORDS Block TEXT Block USE ANY Block DIALOG Block See also the Supporting Statements and Expressions.

COMPONENT Block
This block is available for composing the source of a COMPONENT. Its syntax is:
COMPONENT module_name NAMED component_name

rule_statement

ENDCOMPONENT

The statements supported are the same as for the RULE block statement. For details, refer to the RULE Block on page 4-9.

FLATFILE Block
This block is available for composing text files. Its syntax is:
FLATFILE module_name NAMED file_name ENDFLATFILE

The statements allowed are the same as for the RULE block statement. For details, refer to the RULE Block on page 4-9.

4-16

TurboCycler Template Language

Other Blocks

KEYWORDS Block
This block is available for composing the KEYWORDS of an object. Its syntax is:
KEYWORDS module_name NAMED object_expr

ENDKEYWORDS

The object_expr translates to the repository object for which the KEYWORDS are to be written. The statements allowed are the same as for the RULE block statement. For details, refer to the RULE Block on page 4-9.

TEXT Block
A new block is available for composing the TEXT of an object. Its syntax is:
TEXT module_name NAMED object_expr ENDTEXT

The object_expr translates to the repository object you are writing the TEXT for. The statements allowed are the same as for the RULE block statement. For details, refer to the RULE Block on page 4-9.

USE ANY Block

This type of USE block accepts any object type for processing. The syntax of the USE ANY statement is:
USE ANY ( variable ) use_statement ENDUSE

If you use the USE ANYENDUSE block, put it after all your USEENDUSE blocks and before the USE ALLENDUSE block.

DIALOG Block
A block type is available for composing user dialogs. The block is: DIALOG module_name // Dialog statements ENDDIALOG The DIALOG block lets you prepare and display a dialog box to the user while the template is running. This can be used to ask questions of the user and to display the results of the generation process.

Specifying Size and Position of User Dialogs and Controls

You can specify the size and position of user dialogs and controls by specifying their coordinates in dialog units. A dialog unit is defined as 1/8 of the average height of the system font and 1/4 the average width of the system font. In other words, there are about 4 dialog units for every character width you specify, and 8 dialog units for every character height. For example, if you wanted to create a dialog that was 40 characters in width and 50 characters in height, you would make the width 160 units and the height 400 units.

AppBuilder 2.1.0 Scripting Tools Reference Guide

4-17

Other Blocks

It is important to note that the origin that you use as the starting point for your coordinates is different in OS/2 and Windows. For OS/2, the origin is bottom and left. For Windows, the origin is top and left.

Migrating Templates From OS/2 to Windows

Because the coordinates origin is different in Windows and OS/2, migrating templates from OS/2 to Windows can be problematic. To compensate for this difference, you can use a variable in Windows called TCORIGIN. The syntax for this variable is: SET TCORIGIN=<OS> where <OS> is either NT or OS2 If you set TCORIGIN to NT (the default in Windows) when creating control and dialog boxes, the coordinates grid will be set to top, left, height, and width. If you set TCORIGIN to OS2, the coordinates grid will be set to bottom, left, height and width. Consequently, if you are migrating a template that was created in OS/2 to Windows, you should set TCORIGIN to OS2.

Creating Controls on a Dialog

Create controls on a dialog using the MAKE...ENDMAKE statement as used in the WINDOW block. All of the controls can be assigned to a variable, and any of the properties can be queried using the QUERY statement. Some of the controls can have a LINKED TO clause, which is always optional. Unlike the WINDOW block MAKE statement, the LINKED TO clause must always specify a template variable. You can use the HAVING clause of the MAKE statement to set the properties of dialog controls. You can also set these properties using the new SET PROPERTY OF VARIABLE function. The following table lists the controls available with the new dialog block and identifies the properties of each control. Note that an N in the table means NT only, while an X indicates both NT and OS/2.

4-18

TurboCycler Template Language

Other Blocks

Setting Properties of Dialog Controls

The following table lists the properties of the dialog controls and describes the characteristics of those properties.
Table 4-2 Dialog Control Properties
AUTOSCROLL BORDER (OS/2 Multiline Edit) BOTTOM CONTOL_TEXT DEFAULT GROUPSTART HEIGHT HORZSCROLL HPSID LEFT MARGIN MULTIPLE_SELECTION PASSWORD READONLY TABSTOP VERTSCROLL WIDTH WORDWRAP

CHECKBOX EDIT_FIELD GROUPBOX LISTBOX MULTILINE_EDIT PUSH_BUTTON RADIO_BUTTON STATIC_TEXT N x

N N N N x N N N

x x x x x x x x

x x x x x x x x x

x x x x x x x x

x x x x x x x x x x N

x x x x x x x x

x x x x x x x x x x x x x

x x x x x x x x N x

x x x x x x x x x

Table 4-3 Property

Dialog Control Property Descriptions Type boolean boolean integer string boolean boolean integer boolean integer integer boolean boolean boolean boolean boolean boolean integer boolean Description Control scrolls right automatically. Also scrolls down for Multiline Edit. Gives the control a border. Sets the vertical position of the bottom edge of the control. Text displayed by the control. Button has heavy emphasis. Used primarily to group radio buttons. Sets the vertical size of the control. Control has a horizontal scroll bar. Allows the template to recognize the control. Sets the position of the control. Gives the control a border. Multiple items can be selected. Text is invisible. Text cannot be altered. User can tab to the control. Control has a vertical scroll bar. Sets the horizontal width of the control. Text automatically wraps.

AUTOSCROLL BORDER BOTTOM CONTROL_TEXT DEFAULT GROUPSTART HEIGHT HORZSCROLL HPSID LEFT MARGIN MULTIPLE_SELECTION PASSWORD READONLY TABSTOP VERTSCROLL WIDTH WORDWRAP

AppBuilder 2.1.0 Scripting Tools Reference Guide

4-19

Other Blocks

Using Linked-to Variables The control types listed below can have a linked-to clause. The linked-to clause is always optional. Unlike the WINDOW block MAKE statement, the linked-to clause must always specify a template variable. CHECKBOX The button is checked if the linked variable contains the value TRUE, otherwise it is unchecked. After the dialog is closed, the variable contains either the value TRUE or FALSE, depending on whether the user checked or unchecked the button. RADIO_BUTTON The button is checked if the linked variable contains the HPSID of the RADIO_BUTTON. After the dialog is closed, the variable contains the HPSID of the button only if it is checked. Normally you will link several, mutually exclusive RADIO_BUTTONS to a single variable. Then, the variable will contain the HPSID of the RADIO_BUTTON selected by the user before closing the dialog. EDIT_FIELD The text displayed in the EDIT_FIELD is taken from the linked variable. After the dialog is closed, the linked variable contains the user-modified text. MULTILINE_EDIT The text displayed in the MULTILINE_EDIT is taken from the linked variable. After the dialog is closed, the linked variable contains the user-modified text. LISTBOX The linked variable must be list. The LISTBOX is populated using the items of the list variable. When the dialog is closed, the variable is modified to contain a list of the selected items from the LISTBOX.

Note

If the LINKED_TO variable has not been assigned a value, it will default to the LOCAL variable.

Using the TCDIALOG Variable to Set the Properties of the Dialog Window
As in the window block, TurboCycler creates a local variable named TCDIALOG upon entry into a dialog block. This variable represents the dialog window itself, and the following properties can be set using this variable: LEFT, for setting the left edge of the dialog BOTTOM, for setting the bottom edge of the dialog TOP, for setting the top edge of the dialog WIDTH, for setting the width of the dialog HEIGHT, for setting the height of the dialog CONTROL_TEXT, for setting the caption displayed on the dialogs title bar

4-20

TurboCycler Template Language

Template Block Features

Processing the Dialog

After using MAKE statements to define the dialog, use the SHOW DIALOG statement to display the dialog to the user. When the user closes the dialog, TurboCycler creates a local variable named TCEVENTSOURCE that contains the HPSID of the push button that closed the dialog.

Note

In NT, if you press the Esc key, the TCEVENTSOURCE variable is assigned the value of IDCANCEL.

Template Block Features

The template language involves these procedures: Declaring Local Variables from Any Block Making Any Block a Callable Procedure Processing Symbols on an Open Drawing

Declaring Local Variables from Any Block

Any block can declare local variables immediately after the first line of the block. Each local variable must be given an initial value. Here are two examples: HIERARCHY Test USES LOCAL [X = 1, Y = Hello] // statements ENDHIERARCHY TEXT Test NAMED X USES LOCAL [Y = QUERY NAME OF X] // statements ENDTEXT Local variables are destroyed when the block exits. A local variable with the same name as a global variable hides the global variable. USE...ENDUSE blocks cannot declare local variables.

Making Any Block a Callable Procedure

You can turn any block into a callable procedure simply by prefixing the block with the procedure keyword: PROCEDURE HIERARCHY Test // statements ENDHIERARCHY PROCEDURE RULE Test NAMED X // statements ENDRULE

AppBuilder 2.1.0 Scripting Tools Reference Guide

4-21

Template Block Features

Procedures are not part of any module, and they will only execute when called from elsewhere in the template. Use a CALL statement to call a procedure: CALL PROCEDURE Test // or... SET PROC = Test CALL PROCEDURE PROC Arguments can also be passed. The procedure declares formal parameters as follows: PROCEDURE REQUIRES [X, Y, Z] HIERARCHY Test // statements ENDHIERARCHY The parameters become local variables to the block and can be referenced immediately, even in the block header: PROCEDURE REQUIRES [ARULE, AVIEW] HIERARCHY Test1 USES LOCAL [X = QUERY NAME OF ARULE] // statements ENDHIERARCHY PROCEDURE REQUIRES [RULENAME] RULE Test2 NAMED RULENAME // statements ENDRULE The CALL statement passes actual arguments: CALL PROCEDURE Test1 PASSING [MYRULE, MYVIEW] Currently, arguments are passed by reference only, so only currently defined variables can be passed as arguments. If the procedure alters the value of a parameter, the value of the corresponding argument is also altered. Do not give two different procedures the same nameonly the first will be recognized as there is no module concept with procedures. Procedures can be called from USE and HIERARCHY blocks only. This restriction enforces the concept that other block types (rule and window, for example) can not functionally decompose.

4-22

TurboCycler Template Language

Other Statements

Other Statements
You can also use these statements in building your application with the templates: CALL Statement CALL SERVICE Statement SELECT Statement APPEND and REMOVE Statements TRAVERSE Statement UPDATE MESSAGE Statement SHOWMESSAGE Statement SET Statement

CALL Statement
The CALL statement allows one template to call another. Its syntax is:
CALL MODULE module_name FOR object , PASSING [ variable ]

IN TEMPLATE

template

This statement executes a module in a template for an object, just as if the object were passed from the user to the template. Although the syntax allows the object to be optional, the TurboCycler Standard Edition flags it as an error; this is a forward-looking language feature that supports the execution of a template without any repository object. The called template begins execution at the USE block that the FOR object names. The module_name and template parameters must be string expressions identifying the module name and template title (not its file name) to be run. The object parameter reduces to a repository object that the called template processes. The optional PASSING clause describes a list of variables common to both templates. You can use each variable for both input and output. A template can call itself. This is more efficient in space and time than calling another template. But keep the following points in mind: The user can run any module in a template for any USEENDUSE blocks. Because the template cannot hide its modules from the user, you must document which modules can be generated from each object type the template accepts, and instruct the user to initially configure the template from the setup dialog. The template must enforce the proper use of modules through programming. A template calling itself shares variables passed to it, but shares no others. Each invocation of the template creates new instances of its variables.

AppBuilder 2.1.0 Scripting Tools Reference Guide

4-23

Other Statements

An error results if the requested template does not exist, does not have the requested module, or does not accept the object type passed. In the case of a CALL statement, a USE ANY block is not considered a match for the object type. The CALL MODULE statement is only allowed in USEENDUSE and HIERARCHYENDHIERARCHY statements.

CALL SERVICE Statement

The CALL SERVICE statement supports user exits. A template can request a service from a DLL (dynamic link library). By using this call, the template and the DLLs can share variables.
CALL SERVICE service [ IN LIBRARY , variable dll_name ]

PASSING

You can initiate user exits to interact with the user or to implement additional functionality beyond the previous capabilities of the templates language. The C header file (TCSDK.H) defines the application program interface for writing user exits. Also C:\appbuilder\template\samples\userexit contains sample user exit code for use as an example. You must put the user exit DLLs in the TurboCycler template directory on the development workstation.

SELECT Statement
TurboCycler Release 2.2.1 includes a selection construct for evaluating arbitrary case expressions. The syntax is: SELECT CASE expr1 : // statements ENDCASE CASE expr2 : // statements ENDCASE . . . DEFAULTCASE : // statements ENDCASE ENDSELECT

4-24

TurboCycler Template Language

Other Statements

APPEND and REMOVE Statements

The APPEND statement appends an item to a list variable: APPEND expression TO list_var If list_var is not a list variable, it becomes one. The statement can be used to compose lists containing arbitrary expressions. The REMOVE statement removes an item from a list, collapsing subsequent items: REMOVE list_var ( index )

If the index is out of bounds, an error is generated.

TRAVERSE Statement
The TRAVERSE statement allows the template to navigate a hierarchy by specifying an explode path and a series of procedures that should be called at each node. The purpose of the statement is to eliminate any explicit navigation logic from the template and to transform a recursive template algorithm into a finite automation: TRAVERSE root_object explode_path ENDTRAVERSE Here is an example showing the explode path: USE RULE( ROOT ) TRAVERSE ROOT ->VIEW VIA RELATION OWNS_VIEW : doView ->->FIELD VIA RELATION VIEW_INCLUDES : doField ->->RECURSE VIA RELATION VIEW_INCLUDES : doView ->RECURSE VIA RELATION USES_RULE : doRule ENDTRAVERSE ENDUSE In the example, the template is interested in finding all views, fields, and rules that are under the root rule. This is done by showing how the template should explode the hierarchy under the root object. In this case, the RECURSE statement is also usedit always refers to objects under the parent having the same type and related via the given relationship. It also specifies that the explosion should be repeated for these objects. Therefore, the first RECURSE refers to the VIEW object because the parent object (having one less arrow) is a VIEW. Furthermore, it says that for each VIEW found, all the explode lines leading to (and including) the RECURSE should be repeated. Note the following: ->VIEW VIA RELATION OWNS_VIEW : foo ->->FIELD VIA RELATION VIEW_INCLUDES : foo ->->RECURSE VIA RELATION VIEW_INCLUDES : foo Here all fields under the first view and all fields under every view under the first view will be seen. Compare this to: ->VIEW VIA RELATION OWNS_VIEW : foo ->->RECURSE VIA RELATION VIEW_INCLUDES : foo

AppBuilder 2.1.0 Scripting Tools Reference Guide

4-25

Other Statements

->->FIELD VIA RELATION VIEW_INCLUDES : foo where only fields under the first view will be seen. However, views descending from the first view will be seen here, just as in the first example. The last item on the line is the name of the procedure that should be called whenever this node is seen. The procedure is called with four arguments, so it must declare four parameters: PROCEDURE foo REQUIRES [PAR, KID, LINK, LEVEL] // any block type where:
PAR KID LINK LEVEL = = = = the parent object the child object the relation between the parent and the child the depth in the hierarchy, starting at 1

Note

TRAVERSE statements cannot be nestedyou cannot start one while another is active because the whole purpose is to specify the complete explode path in the first one so there is no need to nest them. You can execute a STOP TRAVERSE statement from within a called procedure to prevent exploding children of the current child object. This is an easy way to stop traversing a particular branch after the template has decided it is no longer interested in those children.

Here is an example of a template: TEMPLATE Test traverse DESCRIPTION ENDDESCRIPTION USAGES USE FUNCTION (INFUNCTION) SET FILENAME = c:\\tra.out TRAVERSE INFUNCTION ->PROCESS VIA RELATION REFINES_INTO :test ->->RULE VIA RELATION IS_DEFINED_BY :test ->->->COMPONENT VIA RELATION USES_COMPONENT :test ->->->->RECURSE VIA RELATION COMPONENT_USES_COMPONENT :test ->->->RECURSE VIA RELATION USES_RULE :test ->->RECURSE VIA RELATION REFINES_INTO :test ENDTRAVERSE ENDUSE ENDUSAGES PROCEDURE REQUIRES [P, C, REL, DEPTH] FLATFILE test NAMED FILENAME SET Z = TYPEOF(C) + + (QUERY NAME OF C) UPDATE MESSAGE Z FOR I = 1 TO DEPTH {$(\t)} ENDFOR {$(TYPEOF(C)):$(QUERY NAME OF C)$(\n)} ENDFLATFIL

4-26

TurboCycler Template Language

Other Statements

UPDATE MESSAGE Statement

Templates can optionally indicate progress by posting messages directly on the work-in-progress dialog using the UPDATE MESSAGE statement: UPDATE MESSAGE Still going... TurboCycler changes the message to be the module name of each block as it enters that block.

SHOWMESSAGE Statement
A new function is available for posting simple message boxes to the user. The syntax is: SHOWMESSAGE (caption, message, buttons, icon) The dialog has caption as its title and displays a message inside the dialog. The dialog can have one of the following values for buttons:
Table 4-4 Buttons OK OK CANCEL RETRY CANCEL ABORT RETRY IGNORE YES NO YES NO CANCEL Dialog Buttons Value 1 3 5 6 7 8

Optionally, the dialog can use an icon:

Table 4-5 Icon Style Hand Question Exclamation Asterisk Information Query dialog Warning dialog Error dialog Dialog Icons Value 1 2 3 4 5 6 7 8

The function returns the button pressed to close the dialog. It will have one of the following values:

AppBuilder 2.1.0 Scripting Tools Reference Guide

4-27

Supporting Statements and Expressions

Table 4-6 Button CANCEL OK ENTER ABORT RETRY IGNORE YES NO

Function Return Buttons Value 0 1 2 3 4 5 6 7

Note

A value of 8 is returned if an error occurs during the SHOWMESSAGE operation.

SET Statement
A new statement for setting properties is available: SET property OF object = value This statement can now be used in WINDOW blocks to set properties of window controls. This is an alternative to using the HAVING clause of the MAKE statement. These properties can also be retrieved using the QUERY expression. TurboCycler now automatically creates a local variable named TCWINDOW upon entry to a WINDOW block. This variable refers to the window itself and may be used, for example, to set the CAPTION, ENTER_KEY, and CLOSE_KEY of the window: WINDOW Test NAMED TEST // window statements SET CAPTION OF TCWINDOW = Foobar ENDWINDOW

Supporting Statements and Expressions

The last part of the template language contains language flows for the following. Common Statement Conditional Expression (conditional_expr) Integer Expression (int_expr) List Expression (list_expr) Object Expression (object_expr) String Expression (string_expr)

4-28

TurboCycler Template Language

Supporting Statements and Expressions

Common Statement
The common statement is a sequence of template language statements that originates in several block statements, such as USAGES, WINDOW, RULE, and HIERARCHY.

Caution

The flow diagrams indicate the common statement refers back only to the originating block statement, not indiscriminately to any other block statement. You must return to the block where you started.

For example, if you originate in the RULE block, the scope of its block statement includes this common statement and that particular rule statement directing you here. The block statement function, including this common statement, supports recursive execution.
RETURN return_code

DEBUG

block_statement block_statement from_expr TO ELSE to_expr

ENDDEBUG block_statement by_expr ENDFOR block_statement string_expr int_expr list_expr object_expr ENDWHILE ENDIF

IF conditional_expr FOR loop_var =

BY

block_statement WHILE SET ( conditional_expr ) string_var int_var list_var object_var = = = =

RETURN Keyword to end the execution of a template for the passed-in object. Through the execution of this statement, you can pass back a specifiable return code. See return_code below for an explanation of the return codes. return_code Either an integer expression or string expression that indicates the reason for terminating the template. When the return code is: An integer, the number is not displayed to the user. Zero means successful completion. Nonzero signifies an error, so any module that depends on this execution should not continue. A string expression, it is displayed to the user and indicates an error. DEBUGENDDEBUG A pair of keywords that surround one or more statements to be analyzed. DEBUG produces output including a trace of the executed instructions, branch conditions, variable assignments, and repository queries. You cannot change or select the DEBUG output. Debug records output in a file specified in the DEBUG_FILE option in the Tools> Workbench Options, TurboCycler tab. You must set the fully qualified path and file name for your DEBUG file. You can also select to write the output only to a file. This will prevent the output from being displayed on the Analysis window in the Workbench.

AppBuilder 2.1.0 Scripting Tools Reference Guide

4-29

Supporting Statements and Expressions

block_statement A variable reference back to the block statement that invoked this common statement. The originator is one of the following block statements: usages block, rule block, window block, or hierarchy block. The block statement consists of this common statement and any unique instructions that are part of the block statement that invoked this common statement. A block statement and this common statement together can execute recursively, as the flow diagrams show. IFENDIF Keywords that surround a sequence of block statements. The IF control conditionally executes the statement(s) that follow. If the conditional expression is true, the block statement that immediately follows it are executed. The ELSE statement or the ENDIF indicate the end of the block. If the conditional statement is false, the ELSE statement is executed if it is present. conditional_expr A conditional expression the program tests for validity. If true, the next block statement(s) are executed; if false, the ELSE block statement(s) are executed. (The template language does not have an explicit THEN.) Refer to Conditional Expression (conditional_expr) on page 4-31 for the syntax. ELSE An alternative logic path that the program follows when the conditional expression of the IF is not true. FORENDFOR Keywords that surround a sequence of block statements. The FOR loop control executes a sequence of instructions repetitively for a specified number of iterations. The range of the from_expr (from expression) and the TO to_expr (to expression) defines the number of loop iterations. You can increment the count of iterations by a value other than one with the BY by_expr (by expression). loop_var Loop variable (an integer variable) that is the counter for the FOR loop. from_expr From expression (an integer expression) that sets the starting count for the FOR loop counter. TO Keyword that specifies the end-point value that limits loop repetitions. to_expr To expression (an integer expression) that sets the ending count for the FOR loop counter. BY Keyword that introduces the value for incrementing the loop count. Otherwise, the increment defaults to counting by one.

4-30

TurboCycler Template Language

Supporting Statements and Expressions

by_expr By expression (an integer expression) that sets the incrementing value for the FOR loop counter. WHILEENDWHILE Keywords that surround a sequence of block statements. The WHILE loop control executes a sequence of instructions repetitively until defined conditions are met. The (conditional_expr) parameter defines the conditions. (conditional_expr) A conditional expression, enclosed in required parentheses, that this program evaluates and acts on. While the conditional expression remains true, the following block statement(s) are executed. Refer to Conditional Expression (conditional_expr) on page 4-31 for the syntax. SET A keyword that assigns values to your variables, including string, integer, list, and object variables. = The equal sign that is the assignment operator. string_expr A string expression for string assignment. Refer to String Expression (string_expr) on page 4-43. int_expr An integer expression for integer assignment. Refer to Integer Expression (int_expr) on page 4-34. list_expr A list expression for a list assignment. Refer to List Expression (list_expr) on page 4-36. object_expr An object expression for an object assignment. Refer to Object Expression (object_expr) on page 4-38.

Conditional Expression (conditional_expr)

A conditional expression combines two expressions with a logical operator; the resultant combination evaluates to true or false. This evaluation can determine the sequence of programming execution. Expressions can be integers, lists, objects, and strings. Refer to Logical and Arithmetic Operators below for comparison results.

AppBuilder 2.1.0 Scripting Tools Reference Guide

4-31

Supporting Statements and Expressions

int_expr

= > < >= <= <>

int_expr

list _expr

= <>

list _expr

object_expr

= <>

object_expr

string_expr

= <> IN

string_expr

AND OR

conditional_expr

int_expr Any integer expression, as defined in Integer Expression (int_expr) on page 4-34. list_expr Any list expression, as defined in List Expression (list_expr) on page 4-36. Lists are equal when they have identical children in the same order. object_expr Any object expression, as defined in Object Expression (object_expr) on page 4-38. Objects are equal when they refer to identical repository objects. string_expr Any string expression, as defined in String Expression (string_expr) on page 4-43. Strings are equal when their characters match exactly. AND/OR Keywords that specify either an additional conditional expression or an alternative conditional expression that enhances the previous qualification. conditional_expr A conditional expression that can be added as another or an alternative conditional expression. (This usage supports recursive invocation of conditional expressions.)

4-32

TurboCycler Template Language

Supporting Statements and Expressions

Logical and Arithmetic Operators

The following operators are used in conditional expressions:
= > < >= <= <> IN equal greater than less than greater than or equal to less than or equal to not equal to contained in or embedded within another string

Table 4-7 shows examples of conditional expressions and how they evaluate.
Table 4-7 Conditional Expressions Evaluation

Expression where X is 1 and Y is 2: x=y y=x x <> y where x is Field X and y is View X: x=y x <> y where x = TurboCycler and y = Turbo: x=y x <> y x IN y y IN x

False False True

False True

False True False True

AppBuilder 2.1.0 Scripting Tools Reference Guide

4-33

Supporting Statements and Expressions

Integer Expression (int_expr)

An integer expression is a combination of whole number values, functions, or operators that evaluate to a whole number.
+ NUMBEROF QUERY int_var (int_expr) int_expr * / + (for window_block only) RIGHTOF LEFTOF TOPOF BOTTOMOF HEIGHTOF (window_control) int_expr digit (list) OF repository_object

object_property

+ and Positive and negative arithmetic operators that act on the following digit parameter. digit Any numeral of one character. NUMBEROF A keyword that counts and reports the number of items in the list specified by the (list) parameter. (list) A list parameter (list expression) that identifies the list whose items are to be counted. Refer to List Expression (list_expr) on page 4-36 for more about list expressions. QUERY A keyword that retrieves information for the repository object that the repository_object parameter names. object_property A parameter that describes the property to be retrieved for the specified object type. Some object properties return strings, others integers. Only object properties having and returning integer values are valid for the integer expression. Refer to Object Types and Properties on page 5-3 for details.

4-34

TurboCycler Template Language

Supporting Statements and Expressions

OF A keyword that identifies the repository_object being queried. repository_object An object expression that defines the repository object for which numeric information is being obtained. int_var An integer variable in the template that has an integer value. (int_expr) Any integer expression, as defined in Integer Expression (int_expr) on page 4-34. The parentheses are optional, but you can use them to improve readability and to resequence the order of operators. int_expr An integer expression that you can use with the following arithmetic operators to derive calculated values. */+Arithmetic operators that function with the surrounding integer expressions and evaluate to an integer value. RIGHTOF/LEFTOF/TOPOF/BOTTOMOF/HEIGHTOF/WIDTHOF Limited to window block statements, these keywords retrieve the dimensions of window control parameters. (window_control) A window control variable that refers to a window that the MAKE or CONTAIN statement creates. Refer to WINDOW Block.

AppBuilder 2.1.0 Scripting Tools Reference Guide

4-35

Supporting Statements and Expressions

List Expression (list_expr)

A list expression refers to a group of objects in the repository. Use this expression to obtain a list of objects whose properties match your selection criteria.
list_var ( list_expr ) CHILD PARENT HAVING [ criteria_property ] AND OR VIA RELATION WITH [ criteria_relation_type [ criteria_property ] criteria_object_typeS OF root_object

criteria_relation_property ] AND OR [ criteria_relation_property ]

ORDER BY

[ property ]

list_var A list variable in the template that refers to an object in the repository. (list_expr) Any list expression enclosed in parentheses to improve readability. CHILD PARENT Keywords that retrieve a list of children or parents of a given object. These keywords serve as the repository interface to promote navigation from object to object. criteria_object_type S The object types of the children or parents to be retrieved from the list. The trailing character S signifies a list of objects is to be retrieved. The plural form of any object type supported by the Information Model is valid, such as RULES, WINDOWS, VIEWS, and FIELDS. (Note that plurals are constructed by putting the suffix S on the base word, with these exceptions: ENTITIES, PROCESSES, and LOGICAL_PROCESSES.) Refer toObject Types and Properties on page 5-3 for a list of object types. OF A keyword that introduces the root_object parameter as the point to begin navigation. root_object An object expression that refers to the object from which you want to start navigation.

4-36

TurboCycler Template Language

Supporting Statements and Expressions

HAVING A keyword that specifies properties the list of children or parent must have. [] A set of brackets enclosing the values of properties that must be met for the retrieved objects. criteria_property Criteria property (an object property expression) that specifies the values that the properties of the retrieved child/parent objects must have. Refer to Object Types and Properties on page 5-3 for a complete list. AND/OR Keywords that specify either an additional criteria_property or an alternative criteria_property that modifies the previous qualification. VIA RELATION A keyword that specifies the relationship type between children or parents. This is a required parameter. criteria_relation_type Criteria relation type (a relation type expression) that specifies the type of relationship to the children/ parent objects. Refer to Relationship Types and Properties on page 5-12 for a detailed list. WITH A keyword that specifies required properties of the relationship (with children or parents) to the object. criteria relation property Criteria relation type (a relation property expression) that specifies the values the properties of the relationship to the retrieved child/parent objects must have. Refer to Relationship Types and Properties on page 5-12 for a detailed list. ORDER BY Sorts the list by the properties specified. Properties can apply to either the entity or the relationship.

Note

TurboCycler automatically sorts lists by SEQUENCE_NUMBER so do not specify ORDER BY [SEQUENCE_NUMBER].

AppBuilder 2.1.0 Scripting Tools Reference Guide

4-37

Supporting Statements and Expressions

Object Expression (object_expr)

An object expression refers to an object in the repository. Using this expression, you can obtain various properties about that object, as described below.
object_var ( object_expr ) object_list CHILD PARENT [ criteria_property ] AND OR VIA RELATION WITH [ criteria_relation_type [ criteria_property ] ( RELATION OF list_index root_object )

object_type

criteria_relation_property ] AND OR [ criteria_relation_property ]

GET

criteria_object_type criteria_object_typeS

NAMED

object_name

AND OR HAVING [ criteria_property ]

DERIVED KEY OF

logical_object

FOR

entity_qualifier

ORIGINATING IDENTIFIER OF

identifier_created_key relationship_created_key key_qualifier

ORIGINATING RELATIONSHIP OF

REFERRED COLUMN OF original_column FOR TO

referred_key_qualifier

The last four flow lines address traceability data that the forward engineering and reverse engineering processes create. Details about these appear later. object_var An object variable in the template that refers to an object in the repository. (object_expr) Any object expression that can be enclosed in parentheses to improve readability.

4-38

TurboCycler Template Language

Supporting Statements and Expressions

object_list A list expression that represents a list of objects in the repository, which you index for a specific item in the list. The index is the offset of the item being accessed. [] A set of brackets that index into a list of objects. RELATION A keyword that refers to a relationship to the specified object in the repository (not to the object itself). Use this expression to obtain sequence number information among other data. list_index An integer expression that is the index into the object list. The first item in a list has an index value of one (1). CHILD/PARENT Keywords that retrieve a list of children or parents of a given object. These keywords serve as the repository interface to promote navigation from object to object. They return only the first qualified object encountered. Refer to Figure 4-3 for a coding example using CHILD and related parameters. object_type An object type of the child or parent to be retrieved. Refer to Object Types and Properties on page 5-3 for a list of object types. OF A keyword that introduces the root_object parameter as the navigation starting point. root_object An object expression that refers to the object from which you want to start navigation. [] A set of brackets that enclose the values of properties the child/parent object must have. criteria_property Criteria property (an object property expression) that requires the child or parent object to have the specified value for the property. Refer toObject Types and Properties on page 5-3 for a detailed list. Examples of the format for this statement are PROPERTY = string_expr and PROPERTY = int_expr. AND/OR Keywords that specify either an additional criteria_property or an alternative criteria_property that modifies the previous qualification. VIA RELATION A keyword that specifies the relationship type between the child or parent. (Note this is a required parameter.) Refer to Figure 4-3 on page 4-42 for a coding example using VIA RELATION and related parameters.

AppBuilder 2.1.0 Scripting Tools Reference Guide

4-39

Supporting Statements and Expressions

criteria_relation_type Criteria relation type specifies the type of relationship to the child/parent object. Refer to Relationship Types and Properties on page 5-12 for details. WITH A keyword that specifies requisite properties of the relationship (with a child or parent) to the object. Refer to Figure 4-3 on page 4-42 for a coding example using WITH and related parameters. criteria_relation_property Criteria relation type (a relation property expression) that specifies the values the properties of the relationship to the child/parent object must have. GET A keyword that specifies repository objects to be retrieved. Allows conditional queries of repository objects. criteria_object_type A property that specifies the type of the object being retrieved. Refer to Object Types and Properties on page 5-3 for a list of valid object types. When the criteria_object_type parameter is not plural, this expression retrieves a single repository object. When criteria_object_type is plural, the expression retrieves any number of objects of the specified type from the repository. NAMED A keyword that identifies the object_name parameter. HAVING A keyword that specifies properties the child or parent must have. Use the HAVING clause to select a subset of these objects. Refer to Figure 4-3 on page 4-42 for a coding example using HAVING and related parameters. object_name A string expression that specifies the name of the object to be retrieved. The object_name parameter can optionally contain a single asterisk (*) as the last character. When accessing the members of the resulting list, the RELATION subscript modifier has no meaning. DERIVED KEY OF A keyword that obtains the key that implements an identifier or a relationship in the repository. To understand key usage with relationships or identifiers, you must understand how forward engineering handles keys. Forward engineering begins with an entity relationship diagram, which consists of entities, attributes, relationships, and identifiers. The forward engineering process turns those objects into a database diagram consisting of tables, keys, and columns. As part of this activity, forward engineering links keys to relationships to produce a foreign key and links keys to identifiers to produce a primary or index key. Consequently, the following TurboCycler functions occur: DERIVED KEY OF Relationship (provides a foreign key) DERIVED KEY OF Identifier FOR entity_qualifier (provides a primary or index key)

4-40

TurboCycler Template Language

Supporting Statements and Expressions

logical_object An object expression that is either an ERD relationship or an identifier. If a relationship, it is not qualified by the entity_qualifier and does return a foreign key. If an identifier, it must be qualified by its owning entity and returns a primary or an index key. FOR A keyword that introduces the entity_qualifier parameter. This phrase applies only to an identifier object that is querying for a primary or index key. entity_qualifier An object expression that names the entity for which an identifier is being sought. ORIGINATING IDENTIFIER OF A keyword that starts the query for an identifier by searching through its primary or index key. This function is the reverse of the DERIVED KEY OF logical_object FOR entity_qualifier function, described above. In this case, you supply the key and receive the identifier object. identifier_created_key An object expression that names the primary or index key from which you receive the corresponding identifier object. ORIGINATING RELATIONSHIP OF A keyword that initiates the query for a relationship by searching through its foreign key. This function is the reverse of the logical_object on page 4-41 . In this case, you supply the key and receive the relationship object. relationship_created_key An object expression that names the foreign key through which you obtain the corresponding relationship object. REFERRED COLUMN OF A keyword that returns a column object that is referred by another column when two tables are connected by a foreign key. To understand referred column queries between tables with keys, you must understand how tables, keys, and columns are structured in database diagrams. If two tables have columns connected by a foreign key, you can extract column objects about one by using the key data from the other. For instance, consider the following example: REFERRED COLUMN OF columnf FOR forkey In this example, you supply a foreign key column (columnf) and the foreign key (forkey) and receive the referred column object of the foreign key that columnf is referred by. Now here is another example: REFERRED COLUMN OF columnp FOR prikey TO forkey In this example, you supply the primary key column (columnp) and the primary or index key (prikey) referred by the foreign key (forkey) and receive the foreign key column object that is referring to columnp. Refer to Figure 4-4 on page 4-43 for a visual representation of these examples of the REFERRED COLUMN OF keyword.

AppBuilder 2.1.0 Scripting Tools Reference Guide

4-41

Supporting Statements and Expressions

original_column An object expression that names the column object from which the search begins. FOR A keyword that names the key_qualifier through which searching starts. key_qualifier An object expression that identifies the key that is searched for the desired response object. TO A keyword that names the foreign key, as described in the second example of the REFERRED COLUMN OF keyword. referred_key_qualifier An object expression that names the foreign key, as described in the second example of the REFERRED COLUMN OF keyword. Additional information Figure 4-3 shows a coding example of the CHILD entity type, HAVING, VIA RELATION, and WITH. Deleting Objects A keyword that specifies repository objects to be deleted. Delete (object_expr)
Figure 4-3 Sample of a Hierarchy Diagram Coded as an Object Expression

Sample of a Hierarchy Diagrammer FILE (1) F (3) VIEW (2) V (5) (5) (5) FLD (4) FLD (4) FLD (4) A CHAR(1) B INTEGER C SMALLINT

Essential elements of the hierarchy (1) File: F (2) View: V (3) Relationship: OWNS_VIEW (4) Fields A, B, and C (5) Relationship: VIEW_INCLUDES

Sample of the equivalent coded object expression for view V:

CHILD VIEW OF F VIA RELATION OWNS_VIEW WITH [SEQUENCE_NUMBER = 10] AND [TYPE = DATA]

Sample of the equivalent coded object expression for field B:

CHILD VIEW OF V HAVING [TYPE = INTEGER] VIA RELATION VIEW_INCLUDES

4-42

TurboCycler Template Language

Supporting Statements and Expressions

Figure 4-4 shows an example of a diagram and flow for the REFERRED COLUMN OF statement.
Figure 4-4 Example of REFERRED COLUMN OF coding

Example of tables and columns connected by foreign key relationship: TABLE EMPL TABLE EMPL

COLUMN Social Security Number WORKS_IN_ DEPT_ID (D)

COLUMN

DEPT_ID

COLUMN

KEY

Department (Primary Key)

(foreign key)

KEY

Employee (Primary Key) Social COLUMN Security Number

COLUMN DEPT_ID (C) (referred by)

KEY (B)

WORKS_IN_ DEPT_FK (Foreign Key) COLUMN WORKS_IN_ DEPT_ID

(refers to)

(A) Sample of template language coding: (1) REFERRED COLUMN OF columnf (A) FOR forkey (B) (2) REFERRED COLUMN OF columnp (C) FOR prikey (D) TO forkey (B). Results: (1) Statement 1 queries A and B, returning column C. (2) Statement 2 queries C and D, returning column A.

String Expression (string_expr)

A string expression refers to a string of characters.
string_literal SUBSTR ( original_string , QUERY object_property OF string_var (string_expr) + string_expr from_expr , to_expr )

repository_object

string_literal A character string enclosed in double quotes.

AppBuilder 2.1.0 Scripting Tools Reference Guide

4-43

Supporting Statements and Expressions

Lexical analysis of string literals The backslash character (\) is the escape sequence in string literals. Supported escape sequences are described in Table 4-8.
Table 4-8 Escape Sequences Description Backslash Horizontal tab (HT) Vertical tab (VT) Backspace (BS) Newline (LF) Carriage return (CR) Form feed (FF) Alert (BEL) Double quote Hex number (all three digits required)

Characters \\ \t \v \b \n \r \f \a \ \xhhh

If any other character follows a backslash, the backslash is ignored.

Caution

Use the double backslash for file names. For example: SET myDirectory = G:\\HPS\\

SUBSTR () A keyword that retrieves a specified character substring from the original_string parameter. original_string A string expression that identifies the character string from which the SUBSTR retrieves a substring. from_expr An integer expression that indicates the starting point of the original_string parameter of retrieved data. to_expr An integer expression that indicates the end point of the original_string parameter of retrieved data. QUERY A keyword that retrieves property information for the repository object that is named by the repository_object parameter. object_property A parameter that describes the property to be retrieved for the specified object type. Some object properties return strings, others integers. Only the object properties having and returning string values are valid for the object expression. Refer toObject Types and Properties on page 5-3 for a complete list. OF A keyword that identifies the repository_object parameter being queried.

4-44

TurboCycler Template Language

Supporting Statements and Expressions

repository_object An object expression that defines the repository object for which character string information is being obtained. string_var A string variable in the template that has a character value. (string_expr) Any string expression, as defined on page 4-43. The parentheses are optional, but you can use them to improve readability. + string_expr A string expression that concatenates another string expression to the one just completed.

Processing Symbols on an Open Drawing

A USE type is supported that allows a template to process the symbols on an open drawing. An example of a template that can be generated from an open ERD is: USAGES USE ERD Drawing (drw) // statements ENDUSE ENDUSAGES Here the variable drw refers to the open drawing. To obtain a list of the entities on the drawing, use: SET ENTS = CONNECTED ENTITIES OF DRW The variable ENTS contains the drawing symbolsnot repository objects. Drawing symbols have the following properties: TYPE, which is the symbol type (ENTITY, for example). ASSOCIATED_OBJECT, which is the associated repository object, if any. SELECTED, which is TRUE if the symbol is selected by the user; otherwise, it is FALSE. FOCUSED, which is TRUE if the symbol was in focus; otherwise, it is FALSE. (Only one symbol can have the focus.) Here is an example of the use of the ENTS variable: FOR I = 1 TO NUMBEROF( ENTS ) SET ENTITY = QUERY ASSOCIATED_OBJECT OF ENTS(I) ENDFOR A symbol can be connected to other symbols. Both boxes and lines are considered symbols without distinction. For the ERD example: SET ENTITYSYMBOL = ENTS(1) // Query for relationship lines coming from the entity SET LINES = CONNECTED RELATIONSHIP_LINES OF ENTITYSYMBOL VIA CONNECTION RELATION_OUT

AppBuilder 2.1.0 Scripting Tools Reference Guide

4-45

Supporting Statements and Expressions

// Query for relationship lines coming into the entity SET LINES = CONNECTED RELATIONSHIP_LINES OF ENTITYSYMBOL VIA CONNECTION RELATION_IN SET REPO_OBJECT = QUERY ASSOCIATED_OBJECT OF LINES(1) SET REPO_LINK = QUERY ASSSOCIATED_OBJECT OF LINES(CONNECTION 1) In the last two lines, repository objects of types RELATIONSHIP and IS_RELATED_VIA are returned, respectively. Notice that these statements have a very strong analogy to the TurboCycler CHILD...VIA RELATION and RELATION array subscript modifier statementsthey are meant to work in the same way for drawing symbols. Table 4-9 through Table 4-13 lists the symbols associated with different types of diagrams.
Table 4-9 Entity Relationship Diagrammer Plural Name n/a n/a n/a n/a ENTITIES BUSINESS_OBJECTS RELATIONSHIP_LINES SUBTYPE_LINES NOTES Symbol Type connection connection connection connection box box line line box

Symbol Name RELATION_OUT RELATION_IN SUBTYPE_OUT SUBTYPE_IN ENTITY BUSINESS_OBJECT RELATIONSHIP_LINE SUBTYPE_LINE NOTE

Table 4-10 State Transition Diagrammer Symbol Name IS_PRECONDITION IS_POSTCONDITION EVENT_CLAUSES STATE EVENT TRANSITION_LINE Plural Name n/a n/a n/a STATES EVENTS TRANSITION_LINES Symbol Type connection connection connection box box line

Table 4-11 Database Diagrammer Symbol Name REFERRED_OUT REFERRED_IN HAS_OUT HAS_IN TABLE KEY FOREIGN_KEY INDEX_KEY HAS_KEY_LINE Plural Name n/a n/a n/a n/a TABLES KEYS FOREIGN_KEYS INDEX_KEYS HAS_KEY_LINES Symbol Type connection connection connection connection box box box box line

4-46

TurboCycler Template Language

Supporting Statements and Expressions

Table 4-11 Database Diagrammer (Continued) Symbol Name REFERRED_KEY_LINE Plural Name REFERRED_KEY_LINES Symbol Type line

Table 4-12 Process Dependency Diagrammer Symbol Name DEPEND_OUT DEPEND_IN TRIGGER_OUT TRIGGER_IN EVENT_TRIGGER_IN EVENT_TRIGGER_OUT LOGICAL_PROCESS DECISION TRIGGER_LINE DEPENDENCY_LINE EVENT_TRIGGER_LINE Plural Name n/a n/a n/a n/a n/a n/a LOGICAL_PROCESSES DECISIONS TRIGGER_LINES DEPENDENCY_LINES EVENT_TRIGGER_LINES Symbol Type connection connection connection connection connection connection box box line line line

Table 4-13 Window Flow Diagrammer Symbol Name FLOW_OUT FLOW_IN NEST_OUT NEST_IN EVENT_OUT EVENT_IN DETACH_OUT DETACH_IN RULE_INITIATES DECISION_OUT DECISION_IN DECISION_NEST_OUT PROCESS ENTRY_POINT DIALOG_UNIT WINDOW RULE DECISION TERMINAL FLOW_LINE NESTED_FLOW_LINE DETACHED_FLOW_LINE MESSAGE_FLOW_LINE Plural Name n/a n/a n/a n/a n/a n/a n/a n/a n/a n/a n/a n/a PROCESSES ENTRY_POINTS DIALOG_UNITS WINDOWS RULES DECISIONS TERMINALS FLOW_LINES NESTED_FLOW_LINES DETACHED_FLOW_LINES MESSAGE_FLOW_LINES Symbol Type connection connection connection connection connection connection connection connection connection connection connection connection box box box box box box box line line line line

AppBuilder 2.1.0 Scripting Tools Reference Guide

4-47

Functions

Functions
The TurboCycler Developers Kit comes with a number of commonly needed functions to assist you in building your templates. Get and File Functions String Manipulation Functions Superseded Functions

Get and File Functions

The following is a list of functions available: GetConfiguration (app, key) GetEnvironment (environment_variable) GetHPSConfiguration (app, key) GetTime (format_string) isDefined (variable_name) NewFilename ( ) removeFile (file_name) ReadFlatFile(pathname)

GetConfiguration (app, key)

This function retrieves the value of the key parameter from the app parameter section of the file that the environment variable TURBOINI points to. This function lets templates place user-editable parameters in this file, rather than hard coding them in the template. Documentation provided with the template must explain what is required of users with respect to this file. Templates must share this file, so section app names should be chosen sensibly (for example, the template title). If the entry cannot be found, an empty string is returned.

GetEnvironment (environment_variable)
This function retrieves the value of any environment_variable. If the requested variable is not defined, an empty string is returned.

GetHPSConfiguration (app, key)

This function retrieves the value of the key parameter from the app parameter section of the HPS.INI file. If the entry cannot be found, an empty string is returned.

4-48

TurboCycler Template Language

Functions

Note

In Windows NT, the HPSINI file cannot be read using the GetHPSConfiguration function. However, AppBuilder can use the registry for the TurboCycler GetHPSConfiguration function. The following sample key and values illustrate how you can set up the the logic:
[HKEY_LOCAL_MACHINE\SOFTWARE\BluePhoenix\Appbuilder\IDWB\Tools\TurboCycler\ Settings] "Copyright1"="copyright CompanyName 2003" "Copyright2"="copyright OtherName 1999"

Then, add the statement:

SET MyCopyRight1 = GetHPSConfiguration("TurboCycler","Copyright1")

GetTime (format_string)
This function uses the format_string parameter to generate a string containing the current date or time information. The format_string is composed of text and, optionally, one or more of the conversion specifiers described in Table 4-14:
Table 4-14 Conversion Specifiers Specifier %a %A %b %B %c %d %H %I %j %m %M %p %S %U %w %W %x %X %y %Y %z %% Description Abbreviated weekday name Full weekday name Abbreviated month name Full month name Date and time Day of the month Hour of the 24-hour day Hour of the 12-hour day Day of the year, from 001 Month of the year, from 01 Minutes after the hour, from 00 AM/PM indicator (AM) Seconds after the minute, from 00 Sunday week of the year, from 00 Day of the week, from 0 for Sunday Monday week of the year from 00 Date Time Year of the century, from 00 Year Time zone name, if any Percent character Example Sun Sunday Dec December Dec 02 1995 06:55:15 02 23 11 335 12 55 AM 48 51 0 43 Dec 02 1995 06:55:15 95 1995 EST %

Using any other % character in the format string is illegal, and an empty string is returned.

AppBuilder 2.1.0 Scripting Tools Reference Guide

4-49

String Manipulation Functions

isDefined (variable_name)
This function returns 1 if the variable_name is defined as a variable in the template; otherwise, it returns 0. This function allows the template to determine whether it is being executed by the user or another template.

NewFilename ( )
This function generates a unique file name.

removeFile (file_name)
This function attempts to delete the file specified by the file_name parameter. It returns 1 if successful or 0 if unsuccessful.

ReadFlatFile(pathname)
TurboCycler reads in text files using the READFLATFILE (pathname) function. The function returns a string containing the text file. Only text files smaller than 64K can be read using this function.

String Manipulation Functions

Note
The first character in a string is at position one, not position zero.

strCenter (str, length, pad) Returns a string of length with str centered. Remaining spaces are filled using pad. strCopies (str, n) Returns a string of n concatenated copies of str. strCutLeft (str, length) Returns str with the leftmost length characters removed. strCutMiddle (str, start, length) Returns str with length characters starting at position start removed. strCutRight (str, length) Returns str with the rightmost length characters removed. strFilespec (str, option) Returns the part of the file name in str specified by option. The option can be: Drive, Dir, Name, or Extension.

4-50

TurboCycler Template Language

String Manipulation Functions

strFind (needle, haystack, int n) Returns the position of the nth occurrence of needle in haystack. strInsert (needle, haystack, n) Inserts needle in haystack at position n. strLeft (str, length) Returns a string comprised of the leftmost length characters of str. strLength (str) Returns the number of characters in str. strLine (str, i) Returns the i the line in str. strLines (str) Returns the number of lines in str, separated by carriage returns. strLower (str) Converts str to lower case. strMiddle (str, start, length) Returns a string comprised of length character taken from str beginning at position start. strReplace (search, replace, str) Replaces each occurrence of the string search in str with the string replace. The search is case insensitive. strReverse (str) Returns a string comprised of the characters from str in reverse order. strRight (str, length) Returns a string comprised of the rightmost length character of str. strToken (str, delimiter_set, n) Returns the nth token in str, using the characters in delimiter_set as delimiters. strTokens (str, delimiter_set) Returns the number of tokens in str separated by any of the characters in delimiter_set. strTrim (str, option) Returns str without leading or trailing white space. The option can be: Leading, Trailing, or Both. strUpper (str) Converts str to upper case.

AppBuilder 2.1.0 Scripting Tools Reference Guide

4-51

Superseded Functions

strWord (str, i) Returns the i the word in str. strWords (str) Returns the number of words in str, separated by white space.

Superseded Functions
Previous releases of TurboCycler Developers Kit provided functions and statements that have since been superseded. The use of these functions and statements is discouraged. A listing of these functions is shown in Table 4-15.
Table 4-15 Superseded Functions For these functions: RIGHTOF() LEFTOF() WIDTHOF() HEIGHTOF() Use:

The new QUERY property statement instead.

For these statements:

Use: The SET property statement instead: SET BOTTOM OF TCWINDOW = 50 SET LEFT OF TCWINDOW = 50 SET WIDTH OF TCWINDOW = 200 SET HEIGHT OF TCWINDOW = 150

POSITION WINDOW SIZE WINDOW

Template Samples
The TurboCycler Developers Kit provides two sample templates: the SQL Delete Rule sample, which is part of the CRUD Rules template, and the Detail Display rule/window sample, which is part of the GUI Rules/Windows template. These samples demonstrate many of the features available in the template language. The samples are located in the directory HPS\AD\TEMPLATES\SAMPLES. The following samples show how to generate object hierarchies, rules, and a window. The SQL Delete Rule Sample is described first, then the Detail Display Rule and Window Sample.

Note

Source code for all the Standard Edition templates is included with the TurboCycler Developers Kit in the directory APPBUILDER\AD\TEMPLATES.

Samples include: SQL Delete Rule Sample Detail Display Rule and Window Sample

4-52

TurboCycler Template Language

Template Samples

SQL Delete Rule Sample

This sample is a part of the Standard Edition CRUD Rules template that generates an SQL Delete Rule for a AppBuilder file object. Generating a completely functional SQL Delete Rule requires defining both the rule hierarchy and rule source code. Therefore, this sample template includes both a hierarchy module and rule module. Notice that both modules have the same name, forcing the generation of both the hierarchy and rule. In the usages block, this template retrieves all the information it needs from the repository and sets up any local variables that multiple modules require. In this example, the process error checks the generated rule source code and rule hierarchy. You can generate an SQL Delete Rule without error-checking, but any errors would remain undetected until you prepared the generated rule. In the hierarchy block, the template generates the SQL Delete Rule hierarchy. Notice that input and output view are both declared as children of the rule and as root-level objects. These declarations ensure that TurboCycler deletes all children not created from this template. In some cases, you may not want to do this. In the rule block, the template generates the source code for the SQL Delete Rule. It includes a comment area at the top saying that it was generated and specifies the name of the file it was generated for. The placement of the { } (curly brace characters) is critical to generating properly spaced and indented rules source. A good example of this placement is the WHERE clause of the SQL ASIS. TEMPLATE SQL Delete Rule Sample DESCRIPTION Generates an SQL Delete Rule for a AppBuilder File object. ENDDESCRIPTION USAGES USE FILE(MyFile) REM --- Retrieve primary view information from repository ---; SET MyPrimeView = CHILD VIEW OF MyFile VIA RELATION OWNS_VIEW WITH [VIEW_USAGE = PRIMARY] SET MyPrimeFields = CHILD FIELDS OF MyPrimeView VIA RELATION VIEW_INCLUDES REM --- Retrieve file information from repository ---; SET MyFileName = QUERY NAME OF MyFile SET MyFileImplementation = QUERY IMPLEMENTATION_NAME OF MyFile ENDUSE USE ALL REM --- Verify that we have a primary view ---; IF MyPrimeView = 0 RETURN The file does not have a primary view. ENDIF REM --- Verify that we have primary fields ---; IF (NUMBEROF(MyPrimeFields)) = 0 RETURN The primary view for the file does not have any fields. ENDIF

AppBuilder 2.1.0 Scripting Tools Reference Guide

4-53

Template Samples

REM --- Verify that we have a file implementation name ---; IF MyFileImplementation = RETURN The file does not have an implementation name. ENDIF REM --- Verify that all primary fields have an implementation name ---; FOR I = 1 TO NUMBEROF(MyPrimeFields) IF (QUERY IMPLEMENTATION_NAME OF MyPrimeFields(I)) = SET MESSAGE = The primary field + (QUERY NAME OF MyPrimeFields(I)) + does not have an implementation name. RETURN MESSAGE ENDIF ENDFOR ENDUSE ENDUSAGES REM ---------------------------------------------------------SQL Delete Rule Modules -------------------------------------------------------------; REM -------------------------------------------------------; HIERARCHY SQL Delete Rule REM --- Create Strings for SQL Delete Rule Modules ---; SET DeleteRuleName = (SUBSTR (MyFileName, 1, 19) ) + _SQL_DEL SET DeleteRuleIV = DeleteRuleName + _IV SET DeleteRuleOV = DeleteRuleName + _OV REM --- Build Hierarchy for the SQL Delete Rule ---; -> RULE DeleteRuleName [DBMS = DB2] ->-> FILE MyFileName VIA RELATION ACCESSES [SEQUENCE_NUMBER = 10] ->-> VIEW DeleteRuleIV VIA RELATION OWNS_VIEW [VIEW_USAGE = Input, SEQUENCE_NUMBER = 20] ->-> VIEW DeleteRuleOV VIA RELATION OWNS_VIEW [VIEW_USAGE = Output, SEQUENCE_NUMBER = 30] REM --- Build Hierarchy for the SQL Delete Rule Input View ---; -> VIEW DeleteRuleIV ->-> VIEW MyPrimeView VIA RELATION VIEW_INCLUDES [SEQUENCE_NUMBER = 10] REM --- Build Hierarchy for SQL Delete Rule Output View ---; -> VIEW DeleteRuleOV ->-> FIELD RETURN_CODE VIA RELATION VIEW_INCLUDES [SEQUENCE_NUMBER = 10] ENDHIERARCHY

4-54

TurboCycler Template Language

Template Samples

RULE SQL Delete Rule NAMED DeleteRuleName { *>--------------------------------------------------------<* *>- Rule: $(DeleteRuleName) -<* *>- SQL Delete Rule for the File: $(MyFile). -<* *>- Automatically Generated by TurboCycler. -<* *>-------------------------------------------------------<* SQL ASIS DELETE FROM $(MyFileImplementation) WHERE } FOR I = 1 TO NUMBEROF(MyPrimeFields) { $(QUERY IMPLEMENTATION_NAME OF MyPrimeFields(I)) = :$(DeleteRuleIV).$(MyPrimeFields(I)) } IF I <> NUMBEROF(MyPrimeFields) {AND } ENDIF ENDFOR { ENDSQL IF SQLCODE = 0 SQL ASIS COMMIT ENDSQL ENDIF MAP SQLCODE TO RETURN_CODE } ENDRULE

Detail Display Rule and Window Sample

This sample is part of the Standard Edition GUI Rules/Windows template that generates a simple Detail Display rule and window with no application logic for a AppBuilder file object. Generating an executable detail display hierarchy requires defining a function/process hierarchy, rule hierarchy, window hierarchy, rule source code, and window panel. Therefore, the sample template includes two hierarchy blocks, a rule block and a window block. Notice that all modules have the same name, which forces the generation of all of these blocks. In the usages block, this template retrieves all information it needs from the repository and sets up any local variables that multiple modules require. In this example, the process error checks the generated rule source code and window panel. If error-checking is not performed, you can generate a detail display window without any fields in it (if no fields were in the data view). In the window hierarchy block, notice how the use of the FOR loop over the fields in the data view clones the data view. This example also shows how to create any kind of hierarchy, including a function/process hierarchy. The sample rule block is relatively simple because it does not include any application logic.

AppBuilder 2.1.0 Scripting Tools Reference Guide

4-55

Template Samples

In the window block, the template makes several controls, including a static text and edit field for every field in the data view. In doing this, a variable (MyBottom) stores the current value of the bottom position of the next window control. This template also creates a simple menu hierarchy and includes a bit map in the top left corner of the screen. It is important to understand how the template maintains the size and position of the window. TEMPLATE Detail Display Sample DESCRIPTION Generates a Detail Display Rule and Window for a AppBuilder File Object. ENDDESCRIPTION USAGES USE FILE(MyFile) REM --- Query repository for information needed by blocks ---; SET MyDataView = CHILD VIEW OF MyFile VIA RELATION OWNS_VIEW WITH [VIEW_USAGE = DATA] SET MyFields = CHILD FIELDS OF MyDataView VIA RELATION VIEW_INCLUDES SET MyFileName = QUERY NAME OF MyFile ENDUSE USE ALL REM --- Verify there is a data view ---; IF MyDataView = 0 RETURN The file does not have a data view. ENDIF REM --- Verify the data view has fields ---; IF (NUMBEROF(MyFields)) = 0 RETURN The data view does not have any fields. ENDIF REM --- Set up Strings needed by blocks ---; SET MyClonedDataView = (SUBSTR (MyFileName, 1, 19) ) + _CDV SET MyDetailRule = (SUBSTR (MyFileName, 1, 16) ) + _SAMPLE_DETAIL SET MyDetailWindow = (SUBSTR (MyFileName, 1, 16) ) + _SAMPLE_DETAIL SET MyProcessName = (SUBSTR (MyFileName, 1, 19) ) + _MAINT ENDUSE ENDUSAGES REM --- Detail Display Function/Process/Rule Hierarchies ---; HIERARCHY Detail Display REM --- Create the Function/Process hierarchy ---; -> FUNCTION MyFileName [MENU_DESCRIPTION = MyFileName]

4-56

TurboCycler Template Language

Template Samples

->-> PROCESS MyProcessName [MENU_DESCRIPTION = MyFileName + Maintenance] VIA RELATION REFINES_INTO [SEQUENCE_NUMBER = 10] REM --- Attach a root rule to the Process ---; -> PROCESS MyProcessName ->-> RULE MyDetailRule VIA RELATION IS_DEFINED_BY [SEQUENCE_NUMBER = 10] REM --- Create the Detail Display Rule Hierarchy ---; -> RULE MyDetailRule ->-> WINDOW MyDetailRule VIA RELATION CONVERSES_WINDOW [SEQUENCE_NUMBER = 110] ->-> VIEW HPS_EVENT_VIEW VIA RELATION OWNS_VIEW [SEQUENCE_NUMBER = 120, VIEW_USAGE = WORK] ENDHIERARCHY REM --- Detail Display Rule Source Code ---; RULE Detail Display NAMED MyDetailRule { *>--------------------------------------------------------<* *>- Rule: $(MyDetailRule) -<* *>- Detail Display Rule for the File: $(MyFile). -<* *>- Automatically Generated by TurboCycler. -<* *>--------------------------------------------------------<* do while EVENT_SOURCE <> Exit map TIME to STATUS_TIME map DATE to STATUS_DATE converse window $(MyDetailRule) caseof EVENT_SOURCE case New clear $(MyDetailRule) endcase enddo } ENDRULE REM --- Detail Display Window Hierarchy ---; HIERARCHY Detail Display REM --- Create the Window Hierarchy ---; -> WINDOW MyDetailWindow ->-> VIEW MyDetailWindow VIA RELATION OWNS_VIEW [SEQUENCE_NUMBER = 10] REM --- Create the Window View Hierarchy ---; -> VIEW MyDetailWindow ->-> FIELD STATUS_DATE [TYPE = DATE, LENGTH = 4] VIA RELATION VIEW_INCLUDES [SEQUENCE_NUMBER = 10] ->-> FIELD STATUS_TIME [TYPE = TIME, LENGTH = 4]

AppBuilder 2.1.0 Scripting Tools Reference Guide

4-57

Template Samples

VIA RELATION VIEW_INCLUDES [SEQUENCE_NUMBER = 20] ->-> VIEW MyClonedDataView VIA RELATION VIEW_INCLUDES [SEQUENCE_NUMBER = 30] REM --- Clone the data view in the window view ---; -> VIEW MyClonedDataView FOR X = 1 TO NUMBEROF(MyFields) ->-> FIELD (QUERY NAME OF MyFields(X)) VIA RELATION VIEW_INCLUDES [SEQUENCE_NUMBER = (10*X)] ENDFOR ENDHIERARCHY REM --- Detail Display Window Panel ---; WINDOW Detail Display NAMED MyDetailWindow SET MyCDV = GET VIEW NAMED MyClonedDataView REM --- Make the Detail Display Menu ---; -> MENUITEM &File ->-> MENUITEM &New [HPSID = New] ->-> SEPARATOR ->-> MENUITEM &Print [HPSID = HPS_MENU_PRINT] ->-> SEPARATOR ->-> MENUITEM E&xit [HPSID = Exit] -> MENUITEM &Edit ->-> MENUITEM &Cut ->-> MENUITEM Co&py ->-> MENUITEM &Paste

[HPSID = HPS_MENU_CUT] [HPSID = HPS_MENU_COPY] [HPSID = HPS_MENU_PASTE]

REM --- Set up area information ---; SET MyWidth = 440 SET MyBottom = (20 + (29 * (NUMBEROF(MyFields) - 1))) REM --- Place all edit fields ---; FOR X = 1 TO NUMBEROF(MyFields) MAKE STATIC_TEXT HAVING [HPSID = ID + (QUERY NAME OF MyFields(X)), LEFT = 20, TEXT = (QUERY SCREEN_LITERAL OF MyFields(X)), BOTTOM = MyBottom, WIDTH = 150, HEIGHT = 19, FONT = SWISS8] ENDMAKE REM --- PROCEDURE TO DETERMINE WIDTH OF FIELD ---; SET FieldType = QUERY TYPE OF MyFields(X) SET FieldLength = QUERY LENGTH OF MyFields(X) IF FieldType = INTEGER IF FieldLength = 15 SET ControlWidth = 60

4-58

TurboCycler Template Language

Template Samples

ELSE SET ControlWidth = 100 ENDIF ELSE IF FieldType = DATE OR FieldType = TIME SET ControlWidth = 100 ELSE SET ControlWidth = 7 * FieldLength IF ControlWidth < 30 SET ControlWidth = 30 ENDIF ENDIF ENDIF MAKE EDIT_FIELD edit HAVING [HPSID = (QUERY NAME OF MyFields(X)), LEFT = 175, BOTTOM = MyBottom, HEIGHT = 19, WIDTH = ControlWidth, FONT = SWISS8, TABSTOP = TRUE] LINKED TO MyFields(X) OF MyCDV ENDMAKE SET MyBottom = MyBottom - 29 IF (RIGHTOF(edit) + 20) > MyWidth SET MyWidth = RIGHTOF(edit) + 20 ENDIF ENDFOR REM --- Reset the bottom to be above all edit fields ---; SET MyBottom = 20 + (29 * NUMBEROF(MyFields)) + 15 REM --- Place Bitmap/Status Information Above Edit Fields ---; MAKE BITMAP HAVING [HPSID = HPS, BOTTOM = MyBottom, HEIGHT = 50, ENDMAKE

LEFT = 20, WIDTH = 50, FILE = DEFAULT.BMP]

MAKE PROTECTED_EDIT_FIELD HAVING [HPSID = STATUS_DATE, LEFT = 80, BOTTOM = MyBottom + 31, HEIGHT = 19, WIDTH = 60, FONT = SWISS8, TABSTOP = FALSE] LINKED TO (GET FIELD NAMED STATUS_DATE) ENDMAKE MAKE PROTECTED_EDIT_FIELD HAVING [HPSID = STATUS_TIME,

LEFT = 80,

AppBuilder 2.1.0 Scripting Tools Reference Guide

4-59

Template Samples

BOTTOM = MyBottom, HEIGHT = 19, WIDTH = 60, FONT = SWISS8, TABSTOP = FALSE] LINKED TO (GET FIELD NAMED STATUS_TIME) ENDMAKE SET MyBottom = MyBottom - 2 MAKE RECTANGLE HAVING [HPSID = Line, BOTTOM = MyBottom, HEIGHT = 1] ENDMAKE SET MyBottom = MyBottom + 50 REM --- Size and Position the window ---; SIZE WINDOW MyWidth BY (MyBottom + 45) POSITION WINDOW AT 50, 50 ENDWINDOW

LEFT = 0, WIDTH = MyWidth,

4-60

TurboCycler Template Language

CHAPTE

TURBOCYCLER REPOSITORY TYPES AND PROPERTIES

AppBuilder 2.1.0 Scripting Tools Reference Guide

Repository Types and Properties describes the object types in the Information Model that TurboCycler can access or generate. The Information Model defines the objects an AppBuilder repository can contain. Repository objects include entities and relationships. The Information Model describes the entity types and relationship types they can have with each other. These objects have properties that you can query or set. Some properties have a set of values called a domain. Refer to the Information Model for complete descriptions of entity types, relationship types, and their properties. Repository Types and Properties describe the types of objects, the relationships between them, and the properties of each that you can use in template language statements. This includes: Object Types and Properties Relationship Types and Properties Property Domains First, there is a short description on how to access repository information. The next section shows a short example of template language statements using repository types and properties. Then, object and relationship types and their corresponding properties are described. Repository Types and Properties ends with a list of the domains for properties that have them.

Repository Object Type Query Sample

A number of TurboCycler template language statements can access the repository and perform queries. For example, you can query the type of a repository object using the TYPEOF (object_expression) function: SET X = GET FIELD NAMED RETURN_CODE SET Y = TYPEOF( X ) // Y = FIELD

Note

All object query statements return lists that are automatically sorted by sequence number.

AppBuilder 2.1.0 Scripting Tools Reference Guide

5-1

Template Language Statement Sample

Template Language Statement Sample

The following template language statement navigates to the data view of FILEA from within a generation template: SET DataView = CHILD VIEW OF FILEA VIA RELATION OWNS_VIEW WITH [VIEW_USAGE = DATA] The next example defines the child object type (VIEW) as an object type. Observe that VIEW is a valid entity type with three properties: an implementation name, a name, and a system ID. VIEW IMPLEMENTATION_NAME NAME SYSID The next example defines the child relationship type OWNS_VIEW as a relationship type having two properties: sequence number and view usage. Notice the VIEW_USAGE property has a domain, ViewUsage. OWNS_VIEW SEQUENCE_NUMBER VIEW_USAGE:

ViewUsage

In the following example, the ViewUsage domain controls the values listed below. ViewUsage ALTERNATE DATA INPUT OUTPUT WORK CANDIDATE FOREIGN INPUT/OUTPUT PRIMARY

You can find a view with VIEW_USAGE 'output' or VIEW_USAGE 'input/output'. However, combining them using the syntax: [View_USAGE = "INPUT/OUTPUT" or VIEW_USAGE = "INPUT"] is not valid. TurboCycler does not recognize the "or" as a condition statement if it is inside the bracket. Use the syntax: [VIEW_USAGE = "INPUT/OUTPUT"] or [VIEW_USAGE = "INPUT"] to achieve the desired result.

5-2

TurboCycler Repository Types and Properties

Object Types and Properties

Object Types and Properties

Object types have properties that you can set or query. The object types properties are described after the object. If a property has a domain of values, those values are included in Property Domains on page 5-23. Table 5-1 lists the supported object types.
Table 5-1 TurboCycler Object Types IDENTIFIER KEY LOCATION LOGICAL_PROCESS MACHINE ORGANIZATION PANEL PROCESS RELATIONSHIP REPORT RULE SECTION SERVER SET STATE SYSTEM TABLE TRANSITION VALUE VIEW WINDOW WINDOW_CONTENT

AUDIT_PROPERTIES APPLICATION_CONFIGURATION ATTRIBUTE BITMAP BITMAP_IMPLEMENTATION BUSINESS_OBJECT CELL COLLECTIONCOLUMN COMPONENT PARTITION DATABASE DATA_STORE DATA_TYPE DRAWING ENTITY EVENT FIELD FILE FSDM_SCHEME FSDM_VALUE FUNCTION HELP

All object types have the properties OBJECT_TEXT and OBJECT_KEYWORDS. For example: SET X = QUERY OBJECT_TEXT OF Y The result of this expression is to store the TEXT of object Y as a string in variable X. Additionally, there are audit properties that are common to all objects in the Workgroup repository (also referred to as Freeway). Table 5-2 is a list of the audit properties and their character restrictions:
Table 5-2 Properties FWY_PROJECT FWY_USER FWY_DATE FWY_TIME FWY_LOCKOWNER FWY_OWNER Workgroup Repository Audit Properties Character Restriction char 10 char 10 char 8 char 8 char 10 char 10

AppBuilder 2.1.0 Scripting Tools Reference Guide

5-3

Object Types and Properties

AUDIT_PROPERTIES
All entities have the read-only audit properties listed in Table 5-4. The tables that follow list specific properties for each entity individually.
Table 5-3 Entity List IDENTIFIER KEY LOCATION LOGICAL_PROCESS MACHINE ORGANIZATION PANEL PROCESS RELATIONSHIP REPORT RULE SECTION SERVER SET STATE SYSTEM TABLE TRANSITION VALUE VIEW WINDOW WINDOW_CONTENT

APPLICATION_CONFIGURATION ATTRIBUTE BITMAP BITMAP_IMPLEMENTATION BUSINESS_OBJECT CELL COLLECTION COLUMN COMPONENT PARTITION DATABASE DATA_STORE DATA_TYPE DRAWING ENTITY EVENT FIELD FILE FSDM_SCHEME FSDM_VALUE FUNCTION HELP

Table 5-4

Universal Read-Only Audit Properties OBJECT_KEYWORDS OWNER REMOTE_DATE_CREATED REMOTE_CREATED_BY REMOTE_TIME_MAINTAINED

CHANGE_NUMBER OBJECT_TEXT PROJECT REMOTE_TIME_CREATED REMOTE_DATE_MAINTAINED REMOTE_MAINTAINED_BY

APPLICATION_CONFIGURATION
Table 5-5 NAME APPLICATION_CONFIGURATION Read-Only Audit Properties SYSID

5-4

TurboCycler Repository Types and Properties

Object Types and Properties

ATTRIBUTE
Table 5-6 ATTRIBUTE Read-Only Audit Properties NAME

DERIVATION: AttributeType SYSID

BITMAP
Table 5-7 BITMAP Read-Only Audit Properties NAME TYPE: BmpType

IMPLEMENTATION_NAME SYSID

BITMAP_IMPLEMENTATION
Table 5-8 BITMAP_IMPLEMENTATION Read-Only Audit Properties COLOR_PLANE BITMAP_IMPLEMENTATION_DESCRIPTION RESERVED TYPE: BMPFormatType X_SIZE Y_SIZE

CODEPAGE COORDINATE_METHOD: CoordSys NAME SYSID X_RESOLUTION Y_RESOLUTION

BUSINESS_OBJECT
Table 5-9 BUSINESS_OBJECT Read-Only Audit Properties NAME TYPE: BusinessObjectType

BUSINESS_OBJECT_DESCRIPTION SYSID

CELL
Table 5-10 CELL Read-Only Audit Properties NAME SYSID PROTOCOL: Protocol

COLLECTION
Table 5-11 COLLECTION Read-Only Audit Properties NAME NUMBER_OF_ELEMENTS SYSID NATURE: CollectNature NUMBER_OF_GROUPS TYPE

AppBuilder 2.1.0 Scripting Tools Reference Guide

5-5

Object Types and Properties

COLUMN
Table 5-12 COLUMN Read-Only Audit Properties AVE_LENGTH LENGTH SCALE TYPE: FieldType IMPLEMENTATION_NAME NAME SYSID

COMPONENT
Table 5-13 COMPONENT Read-Only Audit Properties DBMS_USAGE: CompDBMSUsage EXECUTION_MODE: ExecutionMode LANGUAGE: Language SOURCE_FILE ENVIRONMENT: CompExecEnv IMPLEMENTATION_NAME NAME SYSID

DATABASE
Table 5-14 DATABASE Read-Only Audit Properties IMPLEMENTATION_NAME NAME TYPE: DBMStype MACHINE_NAME SYSID

DATA_STORE
Table 5-15 DATA_STORE Read-Only Audit Properties DATA_STORE_DESCRIPTION SYSID NAME

DATA_TYPE
Table 5-16 DATA_TYPE Read-Only Audit Properties FRACTION NAME TYPE: FieldType LENGTH SYSID

DRAWING
Table 5-17 DRAWING Read-Only Audit Properties NAME TYPE: Drawing SYSID

5-6

TurboCycler Repository Types and Properties

Object Types and Properties

ENTITY
Table 5-18 ENTITY Read-Only Audit Properties ACTIVITY_PERIOD: Duration AVERAGE_INSERTS EXPECTED_ROWS MINIMUM_ROWS SYSID AVERAGE_DELETES AVERAGE_UPDATES MAXIMUM_ROWS NAME TYPE: EntityType

EVENT
Table 5-19 EVENT Read-Only Audit Properties CLASS: NAME TYPE EventClass EVENT_DESCRIPTION SYSID

FIELD
Table 5-20 FIELD Read-Only Audit Properties FRACTION LENGTH MINIMUM PICTURE_CLAUSE SCREEN_LITERAL SHORT_SCREEN_LITERAL TYPE: FieldType IMPLEMENTATION_NAME MAXIMUM NAME REF SCREEN_PICTURE SYSID

FILE
Table 5-21 FILE Read-Only Audit Properties IMPLEMENTATION_NAME SYSID NAME TYPE: FileType

FSDM_SCHEME
Table 5-22 FSDM_SCHEME Read-Only Audit Properties FSDM_SCHEME_DESCRIPTION NAME MUTUALLY_EXCLUSIVE: Boolean SYSID

FSDM_VALUE
Table 5-23 FSDM_VALUE Read-Only Audit Properties FSDM_VALUE_DESCRIPTION SYSID NAME

AppBuilder 2.1.0 Scripting Tools Reference Guide

5-7

Object Types and Properties

FUNCTION
Table 5-24 FUNCTION Read-Only Audit Properties CHILD_MENU: ChildMenu NAME WORKSTATION_GROUP MENU_DESCRIPTION SYSID

HELP
Table 5-25 HELP Read-Only Audit Properties HELP_DESCRIPTION NAME COUNTRY_LANGUAGE: CountryLanguage FORMAT: HelpFmt SYSID SOURCE_FILE

IDENTIFIER
Table 5-26 IDENTIFIER Read-Only Audit Properties NAME TYPE: IdentifierType SYSID

KEY
Table 5-27 KEY Read-Only Audit Properties IMPLEMENTATION_NAME SYSID DELETE_RULE: KeyDeleteRule NAME TYPE: DBtypeKey UNIQUE: Boolean

LOCATION
Table 5-28 LOCATION Read-Only Audit Properties LOCATION_DESCRIPTION SYSID NAME

LOGICAL_PROCESS
Table 5-29 LOGICAL_PROCESS Read-Only Audit Properties LOGICAL_PROCESS_DESCRIPTION NAME TYPE: LogicalProcessType MODE: LogicalProcessMode SYSID

MACHINE
Table 5-30 MACHINE Read-Only Audit Properties GROUP IMPLEMENTATION_NAME

5-8

TurboCycler Repository Types and Properties

Object Types and Properties

Table 5-30 MACHINE Read-Only Audit Properties (Continued) NAME OPERATING_SYSTEM_RELEASE OPERATING_SYSTEM: OStype SYSID

ORGANIZATION
Table 5-31 ORGANIZATION Read-Only Audit Properties NAME SYSID

PANEL
Table 5-32 PANEL Read-Only Audit Properties CODEPAGE (525) COUNTRY_LANGUAGE: CountryLanguage (531) SOURCE_FILE PANEL_DESCRIPTION SYSID Y_RESOLUTION BASE: Boolean (531) GUI: GUI (531) COORDINATE_METHOD: CoordSys NAME X_RESOLUTION

PARTITION
Table 5-33 PARTITION Read-Only Audit Properties CELL_RANK IMPLEMENTATION_NAME NAME PLAN_NAME QUALIFIER SYSID DATABASE_SUBSYSTEM LINK_TYPE: SrvLinkType SERVER_OWNER PROTOCOL: Protocol START_TYPE: SrvStartType TYPE: ServerType

PROCESS
Table 5-34 PROCESS Read-Only Audit Properties CHILD_MENU: ChildMenu MENU_DESCRIPTION SYSID EXECUTION_ENVIRONMENT: ProcessEnv NAME WORKSTATION_GROUP

RELATIONSHIP
Table 5-35 RELATIONSHIP Read-Only Audit Properties ACTIVITY_PERIOD: Duration AVERAGE_INSERTS EXPECTED_ROWS MINIMUM_ROWS SYSID AVERAGE_DELETES AVERAGE_UPDATES MAXIMUM_ROWS NAME TYPE: ComplexIndicator

AppBuilder 2.1.0 Scripting Tools Reference Guide

5-9

Object Types and Properties

REPORT
Table 5-36 REPORT Read-Only Audit Properties EXECUTION_ENVIRONMENT: ReportExecEnv LEFT_MARGIN NAME PAGE_SIZE SYSID IMPLEMENTATION_NAME LINE_SIZE ORIENTATION: Orientation PRINTER_TYPE: PrinterType TOP_MARGIN

RULE
Table 5-37 RULE Read-Only Audit Properties DBMS: RuleDBMSUsage EXECUTION_MODE: ExecuteMode ISOLATION_MODE: IsolationMode PACKAGE SOURCE_FILE ENVIRONMENT: RuleExecEnv IMPLEMENTATION_NAME NAME PLAN_NAME SYSID

SECTION
Table 5-38 SECTION Read-Only Audit Properties IMPLEMENTATION_NAME SYSID NAME

SERVER
Table 5-39 SERVER Read-Only Audit Properties COLLECTION_ID ISOLATION_MODE: IsolationMode MINIMUM_TRANSACTION_ID NEXT_TRANSACTION_ID IMPLEMENTATION_NAME MAXIMUM_TRANSACTION_ID NAME

SET
Table 5-40 SET Read-Only Audit Properties FRACTION LENGTH PICTURE STYLE: SetStyle TYPE: SetType IMPLEMENTATION_NAME NAME REPRESENTATION_LENGTH SYSID

5-10

TurboCycler Repository Types and Properties

Object Types and Properties

STATE
Table 5-41 STATE Read-Only Audit Properties STATE_DESCRIPTION SYSID NAME TYPE: StateType

SYSTEM
Table 5-42 SYSTEM Read-Only Audit Properties SYSTEM_DESCRIPTION SYSID NAME

TABLE
Table 5-43 TABLE Read-Only Audit Properties ACTIVATION_PERIOD: Duration AVE_INSERTS IMPLEMENTATION_NAME MINIMUM_ROWS SYSID AVE_DELETES CREATOR MAXIMUM_ROWS NAME TYPE: Table_View

TRANSITION
Table 5-44 TRANSITION Read-Only Audit Properties NAME SYSID

VALUE
Table 5-45 VALUE Read-Only Audit Properties IMPLEMENTATION_NAME SYSID NAME

VIEW
Table 5-46 VIEW Read-Only Audit Properties IMPLEMENTATION_NAME SYSID NAME

WINDOW
Table 5-47 WINDOW Read-Only Audit Properties IMPLEMENTATION_NAME SYSID NAME

AppBuilder 2.1.0 Scripting Tools Reference Guide

5-11

Relationship Types and Properties

WINDOW_CONTENT
Table 5-48 WINDOW_CONTENT Read-Only Audit Properties GUI: GUI SYSID NAME

Relationship Types and Properties

Relationship types have properties you can set or query. In Table 5-49, the properties of the relationship type are described after the relationship. If a property has a domain of values, it follows the property description. Refer to Property Domains for a complete list of property domains.
Table 5-49 Relationship Types and Properties
ACCESSES APPLICATION_CONFIGURATION_HAS_CONFIGURATION_UNIT BITMAP_HAS_BITMAP_IMPLEMENTATION BUSINESS_OBJECT_OWNS BUSINESS_OBJECT_REFINES_INTO_BUSINESS_OBJECT CELL_CONTAINS COMPONENT_USES_COMPONENT CONFIGURATION_UNIT_ENCAPSULATES CONNECTS_TO CONTAINS_VALUE CONVERSES_WINDOW DATABASE_HAS_TABLE DATATYPE_IS_COMPOSED_OF_DATATYPE DATATYPE_IS_CONSTRAINED_BY_SET DATA_STORE_IS_REPLACED_BY_ENTITY DEPENDS_ON_LOGICAL_PROCESS ENTITY_IS_DISTRIBUTED_AT ENTITY_IS_MODIFIED_AT_LOCATION EVENT_CAUSES EVENT_HAS_RULE EVENT_INFLUENCES_BUSINESS_OBJECT EVENT_TRIGGERS FILE_IS_FORWARDED_TO_FILE FSDM_SCHEMA_HAS_FSDM_VALUE FSDM_VALUE_CLASSIFIES_FSDM_SCHEMA FUNCTION_INTERSECTS_WITH_ENTITY FUNCTION_IS_CARRIED_OUT_AT_LOCATION HAS_IDENTIFIER HAS_STATE IDENTIFIER_IS_COMPOSED_OF IMPLEMENTED_BY INITIATES_EVENT IS_COMPOSED_OF_ATTRIBUTE IS_RELATED_VIA IS_REPLACED_BY IS_TYPED_BY KEY_HAS_COLUMN LOGICAL_PROCESS_AFFECTS LOGICAL_PROCESS_IMPLEMENTED_BY MACHINE_CAN_ACCESS_MACHINE ORGANIZATION_SUPPORTS_ENTITY ORGANIZATION_SUPPORTS_FUNCTION ORGANIZATION_SUPPORTS_PROCESS OWNS_VIEW PROCESS_DEPENDS_ON_PROCESS PROCESS_IMPACTS_ENTITY PROCESS_IS_CARRIED_OUT_AT_LOCATION PROCESS_REFINES_INTO_PROCESS PROCESS_REPLACES_SYSTEM REFERS_TO REFINES_INTO RELATION_IS_RELATED_VIA_RELATION REPORT_CONTAINS_SECTION RESULTS_IN_STATE RULE_CONVERSES_REPORT RULE_DEPENDS_ON_RULE RULE_TRIGGERS_EVENT SERVER_CONTAINS_RULE SERVER_DERIVES_SERVER SYSTEM_AFFECTS_DATA_STORE TABLE_HAS_COLUMN TABLE_HAS_KEY TABLE_IS_BASED_ON_TABLE TABLE_REFERRED_BY_KEY TRIGGERS_LOGICAL_PROCESS USES_COMPONENT

5-12

TurboCycler Repository Types and Properties

Relationship Types and Properties

Table 5-49 Relationship Types and Properties (Continued)

IS_COMPOSED_OF_EVENT IS_COMPOSED_OF_LOGICAL_PROCESS IS_DEFINED_BY IS_DESCRIBED_BY IS_KEYED_BY IS_PRECONDITIONED_BY_STATE USES_RULE VIEW_INCLUDES WINDOW_CONTENT_HAS_HELP WINDOW_CONTENT_HAS_PANEL WINDOW_HAS_BITMAP531 WINDOW_HAS_WINDOW_CONTENT

ACCESSES
Table 5-50 Domain Values SEQUENCE_NUMBER

APPLICATION_CONFIGURATION_HAS_CONFIGURATION_UNIT
Table 5-51 Domain Values SEQUENCE_NUMBER

BITMAP_HAS_BITMAP_IMPLEMENTATION
Table 5-52 Domain Values SEQUENCE_NUMBER

BUSINESS_OBJECT_OWNS
Table 5-53 Domain Values SEQUENCE_NUMBER

BUSINESS_OBJECT_REFINES_INTO_BUSINESS_OBJECT
Table 5-54 Domain Values SEQUENCE_NUMBER

CELL_CONTAINS
Table 5-55 Domain Values APPLICATION_SERVER_FLAG MACHINE_IMPLEMENTATION_NAME NETWORK_ID COMMUNICATION_GATEWAY_FLAG MANAGER_FLAG SEQUENCE_NUMBER

COMPONENT_USES_COMPONENT
Table 5-56 Domain Values SEQUENCE_NUMBER

AppBuilder 2.1.0 Scripting Tools Reference Guide

5-13

Relationship Types and Properties

CONFIGURATION_UNIT_ENCAPSULATES
Table 5-57 Domain Values SEQUENCE_NUMBER

CONNECTS_TO
Table 5-58 Domain Values SEQUENCE_NUMBER

CONTAINS_VALUE
Table 5-59 Domain Values SEQUENCE_NUMBER SYMBOL

CONVERSES_WINDOW
Table 5-60 Domain Values SEQUENCE_NUMBER

DATABASE_HAS_TABLE
Table 5-61 Domain Values ACTIVATION_PERIOD: Duration AVE_INSERTS DONE_FLAG: Boolean MAXIMUM_ROWS SEQUENCE_NUMBER AVE_DELETES AVE_UPDATES DO_FLAG: Boolean MINIMUM_ROWS

DATATYPE_IS_COMPOSED_OF_DATATYPE
Table 5-62 Domain Values OCCURS SEQUENCE_NUMBER

DATATYPE_IS_CONSTRAINED_BY_SET
Table 5-63 Domain Values SEQUENCE_NUMBER

5-14

TurboCycler Repository Types and Properties

Relationship Types and Properties

DATA_STORE_IS_REPLACED_BY_ENTITY
Table 5-64 Domain Values COMMENTS SEQUENCE_NUMBER

DEPENDS_ON_LOGICAL_PROCESS
Table 5-65 Domain Values DEPENDS_ON_LOGICAL_PROCESS_DESCRIPTION SEQUENCE_NUMBER

ENTITY_IS_DISTRIBUTED_AT
Table 5-66 Domain Values COMMENTS PARTITIONED: Boolean REPLICATED: Boolean SUBSET: Boolean VARIANT: Boolean MASTER: Boolean REORGANIZED: Boolean SEQUENCE_NUMBER TELEPROC: Boolean

ENTITY_IS_MODIFIED_AT_LOCATION
Table 5-67 Domain Values COMMENTS DELETE: Boolean UPDATE: Boolean CREATE: Boolean READ: Boolean

EVENT_CAUSES
Table 5-68 Domain Values EVENT_CAUSES_DESCRIPTION SEQUENCE_NUMBER

EVENT_HAS_RULE
Table 5-69 Domain Values ACTION_HOST SEQUENCE_NUMBER ACTION_TYPE: ActionType VIEW_MAPPING

EVENT_INFLUENCES_BUSINESS_OBJECT
Table 5-70 Domain Values EVENT_INFLUENCES_BUSINESS_OBJECT_DESCRIPTION SEQUENCE_NUMBER

AppBuilder 2.1.0 Scripting Tools Reference Guide

5-15

Relationship Types and Properties

EVENT_TRIGGERS
Table 5-71 Domain Values EVENT_TRIGGERS_DESCRIPTION INCLUSIVE_FLAG: InclusiveFlag EXOR_SEQUENCE_NUMBER SEQUENCE_NUMBER

FILE_IS_FORWARDED_TO_FILE
Table 5-72 Domain Values DELETE_RULE SEQUENCE_NUMBER INSERT_RULE UPDATE_RULE

FSDM_SCHEMA_HAS_FSDM_VALUE
Table 5-73 Domain Values SEQUENCE_NUMBER

FSDM_VALUE_CLASSIFIES_FSDM_SCHEMA
Table 5-74 Domain Values SEQUENCE_NUMBER

FUNCTION_INTERSECTS_WITH_ENTITY
Table 5-75 Domain Values COMMENTS DELETE: Boolean SEQUENCE_NUMBER CREATE: Boolean READ: Boolean UPDATE: Boolean

FUNCTION_IS_CARRIED_OUT_AT_LOCATION
Table 5-76 Domain Values COMMENTS MINOR_INV: Boolean MAJOR_INV: Boolean SEQUENCE_NUMBER

HAS_IDENTIFIER
Table 5-77 Domain Values SEQUENCE_NUMBER

HAS_STATE
Table 5-78 Domain Values SEQUENCE_NUMBER

5-16

TurboCycler Repository Types and Properties

Relationship Types and Properties

IDENTIFIER_IS_COMPOSED_OF
Table 5-79 Domain Values SEQUENCE_NUMBER

IMPLEMENTED_BY
Table 5-80 Domain Values

SEQUENCE_NUMBER INITIATES_EVENT
Table 5-81 Domain Values INITIATES_EVENT_DESCRIPTION SEQUENCE_NUMBER

IS_COMPOSED_OF_ATTRIBUTE
Table 5-82 Domain Values OCCURS SEQUENCE_NUMBER

IS_COMPOSED_OF_EVENT
Table 5-83 Domain Values SEQUENCE_NUMBER

IS_COMPOSED_OF_LOGICAL_PROCESS
Table 5-84 Domain Values SEQUENCE_NUMBER

IS_DEFINED_BY
Table 5-85 Domain Values SEQUENCE_NUMBER

IS_DESCRIBED_BY
Table 5-86 Domain Values SEQUENCE_NUMBER OPTIONALITY: Boolean

IS_KEYED_BY
Table 5-87 Domain Values SEQUENCE_NUMBER TYPE: KeyType

AppBuilder 2.1.0 Scripting Tools Reference Guide

5-17

Relationship Types and Properties

IS_PRECONDITIONED_BY_STATE
Table 5-88 Domain Values IS_PRECONDITIONED_BY_STATE_DESCRIPTION SEQUENCE_NUMBER

IS_RELATED_VIA
Table 5-89 Domain Values ABSTRACT: Boolean CONTROLLING: Boolean MAXIMUM_CARDINALITY OPTIONALITY: Boolean SEQUENCE_NUMBER CARDINALITY: Cardinal DEPENDENT: Boolean MINIMUM_CARDINALITY ROLE

IS_REPLACED_BY
Table 5-90 Domain Values COMMENTS PLANNED: Boolean CURRENT: Boolean SEQUENCE_NUMBER

IS_TYPED_BY
Table 5-91 Domain Values SEQUENCE_NUMBER

KEY_HAS_COLUMN
Table 5-92 Domain Values SEQUENCE_NUMBER

LOGICAL_PROCESS_AFFECTS
Table 5-93 Domain Values COMMENTS DELETES: Boolean SEQUENCE_NUMBER CREATES: Boolean READS: Boolean UPDATES: Boolean

LOGICAL_PROCESS_IMPLEMENTED_BY
Table 5-94 Domain Values SEQUENCE_NUMBER

MACHINE_CAN_ACCESS_MACHINE
Table 5-95 Domain Values SEQUENCE_NUMBER

5-18

TurboCycler Repository Types and Properties

Relationship Types and Properties

ORGANIZATION_SUPPORTS_ENTITY
Table 5-96 Domain Values COMMENTS DELETE: Boolean SEQUENCE_NUMBER CREATE: Boolean READ: Boolean UPDATE: Boolean

ORGANIZATION_SUPPORTS_FUNCTION
Table 5-97 Domain Values COMMENTS MINOR_INVOLVEMENT: Boolean SEQUENCE_NUMBER MAJOR_INVOLVEMENT: Boolean RESPONSIBLE

ORGANIZATION_SUPPORTS_PROCESS
Table 5-98 Domain Values COMMENTS MINOR_INVOLVEMENT: Boolean SEQUENCE_NUMBER MAJOR_INVOLVEMENT: Boolean RESPONSIBLE: Boolean

OWNS_VIEW
Table 5-99 Domain Values SEQUENCE_NUMBER VIEW_USAGE: ViewUsage

PROCESS_DEPENDS_ON_PROCESS
Table 5-100 Domain Values PROCESS_DEPENDS_ON_PROCESS_DESCRIPTION INCLUSIVE_FLAG: InclusiveFlag EXOR_SEQUENCE_NUMBER SEQUENCE_NUMBER

PROCESS_IMPACTS_ENTITY
Table 5-101 Domain Values COMMENTS DELETE: Boolean SEQUENCE_NUMBER CREATE: Boolean READ: Boolean UPDATE: Boolean

PROCESS_IS_CARRIED_OUT_AT_LOCATION
Table 5-102 Domain Values COMMENTS MINOR_INVOLVEMENT: Boolean MAJOR_INVOLVEMENT: Boolean SEQUENCE_NUMBER

AppBuilder 2.1.0 Scripting Tools Reference Guide

5-19

Relationship Types and Properties

PROCESS_REFINES_INTO_PROCESS
Table 5-103 Domain Values CONDITIONAL_FLAG SEQUENCE_NUMBER

PROCESS_REPLACES_SYSTEM
Table 5-104 Domain Values SEQUENCE_NUMBER

REFERS_TO
Table 5-105 Domain Values SEQUENCE_NUMBER

REFINES_INTO
Table 5-106 SEQUENCE_NUMBER

RELATION_IS_RELATED_VIA_RELATION
Table 5-107 Domain Values SEQUENCE_NUMBER

REPORT_CONTAINS_SECTION
Table 5-108 Domain Values BREAK_FIELD LEFT_MARGIN PRINT_OPTIONS: PrintOpt SEQUENCE_NUMBER BREAK_QUALIFIER PAGE_PLACEMENT: PagePlace SECTION_TYPE: SectionType SEQUENCE_NUMBER_BREAK

RESULTS_IN_STATE
Table 5-109 Domain Values RESULTS_IN_STATE_DESCRIPTION SEQUENCE_NUMBER

RULE_CONVERSES_REPORT
Table 5-110 Domain Values SEQUENCE_NUMBER

5-20

TurboCycler Repository Types and Properties

Relationship Types and Properties

RULE_DEPENDS_ON_RULE
Table 5-111 Domain Values RULE_DEPENDS_ON_RULE_DESCRIPTION INCLUSIVE_FLAG EXOR_SEQUENCE_NUMBER SEQUENCE_NUMBER

RULE_TRIGGERS_EVENT
Table 5-112 Domain Values CONDITION TYPE: RuleTriggerType SEQUENCE_NUMBER VIEW_MAPPING

SERVER_CONTAINS_RULE
Table 5-113 Domain Values ENTRY_TYPE: EntryType SEQUENCE_NUMBER RULE_OBJ_NAME SERVICE_NAME

SERVER_DERIVES_SERVER
Table 5-114 Domain Values SEQUENCE_NUMBER

SYSTEM_AFFECTS_DATA_STORE
Table 5-115 Domain Values COMMENTS DELETE: Boolean SEQUENCE_NUMBER CREATE: Boolean READ: Boolean UPDATE: Boolean

TABLE_HAS_COLUMN
Table 5-116 Domain Values DISTINCT NULL_INDICATOR: Null DISTINCT_TYPE: DistinctType SEQUENCE_NUMBER

TABLE_HAS_KEY
Table 5-117 Domain Values SEQUENCE_NUMBER

TABLE_IS_BASED_ON_TABLE
Table 5-118 Domain Values SEQUENCE_NUMBER

AppBuilder 2.1.0 Scripting Tools Reference Guide

5-21

Relationship Types and Properties

TABLE_REFERRED_BY_KEY
Table 5-119 Domain Values REFERENTIAL_INTEGRITY: Boolean SEQUENCE_NUMBER

TRIGGERS_LOGICAL_PROCESS
Table 5-120 Domain Values TRIGGERS_LOGICAL_PROCESS_DESCRIPTION SEQUENCE_NUMBER

USES_COMPONENT
Table 5-121 Domain Values SEQUENCE_NUMBER

USES_RULE
Table 5-122 SEQUENCE_NUMBER

VIEW_INCLUDES
Table 5-123 Domain Values NULL_INDICATOR: NullInd SEQUENCE_NUMBER OCCURS

WINDOW_CONTENT_HAS_HELP
Table 5-124 Domain Values SEQUENCE_NUMBER

WINDOW_CONTENT_HAS_PANEL
Table 5-125 Domain Values SEQUENCE_NUMBER

WINDOW_HAS_BITMAP531
Table 5-126 Domain Values SEQUENCE_NUMBER

WINDOW_HAS_WINDOW_CONTENT
Table 5-127 Domain Values SEQUENCE_NUMBER

5-22

TurboCycler Repository Types and Properties

Property Domains

Property Domains
A property can have a set of values called a domain. Table 5-128 is a list of all the domains and the values of each domain listed alphabetically.
Table 5-128 Property Domains ActionType AttributeType BMPFormatType BmpType Boolean BusinessObjectType Cardinal ChildMenu CollectNature CompDBMSUsage CompExecEnv ComplexIndicator CountryLanguage531 CoordSys DBtypeKey DistinctType Drawing Duration EntityType EntryType ExecuteMode ExecutionMode FieldType FileType GUI HelpFmt531 IdentifierType Inclus_Flag IsolationMode KeyDeleteRule531 KeyType Language LogicalProcessMode LogicalProcessType Null NullInd OStype Orientation PagePlace PrinterType ProcessEnv Protocol ReportExecEnv RuleDBMSUsage RuleExecEnv RuleTriggerType SectionType ServerType SetStyle SetType SrvLinkType SrvStartType StateType Table_View ViewUsage

ActionType
Table 5-129 Domain Values CLIENT_ASYNC SERVER_NON_TRANSACTION SERVER_TRANSACTION CLIENT_POPUP SERVER_ASYNC

AppBuilder 2.1.0 Scripting Tools Reference Guide

5-23

Property Domains

AttributeType
Table 5-130 Domain Values DERIVED FUNDAMENTAL

BMPFormatType
Table 5-131 Domain Values BITMAP

BmpType
Table 5-132 Domain Values BITMAP ICON

Boolean
Table 5-133 Domain Values FALSE TRUE

BusinessObjectType
Table 5-134 Domain Values REFERENTIAL TRANSACTIONAL

Cardinal
Table 5-135 Domain Values MANY UNKNOWN ONE

ChildMenu
Table 5-136 Domain Values MENU_BAR PULL_DOWN NO_MENU

CollectNature
Table 5-137 Domain Values LOGICAL RELATIONAL PHYSICAL

5-24

TurboCycler Repository Types and Properties

Property Domains

CompDBMSUsage
Table 5-138 Domain Values DB2 NOT_APPLICABLE DLI

CompExecEnv
Table 5-139 Domain Values CICS IMS PC PC_USER CICS_BATCH MVS_BATCH PC_SYSTEM STRATUS

ComplexIndicator
Table 5-140 Domain Values AND REGULAR XOR IOR SUBTYPE

CountryLanguage531
Table 5-141 Domain Values US_ENGLISH UK_ENGLISH

CoordSys
Table 5-142 Domain Values CHARACTER PIXEL

DBtypeKey
Table 5-143 Domain Values FOREIGN PRIMARY INDEX

DistinctType
Table 5-144 Domain Values ABSOLUTE RATIO

AppBuilder 2.1.0 Scripting Tools Reference Guide

5-25

Property Domains

Drawing
Table 5-145 Domain Values DATABASE_DESIGN ENTITY_RELATIONSHIP ENTITY_VS_LOCATION_2 FUNCTION_VS_LOCATION ORGANIZATION_VS_ENTITY PROCESS_DEPENDENCY STATE_TRANSITION SYSTEM_VS_PROCESS DATA_STORE_VS_ENTITY ENTITY_VS_LOCATION_1 FUNCTION_VS_ENTITY MATRIX ORGANIZATION_VS_PROCESS PROCESS_VS_ENTITY SYSTEM_VS_DATA_STORE WINDOW_FLOW

5-26

TurboCycler Repository Types and Properties

Property Domains

Duration
Table 5-146 Domain Values DAY QUARTER YEAR MONTH WEEK

EntityType
Table 5-147 Domain Values ASSOCIATIVE INTERSECTION CHARACTERISTIC KERNEL

EntryType
Table 5-148 Domain Values PRIVATE PUBLIC

ExecuteMode
Table 5-149 Domain Values ASYNCHRONOUS SYNCHRONOUS

ExecutionMode
Table 5-150 Domain Values HAS_SUBROUTINE NO_SUBROUTINE

FieldType
Table 5-151 Domain Values CHARACTER DECIMAL IMAGE MIXED_CHARACTER TEXT TIMESTAMP DATE GRAPHIC_CHARACTER INTEGER PICTURE TIME VARCHAR

AppBuilder 2.1.0 Scripting Tools Reference Guide

5-27

Property Domains

FileType
Table 5-152 Domain Values DB2

GUI
Table 5-153 Domain Values 3270 OS2_PM PWS_GENERIC OPEN_LOOK OSF_MOTIF WINDOWS

HelpFmt531
Table 5-154 Domain Values IPF HPS RTF

IdentifierType
Table 5-155 Domain Values ALTERNATE PRIMARY CANDIDATE

Inclus_Flag
Table 5-156 Domain Values EXCLUSIVE REGULAR INCLUSIVE

IsolationMode
Table 5-157 Domain Values GET XDR-GET SET XDR-SET

KeyDeleteRule531
Table 5-158 Domain Values CASCADE RESTRICT NULL

5-28

TurboCycler Repository Types and Properties

Property Domains

KeyType
Table 5-159 Domain Values DELETE_KEY UPDATE_KEY

Language
Table 5-160 Domain Values ASSEMBLER COBOL C PLI

LogicalProcessMode
Table 5-161 Domain Values ACTION DECISION

LogicalProcessType
Table 5-162 Domain Values ASSOCIATE CAPTURE RETRIEVE VALIDATE CALCULATE DELETE UPDATE

Null
Table 5-163 Domain Values NOT_NULLS_WITH_DEFAULT NULLS_NOT_ALLOWED NULLS_ALLOWED

NullInd
Table 5-164 Domain Values NOT_NULLS_WITH_DEFAULT NULLS_NOT_ALLOWED NULLS_ALLOWED

OStype
Table 5-165 Domain Values AIX CICS_MVS HPUX OS/400 SUN_OS WINDOWS_NT CICS_6000 CICS_OS2 mainframe OS2 WINDOWS WIN_OS2

AppBuilder 2.1.0 Scripting Tools Reference Guide

5-29

Property Domains

Orientation
Table 5-166 Domain Values LANDSCAPE PORTRAIT

PagePlace
Table 5-167 Domain Values END_PAGE LAST_PAGE SAME_PAGE FIRST_PAGE NEXT_PAGE WHOLE_PAGE

PrinterType
Table 5-168 Domain Values 3800 GENERIC

ProcessEnv
Table 5-169 Domain Values CICS PC PC_AND_SYSTEM_88 SYSTEM_88 NOT_APPLICABLE PC_AND_CICS PC_SYSTEM_88_AND_CICS SYSTEM_88_AND_CICS

Protocol
Table 5-170 Domain Values LU2 NAMED_PIPES NOVELL_SPX UDP LU62 NETBIOS TCPIP

ReportExecEnv
Table 5-171 Domain Values BATCH CICS_BATCH CICS

RuleDBMSUsage
Table 5-172 Domain Values DB2 N/A

5-30

TurboCycler Repository Types and Properties

Property Domains

RuleExecEnv
Table 5-173 Domain Values CICS IMS LANDP_SERVER PC PC_AND_IMS CICS_AND_BATCH LANDP_FUNCTION MVS_BATCH PC_AND_CICS STRATUS

RuleTriggerType
Table 5-174 Domain Values POST PRE

SectionType
Table 5-175 Domain Values BREAK HEADER FOOTER REGULAR

ServerType
Table 5-176 Domain Values CICS ENCINA IMS ONC DCE HPS LANDP TUXEDO

SetStyle
Table 5-177 Domain Values DEFINE LOOKUP ERROR VALUES

SetType
Table 5-178 Domain Values CHARACTER GRAPHIC_CHAR MIXED_CHAR DECIMAL INTEGER

SrvLinkType
Table 5-179 Domain Values DYNAMIC STATIC

AppBuilder 2.1.0 Scripting Tools Reference Guide

5-31

Property Domains

SrvStartType
Table 5-180 Domain Values AUTOSTART FORKING

StateType
Table 5-181 Domain Values FINAL INTERMEDIATE INITIAL

Table_View
Table 5-182 Domain Values TABLE VIEW

ViewUsage
Table 5-183 Domain Values ALTERNATE DATA INPUT OUTPUT WORK CANDIDATE FOREIGN INPUT/OUTPUT PRIMARY

5-32

TurboCycler Repository Types and Properties

CHAPTER

TURBOCYCLER WINDOW CONTROLS

AppBuilder 2.1.0 Scripting Tools Reference Guide

Windows Controls provides instructions for coding window blocks and supplies the reference data to complete the window control definitions in Chapter 4, TurboCycler Template Language. Controls are the visual elements in a window that an end user can interact with. Window Statement Control Types Window Control Properties Property Types and Property Values Window Properties Matrix The TurboCycler template language lets you design a window by creating controls and arranging them in a window. In addition to controls, a window can have a menu bar with pull-down menus.

Creating Controls
When you create a control with a MAKE statement, you also set its properties. Controls generally require positioning properties such as LEFT, BOTTOM, WIDTH, and HEIGHT. Any property not explicitly set defaults to settings similar to those in Window Painter. Specify colors by either of two methods. The first is to set the RGB color value explicitly; the other is to set a property to a color listed under colortype. The first example uses the three RGB colors: MAKE STATIC_TEXT HAVING [ HPSID = ID_TEXT_1, BGCOLOR_RED = 255, BGCOLOR_GREEN = 0, BGCOLOR_BLUE = 0 ] ENDMAKE The second example uses an explicit color type definition that produces the same result. MAKE STATIC_TEXT HAVING [ HPSID = ID_TEXT_2, BGCOLOR = RED ] ENDMAKE

AppBuilder 2.1.0 Scripting Tools Reference Guide

6-1

Window Statement Control Types

However, you cannot use both methods to set the same color property. For example, you can set a controls background color with the three RGB properties BGCOLOR_RED, BGCOLOR_GREEN, and BGCOLOR_BLUE. Or you can set it with the single colortype property BGCOLOR. You must establish a relationship between a SPREADSHEET and its CELLs. First, create your spreadsheet with a MAKE statement, and then associate each of its cells with the spreadsheet through the CONTAIN statement, as shown next. MAKE SPREADSHEET Spreadsheet HAVING [BOTTOM = 40, LEFT = 20, HEIGHT = 155, WIDTH = 200, HPSID = ID_SPREADSHEET ] LINKED TO MyDataView ENDMAKE CONTAIN CELL IN Spreadsheet HAVING [WIDTH = CellWidth, HEIGHT = 22, HPSID = (QUERY NAME OF MyDataFields(I)), CONTROL_TEXT = (QUERY SCREEN_LITERAL OF MyDataFields(I)), IMMEDIATE_RETURN = TRUE ] LINKED TO MyDataFields(I) ENDCONTAIN You need the same relationship for LB_COLUMN (which must be in a LISTBOX) and CHART_X_AXIS and CHART_Y_AXIS (which must be in a CHART_WINDOW). Finally when TABSTOP is TRUE, the tabbing order for controls is the same order as they are created in the window block. The following pages list the window statements control types and their properties. Also see Table 6-42 on page 6-26 for a summary of all the control types and properties.

Window Statement Control Types

Window controls are the visual elements in a window that the end user interacts with. The window control types and their properties are described in this topic. Refer to Window Properties Matrix for a cross-referenced list of all window controls and properties. The window controls in TurboCycler are listed in Table 6-1.
Table 6-1 BITMAP CELL CHART_WINDOW CHART_X_AXIS CHART_Y_AXIS TurboCycler Window Controls GROUPBOX HOTSPOT LB_COLUMN LISTBOX MULTILINE_EDIT

6-2

TurboCycler Window Controls

Window Statement Control Types

Table 6-1

TurboCycler Window Controls (Continued) PROTECTED_EDIT_FIELD PUSH_BUTTON RADIO_BUTTON RECTANGLE SPREADSHEET STATIC_TEXT

CHECKBOX DROPDOWN_COMBOBOX DROPDOWN_LISTBOX EDIT_FIELD ELLIPSE FILE_EDITOR

BITMAP
A special type of static control that displays a bitmap from a file. It cannot be linked to a repository object. Its properties are:
Table 6-2 BOTTOM HEIGHT LEFT WIDTH BITMAP Control Properties FILE HPSID VISIBLE

CELL
Represents a column in a SPREADSHEET, and as such is not a visual control. The linked-to field must be in a multiply-occurring logical view. A CELL can be created only by a CONTAIN statement. Its properties are:
Table 6-3 CELL Properties FIELD_TEXT HEADER_BOTTOM HPSID JUSTIFICATION MAXIMUM PICTURE WIDTH

CHARFORMAT FIELD_TYPE HEIGHT IMMEDIATE_RETURN MANDATORY MINIMUM CONTROL_TEXT

CHART_WINDOW
Displays data graphically in one of 13 different formats. End users cannot tab to a chart. The CHART_WINDOW must be linked to a multiply-occurring view. Data to be displayed is specified by creating CHART_X_AXIS and CHART_Y_AXIS controls using the CONTAIN statement. A window can contain no more than ten CHART_WINDOW controls. Its properties are:
Table 6-4 BOTTOM FOOTING FOOTING_COLOR_RED CHART_WINDOW Properties CHART_TYPE FOOTING_COLOR FOOTING_COLOR_GREEN

AppBuilder 2.1.0 Scripting Tools Reference Guide

6-3

Window Statement Control Types

Table 6-4

CHART_WINDOW Properties (Continued) HEADING HEADING_COLOR_RED HEADING_COLOR_BLUE HPSID LEFTLABEL LEFTLABEL_COLOR_RED LEFTLABEL_COLOR_GREEN MINIMIZE RIGHTLABEL RIGHTLABEL_COLOR_RED RIGHTLABEL_COLOR_BLUE WIDTH

FOOTING_COLOR_BLUE HEADING_COLOR HEADING_COLOR_GREEN HEIGHT LEFT LEFTLABEL_COLOR LEFTLABEL_COLOR_BLUE MAXIMIZE RESIZE RIGHTLABEL_COLOR RIGHTLABEL_COLOR_GREEN CONTROL_TEXT

CHART_X_AXIS
Represents an x-axis variable in a CHART_WINDOW, and thus is not really a visual control. This control must be created with the CONTAIN statement. The linked-to field must be in a multiply-occurring view and can be of any type. Only one CHART_X_AXIS control is created per CHART_WINDOW. Its property is:
Table 6-5 HPSID CHART_X_AXIS Properties

CHART_Y_AXIS
Represents a y-axis variable in a CHART_WINDOW, and thus is not really a visual control. This control must be created with the CONTAIN statement. The linked-to field must be in a multiply-occurring view and must be of numeric type. A CHART_WINDOW can contain up to eight CHART_Y_AXIS controls. Its properties are;
Table 6-6 HPSID CHART_y_AXIS Properties LEGEND

CHECKBOX
A toggle switch you can use when its setting is independent of any other control. The linked-to field type is character, and its length must be one. You can specify a mnemonic key with the CONTROL_TEXT property. Its properties are:
Table 6-7 BDCOLOR BDCOLOR_GREEN BGCOLOR BGCOLOR_GREEN CONTROL_TEXT Properties BDCOLOR_RED BDCOLOR_BLUE BGCOLOR_RED BGCOLOR_BLUE

6-4

TurboCycler Window Controls

Window Statement Control Types

Table 6-7 BOTTOM

CONTROL_TEXT Properties (Continued) FGCOLOR FGCOLOR_GREEN FONT HEIGHT IMMEDIATE_RETURN TABSTOP VISIBLE

FGCOLOR_RED FGCOLOR_BLUE GROUPSTART HPSID LEFT CONTROL_TEXT WIDTH

DROPDOWN_COMBOBOX
Combines an EDIT_FIELD and a LISTBOX. The user can enter a value in the control or select a value from a scrollable list. The linked-to field must have its Reference Table Name attribute set to the System ID of the online validation set associated with the field entity in the hierarchy. Its properties are:
Table 6-8 BDCOLOR BDCOLOR_GREEN BGCOLOR BGCOLOR_GREEN BOTTOM FGCOLOR_RED FGCOLOR_BLUE FONT HEIGHT IMMEDIATE_RETURN MANDATORY VISIBLE DROPDOWN_COMBOBOX Properties BDCOLOR_RED BDCOLOR_BLUE BGCOLOR_RED BGCOLOR_BLUE FGCOLOR FGCOLOR_GREEN FILE GROUPSTART HPSID LEFT TABSTOP WIDTH

DROPDOWN_LISTBOX
Behaves like the DROPDOWN_COMBOBOX except that the user can enter values only from the set referenced by the Reference Table Name attribute of the linked-to field. Its properties are:
Table 6-9 BDCOLOR BDCOLOR_GREEN BGCOLOR BGCOLOR_GREEN BOTTOM FGCOLOR_RED FGCOLOR_BLUE FONT DROPDOWN_LISTBOX Properties BDCOLOR_RED BDCOLOR_BLUE BGCOLOR_RED BGCOLOR_BLUE FGCOLOR FGCOLOR_GREEN FILE GROUPSTART

AppBuilder 2.1.0 Scripting Tools Reference Guide

6-5

Window Statement Control Types

Table 6-9 HEIGHT

DROPDOWN_LISTBOX Properties (Continued) HPSID LEFT TABSTOP WIDTH

IMMEDIATE_RETURN MANDATORY VISIBLE

EDIT_FIELD
Defines an entry field in which the end user can enter and edit data associated with the linked-to field, which can be a single occurrence field of any type except TIMESTAMP. Its properties are:
Table 6-10 EDIT_FIELD Properties BDCOLOR BDCOLOR_GREEN BGCOLOR BGCOLOR_GREEN BOTTOM FGCOLOR FGCOLOR_GREEN FONT HEIGHT IMMEDIATE_RETURN LEFT MAXIMUM PICTURE VISIBLE BDCOLOR_RED BDCOLOR_BLUE BGCOLOR_RED BGCOLOR_BLUE CHARFORMAT FGCOLOR_RED FGCOLOR_BLUE GROUPSTART HPSID JUSTIFICATION MANDATORY MINIMUM TABSTOP WIDTH

ELLIPSE
A special type of static control that displays a filled ellipse in the window. It cannot be linked to a repository object. Its properties are:
Table 6-11 ELLIPSE Properties BLUE COLOR HEIGHT LEFT WIDTH BOTTOM GREEN HPSID RED

FILE_EDITOR
Allows end users to view, but not edit, the contents of a text file. The linked-to field must be of type character or variable character and must contain the complete path name of the file to display at run time. Its properties are:

6-6

TurboCycler Window Controls

Window Statement Control Types

Table 6-12 FILE_EDITOR Properties BDCOLOR BDCOLOR_GREEN BGCOLOR BGCOLOR_GREEN BOTTOM FGCOLOR_RED FGCOLOR_BLUE GROUPSTART HPSID TABSTOP WIDTH BDCOLOR_RED BDCOLOR_BLUE BGCOLOR_RED BGCOLOR_BLUE FGCOLOR FGCOLOR_GREEN FONT HEIGHT LEFT VISIBLE WORDWRAP

GROUPBOX
Associates related controls, usually RADIO_BUTTONs. Within the group, the end user can use the arrow keys rather than Tab to navigate among controls. A GROUPBOX cannot be linked to a repository object. Its properties are:
Table 6-13 GROUPBOX Properties BOTTOM FGCOLOR FGCOLOR_GREEN FONT HPSID VISIBLE CONTROL_TEXT FGCOLOR_RED FGCOLOR_BLUE HEIGHT LEFT WIDTH

HOTSPOT
Behaves like a PUSH_BUTTON but is not displayed at run time. Usually a HOTSPOT is positioned behind a BITMAP to create what appears to end users as a bitmap push button. Like a PUSH_BUTTON, a HOTSPOT cannot be linked to a repository object. Its properties are:
Table 6-14 HOTSPOT Properties BOTTOM HPSID WIDTH HEIGHT LEFT

LB_COLUMN
Represents a column in a LISTBOX, and thus is not really a visual control. The linked-to field must be in a multiply-occurring logical view. You must create one LB_COLUMN for each LISTBOX using the CONTAIN statement. Its properties are:

AppBuilder 2.1.0 Scripting Tools Reference Guide

6-7

Window Statement Control Types

Table 6-15 LB_COLUMN Properties CHARFORMAT MAXIMUM PICTURE JUSTIFICATION MINIMUM

LISTBOX
Displays a list of choices in a vertically scrolling window. A LISTBOX is linked to a multiply-occurring view. The field entity is specified by creating a LB_COLUMN in a CONTAIN statement. Its properties are:
Table 6-16 LISTBOX Properties AUTO_CALL BDCOLOR_RED BDCOLOR_BLUE BGCOLOR_RED BGCOLOR_BLUE FGCOLOR FGCOLOR_GREEN FONT HEIGHT IMMEDIATE_RETURN SELECT_MODE VISIBLE BDCOLOR BDCOLOR_GREEN BGCOLOR BGCOLOR_GREEN BOTTOM FGCOLOR_RED FGCOLOR_BLUE GROUPSTART HPSID LEFT TABSTOP WIDTH

MULTILINE_EDIT
Defines an entry field in which the user can enter text on multiple lines. The linked-to field must be of the type character or variable character. Its properties are:
Table 6-17 MULTILINE_EDIT Properties BDCOLOR BDCOLOR_GREEN BGCOLOR BGCOLOR_GREEN BOTTOM FGCOLOR_RED FGCOLOR_BLUE GROUPSTART HPSID LEFT READ_ONLY VISIBLE WORDWRAP BDCOLOR_RED BDCOLOR_BLUE BGCOLOR_RED BGCOLOR_BLUE FGCOLOR FGCOLOR_GREEN FONT HEIGHT IMMEDIATE_RETURN MANDATORY TABSTOP WIDTH

6-8

TurboCycler Window Controls

Window Statement Control Types

PROTECTED_EDIT_FIELD
Behaves like an EDIT_FIELD except that the end user cannot edit the displayed data. Its properties are:
Table 6-18 PROTECTED_EDIT_FIELD Properties BDCOLOR BDCOLOR_GREEN BGCOLOR BGCOLOR_GREEN BOTTOM FGCOLOR FGCOLOR_GREEN FONT HEIGHT IMMEDIATE_RETURN LEFT MINIMUM TABSTOP WIDTH BDCOLOR_RED BDCOLOR_BLUE BGCOLOR_RED BGCOLOR_BLUE CHARFORMAT FGCOLOR_RED FGCOLOR_BLUE GROUPSTART HPSID JUSTIFICATION MAXIMUM PICTURE VISIBLE

PUSH_BUTTON
Usually completes an end users interaction with the window. When the end user selects a PUSH_BUTTON, its HPSID is returned to the invoking rule. You cannot link a PUSH_BUTTON to a repository object. There are two methods used to associate push buttons with shortcut keys: Specify the key as an ASCII character using the ASCII_KEY property Use the function keys listed under the funckeytype property domain with the FUNC_KEY property. You cannot mix the methods. Do not specify the same button with both methods. However, you can use one method for one button and the other method for a different button. You can also set the MODIFIER property to require that the Ctrl, Alt, or Shift key be pressed simultaneously with the ASCII_KEY or FUNC_KEY property. For Window Painter compatibility, you must set MODIFIER to CTRL if the shortcut is an ASCII_KEY. You can use only one modifier, so, for example, attempting to combine the Ctrl+Tab keys is an error. You can specify a PUSH_BUTTON mnemonic by the CONTROL_TEXT property. The PUSH_BUTTON properties are listed in Table 6-19.
Table 6-19 PUSH_BUTTON Properties ASCII_KEY BDCOLOR BDCOLOR_BLUE BDCOLOR_GREEN BDCOLOR_RED FGCOLOR_GREEN FGCOLOR_RED FONT FUNC_KEY GROUPSTART

AppBuilder 2.1.0 Scripting Tools Reference Guide

6-9

Window Statement Control Types

Table 6-19 PUSH_BUTTON Properties (Continued) BGCOLOR BGCOLOR_BLUE BGCOLOR_GREEN BGCOLOR_RED BOTTOM CONTROL_TEXT FGCOLOR FGCOLOR_BLUE HEIGHT HPSID LEFT MODIFIER TABSTOP VISIBLE WIDTH

RADIO_BUTTON
A toggle switch that indicates one of a mutually exclusive set of choices. The linked-to field has type character and a length sufficient to hold the longest HPSID of the RADIO_BUTTONs in the group. You can specify a mnemonic key with the CONTROL_TEXT property. Its properties are listed in Table 6-20.
Table 6-20 RADIO_BUTTON Properties BDCOLOR BDCOLOR_BLUE BDCOLOR_GREEN BDCOLOR_RED BGCOLOR BGCOLOR_BLUE BGCOLOR_GREEN BGCOLOR_RED BOTTOM CONTROL_TEXT FGCOLOR FGCOLOR_BLUE FGCOLOR_GREEN FGCOLOR_RED FONT GROUPSTART HEIGHT HPSID IMMEDIATE_RETURN LEFT TABSTOP VISIBLE WIDTH

RECTANGLE
A special type of static control that displays a filled rectangle on the window. It cannot be linked to a repository object. Its properties are listed in Table 6-21.
Table 6-21 RECTANGLE Properties BLUE BOTTOM COLOR GREEN HEIGHT HPSID LEFT RED WIDTH

6-10

TurboCycler Window Controls

Window Statement Control Types

SPREADSHEET
Contains columns that represent linked fields and rows that represent each field occurrence. The end user can edit cells thus formed. The SPREADSHEET must be linked to a multiply-occurring logical view. Specify the fields displayed in each column by creating a CELL control using the CONTAIN statement for each field. This control only supports the following fonts: SYSTEMFONT8, SWISS8, ROMAN8, MODERN8, MODERN10, and MODERN12. Its properties are listed in Table 6-22.
Table 6-22 SPREADSHEET Properties AUTO_CALL AUTO_SELECT BDCOLOR BDCOLOR_BLUE BDCOLOR_GREEN BDCOLOR_RED BGCOLOR BGCOLOR_BLUE BGCOLOR_GREEN BGCOLOR_RED BOTTOM CELL_HEIGHT DRAW_LINES FGCOLOR FGCOLOR_BLUE FGCOLOR_GREEN FGCOLOR_RED FONT GROUPSTART HEADER_HEIGHT HEADER_HPSID HEIGHT HPSID LEFT NUMBERING_RECORD ROW_SELECT SCROLL_LOCK SELECT_MODE TABSTOP VISIBLE WIDTH

STATIC_TEXT
Displays labels or instructions. A STATIC_TEXT cannot be linked to a repository object. Its properties are listed in Table 6-23.
Table 6-23 STATIC_TEXT Properties BDCOLOR BDCOLOR_BLUE BDCOLOR_GREEN BDCOLOR_RED BGCOLOR BGCOLOR_BLUE BGCOLOR_GREEN BGCOLOR_RED BOTTOM CONTROL_TEXT FGCOLOR FGCOLOR_BLUE FGCOLOR_GREEN FGCOLOR_RED FONT HEIGHT HPSID LEFT VISIBLE WIDTH

AppBuilder 2.1.0 Scripting Tools Reference Guide

6-11

Window Control Properties

Window Control Properties

Table 6-24 lists all the properties and the property types for window block controls. The linked subtopics describe each property in alphabetical order. Refer to Property Types and Property Values for more details. For a cross-referenced chart of all window controls and properties, refer to the Window Properties Matrix. The window control properties in TurboCycler are listed in Table 6-24.
Table 6-24 Window Control Properties A B C-D-E F G-H I-J-K-L M-N-O PICTURE string R S through Z

A
ASCII_KEY string

Specifies an ASCII character to be used as the shortcut key for a control. If you specify ASCII_KEY, set MODIFIER to CTRL. (Refer to MODIFIER on page 6-19 and FUNC_KEY on page 6-16.)

AUTO_CALL

boolean

If AUTO_CALL is TRUE for a LISTBOX or SPREADSHEET, control returns to the invoking rule when the end user tries to scroll beyond the first or last occurrence defined in the view data structure associated with the list box. The rule can then retrieve more data. Set AUTO_CALL only if you do not use the component SET_VIRTUAL_LISTBOX_SIZE described in the AppBuilder documentation for your system.

AUTO_SELECT

boolean

If AUTO_SELECT is TRUE, the end user can select an item in a SPREADSHEET by putting the cursor on it. Any selected item is deselected. If AUTO_SELECT is FALSE, the end user can move the cursor without changing the selection. AUTO_SELECT does not apply when SELECT_MODE is set to MULTIPLE. (See SELECT_MODE on page 6-22.)

B
BDCOLOR colortype

Sets the border color of the control to one of the colors listed for colortype.

6-12

TurboCycler Window Controls

Window Control Properties

BDCOLOR_RED

integer

Sets the border color RGB red value. Assign an integer value between 0 and 255.

BDCOLOR_GREEN

integer

Sets the border color RGB green value. Assign an integer value between 0 and 255.

BDCOLOR_BLUE

integer

Sets the border color RGB blue value. Assign an integer value between 0 and 255.

BGCOLOR

colortype

Sets the background color of the control to one of the colors listed for colortype.

BGCOLOR_RED

integer

Sets the background color RGB red value. Assign an integer value between 0 and 255.

BGCOLOR_GREEN

integer

Sets the background color RGB green value. Assign an integer value between 0 and 255.

BGCOLOR_BLUE

integer

Sets the background color RGB blue value. Assign an integer value between 0 and 255.

BLUE

integer

Sets the control color RGB blue value. Assign an integer value between 0 and 255.

BOTTOM

integer

Sets the vertical position of the bottom edge of the control.

C-D-E
CELL_HEIGHT
Sets the vertical size of a CELL in a SPREADSHEET.

integer

AppBuilder 2.1.0 Scripting Tools Reference Guide

6-13

Window Control Properties

CHARFORMAT
Sets the case of text in the control.

charformattype

CHART_TYPE

charttype

Sets the type of chart displayed in a CHART_WINDOW control to one to the types listed under charttype.

CHECK_MANDATORY_FIELDS

boolean

If TRUE, all controls that have their MANDATORY property set to TRUE must contain valid entries when the end user selects the PUSH_BUTTON. If a control does not contain a valid entry, a message box is displayed and the first control containing an invalid entry receives the input focus. (See MANDATORY on page 6-18.)

COLOR

colortype

Sets the control color to one of the colors listed for colortype.

CONTROL_TEXT

string

Specifies the label that appears on CELL, CHART_WINDOW, CHECKBOX, GROUPBOX, PUSH_BUTTON, RADIO_BUTTON, or STATIC_TEXT controls. To define a mnemonic key, precede the character with an ampersand (&) or a tilde (~).

DRAW_LINES

drawlinestype

Determines whether a SPREADSHEET is displayed with horizontal and vertical lines, horizontal lines only, vertical lines only, or no lines at all.

F
FGCOLOR colortype

Sets the foreground color of the control to one of the colors listed for colortype.

FGCOLOR_RED

integer

Sets the foreground color RGB red value. Assign an integer value between 0 and 255.

FGCOLOR_GREEN

integer

Sets the foreground color RGB green value. Assign an integer value between 0 and 255.

6-14

TurboCycler Window Controls

Window Control Properties

FGCOLOR_BLUE

integer

Sets the foreground color RGB blue value. Assign an integer value between 0 and 255.

FIELD_TEXT

string

If the FIELD_TYPE property of a CELL were CONTROL_TEXT, specifies the text to be displayed. If the FIELD_TYPE is not CONTROL_TEXT, do not set this property.

FIELD_TYPE

fieldtype

Specifies the type of field displayed in a CELL: text, edit, or protected edit.

FILE

string

For a BITMAP, identifies the bit map file associated with the control; for a DROPDOWN_COMBOBOX, specifies the Reference Table Name of the field entity linked to the DROPDOWN_COMBOBOX with a .REF extension. The Reference Table Name attribute should be the system ID of the online validation set associated with the field entity in the hierarchy.

FONT

fonttype

Sets the font of labels and input text. Use the default font where possible to make the windows device independent. Not all controls support all fonts. Note that selecting a font can cause the HEIGHT property to be ignored for EDIT_FIELD, PROTECTED_EDIT_FIELD, RADIO_BUTTON, and CHECKBOX controls.

FOOTING

string

Sets the footing text displayed in a CHART_WINDOW.

FOOTING_COLOR

colortype

Sets the color of the FOOTING text displayed in a CHART_WINDOW.

FOOTING_COLOR_RED

integer

Sets the RGB color red value of the FOOTING text displayed in a CHART_WINDOW. Assign an integer value between 0 and 255.

FOOTING_COLOR_GREEN

integer

Sets the RGB color green value of the FOOTING text displayed in a CHART_WINDOW. Assign an integer value between 0 and 255.

AppBuilder 2.1.0 Scripting Tools Reference Guide

6-15

Window Control Properties

FOOTING_COLOR_BLUE

integer

Sets the RGB color blue value of the FOOTING text displayed in a CHART_WINDOW. Assign an integer value between 0 and 255.

FUNC_KEY

funckeytype

Sets the function key to be used as a shortcut key for the control. (See ASCII_KEY on page 6-12.)

G-H
GREEN integer

Sets the control color RGB green value. Assign an integer value in the range of 0 to 255.

GROUPSTART

boolean

If TRUE, specifies that the control starts a group. Do not set this property for other controls in the group. Create all controls in the group in sequence so that the tab order will be correct.

HEADER_BOTTOM

integer

Specifies the vertical position of the column headings in a SPREADSHEET control.

HEADER_HEIGHT

integer

Specifies the height of the column headings in a SPREADSHEET control.

HEADER_HPSID

string

Specifies the HPSID for static text in a multicolumn list box header.

HEADING
Sets heading text displayed in a CHART_WINDOW.

string

HEADING_COLOR

colortype

Sets the color of the HEADING text displayed in a CHART_WINDOW.

6-16

TurboCycler Window Controls

Window Control Properties

HEADING_COLOR_RED

integer

Sets the RGB color red value of the HEADING text displayed in a CHART_WINDOW. Assign an integer value between 0 and 255.

HEADING_COLOR_GREEN

integer

Sets the RGB color green value of the HEADING text displayed in a CHART_WINDOW. Assign an integer value between 0 and 255.

HEADING_COLOR_BLUE

integer

Sets the RGB color blue value of the HEADING text displayed in a CHART_WINDOW. Assign an integer value between 0 and 255.

HEIGHT
Sets the vertical size of the control.

integer

HPSID

string

Contains the text that uniquely identifies the control to the system. Every HPSID must be unique for the generated application to work correctly at run time.

I-J-K-L
IMMEDIATE_RETURN boolean

If TRUE, returns control to the invoking rule when the end user navigates away from the control. For a read-only control, double-clicking on the control returns program control to the invoking rule.

JUSTIFICATION

justificationtype

Causes control text to be right justified, left justified, or centered. This property applies to all the field types: text, numeric, date, and time.

LEFT
Sets the horizontal position of the control.

integer

LEFTLABEL

string

Sets the text displayed on the left side of a CHART_WINDOW.

AppBuilder 2.1.0 Scripting Tools Reference Guide

6-17

Window Control Properties

LEFTLABEL_COLOR

colortype

Sets the color of the LEFTLABEL text displayed in a CHART_WINDOW.

LEFTLABEL_COLOR_RED

integer

Sets the RGB color red value of the LEFTLABEL text displayed in a CHART_WINDOW. Assign an integer value between 0 and 255.

LEFTLABEL_COLOR_GREEN

integer

Sets the RGB color green value of the LEFTLABEL text displayed in a CHART_WINDOW. Assign an integer value between 0 and 255.

LEFTLABEL_COLOR_BLUE

integer

Sets the RGB color blue value of the LEFTLABEL text displayed in a CHART_WINDOW. Assign an integer value between 0 and 255.

LEGEND

string

Specifies the legend label for a CHART_Y_AXIS control in a CHART_WINDOW.

M-N-O
MANDATORY boolean

If TRUE, requires that the control contain valid input when the end user selects a PUSH_BUTTON having CHECK_MANDATORY_FIELDS set to TRUE. (See CHECK_MANDATORY_FIELDS on page 6-14.)

MAXIMIZE

boolean

If TRUE, a maximize arrow appears on the window of a CHART_WINDOW.

MAXIMUM
Sets the maximum value allowed for numeric fields.

decimal

MINIMIZE

boolean

If TRUE, a minimize arrow appears on the window of a CHART_WINDOW.

6-18

TurboCycler Window Controls

Window Control Properties

MINIMUM
Sets the minimum value allowed for numeric fields.

decimal

MODIFIER

modifiertype

Specifies that the Ctrl, Alt, or Shift keys must be pressed with a FUNC_KEY or ASCII_KEY to activate a shortcut key for a control. You can use only one modifier. For a ASCII_KEY, set the MODIFIER to CTRL. (See ASCII_KEY on page 6-12 and FUNC_KEY on page 6-16.)

NUMBERING_RECORD

boolean

When TRUE, the rows of a SPREADSHEET control are numbered on the left side of the control.

PICTURE

string

Sets the display format of fields. The string consists of literal text and format specifiers that control the appearance of date, time, and numeric fields, as shown in Table 6-25 through Table 6-29. For the date and time fields, the picture can combine literal text with the specifiers, as shown in Table 6-26 and Table 6-28.
Table 6-25 Date Specifiers Specifier %c %D %d %j %M %m %W %Y %y Description Century Day of the month, with suffix Day of the month Julian day Month of the year, text Month of the year Day of the week, text Year Years since 1900

Table 6-26 Standard Date Formats Date %m/%d/%y %0m/%0d/%0y %m-%d %m-%y %0c%0y%0m%0d %W, %M %D, %Y Today is %W. %d/%m/%y %0d/%0m/%y %d-%m Example 1/5/95 01/05/95 1-5 1-95 19950105 Thursday, January 5th, 1995 Today is Thursday 1/5/95 01/05/95 5-1

AppBuilder 2.1.0 Scripting Tools Reference Guide

6-19

Window Control Properties

Table 6-26 Standard Date Formats (Continued) Date %j %c Example 5 19

For time fields, the picture can contain literal text alone and in combination with the specifiers, as shown in Table 6-27 and Table 6-28.
Table 6-27 Time Format Specifiers Specifier %H %h %M %m %s %t %x Description Hour, text (24-hour clock) Hour (12-hour clock) Minutes, text Minutes Seconds Hour (24-hour clock) AM/PM indicator

Table 6-28 Standard Time Formats Time display picture %0h:%0m:%0s %x %0h:%0m:%0s %h-%m-%s %x %t-%m-%s %h %x %H %M Time is %H The time is %h-%m-%s %x. Example 01:22:03 PM 13:22:03 1-22-3 PM 13-22-3 1 PM Thirteen Twenty_Two Time is Thirteen The time is 1-22-3 PM.

For numeric fields, valid replacement characters are: 9 . , $ Z * S + - cr db, as shown in Table 6-29. The country setting determines the replacement of the characters: . , $ S.
Table 6-29 Numeric and Replacement Characters Character 9 . , $ Z * S + cr db Description Numeric character Decimal separator Thousands separator Currency symbol Suppress leading zeroes Pad left with asterisks Sign character Sign character, printed only if positive Sign character, printed only if negative Credit symbol, printed only if negative Debit symbol, printed only if negative

6-20

TurboCycler Window Controls

Window Control Properties

R
READ_ONLY boolean

If TRUE, the end user cannot change the text in the control.

RED

integer

Sets the control color RGB red value. Assign an integer value between 0 and 255.

RESIZE

boolean

If TRUE, end users can grab the border of a CHART_WINDOW to resize the chart.

RIGHTLABEL

string

Sets the text displayed on the right side of a CHART_WINDOW.

RIGHTLABEL_COLOR

colortype

Sets the color of the RIGHTLABEL text displayed in a CHART_WINDOW.

RIGHTLABEL_COLOR_RED

integer

Sets the RGB color red value of the RIGHTLABEL text displayed in a CHART_WINDOW. Assign an integer value between 0 and 255.

RIGHTLABEL_COLOR_GREEN

integer

Sets the RGB color green value of the RIGHTLABEL text displayed in a CHART_WINDOW. Assign an integer value between 0 and 255.

RIGHTLABEL_COLOR_BLUE

integer

Sets the RGB color blue value of the RIGHTLABEL text displayed in a CHART_WINDOW. Assign an integer value between 0 and 255.

ROW_SELECT

boolean

If TRUE, the end user can select an entire row in a SPREADSHEET by clicking a cell in a row. Otherwise, only the clicked-on cell is selected.

AppBuilder 2.1.0 Scripting Tools Reference Guide

6-21

Window Control Properties

S through Z
SCROLL_LOCK boolean

If TRUE, the end user can tab to the next row in a SPREADSHEET when reaching the end of the current row; also, the end user must press Ctrl+Tab to shift the input focus to the next control in the window. If FALSE, the end users tabbing at the end of a row shifts the input focus to the next control in the window.

SELECT_MODE

selectmodetype

Specifies in a SPREADSHEET whether the end user can select only one item (SINGLE), zero or more items (MULTIPLE), or one or more items (EXTENDED).

TABSTOP

boolean

If TRUE, the end user can tab to the control. The order that you specify objects in the window block determines the tabbing order of window controls in the completed window.

VISIBLE
If TRUE, the control is visible to the end user.

boolean

WIDTH

integer

Sets the horizontal width of the control. For a CELL, this is the width of the column in the SPREADSHEET.

WORDWRAP

boolean

If TRUE, automatically wraps text displayed in a MULTILINE_EDIT to a new line, based on the size of the control. If FALSE, the end user must scroll horizontally to see hidden text.

6-22

TurboCycler Window Controls

Property Types and Property Values

Property Types and Property Values

This section details the contents of each of the window block properties in TurboCycler, as listed in Table 6-30. The supported values for each property type are listed in the tables under each subheading. Refer to Window Control Properties for cross-reference of support for properties and controls.
Table 6-30 Window Block Property Types boolean charformattype charttype colortype drawlinestype fieldtype fonttype funckeytype justificationtype modifiertype selectmodetype

boolean
Table 6-31 boolean Property Types FALSE NO TRUE YES 0 false no true yes 1

charformattype
Table 6-32 charformattype Property Types ALLFIRSTUPPER LOWER FIRSTUPPER UPPER

charttype
Table 6-33 charttype Property Types AREACHART2D BARCHART2D BARLINECHART2D CANDLE2D COLUMNCHART3D LINECHART2D PERBARCHART3D PIECHART3D SMOOTHLINECHART2D STACKEDBARCHART2D AREACHART3D BARCHART3D BARLINECHART3D COLUMNCHART2D HILOCLOSE2D LINECHART3D PIECHART2D POINTANDFIG2D SCATTERCHART2D STACKEDBARCHART3D

AppBuilder 2.1.0 Scripting Tools Reference Guide

6-23

Property Types and Property Values

colortype
Table 6-34 colortype Property Types BLACK BROWN DARK_BLUE DARK_GRAY DARK_MAGENTA DARK_YELLOW GREEN PINK WHITE BLUE CYAN DARK_CYAN DARK_GREEN DARK_RED GRAY MAGENTA RED YELLOW

drawlinestype
Table 6-35 drawslinestype Properties HLINES VHLINES NOLINES VLINES

fieldtype
Table 6-36 fieldtype Properties EDIT CONTROL_TEXT PROTECTED

fonttype
Table 6-37 fonttype Properties MODERN8 MODERN12 ROMAN10 ROMAN14 ROMAN24 SWISS10 SWISS14 SWISS24 MODERN10 ROMAN8 ROMAN12 ROMAN18 SWISS8 SWISS12 SWISS18 SYSTEMFONT8

6-24

TurboCycler Window Controls

Property Types and Property Values

funckeytype
Table 6-38 funckeytype Properties F1 F3 F5 F7 F9 F11 F2 F4 F6 F8 F10 F12

justificationtype
Table 6-39 justificationtype Properties CENTER RIGHT LEFT

modifiertype
Table 6-40 modifiertype Properties ALT SHIFT CTRL

AppBuilder 2.1.0 Scripting Tools Reference Guide

6-25

Window Properties Matrix

selectmodetype
Table 6-41 EXTENDED SINGLE MULTIPLE

Window Properties Matrix

Table 6-42 provides a comprehensive matrix indicating supported properties and controls for windows
Table 6-42 Window Properties Controls: STATIC_TEXT SPREADSHEET RECTANGLE RADIO_BUTTON PUSH_BUTTON PROTECTED_EDIT_FIELD MULTILINE_EDIT LISTBOX LB_COLUMN HOTSPOT GROUPBOX FILE_EDITOR ELLIPSE EDIT_FIELD DROPDOWN_LISTBOX DROPDOWN_COMBOBOX CHECKBOX CHART_Y_AXIS CHART_X_AXIS CHART_WINDOW CELL BITMAP

Properties AUTO_CALL AUTO_SELECT BDCOLOR BDCOLOR_RED BDCOLOR_GREEN BDCOLOR_BLUE BGCOLOR BGCOLOR_RED BGCOLOR_GREEN BGCOLOR_BLUE BLUE BOTTOM CELL_HEIGHT CHARFORMAT CHART_TYPE CHECK_MANDATORY_FIELDS COLOR DRAW_LINES FGCOLOR FGCOLOR_RED FGCOLOR_GREEN FGCOLOR_BLUE FIELD_TEXT FIELD_TYPE FILE x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x

x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x

x x

x x x x

x x x x

x x x x

x x x x

x x x x

x x x x

x x x x

x x x x

x x x x x x

6-26

TurboCycler Window Controls

Window Properties Matrix

Table 6-42 Window Properties (Continued) Controls: STATIC_TEXT SPREADSHEET RECTANGLE RADIO_BUTTON PUSH_BUTTON PROTECTED_EDIT_FIELD MULTILINE_EDIT LISTBOX LB_COLUMN HOTSPOT GROUPBOX FILE_EDITOR ELLIPSE EDIT_FIELD DROPDOWN_LISTBOX DROPDOWN_COMBOBOX CHECKBOX CHART_Y_AXIS CHART_X_AXIS CHART_WINDOW CELL BITMAP

Properties FONT FOOTING FOOTING_COLOR FOOTING_COLOR_RED FOOTING_COLOR_GREEN FOOTING_COLOR_BLUE FUNC_KEY GREEN GROUPSTART HEADER_BOTTOM HEADER_HEIGHT HEADER_HPSID HEADING HEADING_COLOR HEADING_COLOR_RED HEADING_COLOR_GREEN HEADING_COLOR_BLUE HEIGHT HPSID IMMEDIATE_RETURN JUSTIFICATION ASCII_KEY LEFT LEFTLABEL LEFTLABEL_COLOR LEFTLABEL_COLOR_RED LEFTLABEL_COLOR_GREEN LEFTLABEL_COLOR_BLUE LEGEND MANDATORY MAXIMIZE MAXIMUM MINIMIZE MINIMUM MODIFIER NUMBERING_RECORD x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x

x x x x x x

x x x x x x x x x x

x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x

x x x x x x x

x x

x x

AppBuilder 2.1.0 Scripting Tools Reference Guide

6-27

Window Properties Matrix

Table 6-42 Window Properties (Continued) Controls: STATIC_TEXT SPREADSHEET RECTANGLE RADIO_BUTTON PUSH_BUTTON PROTECTED_EDIT_FIELD MULTILINE_EDIT LISTBOX LB_COLUMN HOTSPOT GROUPBOX FILE_EDITOR ELLIPSE EDIT_FIELD DROPDOWN_LISTBOX DROPDOWN_COMBOBOX CHECKBOX CHART_Y_AXIS CHART_X_AXIS CHART_WINDOW CELL BITMAP

Properties PICTURE READ_ONLY RED RESIZE RIGHTLABEL RIGHTLABEL_COLOR RIGHTLABEL_COLOR_RED RIGHTLABEL_COLOR_GREEN RIGHTLABEL_COLOR_BLUE ROW_SELECT SCROLL_LOCK SELECT_MODE TABSTOP CONTROL_TEXT VISIBLE WIDTH WORDWRAP x x x x x x x x x x x x x x x x x x x

x x

x x x x x x x

x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x

6-28

TurboCycler Window Controls

Index

INDEX
AppBuilder 2.1.0 Scripting Tools Reference Guide

A
Attribute Object 1-19 Audit Properties universal 5-4 Workgroup Repository 5-3 AUDIT_PROPERTIES 5-4

Dialog Window using TCDIALOG variable 4-20 Dialogs and Controls specifying size and position 4-17 Dictionary Object 1-21 drawing file 1-20 Drawing Objects 1-10

B
Blocks additional 4-16

E
Entity List 5-4 entity relationship diagram (ERD) 2-5, 2-15 Entity Relationship Diagrammer symbols 4-46 escape sequences 4-44 executing the application 2-20 expression conditional 4-31 integer 4-34 list 4-36 object 4-38 object in hierarchy diagram 4-42 string 4-43 supporting 4-28 expressions 4-28

C
CHILD 4-42 ChildScript Object 1-8 CoCtrl Object 1-17 CoDraw Object 1-10 color values (TurboScripter) 1-15 COMPONENT Block 4-16 Component_Folder 1-22 Construction Workbench 1-1 controls creating on a dialog 4-18 CoPanel Object 1-11 country values (TurboScripter) 1-14 CRUD Rules template 2-6

F
FIELD 4-8 Field and View Rename template 2-11 FLATFILE Block 4-16 flow diagram reading 4-2 flow diagrams defined 4-1 forward engineering 2-5, 2-16 Functions 4-48 Get and File 4-48 String Manipulation 4-50 Superseded 4-52 functions (template language) 4-48

D
database diagram (DBD) 2-5 Database Diagrammer symbols 4-46 declaring local variables 4-21 default templates 2-4 Detail Display Rule and Window sample 4-55 Detail Display rule/window sample 4-52 Developer Kit (SDK) 3-1 DIALOG Block 4-17 Dialog Controls processing 4-21 setting properties 4-19

G
generating the application 2-4

AppBuilder 2.1.0 Scripting Tools Reference Guide

Generation Template 3-1 GetChildren 1-21 GetParents 1-21 GUI Rules/Windows template 2-8

P
preparing the application 2-19 procedure callable blocks 4-21 procedures (template language) 4-21 Process Dependency Diagrammer symbols 4-47 processing symbols 4-45 Property Domains 5-23 Property Object, see Attribute Object 1-19 Property Types 6-23 Property Values 6-23

H
HIERARCHY Block 4-6 Hierarchy Block double arrow 4-7 Hierarchy Cloner template 2-11, 2-12 hierarchy diagram (HD) 2-5 Host Object 1-8

I
initialization file settings 2-13

R
registry setting trace output 1-7 Registry settings 1-22 Relationship Types listed with properties 5-12 Rename Verify template 2-11 Repo Object 1-2 RULE 4-8 RULE Block 4-9

J
JScript 1-1, 1-20

K
Key 1-21 Key, Item pair 1-21 KEYWORDS Block 4-17

S
screen literals 2-18 scripting engine 1-9 Select Generation Templates window 2-4 SEQUENCE= 4-8 specifying output (TurboCycler) 2-3 SQL Delete Rule sample 4-52, 4-53 starting TurboCycler 2-1 State Transition Diagrammer symbols 4-46 statement APPEND and REMOVE 4-25 CALL 4-23 CALL SERVICE 4-24 common 4-29 SELECT 4-24 SET 4-28 SHOWMESSAGE 4-27 supporting 4-28 template language sample 5-2 TRAVERSE 4-25 UPDATE MESSAGE 4-27 statements for use in applications 4-23 symbols processing on open drawings 4-45 symbols (template language) 4-2 syntax conventions (template language) 4-2 syntax of template language 4-1

L
language flows (template language) 4-28 LENGTH= 4-8

M
making a callable procedure 4-21

O
object Attribute 1-19 ChildScript 1-8 CoCtrl 1-17 CoDraw 1-10 CoPanel 1-11 Host 1-8 Repo 1-2 Trace 1-7 TSEnt 1-4 TSRel 1-6 TurboHost 1-9 Object Type query sample 5-1 Object Types listed with properties 5-3 OLE Automation 1-11 open drawing 4-45 OWNS_VIEW 4-8, 4-42

Index

ii

T
table window controls and properties 6-26 TCDIALOG using the variable to set properties 4-20 template samples 4-52 Template Block features 4-21 template language 4-1 functions 4-48 language flows 4-28 procedures 4-21 statements 4-3 symbols 4-2 syntax conventions 4-2 window control 6-1 template statements 4-3 template, default CRUD Rules 2-6 Field and View Rename 2-11 GUI Rules/Windows 2-8 Hierarchy Cloner 2-11, 2-12 Rename Verify 2-11 Utilities 2-10 templates creating 3-1 customizing 3-2 migrating from OS/2 4-18 TEXT Block 4-17 top level objects 1-10 trace file 1-7, 1-22 trace level 1-7 Trace Object 1-7 transforming (the database diagram) 2-5, 2-17 TSATL library 1-21 TSEnt Object 1-4 TSRel Object 1-6 TURBO.INI settings 2-13 TurboCycler specifying output 2-3 starting 2-1 TurboHost Object 1-9

TurboScript object Attribute 1-19 ChildScript 1-8 CoCtrl 1-17 CoDraw 1-10 CoPanel 1-11 Host 1-8 Repo 1-2 Trace 1-7 TSEnt 1-4 TSRel 1-6 TurboHost 1-9 TurboScripter, defined 1-1 TYPE= 4-8

U
USAGE= 4-8 USAGES Block 4-5 USE ANY Block 4-17 Utilities template 2-10

V
variables declaring from any block 4-21 VBScript 1-1, 1-20 VIA RELATION 4-8 VIA RELATIONSHIP 4-42 VIEW 4-8, 4-42 VIEW_INCLUDES 4-8

W
window properties 6-26 WINDOW Block 4-12 Window Block Property Types 6-23 window control (template language) 6-1 Window Controls properties 6-12 types 6-2 window controls 6-2 Window Flow Diagrammer symbols 4-47 Window Painter 1-14 window properties 6-2 Windows Controls 6-1 WITH 4-42

Index

iii