Doc-To-Help Standard Manual
by Robelle Solutions Technology Inc.
Program and manual copyright © 1981-2018 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 Solutions Technology Inc.
372, 7360 137 Street
Surrey, BC Canada V3W 1A3
Suprtool/Open is a new version of Suprtool designed to be platform independant. Suprtool/Open is designed to read, select, and sort data from Oracle, and Eloquence databases and data files with fixed-length records. Suprtool/Open is designed to be similar to Suprtool for MPE and Suprtool for HP-UX.
Suprlink/Open provides high-speed data-file linking based on a sort key. Use STExport to convert fields in a self-describing input file into an output file that can be imported into different applications.
· The List command now has a NOSAMETO option to turn off the SAMETO feature.
· Set Backwardchain On, will cause the Chain command to do a backward chained read.
· STExport has a new set command called Set Excel Leadzero On which tells the Excel command to add leading zeroes to the fields specified in the Excel Preserve command.
· Suprtool has a new function available to the if/extract commands called $inrecnum, which expects a double integer result.
· Suprtool has a new function called $leadzeroz, which will add leading zeroes to a display field and will optionally justify the field.
· Suprtool has a four new string handling functions, specifically, $justifyl, $justifyr, $leadzerob and $respace.
· Suprtool / Open now has the ability to read Self-Describing files from HP-UX natively on Linux. Suprtool / Open can also create Self-Describing files for use on HP-UX with Set SDOutIsBe On.
· Suprtool / Open now has the ability to read Flat files from HP-UX and natively handle Big Endian Integer and Logical fields with Set FFISBE On.
· Suprtool / Open can handle and create BigEndian Logical fields with Set EndianLog On.
· A new utility to convert the version number and field information for HP-UX Self-Describing files to be used on Linux natively called sdlinux.
· Output,num would not work if the input source was a self-describing or a flat file.
· An Output file would have a null written in the last byte incorrectly if the output file was an uneven byte length and if a sort was specified.
· A new $month function in the if / extract option allows you to add or subtract a number of months from a given date.
· STExport has a new command called Excel command which allows you to format a field in a format that allows leading zeroes or spaces to be preserved.
· A new option called JSON will output SD data in Java Script Object Notation.
· Suprtools new banner would show the incorrect day and day of week in certain circumstances. This was cosmetic only.
· The Add command would fail if a Table in an Oracle database accessible by a given username had more than 2.1 billion entries on Oracle 11 and higher.
· Suprtool/Open now has the option to read MySQL databases. We are looking for feedback on where to take this feature.
· Set CleanChar to a single character, after a Set CleanChar “<null>” would not come into effect due to the special null flag not being reset. This was in both Suprtool and STExport.
· The input command now accepts the keywords($first/$last) when inputting a range of records.
· Suprlink now has it’s own “Suprmgr” file. Suprlink will process all the commands in /opt/robelle/linkmgr on startup.
· STExport now has it’s own “Suprmgr” file. STExport will process all the commands in /opt/robelle/stexpmgr on startup.
· Set Comlog On has been added to Suprtool, Suprlink and STExport to log all commands entered in Suprtool, Suprlink or STExport are logged in it’s own file.
· Suprtool would potentially have problems with system commands in variable-length scripts if the command ended in a number that had a length of eight numbers.
· Suprtool would fail with a write error in the case of an Input SD file with BigEndian Fields, Set EndianInt BE and if the output was to an SQL Table via the Add command and the output was sorted.
· Suprtool would lose track of Table data field information, on tables held with the hold option in subsequent tasks.
· Suprtool now has the $proper function which will shift the first character in a string and any first character after a space or ampersand.
· Suprtool now has the Translate command and a $translate function to obfuscate test data or any byte field from being readable.
· Suprtool/Open 5.7 Build 6 and higher supports the Oracle 12 client.
· Suprtool/Open would not parse a negative number into a quad integer container.
· Suprtool for Itanium and Suprtool/Open would not properly convert negative, single and double integers when output/,display is invoked.
· Suprtool for Itanium and Suprtool/Open incorrectly reallocated if/extract code space on subsequent tasks, which would eventually cause Suprtool to fail with the error, “Unable to allocate heap space.”
· Suprtool for Itanium and Suprtool/Open did not properly handle sorting of display type with over punch.
· Suprtool, Suprlink and STExport now handle 512 fields on HP-UX and Open platforms.
· Suprtools' extract command now has three special keywords to help with extract using a range, which is designed to make your Suprtool scripts more easily maintained. Suprtool now has $all, $first and $last which respectively means all fields, the first field or the last field. Note that $first and $last may only be used in a range extract.
· $subcount has been added to keep a running count for a given sort break.
· Suprtool had problems with brackets and arithmetic expressions for packed-decimal and display data-types. (Build 12)
· Suprtool had problems with improper rounding for Packed-decimal, Quad and Zoned-Decimal data types and arithmetic expressions. (Build 12)
· Suprtool would use an incorrect field definition when copying a file where the input file had a duplicate field name with different field definition, the second field would utilize the first definition.
· Suprtool/Open would potentially incorrectly set the decimal or date attribute on a straight copy of an SD file. This was introduced by the fix to copying SD files with duplicate fieldnames and was in 5.5.04 pre-release and 5.5.11 and 5.6 Build 1. This is fixed in Suprtool/Open 5.6 Build 3.
Suprtool/Open first release is designed to be compatible with Suprtool for HP-UX.
The user manual contains the full description of all the Suprtool suite of products including Dbedit, Suprlink, STExport, and Suprtool2, as well as usage tips and commands for each. The manuals are up-to-date with all the latest changes. To see only the changes in the latest version, see the "What's New" section of the manual.
You can download our manuals and Change Notices in various formats and order printed (hardcopy) manuals from our web site at:
The following instructions describe the installation process of a new Suprtool release. The new version overwrites an existing version of Suprtool on your system.
There are typically two main types of installations. The first and most often utilized is the Download instructions. You can find the download install instructions here:
If you have any questions or run into any problems, please call us. Technical support is available on weekdays from 8 a.m. to 4 p.m. Pacific time at 1.800.453.8970. Technical support can also be obtained via e-mail at: firstname.lastname@example.org
Suprtool is constantly being updated with new features. The following section describes the new enhancements to Suprtool since Suprtool 5.9
Suprtool/Open now has the ability to read self-describing files that come directly from HP-UX. Suprtool/Open will depending on the version of the SD file format will when necessary, convert all of the SD information from BigEndian data to Little Endian numbers such that Suprtool/Open will be able to natively read the files.
Sdlinux is a new utility available for HP-UX that will help aid in allowing Suprtool/Open to know whether or not an SD file is bigendian or smallendian.
Suprtool/Open now has the ability to read and write Self-Describing files with Integers that are in BigEndian format.
Set EndianInt BE
Will tell Suprtool to write out any Integer in BigEndian byte order on Linux on a small endian machine.
Suprtool/Open now has the ability to read and write Self-Describing files with Logicals that are in BigEndian format.
Set EndianLog BE
Will tell Suprtool to write out any Logical in BigEndian byte order on Linux on a small endian machine.
Suprtool/Open now has the ability to read Flat Files with BigEndian Data. If SetFFISBE is turned On, Suprtool will assume that Integer and Logical fields are in BigEndian format.
Suprtool now has a utility called sdlinux, which will help convert an HP-UX self-describing file which will have Big Endian numbers, in the Self-Describing information and in the integers in the data file. The sdlinux utility is available in the Suprtool 6.0 HP-UX download or you can ftp the utility from our ftp site by doing the following from you HP-UX system:
Please note that you need Suprtool 6.0 version of Suprtool/Open, but there is no dependency, on what version of Suprtool you are using on HP-UX. The utility was just distributed with the 6.0 version as it was the next available release vehicle.
Sdlinux, will change the sd version field which tells Suprtool/Open the endianness of the sd file.
BIG (HP-UX) LITTLE(LINUX)
BIG (HP-UX) LITTLE(LINUX)
The sdlinux utility has four options, -f, -r, -h and –d. Only one option can be specified at any given time:
B.00.00 becomes B.00.02 and
B.00.01 becomes B.00.03
Any integer/logical field gets flagged as BE.
B.00.02 becomes B.00.00 and
B.00.03 becomes B.00.01
Any integer/ logical field gets the Endianness flag turned off.
B.00.02 becomes B.00.00 and
B.00.03 becomes B.00.01
Any integer/logical field gets the Endianness flag turned off.
The sdlinux utility gets run with the above options and a filename for an argument as in:
The filename specified just needs to be the data file name not the sd filename. Regardless, sdlinux will figure out what to do if the .sd extension is in the filename argument.
Please see the following example how you can move data from HP-UX, to Linux natively without having to export to ascii. On HP-UX, you simply create a self-describing file as you normally would:
Then you can use sdlinux to make some quick changes to the Self-describing information, specifically the version in the header and the integers and logicals get updated with the big endian flag being turned on:
You can then ftp the data file and the sd file over to your Linux box:
You can then reverse the effects of the –f option with the –r option on the files after you have transferred:
Then on Linux you can read the sd file natively even though the sd information has big endian information and the data file can be read with bigendian integers and logicals.
The Set command, SDOutBE when turned on Suprtool/Open on a Little Endian Linux box will create an SD file with BigEndian data such that it can be transferred to an HP-UX box and read natively on HP-UX.
The Set command, Backwardchain when turned on will tell the Chain command to do a Backward Chained read.
The if / extract commands can now utilize a new function called $INRECNUM, which allows you to use the input record number in certain tasks. For example, the task below would find record number 11.
You can also, utilize the $inrecnum function in the extract command:
The $inrecnum function was designed to find records especially in the instance where duplicate records are in a particular data source and cannot be isolated by any other means.
describes the new enhancements to Suprtool since Suprtool 5.9
The if / extract commands can now utilize a new function called $LEADZEROZ, which allows you to add leading zeroes to a specific display field. This was designed specifically for the extract command and fixing up data but can be used in the if command as well.
$NUMBER is capable of fixing up numbers, but the new $LEADZEROZ function is more lightweight and simply adds leading zeroes, and has an option to justify right as shown below. The source data looks like this:
You can format with the following:
The $LEADZEROZ function cannot fix issues like commas and decimal places in a display field, this can be handled by the $number function.
The if / extract commands can now utilize a new function called $LEADZEROB, which allows you to add leading zeroes to a specific byte field. This was designed specifically for the extract command and fixing up data but can be used in the if command as well. The data looks like this:
The if / extract commands can now utilize a new function called $JUSTIFYL, which allows you to left justify text to the left side of a field.
The if / extract commands can now utilize a new function called $JUSTIFYR, which allows you to right justify text to the right side of a field.
The if / extract commands can now utilize a new function called $RESPACE, which allows you to fixup byte data that has multiple spaces in between text. For example your data looks like this:
It can easily be fixed up and converted to what is shown below:
Suprtool is constantly being updated with new features. The following section describes the new enhancements to Suprtool since Suprtool 5.8.10
The if / extract commands can now utilize a new function called $Month, which will add a given number of months to a given date in the format of ccyymmdd or yyyymmdd.
The above task will take the field mydate and add four months to it. Suprtool will check if the date is valid and adjust the date within reason. For example if the given month for mydate has 31 days and the day is 31, and the month mydate becomes when the date is added to has only 30 days. The date will be adjusted to have the 30th for the day.
The Excel command can be used to produce columns of data that when imported will preserve spaces or leading zeroes.
EXCEL PRESERVE <fieldname>
STExport can generate columns that are imported into Excel in such a way that leading zeroes are preserved. While the format produced is not traditional CSV, the format will produce a field in the form:
This form when imported into Excel will preserve the leading zeroes. In order to invoke this format the Excel command has very simple syntax:
These simple commands will generate a file that will have the usually formatted fields as well as some fields formatted specifically for preserving spaces and leading zeroes in Excel.
The result of such an STExport task will look as follows:
The JSON command specifies STExport to generate Json output. Use the JSON to produce Java Script Object Notation documents for either Internet or Intranet applications.
STExport can generate JSON output with just a few commands.
These four simple commands will generate a file that can be read by various applications. The result of such an STExport task will look as follows:
The Object option allows the JSON data to be wrapped in a specific Object description.
Looks like this:
Note that the example of the Output has one field per line with data. Normally this would have to be specified via the command line but the data is shown this way simply due to space constraints.
For files that have many fields you may want to consider using the OneLine option of the JSON command:
STExport will put each field and data on one line with the appropriate beginning and end notation.
You can enter multiple JSON commands per task to set the JSON options you require.
An example of the output generated by the above commands is as follows:
Suprtool/Open now has the ability to read MySQL databases via the Open and Select commands. We are looking for alpha, beta testers and feedback specifically on how to treat certain data items. Please e-mail Neil Armstrong at email@example.com to request a trial of this software.
Suprtool now has $first and $last mnemonics, which can be used on a range selection of records on the input command. It was designed to handle a request to list the last N number of records in a file as in:
Suprtool will parse the Range selection and semantically check if the record range entered is logical. For instance, $first-2 and $last+10, which do not make logical sense would throw and error. Similarly if a record only has 5 records in it then $last-10 or $first+7, would also throw an error.
Enhancements in Version 5.7
Suprlink now has a “suprmgr” file similar to Suprtool. Suprlink will process all the commands found in /opt/robelle/linkmgr or $ROBELLE/linkmgr.
STExport now has a “suprmgr” file similar to Suprtool. STExport will process all the commands found in /opt/robelle/stexpmgr or $ROBELLE/stexpmgr.
Suprtool, Suprlink and STExport can now log all commands in each product. Every command will be logged if the setting Set ComLog, is on. Commands will not be logged if the user does not have write access to the comlog file. There are three separate log files, one for each product. The stlog file for Suprtool, sllog for Suprlink and sxlog for STExport. The files are by default located in /opt/robelle/log/suprtool directory. If the $ROBELLE variable is set, the log files would be in the directory $ROBELLE/log/suprtool.
The format of the log file is as follows:
DateTime, UID, PID, command entered
The Date and Time is 16 bytes in the format Year, Month, Day, Hours, Minutes, Seconds.
UID/PID are six digit numbers, followed by the command with a line feed at the end.
Please note that if this command is global the log files can expand quickly, taking up disc space by default in the /opt/robelle directory. You can redirect where the commands are logged by using linked files.
The user running any of the products must have write access to the log files whether Link files or directly.
Suprtool now has the $proper function which will shift to upper case the first character of a byte type field and after any space or ampersand. It will also shift to lower case any other characters in the byte-field.
Considering the following data, you can fix all of the product names with one simple task:
Note that any character after a space, “&”, or “-“ is upshifted for a proper name. Suprtool will also downshift those characters that do not qualify as needing proper capitalization and it is a capital character, the proper function will downshift those characters. See an example below:
The $proper function only works on byte type fields.
Suprtool now has a $translate function which in conjunction with the translate command allows you to build a translation table, whereby you can translate from any byte character to any character. We have also added a method to a supplied translate table which will allow you to obscure the data such that it can’t be read.
You can make your own Translate table using the Translate command, where you can specify the character you want to translate and what you want to translate to, using Decimal Notation. So if you want to translate “A” to “Z”, you would type the command:
So you specify the from character on the left in decimal which is the capital-A and the to-character is also in decimal format which is capital-Z, which is decimal 90. If you want to reverse the translation you can simply do the following command and translate the field back with:
This is not meant to be an encryption solution, but it will help obfuscate test date really quickly.
Suprtool's extract command now has three new keywords, which can be used for extract range feature. You can now say extract $all, extract $first / $last on an SD file or Image/Eloquence dataset. The intention is to make your scripts more easily maintained. If you had a script that you wanted to put a sequence number at the beginning and then extract the rest of the dataset you previously had to specify the starting field and the ending field. For example if the first field in a dataset was order-no and the last field was pst-code you may have a script that looked like this.
If you added any fields to the beginning or end of the dataset you would have to re-write the script. Now you can write the script as being:
You can also write the script using $first / $last as your preference, but $first and $last are also useful if you need to add data into the middle of the fields you extract:
Please note that if a self-describing file has a fieldname that is a duplicate field and one of the duplicate fields is the last field in the file, then $first / $last and $all, will only extract up to the first occurrence of the duplicate fieldname. This may seem as an issue but it is consistent with what Suprtool does currently with extract from a range. Currently and prior to the $first / $last enhancement Suprtool would have extracted only up to the first occurrence of the field if you had a file such as this:
Notice that FILLER is a duplicate named field, so if you entered, extract char-field / filler, Suprtool would only extract up to and including the first FILLER field. For consistency, extract $first / $last behaves the same way.
Suprtool now supports 512 data items in both Eloquence datasets and SD files and Oracle fields. STExport and Suprlink have also been updated to support the increased number of data items in the SD fields that they read, but please note that other limitations still exist. [5.5.10]
$SubCount has been added to provide a counter that only gets reset at a given sort break.
What Suprtool will do in this case is start incrementing a number starting with 1, and increase by 1 for any given char-field value. This way you can add a counter based on a sort break for a given field.
Add Command. The Add command would fail if a Table in an Oracle database accessible by a given username had more than 2.1 billion entries on Oracle 11 and higher.
Output , Display Command. Suprtool for Itanium and Suprtool/Open would not properly convert negative, single and double integers when output/,display is invoked
Quad Integer Input Parsing. Suprtool/Open would not parse a negative number into a quad integer container.
If Command. Suprtool for Itanium and Suprtool/Open incorrectly reallocated if/extract code space on subsequent tasks, which would eventually cause Suprtool to fail with the error, “Unable to allocate heap space.”
Arithmetic Expressions. Suprtool/Open had problems with arithmetic expressions with brackets for Packed-Decimal and Zoned-Decimal data types.
Arithmetic Expressions. Suprtool/Open had problems with rounding for arithmetic expressions with Quad Integers, Packed-Decimal and Zoned-Decimal data types.