User Manual

Doc-To-Help Standard Manual

 

 

 

 

 

 

 

 


 

Program and manual copyright 1981-2011 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.4 for MPE: 1

User Manual 1

Program and manual copyright 1981-2011 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.4. 21

Highlights in Suprtool 5.3. 21

Highlights in Suprtool 5.2. 21

Highlights in Suprtool 5.1.02. 21

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 41

Total by Field. 41

Running Totals. 41

Running SubTotals. 41

Listing Records. 42

Changing the Output Record Format 42

Producing a Condensed Dataset Listing. 43

Simple Reports. 43

Your First Report 43

Printing a Report 44

Specifying Your Own Title. 44

Column Headings. 44

Printing Mailing Labels. 45

Running Suprtool under MPE 46

How to Run Suprtool 46

How to Xeq a Suprtool Task. 46

Info= for Commands. 46

Son Process. 47

Combining Info= and Son Process. 47

Exit with Verify. 48

Preventing Suprtool from Suspending. 48

Stdin and Stdlist Files. 48

Input and Output Files. 49

Using CREATEPROCESS. 49

Duplicating Files. 49

Job Control Word. 49

Suprmgr Configuration File. 50

Using Suprtool in Batch. 50

SuprtoolOutCount JCW... 50

SuprtoolFullCount Variable. 51

Summary of Parm= Values. 51

Suprtool Issues and Solutions 53

A Suprtool Task. 53

Input Choices. 53

Processing Selections. 53

Output Choices. 53

Suprtool and Allbase. 54

Data-Types. 54

Date and Time Types. 55

Restrictions. 55

Suprtool and IMAGE.. 55

Reading Datasets. 55

Serial vs. Keyed Access. 56

When to Use Suprtool with IMAGE.. 56

TurboIMAGE Compatibility. 57

Locking of IMAGE Datasets. 57

Database Maintenance (Delete, Put) 58

B-trees. 59

Master Dataset Expansion (MDX) 59

Jumbo Datasets and Large Datasets. 59

Suprtool and KSAM Files. 60

Locking Output KSAM Files. 60

Locking Input KSAM Files. 60

Compatibility Mode KSAM/V Files. 61

Reorganizing KSAM/V Files. 61

KSAM/XL Files. 62

Loading KSAM/XL Files. 62

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

Reuse option and KSAM/XL Files. 63

Suprtool and MPE Files. 63

Buffered and NOBUF File Access. 63

Message Files. 64

Circular Files. 64

RIO Files. 64

Temporary Files. 65

Lockwords. 65

Copying User Labels. 65

SDUnix Utility. 66

SDUnix Parameters. 66

LF vs. NOLF. 66

Examples. 66

Link vs. Query. 67

Suprtool and Self-Describing Files. 67

Create an SD File from a Dataset 67

Create an SD File from a Data File. 67

SD Files as Input 68

Listing SD Files. 68

Decimal Places and Date Formats. 68

Restrictions of SD Files. 68

Creating KSAM SD Files. 69

HowMessy Loadfile. 70

Notes on SD Files. 70

Convert an SD File to a Disc File. 70

Suprtool and Sorting Files. 70

Fast Sorting. 71

Native Language Support 71

With Reduced Disc Space. 71

Suprtool and Tape Files. 72

Labelled Tapes. 72

Multiple Files. 73

Notes. 73

File User Labels. 73

Suprtool and Remote File Access. 74

Network Services (NS) 74

Suprtool and MPE/iX.. 74

Calling Suprtool in Native Mode. 74

User XL Files. 74

When Errors Occur 75

Sorting with Suprtool/iX.. 75

Suprtool and CI Variable Substitution. 75

Example. 75

Batch Requires Indent 76

Avoiding Double Resolution. 76

Suprlink and STExport 77

Suprtool and User Prompting. 77

Example. 78

Resolving Variables. 78

Suprtool and Personal Computers. 78

Downloading to the PC.. 79

Decimal Places. 79

Spreadsheets. 79

Suprtool and PowerHouse Applications. 79

Suprtool with Quiz/QTP. 79

Step 1: Create a Subfile with Quiz. 80

Step 2: Output Erase in Suprtool 80

Step 3: Report with Quiz. 80

Using QTP to Create Subfiles. 81

Creating Subfile with Command File. 81

Suprtool and PowerHouse Data-Types. 83

Suprtool Definitions - QSCHEMA.. 85

Notes on QSHOW Output 86

The Quiz Report 87

Quiz: Generating Suprtool Commands. 88

Generating Suprtool Commands from Quick. 88

Suprtool and Application Systems. 89

Third-Party Indexing. 89

Z-type TPI-keys. 89

Omnidex without TPI. 90

OmniQuest 91

Suprtool with TRANSACT.. 91

XSORT and RPG.. 92

QUERY Program... 92

SRN Chronos Dates. 93

Year 2000 Solutions with Suprtool 93

What If I Have Four-Digit Years?. 93

What does Set Date Cutoff do?. 94

Stddate and Set Date Cutoff. 94

What does Set Date ForceCentury do?. 94

What If I Have Two-Digit Years?. 94

What Is Wrong with Two-Digit Years?. 95

How Do $Today and $Date Work?. 95

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

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

aammdd Date Format 96

Invalid Dates. 97

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

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

Case 2: X6 yymmdd Data to X8 ccyymmdd. 99

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

Year 2000 Testing. 101

Performance Issues. 102

Native Mode and Compatibility Mode. 102

CPU-Bound?. 102

Sort Speed. 103

Analyzing Performance Data. 103

Suprtool Performance Hints. 104

Obtaining Accurate Measurements. 104

Performance Summary. 105

Suprtool Commands 107

General Notes. 107

Abbreviating. 107

Uppercase or Lowercase. 107

Multiple Commands per Line. 107

Continuation. 108

Comments on Command Lines. 108

STREAMX.. 108

MPE Commands. 109

MPE/iX Commands. 109

Calculator 109

Control-Y Interrupt 109

Error Recovery. 110

Add Command [AD] 111

Base Command [BA] 112

Before Command [B] 115

Chain Command [C] 117

Clean Command [CL] 120

Removing Bad Characters. 120

Define Command [D] 121

Delete Command [DEL] 126

Do Command [DO] 128

Duplicate Command [DU] 129

Edit Command [ED] 134

Exit Command [E] 135

Export Command [EXP] 137

Extract Command [EXT] 138

Constants. 138

Dates. 140

Range of Fields. 142

Numeric Expressions. 143

$SubTotal Function. 145

$Total Function. 145

$Counter Function. 146

String Expressions. 146

Splitting Variable Length Strings. 148

Cleaning your Data. 149

Clean Command Syntax. 149

Setting the Clean Character 149

Cleaning a Field. 150

Cleaning your data. 150

Extract from a Table. 150

Data Conversion. 152

$Number Function. 153

Numeric to Byte Conversion. 154

$Edit Function. 154

Placeholders and Format Characters. 154

Byte-Type Formatting. 155

Z-placeholder for byte-fields. 156

Overflow and limits. 156

Numeric field edit-masks. 156

Signs. 157

Decimal Places. 157

Data and Edit mask: 158

Currency and Dollar signs. 158

Overflow and floating dollar 158

Set CurrencySymbol 159

Overflow and limits. 159

Form Command [F] 161

Get Command [G] 166

Help Command [H] 169

If Command [IF] 170

Expressions. 170

Constants. 173

Subscripts. 174

Numeric Expressions. 175

String Expressions. 177

Date Selection. 181

Long Expressions. 187

Input Command [I] 190

Item Command [IT] 193

Date Formats. 193

Decimal Places. 196

Notes. 197

Key Command [K] 199

Link Command [LIN] 201

List Command [L] 202

Format 202

LaserJet Listings. 203

Headings in Listings. 204

Simple Reports. 205

List Device. 206

Listredo Command [LISTREDO] 208

Numrecs Command [N] 209

Open Command [OP] 211

Output Command [O] 212

Put Command [P] 219

Q Command [Q] 221

Redo Command [REDO] 222

Reset Command [R] 225

Select Command [SEL] 226

Set Command [S] 227

Allbase. 229

Arithmetic. 229

Baseclose. 229

Blocksize. 229

Buffer 229

CleanChar 230

CurrencySymbol 230

Date Cutoff. 230

Date ForceCentury. 232

Date IfYY2000Error 232

Date MapToPHDate8. 232

DecimalSymbol 233

Defer 233

DumpOnError 233

EditStopError 233

Eofread. 234

FastRead. 234

Filecode. 234

Filename. 235

Firstrec. 235

Hints. 235

Ifcheck. 235

Ignore. 236

InitExtents. 236

ItemAbbreviateDate. 236

ItemLock. 236

Interactive. 237

LabelledTapeRewind. 237

Limits. 237

List 238

List Date. 238

List PCL.. 239

List Time. 240

Lock. 240

MakeAbsent 241

NLS. 241

NumBug. 242

Openmode. 242

Oracle Rows. 242

Oracle OpenFix. 242

Oracle Integer 242

Oracle PassShift 242

Oracle ZeroNull 243

Pattern. 243

Prefetch. 243

Privmode. 244

Progress. 244

Prompt 245

RealMap. 245

Recover 245

Redo. 245

Sortfast 246

Squeeze. 247

Statistics. 247

Subsystem... 247

Suspend. 248

ThousandSymbol 248

Userlabels. 248

Varsub. 249

VarsubCompat 249

VarsubDebug. 249

Warnings. 249

Sort Command [SO] 250

Table Command [TA] 252

Adding Individual Values to a Table. 252

Adding Values from a File. 253

Total Command [T] 257

Update Command [UP] 259

Use Command [U] 260

Userpause Command [USER] 262

Verify Command [V] 263

Xeq Command [X] 264

Calculator Command [=] 265

Suprtool Errors and Warnings 268

Two Types Of Messages. 268

Errors. 268

Warnings. 269

Welcome to STExport 271

Welcome to STExport 271

Installing STExport 271

Built-In File Names. 271

Accessing STExport 273

How To Run STExport 273

How to Xeq an STExport Task. 273

Son Process. 273

Suprtool Export Command. 274

Preventing MPE Commands. 274

Exit with Verify. 274

Preventing STExport from Suspending. 274

Job Control Word. 275

Using STExport in Batch. 275

Summary of Parm= Values. 275

STExportOutCount JCW... 275

STExportFullCount Variable. 276

Introduction to STExport 277

Importing Data. 277

Input File. 277

Data-Types. 277

Formatting Commands. 278

Commands. 278

Performance Considerations. 278

CI Variable Substitution. 279

STExport Commands 281

General Notes. 281

Abbreviating. 281

Uppercase or Lowercase. 281

Comments on Command Lines. 281

STREAMX.. 282

MPE Commands. 282

MPE/iX Commands. 282

File Names. 282

Calculator 283

Control-Y.. 283

Before Command [B] 284

Clean Command [CL] 286

Removing Bad Characters. 286

Columns Command [C] 287

Date Command [DA] 288

Decimal Command [DEC] 290

Delimiter Command [DE] 291

Do Command [DO] 292

Escape Command [ES] 293

Exit Command [E] 294

Exit Abort [EA] 294

Exit Suspend [ES] 294

Exit Xeq [EX] 295

Floating Command [FL] 296

Form Command [F] 297

Heading Command [HEA] 299

Help Command [H] 301

HTML Command [HT] 302

Input Command [I] 304

Listredo Command [LISTREDO] 305

Output Command [O] 306

Quote Command [Q] 307

Redo Command [REDO] 308

Reset Command [R] 309

Set Command [S] 310

CleanChar 310

Mapped. 310

Redo. 310

Statistics. 311

Varsub. 312

VarsubDebug. 312

Warnings. 312

Xmltagchar 312

ZonedFix. 313

Sign Command [SI] 314

Spaces Command [SP] 315

Use Command [U] 316

Verify Command [V] 317

Xeq Command [X] 318

XML Command [XML] 319

Zero Command [Z] 322

Example of STExport Output 323

Example. 323

Limits Within STExport 327

Maximums. 327

Welcome to Dbedit 328

Introduction. 328

Restrictions. 328

Functions of Dbedit 328

Performance of Dbedit 329

Field Lists. 329

Database Locking. 330

Decimal Points. 330

Critical-Item Update. 330

Dbedit Commands 333

General Notes. 333

Abbreviating. 333

Uppercase or Lowercase. 333

Continuation. 333

Control-Y.. 334

Comments on Command Lines. 334

MPE Commands. 334

MPE/iX Commands. 334

Calculator 334

Example Database. 335

Prompting for Search Criteria. 335

Command Parameters. 335

File Parameter 335

Option Parameter 336

Numeric-Value Option. 336

All Option. 336

Key Option. 336

Limit Option. 337

Related Option. 337

Under Option. 337

Updatekey Option. 338

Subcommands. 338

Add Command [A] 340

Before Command [B] 341

Change Command [C] 342

Delete Command [D] 343

Do Command [DO] 344

Exit Command [E] 345

File Command [F] 346