Doc-To-Help Standard Manual
by Robelle Solutions Technology Inc.
Program and manual copyright © 1981-2019 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
Use Suprtool/UX to read, select, and sort data from Oracle, Allbase and Eloquence databases and data files with fixed-length records. Suprtool/UX is designed to be similar to Suprtool for MPE while providing necessary HP-UX features.
Suprlink/UX 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.
· Suprtool has a new function called $length that will return a double integer value of the length of a byte and/or numeric field.
· The $ROBELLE variable has been expanded to 58 characters.
· Suprtool has a new option called Set EditSignNeutral which tells the $edit function to treat Neutral zoned and packed fields to be positive and treated as such by the $edit function.
· Suprlink now supports 8192 bytes on both the input file and the link file.
· Suprlink now supports 16384 bytes on the output file in Suprlink
· Stexport now supports 8192 bytes on both the input file and output files.
· 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.
· The Add command to add data to an Oracle table would fail on some tables with an abort if there were a large number of tables in the database.
· A new function in Suprtools if/extract engine called $month is capable of adding or subtracting months for 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.
· 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.
· Suprtools new banner would show the incorrect day and day of week in certain circumstances. This was cosmetic only.
There are two types of machines that HP has that run HP-UX, the older machines are based on the PA_RISC chip and the new machines that use the Itanium (and Itanium 2 chips). There are also program files that are specific to each chip. PA_RISC programs can run on both PA_RISC and Itanium machines, however, Itanium programs can only run on Itanium machines.
Any program that runs on Itanium must utilize libraries that match its own program type. Therefore if a PA_RISC program runs on Itanium and looks for a library, it must find/load the PA_RISC version of the libraries that it needs and conversely an Itanium program must load the libraries specific to its type.
How to Tell what Machine I am on?
There are many ways to tell what kind of machine you are on, here are a couple:
In each case the Itanium machine will typically say ia64 somewhere in the result of the above two commands. PA_RISC machines typically say "9000" somewhere in the string.
What is the Program File Type?
Since there are two types of machines there are also at least two types of program files. Suprtool is primarily either PA_RISC 1.1 or ELF-32 / IA64 which is also known as Itanium. To determine the type of program file you can use the file command:
The PA_RISC binary can run on both platforms but you need to have PA_RISC libraries for Eloquence or Oracle if you are using the Oracle module. An Itanium binary will not run on a PA_RISC machine and will fail with "cannot execute".
Of course we've made a provision to identify if you are running the ia version of Suprtool in the banner and verify command with the ia after the UX :
Suprtool by default looks in the libraries in any of the directories named in SHLIB_PATH. For example to insure that Suprtool resolves the library loads you can set the SHLIB_PATH system wide in your /etc/profile file in the following manner:
If you do not have the SHLIB_PATH variable set to a value where the libraries can be found, Suprtool will then try to load from their default names locations. For Eloquence the default location is :/opt/eloquence6/lib/pa11_32.
The Oracle interface will first try to load libclntsh.so and then attempt to load libclntsh.sl from $ORACLE_HOME/lib32/libclntsh.sl.
You can change Suprtool to pay attention to LD_LIBRARY_PATH and use dlopen to load libraries by setting the environment variable:
It is generally advisable to use DLOPEN or the ROBELLE_DYN_LOAD option when using the Itanium version. The PA_RISC version of Suprtool can use either type of loading, the default or the dlopen method invoked with ROBELLE_DYN_LOAD.
The Itanium version will make one more attempt at loading the Eloquence libraries from hpux32/libimage3k.sl and hpux32/libeqdb.sl as most users are setting SHLIB_PATH and LD_LIBRARY_NAME pointing to the lib directory.
Fastread option is now set to Off for Suprtool for HP-UX. The Dynamic loading version of Suprtool the option is set to off.
Suprtool production versions 5.1 thru 5.4.01 would incorrectly double the record size for an output,data file when either Set Ifouroutput or Set Oracle Integer were on. This has been fixed but if your script accounted for a doubled record size this may cause and issue as we no longer incorrectly write out double the bytes. If you want to have the old bug behaviour to be re-instated you can Set Oracle DataBug On. The default for this setting is off.
There are a couple of differences in the Itanium version of Suprtool, which you need to be aware of.
The DBEdit module is not available in the Itanium versions of Suprtool. This module is invoked by the EDIT command.
The layout for the Verify command is slightly different then the PA-RISC versions of Suprtool.
This program runs only on CPUs whose serial numbers have been encoded (the "uname" on HP-UX). If it fails to run and you get an "invalid HPSUSAN" error message, contact Robelle for assistance, via firstname.lastname@example.org or the support number at 1.289.480.1060.
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.
The following instructions describe the installation process of a new Suprtool release. The new version overwrites an existing version of Suprtool on your HP-UX system.
There are typically two main types of installations. The first and most often utilized is the Download instructions. You can find the HP-UX download install instructions here:
Tape installation instructions can be found 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.289.480.1060. Technical support can also be obtained via e-mail at: email@example.com If your new version of software will not run, you can page someone from technical support by calling the support number, or you can typically easily run extend with the disaster option to tide you over until business hours. Instructions for this are available at:
You can download our manuals and Change Notices in various formats and order printed (hardcopy) manuals from our web site at:
Suprtool is constantly being updated with new features. The following section describes the new enhancements to Suprtool since Suprtool 6.0
Suprtool has a new function called $length which returns a double integer number that is the length of a given byte or numeric field. For byte type fields Suprtool starts at the right most byte position to look for any non-space character and calculates the length of the data. For numeric fields Suprtool will convert the number to display and starting on the left will search for any non-zero character to establish the length.
Below is an excerpt from the manual, that describes how it can be used:
Purpose of the $length frunction is to return the length of the specified byte field as if the field has had the $rtrim function applied or the position of the rightmost non-space character.
The $ROBELLE variable on HP-UX and Open platforms has been expanded to 55 characters for the $ROBELLE directory name when you are installing outside of /opt/robelle. You use the $robelle variable to tell suprtool and all of the programs that come with suprtool where to find where it is installed.
The $edit function converts data from numeric to byte and applies an edit mask to format the data. Neutral data is not considered to be signed so if you have neutral data, a positive sign will not be applied to the edit mask. With Set EditSignNeutral turned on, Suprtool will consider the Neutral data to be positive and therefore print out the “+” or “DR”, depending on the edit-mask used.
STExport now supports 8196 bytes on the input, and the output file.
Suprlink now supports 8196 bytes on the input file, link file and 16384 bytes on the output file.
Suprtool is constantly being updated with new features. The following section describes the new enhancements to Suprtool since Suprtool 5.9
The List command now has a NOSAMETO option to turn off the SAMETO feature.
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.
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 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.
Sdlinux, is a small utility that 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:
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.
Suprtool is constantly being updated with new features. The following section describes the new enhancements to Suprtool since Suprtool 5.8
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:
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.
Banner. The opening banner at runtime would display the wrong day and day of month. This was only an issue in Suprtool 5.8.
Set CleanChar. 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.
STExport/Suprlink. PA_RISC versions of Suprlink and STExport would fail when attempting to report an error on an OUTPUT file if the user specified a directory that didn’t exist or the user didn’t have write permission to.
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.