Suprtool/Open 5.8

User Manual

Doc-To-Help Standard Manual

 

 

 

 

 

 

 

by Robelle Solutions Technology Inc.

 

suprtool

 


 

Program and manual copyright 1981-2015 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

Table of Contents                                                                                                      3

Welcome to Suprtool                                                                                              15

Introduction......................................................................................................... 15

Suprtool Components............................................................................................ 15

STExport - Data Export Utility.................................................................... 15

Suprlink - Multidataset Access.................................................................... 15

Documentation..................................................................................................... 16

Notation.............................................................................................................. 16

Suprtool Version 5.7                                                                                               18

Highlights in Suprtool 5.7...................................................................................... 18

Installing Suprtool                                                                                                   19

Overview............................................................................................................. 19

Who Needs To Use These Instructions...................................................................... 19

Instructions for Installing........................................................................................ 19

Quick Start Guide for Suprtool                                                                             20

How to Run Suprtool............................................................................................ 20

What is a Task?.................................................................................................... 20

Copying Files...................................................................................................... 20

Copying One File..................................................................................... 20

Appending to a File................................................................................... 21

Fields in Data Files............................................................................................... 21

What is a Self-Describing File?.................................................................... 21

Creating an SD File................................................................................... 21

Define Fields in a Data File........................................................................ 21

Create an SD File from a Data File............................................................... 22

Repeating Commands............................................................................................ 22

Repeating a Command............................................................................... 22

Selecting Database Records..................................................................................... 23

Select All Records..................................................................................... 23

Look at the First Few Records..................................................................... 23

Selecting by Criteria.............................................................................................. 24

Simple Criteria......................................................................................... 24

Complex Criteria...................................................................................... 24

String of Digits........................................................................................ 24

Selecting by Date.................................................................................................. 24

Select by Today's Date............................................................................... 25

Select by Particular Date............................................................................. 25

Select by Year.......................................................................................... 25

Select Prior Month.................................................................................... 25

Selecting by Lists of Values.................................................................................... 26

Finding Data Based on a List...................................................................... 26

Finding Data Based on a File...................................................................... 26

Finding Data Based on Another Tables Criteria............................................. 27

Finding Data in a Data File......................................................................... 27

Sorting Database Records....................................................................................... 27

Sort Records............................................................................................ 27

Sort Records in Descending Order................................................................ 28

Sort by Multiple Keys............................................................................... 28

Duplicate Records................................................................................................. 28

Report without Duplicate Records................................................................ 28

Report Only the Duplicate Records............................................................... 29

Report Only the Unique Records.................................................................. 29

Report Only the Duplicates and Their Originals.............................................. 30

Deleting Duplicate Data File Records............................................................ 30

Decimal Places..................................................................................................... 31

Converting Numbers.............................................................................................. 31

Counts and Subtotals............................................................................................. 32

Count and Subtotal on Sort Keys................................................................. 32

Sort by Count or Subtotal.......................................................................... 32

Total by Field.......................................................................................... 33

Running Totals......................................................................................... 33

Running SubTotals................................................................................... 33

Listing Records.................................................................................................... 34

Changing the Output Record Format........................................................................ 34

Producing a Condensed Table Listing....................................................................... 35

Simple Reports..................................................................................................... 35

Your First Report...................................................................................... 35

Column Headings..................................................................................... 36

Printing Mailing Labels............................................................................. 36

Running Suprtool                                                                                                     39

Running Suprtool................................................................................................. 39

Setting Up a PATH for Suprtool.............................................................................. 39

Bourne and Korn Shells............................................................................. 39

C Shell................................................................................................... 40

Dynamic Loading.................................................................................................. 40

Control Characters and stty..................................................................................... 40

Suprmgr Configuration Files................................................................................... 41

On-Line vs. Batch Access....................................................................................... 41

Command Line Options......................................................................................... 41

Initial Command Line:  -ccmdstring............................................................. 41

Default Outcount File Name:  -oc................................................................. 41

Exit with Verify:  -v.................................................................................. 42

Combining -c and -v.................................................................................. 42

Loader Warnings....................................................................................... 42

Unix/Linux Notes................................................................................................. 42

Shell Commands...................................................................................... 42

Hardcoded File Names and ROBELLE Variable.......................................................... 43

ROBELLE Variable................................................................................... 43

/opt/robelle/suprmgr.................................................................................. 43

Outcount File........................................................................................... 43

Differences Between MPE and Open......................................................................... 43

Record Length.......................................................................................... 44

Line Feeds............................................................................................... 44

Duplicate Output Files............................................................................... 44

Classic Reals............................................................................................ 44

Input from Stdlist..................................................................................... 45

Missing Features....................................................................................... 45

Suprtool Issues and Solutions                                                                             47

A Suprtool Task................................................................................................... 47

Input Choices........................................................................................... 47

Processing Selections................................................................................. 47

Output Choices......................................................................................... 47

Suprtool and Oracle............................................................................................... 48

Data-Types............................................................................................... 48

Number Data-Type.................................................................................... 48

Order By vs. Sort...................................................................................... 49

Restrictions.............................................................................................. 49

Suprtool and Self-Describing Files........................................................................... 49

Create an SD File from a Table.................................................................... 49

Create an SD File from a Data File............................................................... 49

SD Files as Input...................................................................................... 50

Listing SD Files....................................................................................... 50

Decimal Places and Date Formats................................................................. 50

Extended Field Names............................................................................... 50

Restrictions of SD Files............................................................................. 51

Suprtool and Sorting Files...................................................................................... 51

Suprtool and Personal Computers............................................................................ 51

Downloading to the PC.............................................................................. 51

Decimal Places......................................................................................... 51

Spreadsheets............................................................................................. 52

Two-Digit Year Solutions....................................................................................... 52

What If I Have Four-Digit Years?................................................................. 52

What does Set Date Cutoff do?.................................................................... 52

Stddate and Set Date Cutoff........................................................................ 53

What does Set Date ForceCentury do?........................................................... 53

What If I Have Two-Digit Years?................................................................. 53

What Is Wrong with Two-Digit Years?.......................................................... 54

How Do $Today and $Date Work?............................................................... 54

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

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

aammdd Date Format................................................................................. 55

Invalid Dates............................................................................................ 56

Can Suprtool Convert Two-Digit Years to Four Digits?................................... 56

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

Case 2:  X6 yymmdd Data to X8 ccyymmdd................................................. 57

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

Performance......................................................................................................... 60

Eloquence Performance............................................................................... 60

Sort Performance....................................................................................... 60

Oracle Performance.................................................................................... 61

Analyzing Performance Data........................................................................ 61

Variable Substitution............................................................................................. 61

Suprtool Functions................................................................................................ 62

UC4/Scripting and Functions.................................................................................. 62

String/Byte Functions............................................................................................ 62

$TRIM (Works on byte type fields).......................................................................... 63

If Usage:.................................................................................................. 63

Extract Usage (target: Byte type fields).......................................................... 63

Example:................................................................................................. 63

Data Examples Before and After:.................................................................. 63

$LTRIM (Works on Byte type fields)....................................................................... 63

If Usage:.................................................................................................. 64

Extract Usage (target: Byte type fields).......................................................... 64

Example:................................................................................................. 64

Data Examples before and after:................................................................... 64

$RTRIM (Works on Byte type fields)....................................................................... 64

If Usage:.................................................................................................. 64

Extract Usage (target: Byte type fields).......................................................... 64

Example:................................................................................................. 64

Data Examples:......................................................................................... 64

Data Result.............................................................................................. 64

$UPPER (Works on Byte-type fields)....................................................................... 65

If Usage:.................................................................................................. 65

Extract Usage (target: Byte type fields).......................................................... 65

Example:................................................................................................. 65

Data Examples:......................................................................................... 65

$LOWER (Works on Byte-type fields)...................................................................... 65

If Usage:.................................................................................................. 65

Extract Usage:.......................................................................................... 65

Example:................................................................................................. 65

Data Examples:......................................................................................... 65

$PROPER (Works on Byte-type fields)..................................................................... 66

If Usage:.................................................................................................. 66

Extract Usage:.......................................................................................... 66

Example:................................................................................................. 66

Data Examples:......................................................................................... 66

$SPLIT (Works on Byte-type fields)......................................................................... 66

If Usage:.................................................................................................. 66

Extract Usage:.......................................................................................... 67

Data Examples:......................................................................................... 67

Data Examples:......................................................................................... 67

$FINDCLEAN (Works on Byte-type fields)............................................................... 67

If Usage:.................................................................................................. 67

$CLEAN (Works on Byte-type fields)....................................................................... 67

If Usage: (Not commonly used)................................................................... 68

Extract Usage:.......................................................................................... 68

Example:................................................................................................. 68

Data Examples:......................................................................................... 68

$TRANSLATE (Works on Byte-type fields).............................................................. 68

If Usage:.................................................................................................. 68

Extract Usage:.......................................................................................... 68

Data Examples: (Using above code).............................................................. 68

$ETOA............................................................................................................... 68

Extract Usage:.......................................................................................... 69

$ATOE............................................................................................................... 69

Extract Usage:.......................................................................................... 69

String Addition.................................................................................................... 69

Extract Usage:.......................................................................................... 69

Example:................................................................................................. 69

Data Result:............................................................................................. 69

Numeric Functions................................................................................................ 69

$TRUNCATE...................................................................................................... 69

If Usage:.................................................................................................. 70

Extract Usage:.......................................................................................... 70

$ABS................................................................................................................. 70

IF Usage:................................................................................................. 70

Extract Usage:.......................................................................................... 70

$TOTAL............................................................................................................. 70

IF Usage:................................................................................................. 70

Extract Usage:.......................................................................................... 70

$SUBTOTAL....................................................................................................... 70

IF Usage:................................................................................................. 71

Extract Usage:.......................................................................................... 71

Example of $TOTAL and $SUBTOTAL....................................................... 71

$COUNTER........................................................................................................ 71

IF Usage:................................................................................................. 71

Extract Usage:.......................................................................................... 72

$SUBCOUNT...................................................................................................... 72

IF Usage:................................................................................................. 72

Extract Usage:.......................................................................................... 72

Examples for $counter and $subcount:.......................................................... 72

$SIGNED............................................................................................................ 73

IF Usage:................................................................................................. 73

Extract Usage:.......................................................................................... 73

Arithmetic Operations............................................................................................ 73

+ - * / mod.............................................................................................. 73

If Usage:.................................................................................................. 73

Extract Usage:.......................................................................................... 73

Conversion/Formatting.......................................................................................... 73

$NUMBER.......................................................................................................... 73

If Usage:.................................................................................................. 74

Extract Usage:.......................................................................................... 74

Data Examples:......................................................................................... 74

$EDIT................................................................................................................. 74

If Usage:.................................................................................................. 74

Extract Usage:.......................................................................................... 74

Data Examples:......................................................................................... 74

Other Functions.................................................................................................... 75

$LOOKUP........................................................................................................... 75

If Usage:.................................................................................................. 75

Extract Usage:.......................................................................................... 75

$NULL............................................................................................................... 75

$READ............................................................................................................... 75

If Usage:.................................................................................................. 75

Date Functions..................................................................................................... 76

$TODAY............................................................................................................. 76

If Usage:.................................................................................................. 76

Extract Usage:.......................................................................................... 76

$DATE............................................................................................................... 76

If Usage:.................................................................................................. 76

Extract Usage:.......................................................................................... 76

$INVALID........................................................................................................... 76

If Usage:.................................................................................................. 76

Extract Usage:.......................................................................................... 76

$STDDATE......................................................................................................... 77

If Usage:.................................................................................................. 77

Extract Usage:.......................................................................................... 77

$DAYS............................................................................................................... 77

If Usage:.................................................................................................. 77

Extract Usage:.......................................................................................... 77

Suprtool Commands                                                                                              78

General Notes....................................................................................................... 78

Abbreviating............................................................................................ 78

Uppercase or Lowercase.............................................................................. 78

Multiple Commands per Line...................................................................... 78

Continuation............................................................................................ 79

Comments on Command Lines................................................................... 79

OS Commands......................................................................................... 79

Calculator................................................................................................ 80

Control-Y Interrupt.................................................................................... 80

Add Command  [Add]........................................................................................... 81

Notes...................................................................................................... 81

Examples................................................................................................. 81

Base Command  [BA]............................................................................................ 83

Before Command  [B]............................................................................................ 85

Chain Command  [C]............................................................................................ 87

Clean Command  [CL]........................................................................................... 89

Removing Bad Characters........................................................................... 89

Define Command  [D]............................................................................................ 90

Delete Command  [DEL]........................................................................................ 95

Do Command  [DO].............................................................................................. 97

Duplicate Command  [DU]..................................................................................... 98

Edit Command  [ED]........................................................................................... 103

Exit Command  [E]............................................................................................. 104

Export Command  [EXP]...................................................................................... 106

Extract Command  [EXT]..................................................................................... 107

Constants............................................................................................... 107

Dates..................................................................................................... 109

Range of Fields....................................................................................... 111

Numeric Expressions................................................................................ 112

$SubTotal Function................................................................................. 114

$Total Function...................................................................................... 114

$Counter Function................................................................................... 114

String Expressions................................................................................... 115

Splitting Variable Length Strings............................................................... 116

Cleaning your Data.................................................................................. 117

Un-printables.......................................................................................... 118

Clean Command Syntax........................................................................... 118

Setting the Clean Character....................................................................... 118

Cleaning a Field...................................................................................... 118

Cleaning your data................................................................................... 119

Extract from a Table................................................................................. 119

Data Conversion...................................................................................... 120

$Number Function................................................................................... 121

Numeric to Byte Conversion..................................................................... 122

$Edit Function........................................................................................ 123

Placeholders and Format Characters............................................................ 123

Byte-Type Formatting.............................................................................. 123

Z-placeholder for byte-fields...................................................................... 124

Overflow and limits................................................................................. 124

Numeric field edit-masks.......................................................................... 125

Signs.................................................................................................... 125

Decimal Places........................................................................................ 126

Data and Edit mask:................................................................................. 126

Currency and Dollar signs......................................................................... 126

Overflow and floating dollar...................................................................... 127

Set CurrencySymbol................................................................................ 127

Overflow and limits................................................................................. 127

Restrictions............................................................................................ 127

Form Command  [F]............................................................................................ 130

Get Command  [G].............................................................................................. 133

Help Command  [H]............................................................................................ 135

If Command  [IF]................................................................................................ 136

Expressions............................................................................................ 136

Constants............................................................................................... 139

Subscripts.............................................................................................. 140

Numeric Expressions................................................................................ 141

String Expressions................................................................................... 143

Date Selection......................................................................................... 146

Long Expressions.................................................................................... 151

Input Command  [I]............................................................................................. 154

Item Command  [IT]............................................................................................ 156

Date Formats.......................................................................................... 156

Decimal Places........................................................................................ 159

Notes.................................................................................................... 160

Key Command  [K]............................................................................................. 162

Link Command  [LIN]......................................................................................... 164

List Command  [L].............................................................................................. 165

Format.................................................................................................. 165

LaserJet Listings..................................................................................... 166

Headings in Listings................................................................................ 167

Simple Reports....................................................................................... 168

List Device............................................................................................. 169

List File................................................................................................ 169

Listredo Command  [LISTREDO].......................................................................... 172

Numrecs Command  [N]....................................................................................... 173

Open Command  [OP].......................................................................................... 174

Remote Databases and Oracle Issues............................................................ 174

Output Command  [O]......................................................................................... 175

Put Command  [P].............................................................................................. 181

Q Command  [Q]................................................................................................ 182

Redo Command  [REDO]..................................................................................... 183

Reset Command  [R]........................................................................................... 186

Select Command  [SEL]....................................................................................... 187

Set Command  [S]............................................................................................... 188

Allbase.................................................................................................. 190

Arithmetic.............................................................................................. 190

Baseclose............................................................................................... 190

Blocksize............................................................................................... 190

Buffer.................................................................................................... 190

CleanChar.............................................................................................. 190

CurrencySymbol..................................................................................... 191

Date Cutoff............................................................................................ 191

Date ForceCentury................................................................................... 192

Date IfYY2000Error................................................................................. 192

Date MapToPHDate8............................................................................... 193

DecimalSymbol...................................................................................... 193

Defer..................................................................................................... 193

DumpOnError......................................................................................... 194

EditStopError......................................................................................... 194

Eofread.................................................................................................. 194

FastRead................................................................................................ 194

Filecode................................................................................................. 194

Filename................................................................................................ 195

Firstrec.................................................................................................. 195

Hints..................................................................................................... 195

HPUXCmdErr <string>......................................................................... 195

Ifcheck................................................................................................... 196

Ignore.................................................................................................... 196

InitExtents............................................................................................. 196

ItemAbbreviateDate.................................................................................. 196

ItemLock............................................................................................... 196

Interactive.............................................................................................. 197

LabelledTapeRewind................................................................................ 197

Limits................................................................................................... 197

Table Size.............................................................................................. 197

Read Only.............................................................................................. 198

List....................................................................................................... 198

List Date................................................................................................ 198

List PCL............................................................................................... 198

List Time............................................................................................... 200

List FormFeed........................................................................................ 200

Lock..................................................................................................... 200

MakeAbsent........................................................................................... 200

NLS...................................................................................................... 200

NumBug................................................................................................ 201

Openmode.............................................................................................. 201

Oracle Rows........................................................................................... 202

Oracle Integer.......................................................................................... 202

Oracle OpenFix....................................................................................... 202

Oracle PassShift...................................................................................... 203

Oracle SpaceNull..................................................................................... 203

Oracle ZeroNull....................................................................................... 203

Pattern................................................................................................... 203

Prefetch................................................................................................. 204

Privmode............................................................................................... 204

Progress................................................................................................. 204

Prompt.................................................................................................. 205

RealMap................................................................................................ 205

Recover................................................................................................. 205

Redo..................................................................................................... 205

SDExtname............................................................................................ 206

Sortfast.................................................................................................. 207

Squeeze................................................................................................. 207

Statistics................................................................................................ 207

Subsystem............................................................................................. 207

Suspend................................................................................................. 207

ThousandSymbol.................................................................................... 207

Userlabels.............................................................................................. 207

Varsub................................................................................................... 207

VarsubCompat........................................................................................ 208

VarsubDebug.......................................................................................... 208

Warnings............................................................................................... 208

Sort Command  [SO]........................................................................................... 209

Table Command [TA].......................................................................................... 211

Adding Individual Values to a Table........................................................... 211

Adding Values from a File........................................................................ 212

TRanslate Command [TR].................................................................................... 215

Total Command [T]............................................................................................. 217

Update Command  [UP]....................................................................................... 219

Use Command  [U].............................................................................................. 220

Userpause Command  [USER]............................................................................... 222

Verify Command  [V].......................................................................................... 223

Xeq Command  [X]............................................................................................. 224

Calculator Command [=]...................................................................................... 225

Suprtool Errors and Warnings                                                                           228

Two Types Of Messages....................................................................................... 228

Errors................................................................................................................ 228

Warnings........................................................................................................... 229

Welcome to STExport                                                                                          230

Welcome to STExport.......................................................................................... 230

Installing STExport............................................................................................. 230

Accessing STExport                                                                                            231

How To Run STExport........................................................................................ 231

How to Xeq an STExport Task.............................................................................. 231

Hardcoded File Names and ROBELLE Variable........................................................ 231

ROBELLE Variable................................................................................. 231

Using STExport in Batch...................................................................................... 232

Command Line Options....................................................................................... 232

Default Outcount File Name:  -oc............................................................... 232

Variable Substitution -v............................................................................ 232

Introduction to STExport                                                                                     233

Importing Data.................................................................................................... 233

Input File........................................................................................................... 233

Data-Types......................................................................................................... 233

Formatting Commands......................................................................................... 234

Commands......................................................................................................... 234

Performance Considerations................................................................................... 234

STExport Commands                                                                                          235

General Notes..................................................................................................... 235

Abbreviating........................................................................................... 235

Uppercase or Lowercase............................................................................ 235

Comments on Command Lines.................................................................. 235

OS Commands....................................................................................... 235

File Names............................................................................................. 236

Calculator.............................................................................................. 236

Control-Y.............................................................................................. 236

Before Command  [B].......................................................................................... 237

Clean Command  [CL]......................................................................................... 239

Removing Bad Characters......................................................................... 239

Columns Command  [C]...................................................................................... 240

Date Command  [DA].......................................................................................... 241

Decimal Command  [DEC]................................................................................... 243

Delimiter Command  [DE].................................................................................... 244

Do Command  [DO]............................................................................................ 245

Escape Command  [ES]........................................................................................ 246

Exit Command  [E]............................................................................................. 247

Exit Abort [EA]...................................................................................... 247

Exit Suspend [ES]................................................................................... 247

Exit Xeq [EX]......................................................................................... 247

Floating Command  [FL]...................................................................................... 248

Form Command  [F]............................................................................................ 249

Heading Command  [HEA]................................................................................... 250

Help Command  [H]............................................................................................ 252

HTML Command  [HT]....................................................................................... 253

Dynamic Web Pages................................................................................ 255

Web Server............................................................................................. 255

Shell Script............................................................................................ 256

Perl Script.............................................................................................. 258

CGI Script............................................................................................. 259

Input Command  [I]............................................................................................. 261

Listredo Command  [LISTREDO].......................................................................... 262

Output Command  [O]......................................................................................... 263

Quote Command  [Q]........................................................................................... 264

Redo Command  [REDO]..................................................................................... 265

Reset Command  [R]........................................................................................... 266

Set Command  [S]............................................................................................... 267

CleanChar.............................................................................................. 267

Mapped................................................................................................. 267

Redo..................................................................................................... 267

Statistics................................................................................................ 268

Varsub................................................................................................... 268

VarsubCompat........................................................................................ 269

VarsubDebug.......................................................................................... 269

Warnings............................................................................................... 269

Xmltagchar............................................................................................. 270

ZonedFix............................................................................................... 270

Sign Command  [SI]............................................................................................ 271

Spaces Command  [SP]........................................................................................ 272

Use Command  [U].............................................................................................. 273

Verify Command  [V].......................................................................................... 274

Xeq Command  [X]............................................................................................. 275

XML Command  [XML]...................................................................................... 276

Zero Command  [Z]............................................................................................. 279

Example of STExport Output                                                                             280

Example............................................................................................................ 280

Limits Within STExport                                                                                        284

Maximums......................................................................................................... 284

Welcome to Suprlink                                                                                            285

Welcome to Suprlink........................................................................................... 285

Terminology and HP-UX...................................................................................... 285

Notation............................................................................................................ 285

Installing Suprlink............................................................................................... 286

Hardcoded File Names and ROBELLE Variable........................................................ 286

ROBELLE Variable................................................................................. 286

Accessing Suprlink                                                                                              287

How To Run Suprlink.......................................................................................... 287

How to Xeq a Suprlink Task.................................................................................