User Manual

Doc-To-Help Standard Manual

 

 

 

 

 

 

 

 


 

Program and manual copyright 1981-2008 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: solutions@robelle.com

E-mail: support@robelle.com

Web: www.robelle.com


Suprtool 5.1.02 for MPE: 1

User Manual 1

Program and manual copyright 1981-2008 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.1.02. 21

Highlights in Suprtool 5.0. 22

Installing Suprtool 23

Overview.. 23

Ecometry Users. 23

Instructions. 23

Getting a Quick Start with Suprtool 24

How to Run Suprtool 24

What is a Task?. 24

Copying Files. 25

Copying One File. 25

Appending to a File. 25

Concatenating Two Files. 25

Fields in Data Files. 25

What is a Self-Describing File?. 25

Creating an SD File. 26

Define Fields in a Data File. 26

Create an SD File from a Data File. 26

Repeating Commands. 27

Repeating a Command. 27

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

Selecting Database Records. 27

Select All Records. 28

Select a Random Sample. 28

Look at the First Few Records. 28

Selecting by Criteria. 28

Simple Criteria. 28

Complex Criteria. 28

String of Digits. 29

Selecting by Date. 29

Select by Today's Date. 29

Select by Particular Date. 29

Select by Year 30

Select Prior Month. 30

Selecting by Lists of Values. 30

Finding Data Based on a List 30

Finding Data Based on a File. 31

Finding Data Based on Another Dataset's Criteria. 31

Finding Data in a Data File. 32

Comparing against a Key and Data. 32

Sorting Database Records. 33

Sort Records. 33

Sort Records in Descending Order 33

Sort by Multiple Keys. 33

Deleting Records. 33

Updating Records. 34

Duplicate Records. 34

Report without Duplicate Records. 34

Report Only the Duplicate Records. 35

Report Only the Unique Records. 35

Report Only the Duplicates and Their Originals. 36

Deleting Duplicate Database Records. 36

Deleting Non-Unique Duplicate Database Records. 37

Deleting Duplicate Data File Records. 38

Sorting IMAGE to KSAM... 39

Loading a Dataset 39

Decimal Places. 39

Converting Numbers. 40

Counts and Subtotals. 40

Count and Subtotal on Sort Keys. 40

Sort by Count or Subtotal 40

Total by Field. 41

Running Totals. 41

Running SubTotals. 41

Listing Records. 42

Changing the Output Record Format 42

Producing a Condensed Dataset Listing. 42

Simple Reports. 43

Your First Report 43

Printing a Report 43

Specifying Your Own Title. 44

Column Headings. 44

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

Reuse option and KSAM/XL Files. 60

Suprtool and MPE Files. 61

Buffered and NOBUF File Access. 61

Message Files. 61

Circular Files. 61

RIO Files. 62

Temporary Files. 62

Lockwords. 62

Copying User Labels. 63

SDUnix Utility. 63

SDUnix Parameters. 63

LF vs. NOLF. 63

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 65

Listing SD Files. 66

Decimal Places and Date Formats. 66

Restrictions of SD Files. 66

Creating KSAM SD Files. 67

HowMessy Loadfile. 67

Notes on SD Files. 68

Convert an SD File to a Disc File. 68

Suprtool and Sorting Files. 68

Fast Sorting. 68

Native Language Support 69

With Reduced Disc Space. 69

Suprtool and Tape Files. 69

Labelled Tapes. 70

Multiple Files. 70

Notes. 71

File User Labels. 71

Suprtool and Remote File Access. 71

Network Services (NS) 71

Suprtool and MPE/iX.. 72

Calling Suprtool in Native Mode. 72

User XL Files. 72

When Errors Occur 72

Sorting with Suprtool/iX.. 72

Suprtool and CI Variable Substitution. 73

Example. 73

Batch Requires Indent 73

Avoiding Double Resolution. 74

Suprlink and STExport 74

Suprtool and User Prompting. 75

Example. 75

Resolving Variables. 75

Suprtool and Personal Computers. 76

Downloading to the PC.. 76

Decimal Places. 76

Spreadsheets. 76

Suprtool and PowerHouse Applications. 77

Suprtool with Quiz/QTP. 77

Step 1: Create a Subfile with Quiz. 77

Step 2: Output Erase in Suprtool 78

Step 3: Report with Quiz. 78

Using QTP to Create Subfiles. 78

Creating Subfile with Command File. 79

Suprtool and PowerHouse Data-Types. 80

Suprtool Definitions - QSCHEMA.. 83

Notes on QSHOW Output 83

The Quiz Report 84

Quiz: Generating Suprtool Commands. 85

Generating Suprtool Commands from Quick. 86

Suprtool and Application Systems. 86

Third-Party Indexing. 86

Z-type TPI-keys. 87

Omnidex without TPI. 87

OmniQuest 88

Suprtool with TRANSACT.. 88

XSORT and RPG.. 89

QUERY Program... 89

SRN Chronos Dates. 90

Year 2000 Solutions with Suprtool 90

What If I Have Four-Digit Years?. 90

What does Set Date Cutoff do?. 91

Stddate and Set Date Cutoff. 91

What does Set Date ForceCentury do?. 91

What If I Have Two-Digit Years?. 91

What Is Wrong with Two-Digit Years?. 92

How Do $Today and $Date Work?. 92

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

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

aammdd Date Format 93

Invalid Dates. 94

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

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

Case 2: X6 yymmdd Data to X8 ccyymmdd. 96

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

Year 2000 Testing. 99

Performance Issues. 99

Native Mode and Compatibility Mode. 100

CPU-Bound?. 100

Sort Speed. 100

Analyzing Performance Data. 101

Suprtool Performance Hints. 101

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] 131

Exit Command [E] 132

Export Command [EXP] 134

Extract Command [EXT] 135

Constants. 135

Dates. 137

Range of Fields. 139

Numeric Expressions. 140

$SubTotal Function. 142

$Total Function. 142

$Counter Function. 143

String Expressions. 143

Splitting Variable Length Strings. 145

Cleaning your Data. 146

Clean Command Syntax. 146

Setting the Clean Character 146

Cleaning a Field. 147

Cleaning your data. 147

Extract from a Table. 147

Data Conversion. 149

$Number Function. 150

Numeric to Byte Conversion. 151

$Edit Function. 151

Placeholders and Format Characters. 151

Byte-Type Formatting. 152

Z-placeholder for byte-fields. 153

Overflow and limits. 153

Numeric field edit-masks. 153

Signs. 154

Decimal Places. 154

Data and Edit mask: 155

Currency and Dollar signs. 155

Overflow and floating dollar 155

Set CurrencySymbol 156

Overflow and limits. 156

Form Command [F] 158

Get Command [G] 163

Help Command [H] 166

If Command [IF] 167

Expressions. 167

Constants. 170

Subscripts. 171

Numeric Expressions. 172

String Expressions. 174

Date Selection. 178

Long Expressions. 184

Input Command [I] 187

Item Command [IT] 190

Date Formats. 190

Decimal Places. 193

Notes. 194

Key Command [K] 196

Link Command [LIN] 198

List Command [L] 199

Format 199

LaserJet Listings. 200

Headings in Listings. 201

Simple Reports. 202

List Device. 203

Listredo Command [LISTREDO] 205

Numrecs Command [N] 206

Open Command [OP] 208

Output Command [O] 209

Put Command [P] 216

Q Command [Q] 218

Redo Command [REDO] 219

Reset Command [R] 222

Select Command [SEL] 223

Set Command [S] 224

Allbase. 226

Arithmetic. 226

Baseclose. 226

Blocksize. 226

Buffer 226

CleanChar 227

CurrencySymbol 227

Date Cutoff. 227

Date ForceCentury. 229

Date IfYY2000Error 229

Date MapToPHDate8. 229

DecimalSymbol 230

Defer 230

DumpOnError 230

EditStopOnError 230

Eofread. 231

FastRead. 231

Filecode. 231

Filename. 232

Firstrec. 232

Hints. 232

Ifcheck. 232

Ignore. 232

InitExtents. 233

ItemAbbreviateDate. 233

ItemLock. 233

Interactive. 233

LabelledTapeRewind. 234

Limits. 234

List 235

List Date. 235

List PCL.. 236

List Time. 237

Lock. 237

MakeAbsent 237

NLS. 238

NumBug. 238

Openmode. 239

Oracle. 239

Oracle. 239

Oracle. 239

This option is not available in the MPE version. 239

Oracle. 239

This option is not available in the MPE version. 239

Oracle. 239

Pattern. 240

Prefetch. 240

Privmode. 240

Progress. 241

Prompt 241

RealMap. 242

This option has no effect in Suprtool for MPE. 242

Recover 242

Redo. 242

Sortfast 243

Squeeze. 244

Statistics. 244

Subsystem... 244

Suspend. 245

ThousandSymbol 245

Userlabels. 245

Varsub. 245

VarsubCompat 246

VarsubDebug. 246

Warnings. 246

Sort Command [SO] 247

Table Command [TA] 249

Adding Individual Values to a Table. 249

Adding Values from a File. 250

Total Command [T] 254

Update Command [UP] 256

Use Command [U] 257

Userpause Command [USER] 259

Verify Command [V] 260

Xeq Command [X] 261

Calculator Command [=] 262

Suprtool Errors and Warnings 265

Two Types Of Messages. 265

Errors. 265

Warnings. 266

Welcome to STExport 268

Welcome to STExport 268

Installing STExport 268

Built-In File Names. 268

Accessing STExport 270

How To Run STExport 270

How to Xeq an STExport Task. 270

Son Process. 270

Suprtool Export Command. 271

Preventing MPE Commands. 271

Exit with Verify. 271

Preventing STExport from Suspending. 271

Job Control Word. 272

Using STExport in Batch. 272

Summary of Parm= Values. 272

STExportOutCount JCW... 272

STExportFullCount Variable. 273

Introduction to STExport 274

Importing Data. 274

Input File. 274

Data-Types. 274

Formatting Commands. 275

Commands. 275

Performance Considerations. 275

CI Variable Substitution. 276

STExport Commands 277

General Notes. 277

Abbreviating. 277

Uppercase or Lowercase. 277

Comments on Command Lines. 277

STREAMX.. 278

MPE Commands. 278

MPE/iX Commands. 278

File Names. 278

Calculator 279

Control-Y.. 279

Before Command [B] 280

Clean Command [CL] 282

Removing Bad Characters. 282

Columns Command [C] 283

Date Command [DA] 284

Decimal Command [DEC] 286

Delimiter Command [DE] 287

Do Command [DO] 288

Escape Command [ES] 289

Exit Command [E] 290

Exit Abort [EA] 290

Exit Suspend [ES] 290

Exit Xeq [EX] 291

Floating Command [FL] 292

Form Command [F] 293

Heading Command [HEA] 295

Help Command [H] 297

HTML Command [HT] 298

Input Command [I] 300

Listredo Command [LISTREDO] 301

Output Command [O] 302

Quote Command [Q] 303

Redo Command [REDO] 304

Reset Command [R] 305

Set Command [S] 306

CleanChar 306

Mapped. 306

Redo. 306

Statistics. 307

Varsub. 307

VarsubDebug. 308

Warnings. 308

Xmltagchar 308

Sign Command [SI] 309

Spaces Command [SP] 310

Use Command [U] 311

Verify Command [V] 312

Xeq Command [X] 313

XML Command [XML] 314

Zero Command [Z] 317

Example of STExport Output 319

Example. 319

Limits Within STExport 323

Maximums. 323

Welcome to Dbedit 324

Introduction. 324

Restrictions. 324

Functions of Dbedit 324

Performance of Dbedit 325

Field Lists. 325

Database Locking. 326

Decimal Points. 326

Critical-Item Update. 326

Dbedit Commands 329

General Notes. 329

Abbreviating. 329

Uppercase or Lowercase. 329

Continuation. 329

Control-Y.. 330

Comments on Command Lines. 330

MPE Commands. 330

MPE/iX Commands. 330

Calculator 330

Example Database. 331

Prompting for Search Criteria. 331

Command Parameters. 331

File Parameter 331

Option Parameter 332

Numeric-Value Option. 332

All Option. 332

Key Option. 332

Limit Option. 333

Related Option. 333

Under Option. 333

Updatekey Option. 334

Subcommands. 334

Add Command [A] 336

Before Command [B] 337

Change Command [C] 338

Delete Command [D] 339

Do Command [DO] 340

Exit Command [E] 341

File Command [F] 342

Form Command [FO] 343

Help Command [H] 344

List Command [L] 345

Listredo Command [LISTREDO] 346

Modify Command [M] 347

Q Command [Q] 348

Redo Command [REDO] 349

Set Command [S] 350

LP. 350

Prompt 350

Quiet 350

Reset 350

Underline. 351

Verify.