User Manual

Doc-To-Help Standard Manual

 

 

 

 

 

 

 

 


 

Program and manual copyright © 1981-2012 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.

 

 

 

 

 

 

 

I

 

Robelle Solutions Technology Inc.

Suite 372, 13711 – 72nd Avenue,

Surrey, B.C. Canada  V3W 2P2

 

Phone:   604.501.2001

Fax:       604.501.2003

 

E-mail:  sales@robelle.com

E-mail:  support@robelle.com

Web:      www.robelle.com


Suprtool 5.5 for MPE: 1

User Manual 1

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

Welcome to Suprtool 17

Introduction. 17

Suprtool Components. 17

Database Editing. 18

Speed Demon - Replacing DBGET Mode-2. 18

STExport - Data Export Utility. 18

Suprlink - Multidataset Access. 18

Suprtool2 - Interface Routine. 19

Documentation. 19

Notation. 19

Highlights  21

Highlights in Suprtool 5.5. 21

Highlights in Suprtool 5.4. 21

Installing Suprtool 22

Overview.. 22

Instructions. 22

Getting a Quick Start with Suprtool 23

How to Run Suprtool 23

What is a Task?. 23

Copying Files. 24

Copying One File. 24

Appending to a File. 24

Concatenating Two Files. 24

Fields in Data Files. 24

What is a Self-Describing File?. 24

Creating an SD File. 25

Define Fields in a Data File. 25

Create an SD File from a Data File. 25

Repeating Commands. 26

Repeating a Command. 26

How to Save On-line Commands to a File. 26

Selecting Database Records. 26

Select All Records. 27

Select a Random Sample. 27

Look at the First Few Records. 27

Selecting by Criteria. 27

Simple Criteria. 27

Complex Criteria. 27

String of Digits. 28

Selecting by Date. 28

Select by Today's Date. 28

Select by Particular Date. 28

Select by Year. 29

Select Prior Month. 29

Selecting by Lists of Values. 29

Finding Data Based on a List 29

Finding Data Based on a File. 30

Finding Data Based on Another Dataset's Criteria. 30

Finding Data in a Data File. 31

Comparing against a Key and Data. 31

Sorting Database Records. 32

Sort Records. 32

Sort Records in Descending Order. 32

Sort by Multiple Keys. 32

Deleting Records. 32

Updating Records. 33

Duplicate Records. 33

Report without Duplicate Records. 33

Report Only the Duplicate Records. 34

Report Only the Unique Records. 34

Report Only the Duplicates and Their Originals. 35

Deleting Duplicate Database Records. 35

Deleting Non-Unique Duplicate Database Records. 36

Deleting Duplicate Data File Records. 37

Sorting IMAGE to KSAM... 38

Loading a Dataset 38

Decimal Places. 38

Converting Numbers. 39

Counts and Subtotals. 39

Count and Subtotal on Sort Keys. 39

Sort by Count or Subtotal 40

Total by Field. 40

Running Totals. 40

Running SubTotals. 40

Listing Records. 41

Changing the Output Record Format 41

Producing a Condensed Dataset Listing. 42

Simple Reports. 42

Your First Report 42

Printing a Report 43

Specifying Your Own Title. 43

Column Headings. 43

Printing Mailing Labels. 44

Running Suprtool under MPE  45

How to Run Suprtool 45

How to Xeq a Suprtool Task. 45

Info= for Commands. 45

Son Process. 46

Combining Info= and Son Process. 46

Exit with Verify. 47

Preventing Suprtool from Suspending. 47

Stdin and Stdlist Files. 47

Input and Output Files. 48

Using CREATEPROCESS. 48

Duplicating Files. 48

Job Control Word. 48

Suprmgr Configuration File. 49

Using Suprtool in Batch. 49

SuprtoolOutCount JCW... 49

SuprtoolFullCount Variable. 50

Summary of Parm= Values. 50

Suprtool Issues and Solutions  51

A Suprtool Task. 51

Input Choices. 51

Processing Selections. 51

Output Choices. 51

Suprtool and Allbase. 52

Data-Types. 52

Date and Time Types. 53

Restrictions. 53

Suprtool and IMAGE.. 53

Reading Datasets. 53

Serial vs. Keyed Access. 54

When to Use Suprtool with IMAGE.. 54

TurboIMAGE Compatibility. 55

Locking of IMAGE Datasets. 55

Database Maintenance (Delete, Put). 56

B-trees. 57

Master Dataset Expansion (MDX). 57

Jumbo Datasets and Large Datasets. 57

Suprtool and KSAM Files. 58

Locking Output KSAM Files. 58

Locking Input KSAM Files. 58

Compatibility Mode KSAM/V Files. 59

Reorganizing KSAM/V Files. 59

KSAM/XL Files. 60

Loading KSAM/XL Files. 60

How Do I Convert CM Ksam to NM KSAM?. 60

Reuse option and KSAM/XL Files. 61

Suprtool and MPE Files. 61

Buffered and NOBUF File Access. 61

Message Files. 62

Circular Files. 62

RIO Files. 62

Temporary Files. 63

Lockwords. 63

Copying User Labels. 63

SDUnix Utility. 64

SDUnix Parameters. 64

LF vs. NOLF. 64

Examples. 64

Link vs. Query. 65

Suprtool and Self-Describing Files. 65

Create an SD File from a Dataset 65

Create an SD File from a Data File. 65

SD Files as Input 66

Listing SD Files. 66

Decimal Places and Date Formats. 66

Restrictions of SD Files. 66

Creating KSAM SD Files. 67

HowMessy Loadfile. 68

Notes on SD Files. 68

Convert an SD File to a Disc File. 68

Suprtool and Sorting Files. 68

Fast Sorting. 69

Native Language Support 69

With Reduced Disc Space. 69

Suprtool and Tape Files. 70

Labelled Tapes. 70

Multiple Files. 71

Notes. 71

File User Labels. 71

Suprtool and Remote File Access. 72

Network Services (NS). 72

Suprtool and MPE/iX.. 72

Calling Suprtool in Native Mode. 72

User XL Files. 72

When Errors Occur. 73

Sorting with Suprtool/iX.. 73

Suprtool and CI Variable Substitution. 73

Example. 73

Batch Requires Indent 74

Avoiding Double Resolution. 74

Suprlink and STExport 75

Suprtool and User Prompting. 75

Example. 76

Resolving Variables. 76

Suprtool and Personal Computers. 76

Downloading to the PC.. 77

Decimal Places. 77

Spreadsheets. 77

Suprtool and PowerHouse Applications. 77

Suprtool with Quiz/QTP. 77

Step 1:  Create a Subfile with Quiz. 78

Step 2:  Output Erase in Suprtool 78

Step 3:  Report with Quiz. 78

Using QTP to Create Subfiles. 79

Creating Subfile with Command File. 79

Suprtool and PowerHouse Data-Types. 81

Suprtool Definitions - QSCHEMA.. 83

Notes on QSHOW Output 84

The Quiz Report 85

Quiz: Generating Suprtool Commands. 86

Generating Suprtool Commands from Quick. 86

Suprtool and Application Systems. 87

Third-Party Indexing. 87

Z-type TPI-keys. 87

Omnidex without TPI 88

OmniQuest 89

Suprtool with TRANSACT.. 89

XSORT and RPG.. 90

QUERY Program.. 90

SRN Chronos Dates. 91

Year 2000 Solutions with Suprtool 91

What If I Have Four-Digit Years?. 91

What does Set Date Cutoff do?. 92

Stddate and Set Date Cutoff. 92

What does Set Date ForceCentury do?. 92

What If I Have Two-Digit Years?. 92

What Is Wrong with Two-Digit Years?. 93

How Do $Today and $Date Work?. 93

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

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

aammdd Date Format 94

Invalid Dates. 95

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

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

Case 2:  X6 yymmdd Data to X8 ccyymmdd. 97

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

Year 2000 Testing. 99

Performance Issues. 100

Native Mode and Compatibility Mode. 100

CPU-Bound?. 100

Sort Speed. 101

Analyzing Performance Data. 101

Suprtool Performance Hints. 102

Obtaining Accurate Measurements. 102

Performance Summary. 103

Suprtool Commands  105

General Notes. 105

Abbreviating. 105

Uppercase or Lowercase. 105

Multiple Commands per Line. 105

Continuation. 106

Comments on Command Lines. 106

STREAMX.. 106

MPE Commands. 107

MPE/iX Commands. 107

Calculator. 107

Control-Y Interrupt 107

Error Recovery. 108

Add Command  [AD]. 109

Base Command  [BA]. 110

Before Command  [B]. 113

Chain Command  [C]. 115

Clean Command  [CL]. 118

Removing Bad Characters. 118

Define Command  [D]. 119

Delete Command  [DEL]. 124

Do Command  [DO]. 126

Duplicate Command  [DU]. 127

Edit Command  [ED]. 132

Exit Command  [E]. 133

Export Command  [EXP]. 135

Extract Command  [EXT]. 136

Constants. 136

Dates. 138

Range of Fields. 140

Numeric Expressions. 141

$SubTotal Function. 143

$Total Function. 143

$Counter Function. 144

String Expressions. 144

Splitting Variable Length Strings. 146

Cleaning your Data. 147

Clean Command Syntax. 147

Setting the Clean Character. 147

Cleaning a Field. 148

Cleaning your data. 148

Extract from a Table. 148

Data Conversion. 150

$Number Function. 151

Numeric to Byte Conversion. 152

$Edit Function. 152

Placeholders and Format Characters. 152

Byte-Type Formatting. 153

Z-placeholder for byte-fields. 154

Overflow and limits. 154

Numeric field edit-masks. 154

Signs. 155

Decimal Places. 155

Data and Edit mask: 156

Currency and Dollar signs. 156

Overflow and floating dollar. 156

Set CurrencySymbol 157

Overflow and limits. 157

Form Command  [F]. 159

Get Command  [G]. 164

Help Command  [H]. 167

If Command  [IF]. 168

Expressions. 168

Constants. 171

Subscripts. 172

Numeric Expressions. 173

String Expressions. 175

Date Selection. 179

Long Expressions. 185

Input Command  [I]. 188

Item Command  [IT]. 191

Date Formats. 191

Decimal Places. 194

Notes. 195

Key Command  [K]. 197

Link Command  [LIN]. 199

List Command  [L]. 200

Format 200

LaserJet Listings. 201

Headings in Listings. 202

Simple Reports. 203

List Device. 204

Listredo Command  [LISTREDO]. 206

Numrecs Command  [N]. 207

Open Command  [OP]. 209

Output Command  [O]. 210

Put Command  [P]. 217

Q Command  [Q]. 219

Redo Command  [REDO]. 220

Reset Command  [R]. 223

Select Command [SEL]. 224

Set Command  [S]. 225

Allbase. 227

Arithmetic. 227

Baseclose. 227

Blocksize. 227

Buffer. 227

CleanChar. 228

CurrencySymbol 228

Date Cutoff. 228

Date ForceCentury. 230

Date IfYY2000Error. 230

Date MapToPHDate8. 230

DecimalSymbol 231

Defer. 231

DumpOnError. 231

EditStopError. 231

Eofread. 232

FastRead. 232

Filecode. 232

Filename. 233

Firstrec. 233

Hints. 233

Ifcheck. 233

Ignore. 234

InitExtents. 234

ItemAbbreviateDate. 234

ItemLock. 234

Interactive. 235

LabelledTapeRewind. 235

Limits. 235

List 236

List Date. 236

List PCL.. 237

List Time. 238

Lock. 238

MakeAbsent 239

NLS. 239

NumBug. 240

Openmode. 240

Oracle Rows. 240

Oracle OpenFix. 240

Oracle Integer. 240

Oracle PassShift 240

Oracle ZeroNull 241

Pattern. 241

Prefetch. 241

Privmode. 242

Progress. 242

Prompt 243

RealMap. 243

Recover. 243

Redo. 243

Sortfast 244

Squeeze. 245

Statistics. 245

Subsystem.. 245

Suspend. 246

ThousandSymbol 246

Userlabels. 246

Varsub. 247

VarsubCompat 247

VarsubDebug. 247

Warnings. 247

Xltrim.. 248

Sort Command  [SO]. 249

Table Command [TA]. 251

Adding Individual Values to a Table. 251

Adding Values from a File. 252

Total Command [T]. 256

Update Command  [UP]. 258

Use Command  [U]. 259

Userpause Command  [USER]. 261

Verify Command  [V]. 262

Xeq Command  [X]. 263

Calculator Command [=]. 264

Suprtool Errors and Warnings  267

Two Types Of Messages. 267

Errors. 267

Warnings. 268

Welcome to STExport 270

Welcome to STExport 270

Installing STExport 270

Built-In File Names. 270

Accessing STExport 272

How To Run STExport 272

How to Xeq an STExport Task. 272

Son Process. 272

Suprtool Export Command. 273

Preventing MPE Commands. 273

Exit with Verify. 273

Preventing STExport from Suspending. 273

Job Control Word. 274

Using STExport in Batch. 274

Summary of Parm= Values. 274

STExportOutCount JCW... 274

STExportFullCount Variable. 275

Introduction to STExport 276

Importing Data. 276

Input File. 276

Data-Types. 276

Formatting Commands. 277

Commands. 277

Performance Considerations. 277

CI Variable Substitution. 278

STExport Commands  279

General Notes. 279

Abbreviating. 279

Uppercase or Lowercase. 279

Comments on Command Lines. 279

STREAMX.. 280

MPE Commands. 280

MPE/iX Commands. 280

File Names. 280

Calculator. 281

Control-Y.. 281

Before Command  [B]. 282

Clean Command  [CL]. 284

Removing Bad Characters. 284

Columns Command  [C]. 285

Date Command  [DA]. 286

Decimal Command  [DEC]. 288

Delimiter Command  [DE]. 289

Do Command  [DO]. 290

Escape Command  [ES]. 291

Exit Command  [E]. 292

Exit Abort [EA]. 292

Exit Suspend [ES]. 292

Exit Xeq [EX]. 293

Floating Command  [FL]. 294

Form Command  [F]. 295

Heading Command  [HEA]. 297

Help Command  [H]. 299

HTML Command  [HT]. 300

Input Command  [I]. 302

Listredo Command  [LISTREDO]. 303

Output Command  [O]. 304

Quote Command  [Q]. 305

Redo Command  [REDO]. 306

Reset Command  [R]. 307

Set Command  [S]. 308

CleanChar. 308

Mapped. 308

Redo. 308

Statistics. 309

Varsub. 310

VarsubDebug. 310

Warnings. 310

Xmltagchar. 310

ZonedFix. 311

Sign Command  [SI]. 312

Spaces Command  [SP]. 313

Use Command  [U]. 314

Verify Command  [V]. 315

Xeq Command  [X]. 316

XML Command  [XML]. 317

Zero Command  [Z]. 320

Example of STExport Output 321

Example. 321

Limits Within STExport 325

Maximums. 325

Welcome to Dbedit 326

Introduction. 326

Restrictions. 326

Functions of Dbedit 326

Performance of Dbedit 327

Field Lists. 327

Database Locking. 328

Decimal Points. 328

Critical-Item Update. 328

Dbedit Commands  331

General Notes. 331

Abbreviating. 331

Uppercase or Lowercase. 331

Continuation. 331

Control-Y.. 332

Comments on Command Lines. 332

MPE Commands. 332

MPE/iX Commands. 332

Calculator. 332

Example Database. 333

Prompting for Search Criteria. 333

Command Parameters. 333

File Parameter. 333

Option Parameter. 334

Numeric-Value Option. 334

All Option. 334

Key Option. 334

Limit Option. 335

Related Option. 335

Under Option. 335

Updatekey Option. 336

Subcommands. 336

Add Command  [A]. 338

Before Command  [B]. 339

Change Command  [C]. 340

Delete Command  [D]. 341

Do Command  [DO]. 342

Exit Command  [E]. 343

File Command  [F]. 344

Form Command  [FO]. 345

Help Command  [H].