Suprtool/Open 5.9.10

User Manual

Doc-To-Help Standard Manual

 

 

 

 

 

 

 

by Robelle Solutions Technology Inc.

 

suprtool

 


 

Program and manual copyright 1981-2017 Robelle Solutions Technology Inc.

 

Permission is granted to reprint this document (but not for profit), provided that copyright notice is given.

 

Qedit and Suprtool are trademarks of Robelle Solutions Technology Inc. Oracle is a trademark of Oracle Corporation, Redwood City, California, USA. Other product and company names mentioned herein may be the trademarks of their respective owners.

 

 

 

 

 

 

 

robelle

 

Robelle Solutions Technology Inc.

Suite 372 - 7360 137 Street

Surrey, B.C. CanadaV3W 1A3

 

Phone:   604.501.2001

Support: 289.480.1060

 

E-mail:  sales@robelle.com

E-mail:  support@robelle.com

Web:     www.robelle.com


Table of Contents

Suprtool/Open 5.9.10  1

User Manual 1

Program and manual copyright 1981-2017 Robelle Solutions Technology Inc. 2

Permission is granted to reprint this document (but not for profit), provided that copyright notice is given. 2

Phone:           604.501.2001  2

Table of Contents  3

Welcome to Suprtool 16

Introduction. 16

Suprtool Components 16

STExport - Data Export Utility. 16

Suprlink - Multidataset Access 16

Documentation. 17

Notation. 17

Suprtool Version 5.9.10  19

Highlights in Suprtool 5.9.10. 19

Highlights in Suprtool 5.9. 19

Highlights in Suprtool 5.8. 19

Highlights in Suprtool 5.7. 20

Installing Suprtool 21

Overview. 21

Who Needs To Use These Instructions 21

Instructions for Installing. 21

Quick Start Guide for Suprtool 22

How to Run Suprtool 22

What is a Task? 22

Copying Files 22

Copying One File 22

Appending to a File 23

Fields in Data Files 23

What is a Self-Describing File? 23

Creating an SD File 23

Define Fields in a Data File 23

Create an SD File from a Data File 24

Repeating Commands 24

Repeating a Command. 24

Selecting Database Records 25

Select All Records 25

Look at the First Few Records 25

Selecting by Criteria 26

Simple Criteria 26

Complex Criteria 26

String of Digits 26

Selecting by Date 26

Select by Today's Date 27

Select by Particular Date 27

Select by Year 27

Select Prior Month. 27

Selecting by Lists of Values 28

Finding Data Based on a List 28

Finding Data Based on a File 28

Finding Data Based on Another Tables Criteria 29

Finding Data in a Data File 29

Sorting Database Records 29

Sort Records 29

Sort Records in Descending Order 30

Sort by Multiple Keys 30

Duplicate Records 30

Report without Duplicate Records 30

Report Only the Duplicate Records 31

Report Only the Unique Records 31

Report Only the Duplicates and Their Originals 32

Deleting Duplicate Data File Records 32

Decimal Places 33

Converting Numbers 33

Counts and Subtotals 34

Count and Subtotal on Sort Keys 34

Sort by Count or Subtotal 34

Total by Field. 35

Running Totals 35

Running SubTotals 35

Listing Records 36

Changing the Output Record Format 36

Producing a Condensed Table Listing. 37

Simple Reports 37

Your First Report 37

Column Headings 38

Printing Mailing Labels 38

Running Suprtool 41

Running Suprtool 41

Setting Up a PATH for Suprtool 41

Bourne and Korn Shells 41

C Shell 42

Dynamic Loading. 42

Control Characters and stty. 42

Suprmgr Configuration Files 43

On-Line vs. Batch Access 43

Command Line Options 43

Initial Command Line:  -ccmdstring. 43

Default Outcount File Name:  -oc 43

Exit with Verify:  -v. 44

Combining -c and -v. 44

Loader Warnings 44

Unix/Linux Notes 44

Shell Commands 44

Hardcoded File Names and ROBELLE Variable 45

ROBELLE Variable 45

/opt/robelle/suprmgr 45

Outcount File 45

Differences Between MPE and Open. 45

Record Length. 46

Line Feeds 46

Duplicate Output Files 46

Classic Reals 46

Input from Stdlist 47

Missing Features 47

Suprtool Issues and Solutions  49

A Suprtool Task. 49

Input Choices 49

Processing Selections 49

Output Choices 49

Suprtool and Oracle 50

Data-Types 50

Number Data-Type 50

Order By vs. Sort 51

Restrictions 51

Suprtool and Self-Describing Files 51

Create an SD File from a Table 51

Create an SD File from a Data File 51

SD Files as Input 52

Listing SD Files 52

Decimal Places and Date Formats 52

Extended Field Names 52

Restrictions of SD Files 53

Suprtool and Sorting Files 53

Suprtool and Personal Computers 53

Downloading to the PC. 53

Decimal Places 53

Spreadsheets 54

Two-Digit Year Solutions 54

What If I Have Four-Digit Years? 54

What does Set Date Cutoff do? 54

Stddate and Set Date Cutoff 55

What does Set Date ForceCentury do? 55

What If I Have Two-Digit Years? 55

What Is Wrong with Two-Digit Years? 56

How Do $Today and $Date Work? 56

Will Suprtool Generate an Error for Two-Digit Year Dates? 57

How Do I Use $Today and $Date with yymmdd Dates? 57

aammdd Date Format 57

Invalid Dates 58

Can Suprtool Convert Two-Digit Years to Four Digits? 58

Case 1:  Converting a J2 Date from yymmdd to ccyymmdd. 58

Case 2:  X6 yymmdd Data to X8 ccyymmdd. 59

Case 3:  Different Date Formats X6 MMDDYY Data to X6 YYMMDD. 61

Performance 62

Eloquence Performance 62

Sort Performance 62

Oracle Performance 63

Analyzing Performance Data 63

Variable Substitution. 63

Suprtool Functions 64

UC4/Scripting and Functions 64

String/Byte Functions 64

$TRIM (Works on byte type fields) 65

If Usage: 65

Extract Usage (target: Byte type fields) 65

Example: 65

Data Examples Before and After: 65

$LTRIM (Works on Byte type fields) 65

If Usage: 66

Extract Usage (target: Byte type fields) 66

Example: 66

Data Examples before and after: 66

$RTRIM (Works on Byte type fields) 66

If Usage: 66

Extract Usage (target: Byte type fields) 66

Example: 66

Data Examples: 66

Data Result 66

$UPPER (Works on Byte-type fields) 67

If Usage: 67

Extract Usage (target: Byte type fields) 67

Example: 67

Data Examples: 67

$LOWER (Works on Byte-type fields) 67

If Usage: 67

Extract Usage: 67

Example: 67

Data Examples: 67

$PROPER (Works on Byte-type fields) 68

If Usage: 68

Extract Usage: 68

Example: 68

Data Examples: 68

$SPLIT (Works on Byte-type fields) 68

If Usage: 68

Extract Usage: 69

Data Examples: 69

Data Examples: 69

$FINDCLEAN (Works on Byte-type fields) 69

If Usage: 69

$CLEAN (Works on Byte-type fields) 69

If Usage: (Not commonly used) 70

Extract Usage: 70

Example: 70

Data Examples: 70

$TRANSLATE (Works on Byte-type fields) 70

If Usage: 70

Extract Usage: 70

Data Examples: (Using above code) 70

$ETOA. 70

Extract Usage: 71

$ATOE. 71

Extract Usage: 71

String Addition. 71

Extract Usage: 71

Example: 71

Data Result: 71

Numeric Functions 71

$TRUNCATE. 71

If Usage: 72

Extract Usage: 72

$ABS. 72

IF Usage: 72

Extract Usage: 72

$TOTAL. 72

IF Usage: 72

Extract Usage: 72

$SUBTOTAL. 72

IF Usage: 73

Extract Usage: 73

Example of $TOTAL and $SUBTOTAL. 73

$COUNTER. 73

IF Usage: 73

Extract Usage: 74

$SUBCOUNT. 74

IF Usage: 74

Extract Usage: 74

Examples for $counter and $subcount: 74

$SIGNED. 75

IF Usage: 75

Extract Usage: 75

Arithmetic Operations 75

+ - * / mod. 75

If Usage: 75

Extract Usage: 75

Conversion/Formatting. 75

$NUMBER. 75

If Usage: 76

Extract Usage: 76

Data Examples: 76

$EDIT. 76

If Usage: 76

Extract Usage: 76

Data Examples: 76

Other Functions 77

$LOOKUP. 77

If Usage: 77

Extract Usage: 77

$NULL. 77

$READ. 77

If Usage: 77

Date Functions 78

$TODAY. 78

If Usage: 78

Extract Usage: 78

$DATE. 78

If Usage: 78

Extract Usage: 78

$INVALID. 78

If Usage: 78

Extract Usage: 78

$STDDATE. 79

If Usage: 79

Extract Usage: 79

$DAYS. 79

If Usage: 79

Extract Usage: 79

$MONTH. 79

If Usage: 80

Extract Usage: 80

Suprtool Commands  81

General Notes 81

Abbreviating. 81

Uppercase or Lowercase 81

Multiple Commands per Line 81

Continuation. 82

Comments on Command Lines 82

OS Commands 83

Calculator 83

Control-Y Interrupt 83

Add Command  [Add] 84

Notes 84

Examples 84

Base Command  [BA] 86

Before Command  [B] 88

Chain Command  [C] 90

Clean Command  [CL] 92

Removing Bad Characters 92

Define Command  [D] 93

Delete Command  [DEL] 98

Do Command  [DO] 100

Duplicate Command  [DU] 101

Edit Command  [ED] 106

Exit Command  [E] 107

Export Command  [EXP] 109

Extract Command  [EXT] 110

Constants 110

Dates 112

Range of Fields 114

Numeric Expressions 115

$SubTotal Function. 117

$Total Function. 117

$Counter Function. 117

String Expressions 118

Splitting Variable Length Strings 119

Cleaning your Data 120

Un-printables 121

Clean Command Syntax. 121

Setting the Clean Character 121

Cleaning a Field. 121

Cleaning your data 122

Extract from a Table 122

Data Conversion. 123

$Number Function. 124

Numeric to Byte Conversion. 125

$Edit Function. 126

Placeholders and Format Characters 126

Byte-Type Formatting. 126

Z-placeholder for byte-fields 127

Overflow and limits 127

Numeric field edit-masks 128

Signs 128

Decimal Places 129

Data and Edit mask: 129

Currency and Dollar signs 129

Overflow and floating dollar 130

Set CurrencySymbol 130

Overflow and limits 130

Restrictions 130

Form Command  [F] 133

Get Command  [G] 136

Help Command  [H] 138

If Command  [IF] 139

Expressions 139

Constants 142

Subscripts 143

Numeric Expressions 144

String Expressions 146

Date Selection. 149

Long Expressions 154

Input Command  [I] 157

Item Command  [IT] 159

Date Formats 159

Decimal Places 162

Notes 163

Key Command  [K] 165

Link Command  [LIN] 167

List Command  [L] 168

Format 168

LaserJet Listings 169

Headings in Listings 170

Simple Reports 171

List Device 172

List File 172

Listredo Command  [LISTREDO] 175

Numrecs Command  [N] 176

Open Command  [OP] 177

Remote Databases and Oracle Issues 177

Output Command  [O] 178

Put Command  [P] 184

Q Command  [Q] 185

Redo Command  [REDO] 186

Reset Command  [R] 189

Select Command  [SEL] 190

Set Command  [S] 191

Allbase 193

Arithmetic 193

Baseclose 193

Blocksize 193

Buffer 193

CleanChar 193

CurrencySymbol 194

Date Cutoff 194

Date ForceCentury. 195

Date IfYY2000Error 195

Date MapToPHDate8. 196

DecimalSymbol 196

Defer 196

DumpOnError 197

EditStopError 197

Eofread. 197

FastRead. 197

Filecode 197

Filename 198

Firstrec 198

Hints 198

HPUXCmdErr <string> 198

Ifcheck. 199

Ignore 199

InitExtents 199

ItemAbbreviateDate 199

ItemLock. 199

Interactive 200

LabelledTapeRewind. 200

Limits 200

Table Size 200

Read Only. 201

List 201

List Date 201

List PCL. 201

List Time 203

List FormFeed. 203

Lock. 203

MakeAbsent 203

NLS. 203

NumBug. 204

Openmode 204

Oracle Rows 205

Oracle Integer 205

Oracle OpenFix. 205

Oracle PassShift 206

Oracle SpaceNull 206

Oracle ZeroNull 206

Pattern. 206

Prefetch. 207

Privmode 207

Progress 207

Prompt 208

RealMap. 208

Recover 208

Redo. 208

SDExtname 209

Sortfast 210

Squeeze 210

Statistics 210

Subsystem.. 210

Suspend. 210

ThousandSymbol 210

Userlabels 210

Varsub. 210

VarsubCompat 211

VarsubDebug. 211

Warnings 211

Sort Command  [SO] 212

Table Command [TA] 214

Adding Individual Values to a Table 214

Adding Values from a File 215

TRanslate Command [TR] 218

Total Command [T] 220

Update Command  [UP] 222

Use Command  [U] 223

Userpause Command  [USER] 225

Verify Command  [V] 226

Xeq Command  [X] 227

Calculator Command [=] 228

Suprtool Errors and Warnings  231

Two Types Of Messages 231

Errors 231

Warnings 232

Welcome to STExport 233

Welcome to STExport 233

Installing STExport 233

Accessing STExport 235

How To Run STExport 235

How to Xeq an STExport Task. 235

Hardcoded File Names and ROBELLE Variable 235

ROBELLE Variable 235

Using STExport in Batch. 236

Command Line Options 236

Default Outcount File Name:  -oc 236

Variable Substitution -v. 236

Introduction to STExport 237

Importing Data 237

Input File 237

Data-Types