Suprtool 5.9.10 for MPE:

User Manual

Doc-To-Help Standard Manual

 

 

 

 

 

 

 

by Robelle Solutions Technology Inc.

 

suprtool

 


 

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

 

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

 

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

 

 

 

 

 

 

 

robelle

 

Robelle Solutions Technology Inc.

Suite 372, 13711 72nd Avenue,

Surrey, B.C. Canada V3W 2P2

 

Phone: 604.501.2001

Support: 289.480.1060

 

E-mail: sales@robelle.com

E-mail: support@robelle.com

Web: www.robelle.com


Table of Contents

Suprtool 5.9.10 for MPE: 1

User Manual 1

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

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

Phone: 604.501.2001 2

Table of Contents 3

Welcome to Suprtool 20

Introduction. 20

Suprtool Components 20

Database Editing. 20

Speed Demon - Replacing DBGET Mode-2. 21

STExport - Data Export Utility. 21

Suprlink - Multidataset Access 21

Suprtool2 - Interface Routine 22

Documentation. 22

Notation. 22

Suprtool Version 5.9.10 24

Highlights in Suprtool 5.9.10. 24

Highlights in Suprtool 5.9. 24

Highlights in Suprtool 5.8. 24

Highlights in Suprtool 5.7. 25

Highlights in Suprtool 5.6. 25

Highlights in Suprtool 5.5. 25

Highlights in Suprtool 5.4. 25

Highlights in Suprtool 5.3. 26

Highlights in Suprtool 5.2. 26

Highlights in Suprtool 5.1.02. 26

Installing Suprtool 28

Overview. 28

Ecometry Users 28

Instructions 28

Getting a Quick Start with Suprtool 29

How to Run Suprtool 29

What is a Task? 29

Copying Files 30

Copying One File 30

Appending to a File 30

Concatenating Two Files 30

Fields in Data Files 30

What is a Self-Describing File? 30

Creating an SD File 30

Define Fields in a Data File 31

Create an SD File from a Data File 31

Repeating Commands 32

Repeating a Command. 32

How to Save On-line Commands to a File 32

Selecting Database Records 32

Select All Records 33

Select a Random Sample 33

Look at the First Few Records 33

Selecting by Criteria 33

Simple Criteria 33

Complex Criteria 33

String of Digits 34

Selecting by Date 34

Select by Today's Date 34

Select by Particular Date 34

Select by Year 35

Select Prior Month. 35

Selecting by Lists of Values 35

Finding Data Based on a List 35

Finding Data Based on a File 36

Finding Data Based on Another Dataset's Criteria 36

Finding Data in a Data File 37

Comparing against a Key and Data 37

Sorting Database Records 38

Sort Records 38

Sort Records in Descending Order 38

Sort by Multiple Keys 38

Deleting Records 38

Updating Records 39

Duplicate Records 39

Report without Duplicate Records 39

Report Only the Duplicate Records 40

Report Only the Unique Records 40

Report Only the Duplicates and Their Originals 41

Deleting Duplicate Database Records 41

Deleting Non-Unique Duplicate Database Records 42

Deleting Duplicate Data File Records 43

Sorting IMAGE to KSAM.. 44

Loading a Dataset 44

Decimal Places 44

Converting Numbers 45

Counts and Subtotals 45

Count and Subtotal on Sort Keys 45

Sort by Count or Subtotal 46

Total by Field. 46

Running Totals 46

Running SubTotals 46

Listing Records 47

Changing the Output Record Format 47

Producing a Condensed Dataset Listing. 48

Simple Reports 48

Your First Report 48

Printing a Report 49

Specifying Your Own Title 49

Column Headings 49

Printing Mailing Labels 50

Running Suprtool under MPE 51

How to Run Suprtool 51

How to Xeq a Suprtool Task. 51

Info= for Commands 51

Son Process 52

Combining Info= and Son Process 52

Exit with Verify. 53

Preventing Suprtool from Suspending. 53

Stdin and Stdlist Files 53

Input and Output Files 54

Using CREATEPROCESS. 54

Duplicating Files 54

Job Control Word. 54

Suprmgr Configuration File 55

Using Suprtool in Batch. 55

SuprtoolOutCount JCW.. 55

SuprtoolFullCount Variable 56

Summary of Parm= Values 56

Suprtool Issues and Solutions 57

A Suprtool Task. 57

Input Choices 57

Processing Selections 57

Output Choices 57

Suprtool and Allbase 58

Data-Types 58

Date and Time Types 59

Restrictions 59

Suprtool and IMAGE. 59

Reading Datasets 59

Serial vs. Keyed Access 60

When to Use Suprtool with IMAGE. 60

TurboIMAGE Compatibility. 61

Locking of IMAGE Datasets 61

Database Maintenance (Delete, Put) 62

B-trees 63

Master Dataset Expansion (MDX) 63

Jumbo Datasets and Large Datasets 63

Suprtool and KSAM Files 64

Locking Output KSAM Files 64

Locking Input KSAM Files 64

Compatibility Mode KSAM/V Files 65

Reorganizing KSAM/V Files 65

KSAM/XL Files 66

Loading KSAM/XL Files 66

How Do I Convert CM Ksam to NM KSAM? 66

Reuse option and KSAM/XL Files 67

Suprtool and MPE Files 67

Buffered and NOBUF File Access 67

Message Files 68

Circular Files 68

RIO Files 68

Temporary Files 69

Lockwords 69

Copying User Labels 69

SDUnix Utility. 70

SDUnix Parameters 70

LF vs. NOLF. 70

Examples 70

Link vs. Query. 71

Suprtool and Self-Describing Files 71

Create an SD File from a Dataset 71

Create an SD File from a Data File 71

SD Files as Input 72

Listing SD Files 72

Decimal Places and Date Formats 72

Restrictions of SD Files 72

Creating KSAM SD Files 73

HowMessy Loadfile 74

Notes on SD Files 74

Convert an SD File to a Disc File 74

Suprtool and Sorting Files 74

Fast Sorting. 75

Native Language Support 75

With Reduced Disc Space 75

Suprtool and Tape Files 76

Labelled Tapes 76

Multiple Files 77

Notes 77

File User Labels 77

Suprtool and Remote File Access 78

Network Services (NS) 78

Suprtool and MPE/iX. 78

Calling Suprtool in Native Mode 78

User XL Files 78

When Errors Occur 79

Sorting with Suprtool/iX. 79

Suprtool and CI Variable Substitution. 79

Example 79

Batch Requires Indent 80

Avoiding Double Resolution. 80

Suprlink and STExport 81

Suprtool and User Prompting. 81

Example 82

Resolving Variables 82

Suprtool and Personal Computers 82

Downloading to the PC. 83

Decimal Places 83

Spreadsheets 83

Suprtool and PowerHouse Applications 83

Suprtool with Quiz/QTP. 83

Step 1: Create a Subfile with Quiz 84

Step 2: Output Erase in Suprtool 84

Step 3: Report with Quiz 84

Using QTP to Create Subfiles 85

Creating Subfile with Command File 85

Suprtool and PowerHouse Data-Types 87

Suprtool Definitions - QSCHEMA. 89

Notes on QSHOW Output 90

The Quiz Report 91

Quiz: Generating Suprtool Commands 92

Generating Suprtool Commands from Quick. 92

Suprtool and Application Systems 93

Third-Party Indexing. 93

Z-type TPI-keys 93

Omnidex without TPI 94

OmniQuest 95

Suprtool with TRANSACT. 95

XSORT and RPG. 96

QUERY Program.. 96

SRN Chronos Dates 97

Year 2000 Solutions with Suprtool 97

What If I Have Four-Digit Years? 97

What does Set Date Cutoff do? 98

Stddate and Set Date Cutoff 98

What does Set Date ForceCentury do? 98

What If I Have Two-Digit Years? 98

What Is Wrong with Two-Digit Years? 99

How Do $Today and $Date Work? 99

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

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

aammdd Date Format 100

Invalid Dates 101

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

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

Case 2: X6 yymmdd Data to X8 ccyymmdd. 103

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

Year 2000 Testing. 105

Performance Issues 106

Native Mode and Compatibility Mode 106

CPU-Bound? 106

Sort Speed. 107

Analyzing Performance Data 107

Suprtool Performance Hints 108

Obtaining Accurate Measurements 108

Performance Summary. 109

Suprtool Functions 109

UC4/Scripting and Functions 109

String/Byte Functions 110

$TRIM (Works on byte type fields) 110

If Usage: 110

Extract Usage (target: Byte type fields) 110

Example: 110

Data Examples Before and After: 110

$LTRIM (Works on Byte type fields) 110

If Usage: 111

Extract Usage (target: Byte type fields) 111

Example: 111

Data Examples before and after: 111

$RTRIM (Works on Byte type fields) 111

If Usage: 111

Extract Usage (target: Byte type fields) 111

Example: 111

Data Examples: 111

Data Result 111

$UPPER (Works on Byte-type fields) 112

If Usage: 112

Extract Usage (target: Byte type fields) 112

Example: 112

Data Examples: 112

$LOWER (Works on Byte-type fields) 112

If Usage: 112

Extract Usage: 112

Example: 112

Data Examples: 112

$PROPER (Works on Byte-type fields) 112

If Usage: 113

Extract Usage: 113

Example: 113

Data Examples: 113

$SPLIT (Works on Byte-type fields) 113

If Usage: 113

Extract Usage: 113

Data Examples: 113

Data Examples: 113

$FINDCLEAN (Works on Byte-type fields) 114

If Usage: 114

$CLEAN (Works on Byte-type fields) 114

If Usage: (Not commonly used) 114

Extract Usage: 114

Example: 114

Data Examples: 114

$TRANSLATE (Works on Byte-type fields) 114

If Usage: 115

Extract Usage: 115

Data Examples: (Using above code) 115

$JUSTIFYL (Works on Byte-type fields) 115

If Usage: 115

Extract Usage: 115

Data Examples: (Using above code) 115

$JUSTIFYR (Works on Byte-type fields) 115

If Usage: 115

Extract Usage: 115

Data Examples: (Using above code) 115

$LEADZEROB (Works on Byte-type fields) 116

If Usage: 116

Extract Usage: 116

Data Examples: (Using above code) 116

$RESPACE (Works on Byte-type fields) 116

If Usage: 116

Extract Usage: 116

Data Examples: (Using above code) 116

$ETOA. 116

Extract Usage: 116

$ATOE. 116

Extract Usage: 117

String Addition. 117

Extract Usage: 117

Example: 117

Data Result: 117

Numeric Functions 117

$TRUNCATE. 117

If Usage: 117

Extract Usage: 117

$ABS. 118

IF Usage: 118

Extract Usage: 118

$TOTAL. 118

IF Usage: 118

Extract Usage: 118

$SUBTOTAL. 118

IF Usage: 118

Extract Usage: 119

Example of $TOTAL and $SUBTOTAL. 119

$COUNTER. 119

IF Usage: 119

Extract Usage: 120

$SUBCOUNT. 120

IF Usage: 120

Extract Usage: 120

Examples for $counter and $subcount: 120

$SIGNED. 121

IF Usage: 121

Extract Usage: 121

Arithmetic Operations 121

+ - * / mod. 121

If Usage: 121

Extract Usage: 121

Conversion/Formatting. 121

$NUMBER. 121

If Usage: 122

Extract Usage: 122

Data Examples: 122

$EDIT. 122

If Usage: 122

Extract Usage: 122

Data Examples: 122

Other Functions 122

$LOOKUP. 122

If Usage: 123

Extract Usage: 123

$READ. 123

If Usage: 123

$INRECNUM.. 123

If Usage: 123

Extract Usage: 123

Date Functions 123

$TODAY. 123

If Usage: 124

Extract Usage: 124

$DATE. 124

If Usage: 124

Extract Usage: 124

$INVALID. 124

If Usage: 124

Extract Usage: 124

$STDDATE. 124

If Usage: 125

Extract Usage: 125

$DAYS. 125

If Usage: 125

Extract Usage: 125

$MONTH. 125

If Usage: 125

Extract Usage: 125

Suprtool Commands 127

General Notes 127

Abbreviating. 127

Uppercase or Lowercase 127

Multiple Commands per Line 127

Continuation. 128

Comments on Command Lines 128

STREAMX. 128

MPE Commands 129

MPE/iX Commands 129

Calculator 129

Control-Y Interrupt 129

Error Recovery. 130

Add Command [AD] 131

Base Command [BA] 132

Before Command [B] 135

Chain Command [C] 137

Clean Command [CL] 140

Removing Bad Characters 140

Define Command [D] 141

Delete Command [DEL] 146

Do Command [DO] 148

Duplicate Command [DU] 149

Edit Command [ED] 154

Exit Command [E] 155

Export Command [EXP] 157

Extract Command [EXT] 158

Constants 158

Dates 160

Range of Fields 162

Numeric Expressions 164

$SubTotal Function. 166

$Total Function. 166

$Counter Function. 166

String Expressions 167

Splitting Variable Length Strings 168

Cleaning your Data 170

Clean Command Syntax. 170

Setting the Clean Character 170

Cleaning a Field. 170

Cleaning your data 171

Extract from a Table 171

Data Conversion. 172

$Number Function. 174

Numeric to Byte Conversion. 175

$Edit Function. 175

Placeholders and Format Characters 175

Byte-Type Formatting. 175

Z-placeholder for byte-fields 176

Overflow and limits 176

Numeric field edit-masks 177

Signs 177

Decimal Places 178

Data and Edit mask: 178

Currency and Dollar signs 178

Overflow and floating dollar 179

Set CurrencySymbol 179

Overflow and limits 179

Form Command [F] 182

Get Command [G] 187

Help Command [H] 190

If Command [IF] 191

Expressions 191

Constants 194

Subscripts 195

Numeric Expressions 196