Automated
Migration to uniX and Windows is a complete tool designed to migrate HP e3000
Cobol, SPL, C, FORTRAN, Pascal and Protos application environments to the
HP9000, Integrity Itanium, Windows,
Linux, Sun or AIX platforms. This product from Speedware is commonly referred to
as AMXW.
Suprtool for AMXW is a
hybrid of Suprtool for HP-UX that uses the AMXW file system intrinsics, shell
commands and CI support such that customers applications require little or no
changes as part of the migration process.
Currently Suprtool for AMXW
is only available on HP-UX.
Suprtool for AMXW can be
run from the standard HP-UX prompt but primarily it is meant to run under the
AMXW shell.
For
AMXW version 8.05.01 Build5 and greater you can install Suprtool for AMXW in a
more MPE like manner, the below instructions rely on the fact that you have
installed the software in the usual Robelle location of /opt/robelle/bin.
You can change the location
of this installation, but the path cannot exceed 40 characters or so. You
will need to create a 'group' and 'account' called PUB and ROBELLE - just like
on the 3000.
You will then need to add a
link to all of the suprtool object files.
There are 3
objects...supamxw, stexamxw and linkamxw.
1. Position
yourself in the PUB.ROBELLE directory.
cd
$NLROOTDIR/ROBELLE/PUB
2. Make the
links. Make sure that your umask is set accordingly so that others will
have access to these links...with read / execute access.
ln
-s /opt/robelle/bin/supramxw suprtool
ln -s /opt/robelle/bin/linkamxw suprlink
ln -s /opt/robelle/bin/stexamxw stexport
ln -s /opt/robelle/bin/supramxw SUPRTOOL
ln -s /opt/robelle/bin/linkamxw SUPRLINK
ln -s /opt/robelle/bin/stexamxw STEXPORT
3. Make sure that your
HPPATH variable contains a refererence to PUB.ROBELLE.
SETVAR
HPPATH "!HPPATH,PUB.ROBELLE"
You will be able to
run suprtool through amxw using:
suprtool
SUPRTOOL
RUN SUPRTOOL.PUB.ROBELLE
Suprtool
for AMXW is based on the code for Suprtool for HP-UX. For the most part the
areas of Suprtool for AMXW that uses the AMXW “MPE” intrinsics related to file
operations. Following are some of the
exceptions and improvements to make Suprtool for HP-UX more MPE like and some
of the key exceptions that are not.
The Flimit and the Eof is
now displayed at the end of the form command of a self-describing file:
>form xyz
File: xyz (SD Version B.00.00)
Entry: Offset
CUSTNO X6 1
MATCHCODE X10 7
NAME1 X32 17
NAME2 X32 49
NAME3 X32 81
STREET X32 113
ZIPCITY X32
145
PHONE X18 177
TURNOVER 3E4 195
SALESAREA X6 219
Limit: 1455
EOF: 1179 Entry Length: 224 Blocking: 1
Since AMXW supports the
concept of File Limits Suprtool for AMXW the NUMRECS command is supported.
While the Output command
parsing is the same for AMXW version as it is the HP-UX version, the lf option
does not come into effect for files created by Suprtool for AMXW. The same applies
to STExport and Suprlink as well.
Suprtool for AMXW supports
temporary files in all of the necessary commands within Suprtool. It will open
temporary files with the input command and generate temp files when created by
the Output command and/or Total command. The same applies to STExport and
Suprlink as well.
Suprtool for AMXW will
check to see if there is room in the file that you are appending to, just like
the MPE version. Therefore you may see the error message:
Error : No room to append records
Suprtool for AMXW uses the
HP-UX version of the code for memory mapped files. This means that Suprtool for
AMXW currently has a limitation of a total of 500 Mb for files.
Suprtool for AMXW supports
two types of variable substitution. The first being the MPE-like variables that
are availabe in the AMXW shell. Suprtool for AMXW will first attempt to resolve
these variables first and then resolve an environment variables that are left
set in the standard HP-UX manner. The same rules apply with Set Varsub on and
Set VarsubCompat on.
There is one issue with
Suprtool for AMXW variable substitution that is different than Variable
Substitution on MPE. Varsub on MPE is
done via a low-level MPE routine, however, since this is not available Suprtool
must do something different that is as close to the MPE version as possible. So
Suprtool surronds a given line in quotes and resolves the variable(s) by
calling AMXW routines in a way that resolves the variables. The issue is
however, that if you mix quotes (typically If command and Extract command), the
variable substitution will fail and only part of the line will be parsed.
Therefore it is advisable not to mix quotes in this situation.
Some Set commands that do
not work in Suprtool for HP-UX do work in Suprtool for AMXW. These are
documented in the following section along with some AMXW specific commands.
The following section
contains the details typically from the MPE manual that are specific to
Suprtool for AMXW and not Suprtool for HP-UX.
Specify
the size of the input file (for tape files), output file (for datasets), and
the sort scratch file.
NUMRECS size
| percentage%
(default: size=10,000 or
EOF of input source)
Parameters
When you know that you are
selecting a small subset of the entire input source, use the Numrecs command to
reduce the size of the sort scratch file and, if required, the size of the
output file. If you select more than size
entries, Suprtool prints a warning message, and ignores the rest of the
input records. However, the output file will have the records that were
selected. Use a percent sign (%) to specify the Numrecs as a percentage of the
input file size. The percentage can range from 1 to 500.
Using Numrecs for Tape Files
The
Numrecs command is required to read more than 10,000 records from a tape file.
Suppose you want to read a tape file with 30,000 records. You would use the
Numrecs command to increase the size of the output file:
>:file t;dev=tape {define tape file}
>input *t {specify Suprtool
input}
>numrecs 30000 {make room for 30000
records}
>output out2 {output file will have
room for}
>xeq { 30000 records}
Reducing File Sizes
Suppose
that the d-sales dataset contains 100,000 entries, but you use the If command
to select 15% of the entries. We would specify 15 as the percentage on the Numrecs command to reduce the size of the sort
scratch file and the output file:
>get d-sales {specify input}
>numrecs 15% {specify 15000 as file
size}
>if
sales-qty<100 {select a subset of
d-sales}
>sort cust-account {sort using the
dataset path}
>output out2 {output file will have
room for}
>xeq { 15000 records}
MPE Files vs. Datasets
When you specify a source
of records using the Input command (as opposed to reading a dataset using the
Get or Chain command), Suprtool attempts to duplicate all of the input file's
attributes in the output file. This includes the file limit. For this reason,
the Numrecs value is ignored if the output file limit is smaller than the input
file limit. Numrecs is still useful when reading MPE files to reduce the size
of the sort scratch file.
Appending to Files
When
you want to create a file that you can append to later, you need to use both
the Numrecs command and the Set Squeeze Off command.
>get d-sales
>numrecs 200% {output file will have
extra room}
>set squeeze off {reserve room between
EOF and LIMIT}
>output dsale
>xeq
...
>get d-history
>output
dsale,append {dsale has room for
appending}
>xeq
SET AMXW External sd [ ON | OFF]
(Default: OFF)
Suprtool for AMXW now
has an option to create the external self-describing file as well as updating
the “label” information that AMXW keeps track of. This was done to help some
other applications work in conjunction with AMXW and Suprtool. The setting you
need to use is:
The default for this setting is off.
While the External SD is written to in this case for the other
Application Suprtool for AMXW will ignore the External SD file when reading
these files.
SET AMXW PerfWrite [ ON | OFF ]
(Default: OFF)
Suprtool for AMXW now
has an option to do multi-record writes to the output file, which has given as
much as a 10 times performance increase.
The default for this setting is off. AMXW version 8.05.01 Build 13
or higher is required for this to work.
SET FILECODE [ number ]
(Initially: 0; Default: no change)
When
Suprtool writes to an old file
(Output,Append and Output,Erase are the only cases), it leaves the filecode of
the output file unchanged. When Suprtool creates a new file with the Output,Ask or Output,Query option, it gives the
file a special filecode (1071 and 1084 respectively). When the input file has a
nonzero filecode, Suprtool carries that filecode over to the new output file.
See "Output Command [O]"
on page 30 for
details on Output options such as Ask, Erase, and Query. To convert a
self-describing file into a non-SD file, see "Suprtool and Self-Describing Files"
on page 30.
In all other cases, new files created by Suprtool have a
default filecode of zero. You can specify an alternate default filecode using
Set Filecode.
Specifying Set Filecode
forces Suprtool to create the output file with a specific filecode whenever it
was going to use zero. To be effective, this Set command should be added to the
Suprmgr file. To configure Suprtool to use the filecode 222 on output files,
you would add this line to your Suprmgr file:
This feature is useful for
MPEX users who wish to manage Suprtool output files. For example, to find all
of the Suprtool output files you would do the following:
:run mpex.pub.vesoft
%!listf @.@.@(code='222')
%exit
Of course, you can still
use a :File command explicitly to override the filecode of the output file.
SET SQUEEZE [ ON | OFF ]
(Initial & Default: <neither>)
Turning
Set Squeeze On forces Suprtool to always truncate the output file limit to the
end-of-file when the output file is closed. Turning Set Squeeze Off forces
Suprtool not to change the limit when closing the output file. By default or by
specifying Set Squeeze (i.e., with no option) forces Suprtool to decide when to
truncate the output limit to the end-of-file.
Suprtool will not squeeze a
file limit if the input source is a file, the output file is not a new file,
the output file is KSAM (CM, NM or KSAM64), or if the Ask or Num query output
options were specified. In all other cases, Suprtool squeezes the file limit
down to the EOF.
Set Squeeze Off can be
combined with the Numrecs command to automate job streams in which data is
appended to the output file. For example,
>get d-sales
>numrecs 200% {output file will have
extra room}
>output dsale
>set squeeze off {reserve room between
EOF and LIMIT}
>xeq
>get d-history
>output
dsale,append {Dsale has room for
appending}
>xeq
Suprtool's primary
function is to extract data quickly; its focus is batch extraction. The key
principle is: the bigger the input data
source and the smaller the subset of data selected, the more performance
improves.
Your aim is to replace serial reads and selection with Suprtool. To
do this, break your task into components: an input choice, some processing
selections, and the output choice.
Suprtool reads
fixed-length data files. You can create self-describing files with Suprtool's
Query or Link output options. It is easier to work with self-describing files
because they have information about the fields in each input record.
Often you select a subset of the input records using the If command.
Only selected records are passed to the processing stage and the output choice.
If you do not specify any
processing, the input records are quickly copied to the output choice. Some of
your processing choices are
1. Sort the records into ascending or
descending sequence (Sort or Key). No records are output until all of the
selected input records have been sorted.
2. Total one or more input record fields
(Total).
3. Remove or select duplicate records
(Duplicate).
Usually you wish to
extract a subset of your records to feed into a report program, so the default
output file is a data file. The default output file format matches the input
file format, unless you use the Extract command. You can specify different
formats for the output file by qualifying the Output command. To have readable
ASCII output, use "output xxx,ascii". To produce
"self-describing" files, use Output xxx,Link.
By default, every output record is identical to the corresponding
input record. The Extract command assembles output records by stringing
together fields extracted from the input records. With the Extract command you
can insert constant values into the output record.
Each output record is written to the output choice. You can also see
a formatted listing of each record with the List command.
Suprtool can read, sort
and write files greater than 2Gb on HP-UX 10.20 or higher. Suprtool is limited
to processing large files with 2.1 billion records or less.
Specify an Allbase
database with the Open
command. Once Suprtool has opened the database, use the Form command to obtain
information about the tables in the database. Use the Select command to choose
what data to read from your Allbase database. Allbase access is available as a
separate add-on module to Suprtool.
When you specify a Select command, Suprtool figures out how to
translate the Allbase internal data-types into ones that Suprtool can process.
Not all Allbase data-types can be processed by Suprtool. The following table
lists the Suprtool data-type that corresponds to the Allbase data-type:
|
Allbase Data-Type
|
Suprtool Data-type
|
|
Integer
|
Double
|
|
Smallint
|
Integer
|
|
Binary
|
Not Supported
|
|
Char
|
Byte
|
|
Varchar
|
Byte
|
|
Real
|
Ieee-32
|
|
Float
|
Ieee-64
|
|
Decimal
|
Packed
|
|
Numeric
|
Packed
|
|
TID
|
Not Supported
|
|
Date
|
Byte
|
|
Time
|
Byte
|
|
Datetime
|
Byte
|
|
Interval
|
Byte
|
|
Varbinary
|
Not Supported
|
|
Long binary
|
Not Supported
|
|
Long varbinary
|
Not Supported
|
Allbase has four types of fields that are associated with dates and
times. These fields are converted to byte-type data and are returned with
specific lengths.
The date and time fields are returned with the following byte
lengths:
|
Data-Type
|
Length
|
|
Date
|
10
|
|
Time
|
8
|
|
Datetime
|
23
|
|
Interval
|
8
|
Suprtool cannot currently handle all Allbase database concepts. The
current restrictions are:
1.
Suprtool requires that the
ownername be specified when selecting a particular table in the following
manner:
>select
* from purchdb.orders
In this example the owner is purchdb and the tablename is orders.
2. Suprtool does not currently handle the
Allbase date format. You can convert the Allbase date format to something that
Suprtool can handle with the TO_CHAR function in the Select statement. For
example:
>select qty,TO_CHAR(date,'YYYYMMDD') from manufdb.testdata
>def mydate,date[1],8 {redefine
testdate }
>item mydate,date,yyyymmdd {define
the date format}
>if mydate<=$today(-900)
You specify an Oracle
database with the Open
command. You can open any Oracle database to which you normally have access. If
you cannot open your Oracle database, check with your system or database
administrator so that your environment can be set up properly. Once Suprtool
has opened the database, use the Form command to obtain information about the
tables in the database. Use the Select command to choose what data to read from
your Oracle databases.
Oracle access is available as a separate add-on module to Suprtool.
When you specify a Select
command, Suprtool figures out how to translate the Oracle internal data-types
so that Suprtool can process them. Not all Oracle data-types can be processed
by Suprtool. The following table lists the Oracle data-type and the
corresponding Suprtool data-type:
|
Oracle Data-Type
|
Suprtool Data-Type
|
|
Varchar2
|
Byte
|
|
Number
|
Varies, see below
|
|
Long
|
Not supported
|
|
Rowid
|
Not supported
|
|
Date
|
Oracle Date
|
|
Raw
|
Not supported
|
|
Long raw
|
Not supported
|
|
Char
|
Byte
|
|
Mislabel
|
Not supported
|
Oracle numbers are
translated into a variety of Suprtool data-types. The translation depends on
the precision of the number and the number of decimal places. The following
table describes the translation for each case:
|
Precision
|
Decimal Places
|
Suprtool Data-Type
|
|
None
|
Any
|
8-byte IEEE
|
|
1-4
|
Zero
|
2-byte Integer
|
|
5-9
|
Zero
|
4-byte Integer
|
|
1-9
|
Non-zero
|
Packed-decimal
|
|
10-27
|
Any
|
Packed-decimal
|
|
28-38
|
Any
|
8-byte IEEE
|
In packed-decimal translations Suprtool uses the precision of the
number to determine the size of a packed-decimal number.
Oracle's Order By statement on the Select command does not always
generate the same results. Specifically, sorted fields with null field values
appear at the beginning when they are sorted by Suprtool's Sort command.
Suprtool/UX cannot handle all Oracle database concepts. The current
restrictions are:
1.
Suprtool/UX can handle
varchar2, char, date, and number data-types. It cannot handle any other
data-type.
2.
Because any Oracle Select
command can be used, it is possible to generate column names that are not
compatible with Suprtool/UX. For example,
>select
sal + comm from bonus
This example produces a column called "sal + comm". In some cases Suprtool/UX correctly uses this
as the column name (e.g., the List command). You cannot refer to this column by
name in any Suprtool/UX command that accepts field names as a parameter.
SDUnix is an MPE program
that takes self-describing file information and writes it out to an MPE flat
file. This flat file can then be transferred to HP-UX together with the data
file so that Suprtool/UX can reference the self-describing information about
the fields.
To copy the SD file to the HP-UX machine, it must have an .sd
extension and be in the same directory as the data file. For example, if the
data filename is /usr/local/data/datafile, the SD file must have the name
/usr/local/data /datafile.sd.
The SD file is written out to the same domain (permanent or
temporary) as the input file. The SD file contains only one record with the
necessary length to store all of the label information.
SDUnix has been included on your HP-UX tape and needs to be
installed on your MPE system. You can do this with either FTP or DSCOPY.
Installing using
FTP
1) Log on as Mgr.Robelle
2) Remove the Sdunixnm file
3) FTP the file from your Unix machine
ftp dopey
binary
cd /opt/robelle/mpe
get sdunixnm sdunixnm;rec=128,1,f,binary;code=nmprg;disc=1400
4) Remove any old versions of Sdunix
5) Rename the program file
To install the CM version of SDUnix, specify Sdunixcm as the file
name, ;disc=400,1,1 for the file size, and PROG for the filecode.
Installing with
DSCOPY
1) Log on as Mgr.Robelle
2) Remove the Sdunixnm file
3) Specify file command for proper program file size
4) DSCOPY the file from your Unix machine
dscopy /opt/robelle/mpe/sdunixnm:hpux[user:password] to
*sdunixnm;bin;fcode=1030;rsize=256;fix;rep
5) Remove any old versions of Sdunix
6) Rename the program file
To install the CM version of SDUnix, specify Sdunixcm as the file
name, ;disc=400,1,1 for the file size, and 1029 for the filecode.
All SDUnix parameters are specified via Info = string. There are three parameters:
input-file sd-file LF | NOLF
The first parameter is the name of an MPE self-describing file. The
second parameter is the name of the .sd file that SDUnix created.
Use the third parameter to specify whether the data file has LF
(line feed) as the record separator, or whether the file does not use a file
separator. If you use FTP to copy the data file to your HP-UX machine, you
should specify the NOLF option and be sure to use a binary mode transfer. If
you are using DSCOPY (with its default options) to copy the data file, you
should specify the LF option.
The following section contains examples of creating an SD file on
MPE, converting the SD information, and finally copying the two files to an
HP-UX machine.
First create an SD file with:
:run suprtool.pub.robelle
>base store,5
Database password [;]?
>get d-inventory
>out dinv,link
>exit
Now you can convert the label information to an .sd file using the
SDUnix utility. Note that the data file is the first file passed in the info
string.
Specify LF if you are using DSCOPY.
:run sdunix.pub.robelle;info="dinv dinvsd lf"
Now you can use DSCOPY to copy the files to the HP-UX machine.
:dscopy dinv to
store.dinv :dopey[data:password]
:dscopy dinvsd to store.dinv.sd:dopey[data:password]
Specify NOLF if you are using FTP.
:run sdunix.pub.robelle;info="dinv dinvsd nolf"
Use FTP to copy the files to the HP-UX machine.
:ftp dopey
ftp> binary
ftp> exitonerror
ftp> put dinv /users/data/store.dinv
ftp> put dinvsd /users/data/store.dinv.sd
ftp> quit
Now you can use Suprtool/UX to read the SD file.
$ suprtool
>input store.dinv
>form
File: store.dinv (SD Version B.00.00) No line feeds
Entry: Offset
BIN-NO I1 1
LAST-SHIP-DATE I2
3
ON-HAND-QTY I2 7
PRODUCT-NO Z8 11
SUPPLIER-NO Z8
19
UNIT-COST P8 27
ITEM-DESC1 X20 31
ITEM-DESC2 X20 51
ITEM-DESC3 X20 71
ITEM-DESC4 X20 91
Entry Length: 110 Blocking: 1
>out dinvfile
>xeq
SDUnix and Suprtool/UX can recognize files created with the ,Query
option and from Query. However, they cannot recognize compound item details or
any Item attributes, such as Decimal or Date type.
A problem with data files
is that there is no field information. Self-describing files solve this problem
by providing field information about the file. Suprtool reads and writes SD
files; Suprlink requires SD files as input and creates an SD file as output.
You request an SD file using the Link option of the Output command.
If you extract columns from the table, only the extracted columns appear in the
SD file.
>select * from sales {input
from a table}
>output salefile,link {salefile
has all of the columns from sales}
>xeq
You must Define and Extract the fields you
want to have in the SD file. Use the Link option of the Output command to
create the file as a self-describing file. Although Suprtool itself allows
longer field names, SD files only store the first 16 characters of a field
name.
>input sales.data,reclen 16,nolf {input
from a data file}
>define cust_no,1,6,byte
>define invoice_date,7,6,integer
>define sales_qty,13,4,packed
>extract cust_no,invoice_date,sales_qty
>output salefile,link {salefile
has all of the extracted columns}
>xeq
When you specify an SD
file as input to Suprtool, all the field information becomes available. You can
select, extract, and total fields without the Define command. In addition, the
Input command no longer needs any Reclen or LF parameters.
>input salefile {self_describing
file}
>form {display
the fields in the file}
>if sales_total > 10000 {select
based on a field}
>extract cust_account {only
extract a few fields}
>extract sales_qty
>extract sales_tax
>extract sales_total
>total sales_total {total
a field from the file}
>output newfile,link {create
a new SD file}
>xeq
Listing SD Files
Suprtool normally lists
data files in an Octal/Char format. When listing an SD file, Suprtool produces
a formatted listing with field names and field values converted into ASCII:
>input salefile {self-describing
file}
>list
{produce
a formatted listing}
>xeq
You use the Item command
to identify items with an implied number of decimal places or a date format. If
you create a self-describing file, this information is retained. When you input
such a file, all Suprtool commands are automatically informed about the decimal
places and date formats. The Form command shows these extra attributes as
comments at the end of each field description. For example,
>input salefile {self_describing
file}
>item deliv_date ,date
,yyyymmdd
>item purch_date ,date
,yyyymmdd
>item sales_tax ,decimal,2
>item sales_total,decimal,2
>output newfile,link {creates
SD file with item attributes}
>xeq
>form newfile {shows
decimal pts. and dates}
A few users have expressed
interest in having the ability to have SD field names be greater than 16
characters. However, a large number of customers have software that relied on
the SD format remaining the same. The compromise was to add Extended names to
the end of the .sd file. The new Extended names will be written out and used
inside Suprtool when you turn on this feature with Set SDExtname On. Suprtool
will only use this information if this setting is turned on.
Suprtool and Suprlink
now have a new optional extended name
format for Self-Describing files. Not all portions of Suprtool and Suprlink
handle the new extended name format, however, not all portions of Suprtool and
Suprlink support the extended name feature.
The Suprtool List
command does not utilize the extended name.
Suprlink does not use
the full extended names for key items, but rather uses the regular truncated
name just as it did previously. Suprlink does however, carry on the Extended
information and writes it to the output file.
So far in this section, we
have shown how to create self-describing files using the Link option of the
Output command. The Link option produces a special form of self-describing
file. Not all software can read this form of self-describing file. You can use
the Query option to create an old-style self-describing file. The Query option
has the following restrictions.
Self-describing files were originally created by HP in MPE so that
files could be fed into HPWORD and HP graphics packages. One problem with HP's
definition was that no provision was made for compound fields (e.g., 10J2).
When Suprtool creates an SD file with compound fields via the Query option, it
uses a special data-type. When you input such a file to Suprtool, all compound
fields are treated as byte arrays. Suprtool correctly copies and extracts these
fields, but you can not select with them. The Query option is not capable of
retaining information about decimal places or date formats.
When Suprtool sorts two
records that have the same key value, the first record read by Suprtool is the
first record on the output file. For data files, this means that input records
with the same key values appear in the same order in the output file.
You can format files to be
downloaded to your PC for use in spreadsheets or databases with the PRN option
of the Output command. Suprtool formats your file as a PC structure (a
comma-delimited file). Not all PC applications support the PRN format. For more
precise data conversion, create a self-describing file then use STExport. See
the STExport manual for details. You transfer the Suprtool output file to your
PC and then import it into your PC application.
After you have created a
PRN file using Suprtool, you can use FTP or any of the many terminal emulator
programs available to download the file to the PC. This includes Reflection
from Walker Richer & Quinn.
Be sure to specify which fields have decimal places when creating
the PRN file. Suprtool reserves extra space for decimal points that appear in
the PRN output. When formatting numeric fields, Suprtool inserts the decimal
point at the correct place. When you import your file into your PC application,
numeric fields are automatically formatted correctly.
The following procedure allows you to include literal headings in
your spreadsheet using only one file, the size and shape of which is computed
by STExport. We have tested this method with MS Excel; it should work with any
spreadsheet that supports the importing of delimited files.
There are two steps. First, build a self-describing file with
Suprtool, then use STExport to convert it to PRN and add the headings.
1. In Suprtool build a self-describing file:
>input ...
>define items...
>item items...
>extract fields...
>output sdfile,link
>xeq
2. In STExport convert to PRN and add the header line:
$input sdfile
$heading fieldnames
$output pcdata
$exit
The file Pcdata is a variable-length PRN file with both headings and
data.
You can use Suprtool to
significantly speed serial extracts using Quiz and QTP from Cognos. In many
cases the changes to existing applications are minor.
Quiz, QTP, and Quick are
components of PowerHouse 4GL, a popular fourth generation language sold by
Cognos. You can improve the performance of Quiz reports by using Suprtool to
select and sort the records from a file or SQL table, and passing selected records
to Quiz for final reporting. To do this, you need some way to tell Quiz about
the record structure of Suprtool's output file. Quiz already has the capacity
to do this without making any changes to the PowerHouse PDL dictionary.
In the following example, Suprtool extracts records from the
Custmast file, sorts them, and writes them to the Cmasfile file. These are the
records we need for the Quiz report.
The first step is to use Quiz to extract one entry from the Custmast
file and write it to a PowerHouse "subfile". Note that you could also
use QTP to build the subfile.
$rm cmasfile.sf
$rm cmasfile.sfd
$quiz
>access custmast
>report summary all
>set subfile name cmasfile keep
>set report limit 1
>go
This creates 2 files:
Cmasfile.sf, containing the extracted data, and Cmasfile.sfd, containing the
PowerHouse record definition for the data portion of the subfile. We use
Suprtool to reload the Cmasfile.sf file with all the records required for the
final report.
Once you have created the PowerHouse subfile, use the Erase option
of the Output command in Suprtool to load the file. This overwrites any data in
the data portion of the subfile, but it does not affect the
"dictionary" for that file.
$suprtool
>input custmast,reclen 80,nolf
>if credit_limit>=1000000
>sort custnum
>output cmasfile.sf,erase
>exit
The Cmasfile.sf file now contains the sorted records for the Quiz
report. Quiz can access the file because the Cmasfile.sfd containsthe record
definition. You can now use Quiz to generate the report:
$quiz
>access *cmasfile
>report ...
>go
You can also use QTP instead
of Quiz to create the PowerHouse subfile:
$rm cmasfile.sf
$rm cmasfile.sfd
$qtp
>access custmast
>set input limit 0
>subfile cmasfile keep include custmast
>go
The process of creating a
subfile is essentially the same regardless of the input file being used. The
only things that change are the subfile and input file names. Here is a script
file for automating this task. This script can be executed before running
Suprtool or from within Suprtool.
#!/bin/sh
rm usefile
echo set report limit 1 >usefile
echo access $2 >>usefile
echo set subfile name $1 keep >>usefile
echo report summary all >>usefile
echo go >>usefile
echo exit
>>usefile
quiz
<usefile
This script accepts two parameters: the name of the subfile to be
created and the name of the file whose structure it will duplicate.
Makesub can be invoked from within Suprtool, as shown below:
$suprtool
>:makesub cmasfile, custmast
>input custmast,reclen 80,nolf
>if credit_limit>=1000000
>sort custnum
>output cmasfile.sf,erase
>exit
Suprtool does not have the
ability to prompt users for selection criteria. You can easily create a short
Quiz procedure to prompt for values and create a file of Suprtool commands.
> define D-PROMPT date format YYMMDD = &
> parm prompt
"Enter selection date: "
> report &
> "input
custmast,reclen 80,nolf"
&
> skip "if
DATEFIELD = " D-PROMPT pic "^^^^^^" &
> skip "output
OUTFILE" &
> skip "xeq"
> set nohead
> set report device disc name STCODE
> set page length 0
> go
Quiz edits the user's input for a valid date. Note that there is no
ACCESS statement, but Quiz still writes one record to the output file. Execute
the resulting commands as a Suprtool usefile:
|
For this discussion we'll ignore the fact that the twenty-first
century really only started in 2001. J
|
Suprtool often has to process dates in both the twentieth and
twenty-first centuries. If you include the century in your dates, Suprtool
should behave as most users expect. If you do not include the century in your
dates, how Suprtool behaves will be dependent on your specific application
and data.
|
If your dates have
four-digit years, Suprtool should work as expected. Selection based on the
$today or $date features will select dates in both the twentieth and
twenty-first centuries. Dates that do not collate correctly (e.g., mmddccyy) will
not be accepted by Suprtool's If command for relative selection (e.g., <,
<=, >, or >=). If you have these date formats you can use the $stddate
function, converts any date format to a ccyymmdd type date.
Suprtool, as it has always done, will continue to sort dates based
on their numeric value and not on any implied date order.
In Suprtool 4.0, we introduced some new command parsing features
that let you control how Suprtool parses the year of the $date function. You
can either use two-digit years by applying a cutoff rule or you can force all
years to be specified as four digits.
Date Cutoff tells Suprtool
what century to use when Suprtool generates a constant date value from the
$date function.
Before version 4.0, Suprtool would assume 19 for the century for any
user-specified $date with a two-digit year. For example:
>item date-field,date,ccyymmdd
>if date-field <= $date(40/12/26)
Previously the $date function would convert the user specified $date
to 1940/12/26 in order for it to be compared to the date-field format of
CCYYMMDD. Now with Set Date Cutoff xx, Suprtool assumes 20 for the century if
the two-digit year specified in the $date function is less than the value of
Set Date Cutoff. For example:
>set date cutoff 50
>item date-field,date,ccyymmdd
>if date-field <= $date(40/12/26)
Suprtool in this case assumes the full $date to be 2040/12/26,
because the 40 in $date is less than the 50 in Set Date Cutoff.
The default value of Set Date Cutoff is 10.
When $Stddate has to
convert from a date with only a two-digit year, the conversion to the
four-digit year will use the value of Set Date Cutoff when converting the date.
For example,
>get sales-detail
>set date cutoff 15
>def new-ship-date,1,4,double
>item ship-date,date,mmddyy
>ext order-no / sales-amount
>ext new-ship-date = $stddate(ship-date)
>out salesinfo,link
>xeq
In this example, if any ship-date has a year of 14 or less, then the
century applied to the new-ship-date field will be 20. Ship-dates with a year
of 15 or more will have a century of 19 applied.
Set Date ForceCentury On
will not allow a yy date to be entered in the $date function, it will force the
user to enter a full ccyy date.
>set date forcecentury on
>item date-field,date,ccyymmdd
>if date-field >= $date(98/12/10)
Error: You must specify the century or Set Date ForceCentury off
The default value for Set Date ForceCentury is off.
If you have dates with
two-digit years, there are two main solutions to making your application ready
for the Year 2000:
1.
Convert all of your date data
to use four-digit years and modify your programs to process four-digit years,
or
2.
Assume that certain dates are
in the twentieth century and some in the twenty-first (this is usually called
date windowing).
The first solution requires that you change all Suprtool Item
commands for two-digit years to a four-digit year format. If you have not
already done so, you may want to isolate all of these Item commands in a single
file per input source (e.g., one file for every dataset in every database in
your application or just one file for every database). You can nest use-files,
making this approach even easier (e.g., having one database use-file that then
includes each dataset use-file with a list of Item commands). You may also want
to use Suprtool to assist you in changing your actual data from two-digit years
to four. See "Can Suprtool Convert
Two-Digit Years to Four Digits?" on page 30 for more details.
If you do not include the century in your dates (the second solution
above), you will have the following problems:
1.
Selecting dates in yymmdd
format will not produce the expected results in relative operations (e.g.,
<, <=, >, or >=). You will need to change all of your If commands
to use the $stddate function.
2.
Sorting dates that include both
20th and 21st century dates, will not collate the way most users expect,
whether with Suprtool, the COBOL sort verbs, or HPs sort tools. This is because
Suprtool, and all HP-supplied tools, sort based on the numeric value of a date.
To make this work correctly within Suprtool, you will need to use the $stddate
function in an Extract command to generate a date with a four-digit year, then
sort on this new date field with another Suprtool task.
Currently the date format of yymmdd collates (sorts) correctly if
the date is not beyond December
31, 1999. Given the current date of 981210, numerically this is
less than next year whose date value is 991210.
At the turn of the century dates in the yymmdd format (or yymm) will
no longer sort correctly because the value of December 10, 2000 (001210) is less than
981210.
Consequently, if we have a date beyond 1999, stored in yymmdd
format, a relative operation such as:
>if date-field >= $date(98/12/10)
will not find the date of December 10, 2000. You will need to use the $stddate
function to make this task work correctly.
>if $stddate(date-field) >= $date(98/12/10)
Suprtool's date functions
($date and $today) are a short-hand method of generating a numeric constant. So
a date selection like:
>item invoice-date,date,YYMMDD
>if invoice-date < $today
is exactly the same as:
>if invoice-date < 980401 {on
1st April, 1998}
Suprtool does record selection on the numeric value of the field and not on the implied date value. If we
move the calendar ahead to January
1, 2000 and do the same commands as above, the result would the
same as if you had typed:
>if invoice-date < 000101 {on
1st January, 2000}
If you have some invoice dates from the previous century (e.g.,
990101 for December 1st,
1999), they will not be selected.
Sometimes.
Because dates beyond 1999 will not collate properly for the YYMMDD
and YYMM formats, starting in version 4.0.11 the If command produces an error
if the year specified in a $date or $today function is greater than 1999 and
the date format is YYMMDD or YYMM, and you are performing a relative operation
(e.g., <, <=, >, or >=).
>item enddate, date, yymmdd
>if enddate >=
$date(*+4/*/*) {21st.
century date}
^
Error: Cannot use a date
beyond 1999 for this format
Suprtool returns this error by default, but you can override it with
the following set command:
>set date ifyy2000error off
This tells Suprtool to allow the previously described relative
operations and suppress the error message. While you can override the error
checking, the behavior of $today and $date is not changed.
If you need to have Suprtool select dates in YYMMDD format with
$Today or $Date, you need to use one of the following solutions:
1.
Change the date storage format
to include the century in all datasets and data files, so you can use the
following item command:
>item
invoice-date,date,CCYYMMDD
2.
Use the $stddate function that
adds the century component to dates in a ccyymmdd format in a J2 container.
Also see "Case 1: Converting a J2 Date from yymmdd to ccyymmdd" on page 30 and "Case 2: X6 yymmdd Data to X8 ccyymmdd" on page 30 for more specific details
on converting two-digit-year date formats into four-digit-year date formats.
The aammdd date format was
developed by James Overman of HP for use in the MM3000 product. This format is
only available for the X6 data-type.
The aammdd format is similar to yymmdd, but the year portion of the
date use a combination of numbers and letters of the alphabet to represent
years beyond 1999.
By substituting a letter of the alphabet in the first position of
the year, we can extend a six-digit date and also ensure that the dates collate
correctly. For example,
|
YY of AAMMDD
|
CCYY
|
|
A0 - A9
|
2000 - 2009
|
|
B0 - B9
|
2010 - 2019
|
|
C0 - C9
|
2020 - 2029
|
Because letters are greater than numbers in the collating sequence
we can ensure that aammdd dates beyond 1999 will order correctly.
Suprtool also supports other date formats with this two-digit year
representation. These formats are aamm, mmddaa and ddmmaa.
The If command has a
$invalid function to find all invalid dates for a particular field. An invalid
date is any number of a particular date format whose date equivalent cannot be
found on the calendar. For example, a date with a month of 99 will be
considered invalid.
>base store.demo
Database password [;]?
>get d-sales
>item deliv-date,date,ccyymmdd
>if $invalid(deliv-date)
>out baddates,link
>xeq
Suprtool is capable of
converting dates from one format to another using a variety of Suprtool
features. We will show how Suprtool can convert common dates without the
century to those that have the century included. While Suprtool can convert
your data, it is up to you to change your programs. Adager, a third-party
program for changing Image database structures, has the ability to change date
fields. Suprtool can convert data in Image databases, flat files,
self-describing files and KSAM files.
The $stddate function can convert six-digit date formats to
ccyymmdd. But what if all the dates are not actually dates, but some dates are
filled with 9s as a flag to an application?
Consider this dataset with two date fields, J2 items and in the date
format yymmdd.
Database: STORE.DB.GREEN
D-SALES Detail Set 5
Entry: Offset
CUST-ACCOUNT Z8
1 (!M-CUSTOMER)
DELIV-DATE J2 9
PRODUCT-NO Z8 13
(M-PRODUCT)
PRODUCT_PRICE J2
21
PURCH_DATE J2 25
SALES-QTY J1 29
SALES-TAX J2 31
SALES_TOTAL J2
35
Capacity: 602 (14) Entries: 10
Highwater: 10 Bytes: 38
First, we need to know and understand our data. Are there any
invalid dates? If so, does the value have some other logical meaning?
>get d-sales
>item deliv-date,date,yymmdd
>item purch_date,date,yymmdd
>if $invalid(deliv-date) or $invalid(purch_date)
>list
>xeq
>GET D-SALES (9) >OUT $NULL (0)
CUST-ACCOUNT = 10010 DELIV-DATE =
999999
PRODUCT-NO =
50513001 PRODUCT_PRICE = 19220
PURCH_DATE = 999999 SALES-QTY = 2
SALES-TAX = 2691 SALES_TOTAL = 21910
>GET D-SALES (10) >OUT $NULL (1)
CUST-ACCOUNT = 10010 DELIV-DATE = 125213
PRODUCT-NO =
50513001 PRODUCT_PRICE = 19220
PURCH_DATE = 1 SALES-QTY = 2691
SALES-TAX = 21910 SALES_TOTAL = 21910
IN=10, OUT=2. CPU-Sec=1. Wall-Sec=1.
In this example, we see two records that do not contain proper
dates. The first record contains all 9s, which is probably used as some sort of
flag. We may need to add 99 in front of these dates.
But the second record is obviously wrong. We can use Dbedit to
correct this before converting the other dates. We need to know our data to
properly convert to a new date format.
Once all the incorrect dates are fixed, we can start converting. We
can add a prefix of 19 or 20 to all the appropriate dates by using the
following Extract statement. Please note that we are updating this directly. In
case we need to redo this task, we only convert those dates that have not yet
been converted. In this example we set the cutoff year to 30 so any dates
before 30 will have 20 as the century and the others will have 19.
>get d-sales
>set date cutoff 30
>item purch_date,date,yymmdd
>item deliv-date,date,yymmdd
>if not $invalid(purch_date) and not $invalid(deliv-date)
>update
>ext purch_date = $stddate(purch_date)
>ext deliv-date = $stddate(deliv-date)
>xeq
We have now converted all the J2 yymmdd dates to a ccyymmdd format
and added the correct century to the date.
The following Suprtool task shows how you can generate a new file to
put into a new database with dates in a different format.
Consider the deliv-date and purch_date fields of the D-Sales
dataset:
Database: STORE.DBOLD.ACCOUNT
D-SALES Detail Set 5
Entry: Offset
CUST-ACCOUNT Z8
1 (!M-CUSTOMER)
DELIV-DATE X6 9
PRODUCT-NO Z8 15
(M-PRODUCT)
PRODUCT_PRICE J2
23
PURCH_DATE X6 27
SALES-QTY J1 33
SALES-TAX J2 35
SALES_TOTAL J2
39
Capacity: 611 (13) Entries: 15
Highwater: 15 Bytes: 42
You want to convert to a date format with room for a cc at the
beginning of the deliv-date and purch_date:
Database: STORE.DB.ACCOUNT
D-SALES Detail Set 5
Entry: Offset
CUST-ACCOUNT Z8
1 (!M-CUSTOMER)
DELIV-DATE X8 9
PRODUCT-NO Z8 17
(M-PRODUCT)
PRODUCT_PRICE J2
25
PURCH_DATE X8
29
SALES-QTY J1 37
SALES-TAX J2 39
SALES_TOTAL J2
43
Capacity: 608 (16) Entries: 0
Highwater: 0 Bytes: 46
In order to convert these dates you need to be able to put either a
19 or 20 in front of the yymmdd date, depending on the value of the year.
Before you can do either of these you must confirm, once again, that you have
no invalid dates.
>base store.dbold
>get d-sales
>item deliv-date,date,yymmdd
>item purch_date,date,yymmdd
>if $invalid(deliv-date) or $invalid(purch_date)
>list
>xeq
Once you have confirmed that there are no invalid dates you can
start converting the dates that you have. Because there are two date fields in
this dataset you must be careful to add the appropriate century for the proper
field. For this example, assume that if a year is less than 1950 then the
century should be 20.
You can easily convert each date by processing each field separately
by using an intermediate self-describing file:
>base store.dbold,1
Database password [;]?
>get d-sales
>set squeeze off
>item deliv-date,date,yymmdd
>if deliv-date >= $date(1950/01/01)
>out sales01,link
>ext cust-account
>ext "19"
>ext deliv-date / sales_total
>xeq
IN=15, OUT=14.
CPU-Sec=1. Wall-Sec=5.
Now insert 20 to the century for the appropriate records:
>base store.dbold
>get d-sales
>if deliv-date < $date(1950/01/01)
>ext cust-account
>ext "20"
>ext deliv-date / sales_total
>out sales01,link,append
>xeq
Now you can convert the other field from the flat file, (sales01)
and add a century to the purch_date field:
>reset
>base {close
the open database}
>in sales01
>item purch_date,date,yymmdd
>if purch_date >= $date(1950/01/01)
>set squeeze off
>out sales02,link
>ext cust-account / product_price
>ext "19"
>ext purch_date / sales_total
>xeq
IN=15, OUT=15.
CPU-Sec=1. Wall-Sec=1.
Because you extracted all 15 records you know you do not have any
records with the purch_date field that need to be updated with a
"20".
Now you can insert the records into the new database:
>base store.db
>in sales02
>put d-sales
>xeq
Now you have converted two dates from an X6 format to an X8 format.
The following Suprtool task shows you how to convert a date in a
self-describing file from mmddyy to yymmdd format.
Consider the following self-describing file with the deliv-date and
purch_date fields:
File: SALES04.DATA.ACCOUNT
(SD Version B.00.00)
Entry: Offset
CUST-ACCOUNT Z8
1
DELIV-DATE X6 9
<<MMDDYY>>
PRODUCT-NO Z8 15
PRODUCT_PRICE I2
23
PURCH_DATE X6 27
<<MMDDYY>>
SALES-QTY I1 33
SALES-TAX I2 35
SALES_TOTAL I2
39
Limit: 115 EOF: 15
Entry Length: 42 Blocking: 97
You want to convert these two dates to a data format of yymmdd
before adding a century in front of the year. This can be easily accomplished
by defining each sub part of the date and extracting those parts in the new
order.
>in sales04
>def deliv-date-mm,deliv-date[1],2
>def deliv-date-dd,deliv-date[3],2
>def deliv-date-yy,deliv-date[5],2
>def purch_date-mm,purch_date[1],2
>def purch_date-dd,purch_date[3],2
>def purch_date-yy,purch_date[5],2
>ext cust-account
>ext deliv-date-yy
>ext deliv-date-mm
>ext deliv-date-dd
>ext product-no / product_price
>ext purch_date-yy
>ext purch_date-mm
>ext purch_date-dd
>ext sales-qty / sales_total
>out sales05,link
>xeq
You now have a file with the dates in yymmdd order, but the
self-describing information shows three separate fields.
File: SALES05.DATE.ACCOUNT
(SD Version B.00.00)
Entry: Offset
CUST-ACCOUNT Z8
1
DELIV-DATE-YY X2
9
DELIV-DATE-MM X2
11
DELIV-DATE-DD X2
13
PRODUCT-NO Z8 15
PRODUCT_PRICE I2
23
PURCH_DATE-YY X2
27
PURCH_DATE-MM X2 29
PURCH_DATE-DD X2
31
SALES-QTY I1 33
SALES-TAX I2 35
SALES_TOTAL I2
39
Limit: 115 EOF: 15
Entry Length: 42 Blocking: 97
You can convert these several fields to one field with another
extract task:
>in sales05
>def deliv-date,9,6,byte
>def purch_date,27,6,byte
>item deliv-date,date,yymmdd
>item purch_date,date,yymmdd
>ext cust-account
>ext deliv-date
>ext product-no
>ext product_price
>ext purch_date
>ext sales-qty / sales_total
>out sales06,link
>xeq
IN=15, OUT=15.
CPU-Sec=1. Wall-Sec=1.
You now end up with a file that looks like this:
File: SALES06.DATA.ACCOUNT
(SD Version B.00.00)
Entry: Offset
CUST-ACCOUNT Z8
1
DELIV-DATE X6 9
<<YYMMDD>>
PRODUCT-NO Z8 15
PRODUCT_PRICE I2
23
PURCH_DATE X6 27
<<YYMMDD>>
SALES-QTY I1 33
SALES-TAX I2 35
SALES_TOTAL I2
39
Limit: 115 EOF: 15
Entry Length: 42 Blocking: 97
You then add the century to these fields as described above.
Testing software to see if
it works in the year 2000 and beyond is difficult. Currently there are three
software tools that change the software date for specific sessions or
applications, making it easier to test software for year 2000 compliance. The
four tools are:
1.
Hourglass from Allegro
Consultants, Inc.
2.
Time Machine from SolutionSoft
Systems, Inc.
3.
Setdate from the HP Jazz
machine on the Web
4.
TimeWarp/3000 from
Omnisolutions
All versions of Suprtool work with Hourglass, but versions previous
to 4.0.13 did not work with Time Machine, Setdate, or TimeWarp. This version of
Suprtool now works with all these tools. Note that this change only applies to
non-expiring versions of Suprtool. Expiring versions of Suprtool (such as
trials, pre-releases, and products obtained through VARs) do not work with Time
Machine or Setdate.
HP-UX sites use Suprtool because it provides access to their data
many times faster than they are used to. Suprtool also enables them to perform
time-consuming DP functions with only a few simple commands. The typical
Suprtool task consists of extracting some data for a report, then feeding the
Suprtool output file into the final report program. For example, you might fill
a data file with the subset of data needed, then report that file with
Microfocus COBOL.
Suprtool/UX has high-speed
dataset reads for Eloquence databases. Suprtool
for HP-UX by default calls dbget to do serial reads, however, if you use Set
FastRead On, you will efficient large reads. Testing
has shown that the CPU time can be improved by anywhere from two to five times
and Wall time has improved anywhere from two to six times faster. In order to
turn this feature on for all accesses you can put the command:
into the file /opt/robelle/suprmgr. This means that Suprtool will
use the faster reads for all runs of Suprtool. Set FastRead On must be set
prior to the Base command otherwise it will be ignored. Starting with Suprtool
version 5.1, Fastread is now on by default in the “regular” version of Suprtool
for HP-UX. The “regular” version of Suprtool for HP-UX/AMXW refers to the
version that does NOT use the ROBELLELIB_IMAGE variable to find and load the
IMAGE intrinsics.
Suprtool/UX uses its own
set of sorting routines. These routines are generally faster than the sorting
algorithms provided with software tools and SQL databases.
If you have the right data, Suprtool/UX can sort much faster than
other HP-UX tools. Because sort performance varies a lot from application to
application, we recommend that you test Suprtool/UX in your own environment.
You can improve the performance of sort operations by moving the
sort workspace to a different physical disk drive than the input file uses.
You can move the sort scratch space by setting the TMPDIR environment
variable to a directory that resides on another physical disk drive, provided
you have read and write access to that directory.
export TMPDIR="/var/tmp/sortscratch"
Suprtool/UX provides you
with easy ways to let either Oracle or Suprtool do most of the work. Whether it
is best to use Oracle or Suprtool depends on your specific machine, database,
and application. You can use the Select command to force Oracle to do much of
the processing or you can use Suprtool to do the work. In our testing, Suprtool
consistently sorts two to four times faster than Oracle. Your performance
improvements may be different from ours, so we recommend that you take some
common tasks and try them with both tools. Here is an example of sorting with
Oracle and then with Suprtool:
Oracle sorts
data
>select * from emp order by ename
Suprtool sorts
data:
>select * from emp
>sort ename
For more information on Oracle performance, we recommend the book Oracle Performance Tuning by Peter Corrigan
and Mark Gurry (published by O'Reilly and Associates).
It is better to test
Suprtool with your own database and your own application needs, rather than
trust a "generic" performance test. The ideal test is an actual
production report whose bad performance is causing you a problem. If you obtain
improvements by using Suprtool, you know that you can achieve better speed in
practice as well as in tests.
Use Suprtool as a front end to your problem report, producing a
small extract file that contains just the fields and records needed for your
final program. Once you get that working, consider linking in data from other
files or datasets using Suprlink. For comparison purposes, run the Suprtool test
at the same time as you would normally run the original program. Comparing a
standalone midnight run
against a mid-day run does not give valid results, nor does comparing two runs
in succession (the second run benefits on HP-UX because the files are already
in memory at that time).
Suprtool supports
environment variable substitution. To use this enhancement you must do a:
Due to how HP-UX
processes work with environment variables any variables must be exported prior
to running Suprtool, STExport or Suprlink. All of these modules support HP-UX
variable Substitution.
export
tablefile='abcdefghijklmnopqrstuvwxyzabcd'
export infile='file1sd'
./suprtool -oc << \!EOD
set varsub on
in $infile
table mytable,char-field,file, &
/users/robdev/suprtool/test/$tablefile
if $lookup(mytable,char-field)
out file05,link
exit
!EOD
Suprtool examines a
command line and looks for variables denoted by the "$" sign. Since
Suprtool has some functions that begin with a $-sign, these will take
precedence regardless of the value set in the variable of the same name.
|
Do not enter the > sign when typing commands.
|
When you run Suprtool, it prompts for commands with a
">" character and reads command lines from the standard input
device. Suprtool commands contain a command name which may include one or
more optional parameters that are each separated by commas.
|
In this chapter, we describe the Suprtool commands in alphabetic
order. Each command name is followed by its minimal abbreviation in brackets.
For example: [D] for Define and [DU] for Duplicate.
Most Suprtool commands work within the context of the input file. In
general, the Base, Chain, Get, Open, Select and Input commands must be entered
before other commands. Once the input source has been specified, commands can
be entered in any order.
You may shorten the
command name to any substring that uniquely defines the command. For example,
Form can be abbreviated as FO or F, since there are no other commands that
start with "F". Duplicate, however, can be abbreviated only to DU,
since there is also a Define command in Suprtool.
>i sdfile {Input
command}
>l {List
command}
>x {Xeq
command}
You can enter the letters in either uppercase or lowercase because
Suprtool upshifts everything in the command line except literal strings within
quotes (e.g., "abc") and disc file names. These two commands are
identical:
>EXTRACT QTY
>extract qty
You can enter several
commands on a single line, if you separate them with semicolons. An entire
"task" can be placed on one input line.
>in sdfile;out new;xeq
>in sdfile;if cust-status<>10,20,30;list;x
Caution: Suprtool cannot distinguish between several commands on one line and
several commands entered on several lines. This is not a problem when using
Suprtool in batch, as Suprtool stops executing when an error occurs. But when
using Suprtool interactively, specifying multiple commands separated by a
semicolon, Suprtool keeps on parsing the rest of the line after it finds an
error. For example, if you misspell the "fldname" when you type the
following,
>get dsetname; if fldname="value";delete;out
filename;xeq
Suprtool sends you an error message with the typo, but continues
with the rest of the command line. This has the effect of deleting all the
entries in the dataset. It is risky to type Xeq on the same command line as any
other command unless:
1.
You are not concerned with the
consequences if you make a mistake (e.g., any "extract" task should
be safe).
2.
You don't make any mistakes.
The usual reason for putting all the commands on one line, including
the Xeq, is to permit repetition of the task by using the Before command. It is
not necessary to type everything on one line because with the Listredo command,
Suprtool allows you to pick and choose any of your last 1000 commands.
|
|
The maximum physical command
line is 256 characters. You may enter commands on multiple input lines by
putting an "&" continuation character at the end of the line.
The maximum total command length is 256 characters. The separating comma in
commands is not optional. Should your If command exceed 256 characters, use
the Table command, or $read.
|
>in sdfile
>if status="20" and & {continue
the If command}
state="AZ","CA","OR" {select
several states}
>output outfile
|
You may also use MPE's :COMMENT command to enter comment lines.
|
Comments may appear at the end of any command line, as long as
they are surrounded by curly braces. Many of the examples in this manual show
comments at the end of command lines. You can enter a comment as the only
item in a Suprtool command line. When you enter continued command lines, the
comment can appear before or after the continuation character:
|
>{The following task extracts all customer records for}
>{ the different
customers we are interested in.}
>in customer
{input self-describing file}
>if status = "10" or & {prepaid status}
status = "20" or
& {current status}
status =
"30" {arrears status}
>output outfile
{output to a disc file}
>exit {execute the task and exit}
If Suprtool doesn't
recognize the command you have entered, it tries to interpret it as an
operating system command. Suprtool also interprets any command line beginning
with an exclamation mark (!) or a colon (:) as an O/S command. For example:
>!# sort custfile by custnum {comment}
>input custfile
>key 1,10 {no
'!' on the next command}
>ls sort* {check
for file name}
>out sortcust
>exit
Any command line beginning with an equal sign (=) is treated as a
calculator expression. This feature can be used to compute blocking factors and
do other calculations without the need of an electronic calculator. For help,
type =?.
You can interrupt a
Suprtool task with the Control-Y key (hold down Control while striking Y).
Suprtool responds by telling you how much work it has done (IN=,OUT=,etc.) and
asks if you wish to stop. Hit the Return key to continue or type YES to stop
the task. Even though you abort the task, your output file is saved (although
it may be empty if you stop before the sort phase is over).
Many HP-UX sites use Control-C as the interrupt key instead of
Control-Y. Use the HP-UX 'stty'
command to display your 'intr' setting. You may see some Suprtool messages
indicating Control-Y is the key combination to enter, when in fact you will
need to use whatever you have defined in stty.
Specify an SQL table to
which you wish to Add records.
Add tablename
Use the Add command to "insert" records into an Oracle
table. You must specify the Oracle tablename
and you must have opened the Oracle database to which you wish to add records.
The tablename specified must be a valid table and not a view. The
fields from the input source, or the extracted names must be the same as the
column names in the table to which you wish to add records.
You do not have to specify all columns in the table; unreferenced
columns will be given default values depending on their data-type.
You cannot currently add records from another SQL table. However,
you can extract the records you want into a file and then add from that file.
The first example shows a typical Add task. A self-describing file's
records are added to the table called customer. This assumes that the
self-describing file has the same structure and that the field names are the
same as the column names.
>open oracle scott tiger {open
SQL database}
>in custrecs {input
file you wish to add}
>add customer {specify
the Oracle table}
>exit {execute
the task}
Our next example shows how to add by redefining the fields from a
self-describing file into a table. The names are redefined so that the field
names being extracted will match those in the table of the SQL database.
>open oracle scott tiger {open
SQL database}
>in custrecs {input
file you wish to add}
>def cust_name,custname {redefine
the items to match}
>def cust_addr,address {the
names in the table}
>extract cust_name {extract
data under the column name}
>extract cust_addr
>add customer {specify
the Oracle table}
>exit {execute
the task}
Our final example shows input from a flat file.
>open oracle scott tiger {open
SQL database}
>in salehist {input
file you wish to add}
>def cust_number,1,6,byte {redefine
the items to match}
>def item_no,7,10,byte {the
names in the table}
>def sales,18,4,double
>extract cust_number {extract
data under the column name}
>extract item_no
>extract sales
>add customer {specify
the Oracle table}
>exit {execute
the task}
Suprtool cannot currently support integers larger than two words.
Opens a specified
Eloquence database. Once you have it open, you can extract data from datasets,
delete entries, load new entries into datasets and Update certain entries.
To close the current
database, use Base without parameters.
BAse [[host][:service]/]database
Open an Eloquence database (close current base). Suprtool will open
an Eloquence database, the syntax has been improved to allow you top optionally
specify the hostname, and or service, to connect to a given database.
base sample,5
base :eloqdb/sample,5
base hostname.robelle.com:eloqdb/sample,5
Basename is the name of your database. Mode is the DBOPEN mode that you want (i.e., mode-1 for shared
updates, mode-5 for shared read-only), and password
is the DBOPEN database password. When the password is included in the Base command, it is always upshifted.
Use the ? option to specify lowercase passwords.
Suprtool opens the Base, which remains open until you do another
Base command, a Reset Base, or a Reset All, even if you do several extracts
from the database.
Examples
The first example shows a typical Suprtool task. A dataset in the
Store database is read and a subset of the entries are sorted into a disc file:
>base store,5,READER {open
for read access only}
>get d-sales {select an input
dataset}
>if sales-total>10000 {choose
a subset of all entries}
>sort cust-account {sort
by account number}
>output salesout {output
has same structure}
>exit { as the d-sales dataset}
Our next example opens the database with the Creator password (which
is the default). No output file is produced; instead, we produce a formatted
listing of the input dataset:
>base store {use the Creator
password}
>form sets {you
cannot remember the names}
>get d-inventory { of the datasets in Store}
>list {print
the dataset fields formatted.}
>exit { no output file is created}
In session mode, this
command would prompt for the database password. If none is entered, or Suprtool
is not running interactively, the Creator password is used by default (;).
Because the open mode was not specified, the database is opened in mode-1.
Database
Passwords in Batch
In batch mode, it is necessary
to specify a database password without the password being echoed on the job
stream listing. A special database password is provided to allow for this. When
a question mark "?" is used as the database password, Suprtool
prompts for the password on the next physical input line without echoing. This
occurs in batch mode or in session mode. For example:
>base store,5,? {Suprtool
prompts for the password.}
Password > {Password
is on this line, but it won't}
>get d-inventory {show
on job stream listing or terminal.}
>exit
Open Modes
Base does not allow mode-7 for exclusive read access, but it does
allow mode-4 for exclusive update while others read. Mode-4 disallows changes
while you are extracting from the database. Mode-3 for fully exclusive access
is tolerated, but causes Suprtool to use slow DBGETs to extract from datasets.
Suprtool allows you to open a second database in the Put command
when you are copying from one database to another.
Eloquence
Libraries
If the Eloquence libraries
have not been loaded Suprtool will print an error on the Base command. To
find out specific error messages as to
why the libraries have not been loaded then just run Suprtool with the –lw
option, which means print loader warnings.
Repeat any combination of
the previous 1000 command lines, with or without editing.
BEFORE [ start [ / stop ] ]
[
string ]
[
ALL | @ ]
(Default: redo previous
line)
(BQ=redo without change)
The Before command allows you to modify the commands before it
executes them. If you don't need to change them, use BQ or Do.
The Before command uses Qedit-style Control characters for modifying
the commands. The default mode is to replace characters. To delete use
Control-D, and to insert use Control-B. If you prefer HP-style modify (D, R, I,
and U), use the Redo command instead of Before.
Examples
>ll *.fd {".sd"
is not spelled right}
*.fd not found
>Before {redo
most recent command}
ll *.fd {last
command is printed}
s {you
enter changes to it}
ll *.sd {the
edited command is shown}
{you
press Return}
>listredo -10/
>before 5 {redo
5th command in stack}
>bef 8/10 {redo
8th through 10th}
>b ls {redo
last ls command}
>b ls * {redo
"ls *" command}
>b @* {redo
last containing "*"}
>before -2 {redo
command before previous}
>before -5/-2 {redo
by relative lines}
Modify Operators
If you wish to change any
characters within the line, the modify operators are the regular Control Codes
used in Qedit:
|
Characters
|
Action
|
|
Any printing characters
|
replace the ones above. (This assumes your EOF key has been
altered from the HP-UX default.)
|
|
Control-D plus spaces
|
deletes columns above.
|
|
Control-B
|
puts you into "insert before" mode.
|
|
Control-A
|
starts appending characters at the end of line.
|
|
Control-A, Control-D, plus spaces
|
deletes from the end.
|
|
Control-T
|
ends Insert Mode, allowing movement to a new column.
|
|
Control-G
|
recovers the original line.
|
|
Control-O
|
specifies "overwrite" mode (needed for spaces).
|
Persistent Redo
Redo commands can be saved in a permanent file and can therefore be
used from another session. You can use the Set
redo command to specify a filename to save your redo commands. Please see
"Redo" on page 30 for details.
Selects an Eloquence
dataset and a search path as the input source for the next extract. For detail
datasets, the Chain command does a DBFIND on the specified search path and uses
DBGET mode-5 to read the records. For master datasets, the Chain command uses
DBGET mode-7. You must have read access to all fields in the dataset entry.
Only one Chain, Get, or Input command is allowed per extract task.
CHAIN setname,search-field=value
[,...]
CHAIN setname,search-field=table-name
When using Chain, the size of the output file defaults to the size
of the Chain dataset. If the dataset is large and the selected subset is small,
you should use the Numrecs command to reduce the size of the output file.
Selection by
Individual Values
Suppose you want to find all the sales records for customer account
"1234". Assuming that cust-account is a search field in the d-sales
dataset, you would use this:
>base store,5,READER {open
for read access only}
>chain d-sales,cust-account="1234" {read
the sales records for customer 1234}
>out out1
>xeq
If you want to select sales records for more than one customer, you
would use:
>chain
d-sales,cust-account="12345","67890","39201"
>out out2
>xeq
Values with
Decimal Places
You can specify values
with decimal places for search fields with implied decimal places. For example,
>item unit-cost,decimal,2 {two
implied decimal points}
>chain d-inventory,unit-cost=10,10.5,10.75
>out out3 {select
records for 1000, 1050, and 1075}
>xeq
Selection with a
Table
You can specify the
records to read using a table. The Table command may appear before or after the
Chain command. Use this option when you have a file of key values to search
for:
>{select the sales records that match the values in custfile}
>chain d-sales,cust-account=sales-table
>table sales-table,cust-account,file,custfile
>out out4
>xeq
Combining Chain
with If
The Chain command selects an input dataset and
a set of key values to search for. To specify additional selection criteria,
use the Chain command to specify the key values and the If command for the
additional selection criteria:
>{select records for customer 1234 where the sales-qty is }
>{ greater than 100}
>chain d-sales,cust-account="1234"
>if sales-qty > 100
>out out5
>xeq
Notes
The Chain command is intended to replace a Get and If combination
where the primary selection is by key value. In many cases, it is still faster
to use the Get command to read the entire dataset than it is to use the Chain
command to use search-paths. Use Set Stat On to compare the performance of the
Chain and Get commands.
The Chain command always reads the chain values in sorted order by
ascending search-value. You do not need to specify a Sort command to have the
output file sorted by the search field.
Specifies what characters
to clean when using the $Clean function.
CLEAN [ SPECIAL |
<string> <range> ]
(Default: None)
Suprtool will "clean" or replace all of the characters
specified in the Clean command from a byte type field when invoked by the
$Clean function. To define what characters that need to be replaced you use the
clean command with the character you want to clean in quotes. Since most of the
characters that you will need to clean are unprintable, you can enter the
decimal equivalent of the character. This is denoted by entering the
"^" character in quotes preceding the decimal number of the character
you wish to clean.
An example of how easy
it would be to clean your database of certain "bad" characters in
byte-type fields would be as follows:
>base mydb,1,;
>get customer
>clean
"^9","^10","^0","^7"
>update
>ext address(1) =
$clean(address(1))
>ext address(2) =
$clean(address(2))
>ext address(3) =
$clean(address(3))
>xeq
The SPECIAL keyword automatically defines Clean characters of
Decimal 0 thru to Decimal 31.
>base mydb,1,;
>get customer
>clean special
>update
>ext address(1) =
$clean(address(1))
>ext address(2) =
$clean(address(2))
>ext address(3) =
$clean(address(3))
>xeq
You can also specify a range of characters with the following
syntax:
>base mydb,1,;
>get customer
>clean
"^0:^10"
>update
>ext address(1) =
$clean(address(1))
>ext address(2) =
$clean(address(2))
>ext address(3) =
$clean(address(3))
>xeq
The above task would clean all byte type fields of any characters
from Decimal 0 (Null) to Decimal 10. (Line Feed)
You can have the Clean function clean the field, and instead of
replacing with a space, the $clean function will essentially shift characters
to the left by Setting the CleanChar in the following manner:
Suprtool will pad the field that was cleaned with the appropriate
amount of characters with a space at the end of the field.
Defines fields that can be
used in the Duplicate, Extract, If, Item, Sort, Table, and Total commands. With
Define, you can do selection on ordinary data files using the same kind of
readable "expression" that you use with databases. You can also
access data fields that are not actually structured as defined in the database
(e.g., implicit subfields within an IMAGE field).
DEFINE field, definition
field is an identifier up to 32 characters long, must begin with a
letter, and can consist of letters A through Z, digits 0 through 9, or the
following symbols:
+ - * / ? # % & @ _ $ '
In the case where the field name is written to a self-describing
file, only the first 16 characters are used.
definition can be in two different forms: absolute or relative.
Absolute
Definitions
DEFINE field, byteposition,sublen [,type] [,subcount]
(Default: type=BYTE, subcount=1)
The byteposition is a positive integer giving the byte index where the
field starts. The first byte is always number 1, not 0. The sublen is the number of bytes in the
field. When the subcount is 1
(default), the sublen is the total
number of bytes in the field. When you specify a subcount, the sublen is
the byte-length of each subfield.
See Data-Types below for the definition of type.
>input uxfile,reclen 40, lf {input
from a disc file}
>def qty,14,4,double {double
integer (PIC S9(9) COMP)}
>def name,5,6 {character
string of 6 bytes}
>sort name {sort
using the field "name"}
>total qty {total
all the values of the field "QTY"}
>exit
Relative
Definitions
DEFINE field, fieldname [ (subscript) ] [ [offset] ]
[,sublen] [,type]
[,subcount]
(Default: sublen/type=same as fieldname)
The fieldname is a field from an Eloquence dataset specified in Get or
Chain, or a column from a table specified in Select, or a field from a
self-describing file, or another Defined field. Relative definitions are
similar to COBOL's Redefine verb.
The sublen
and type are optional. They
default to the total byte length and type of the fieldname. The (subscript)
parameter is an optional sub-item index for arrays such as Eloquence compound
items like 5J2 or 4X20. The first sub-item is number 1, and if no subscript is
provided, Suprtool uses the first sub-item. The [offset] parameter is optional and specifies a byte offset from the
position that would otherwise be used. This allows you to define fields
relative to other fields. The [offset] starts
at 1 and not at 0 (i.e., FIELD[1] is the first byte of the field).
To define a field that corresponds to the second index of the
address array of the customer file, you would use:
>in customer {self-describing
file}
>define city,address(2)
>if city="Vancouver"
>list
>xeq
Data-Types
Here are the valid types:
|
Type
|
Description
|
|
BYTE
|
printable ASCII characters
|
|
INT/INTEGER
|
two's complement
|
|
DOUBLE
|
two's complement
|
|
IEEE
|
IEEE floating-point
|
|
PACKED
|
packed-decimal
|
|
PACKED*
|
packed-decimal, last nibble unused
|
|
DISPLAY
|
zoned-decimal numeric field
|
|
LOGICAL
|
unsigned integer
|
|
CHARACTER
|
for Native Language Support
|
The Define command also accepts Fpoint as the data-type for IEEE
numbers.
The following table shows the Suprtool definitions for the IMAGE
data-types:
|
IMAGE Type
|
Number of Bytes
|
COBOL Declaration
|
SUPRTOOL Definition
|
|
I1
|
2
|
S9(4) COMP
|
>define a,1,2,integer
|
|
I2
|
4
|
S9(9) COMP
|
>define a,1,4,double
|
|
I4
|
8
|
S9(18) COMP
|
>define a,1,8,integer
|
|
J1
|
2
|
S9(4) COMP
|
>define a,1,2,integer
|
|
J2
|
4
|
S9(9) COMP
|
>define a,1,4,double
|
|
J4
|
8
|
S9(18) COMP
|
>define a,1,8,integer
|
|
Un
|
n
|
A(n)
|
>define a,1,n,byte
|
|
Xn
|
n
|
X(n)
|
>define a,1,n,byte
|
|
Zn
|
n
|
9(n)
|
>define a,1,n,display
|
|
Pn
|
n/2
|
S9(n-1) COMP-3
|
>define a,1,n/2,packed
|
|
K1
|
2
|
|
>define a,1,2,logical
|
|
K2
|
4
|
|
>define a,1,4,logical
|
|
E2
|
4
|
|
>define a,1,4,ieee
|
|
E4
|
8
|
|
>define a,1,8,ieee
|
Data-type Display may have a trailing overpunch sign.
Packed-Decimal
Fields
When defining
packed-decimal fields, you must convert the number of decimal digits into a
byte count. The last digit of a decimal field is always used for the sign. There are two data-types for decimal
fields: PACKED for those that end on a byte boundary and PACKED* for those that
end in the middle of a byte. Here are some example definitions of
packed-decimal fields:
|
Suprtool Definition
|
Description
|
|
>define m,1,2,packed
|
s9(3) COMP-3, P4 in IMAGE, 2 bytes, 4 nibbles, last is sign digit
|
|
>define n,1,2,packed*
|
s9(2) COMP-3, P4 in IMAGE, 2 bytes, 4 nibbles, last digit is
unused
|
|
>define p,1,6,packed
|
s9(11) COMP-3, P12 in IMAGE, 6 bytes, 3 words, 11 digits
|
Data-Type
Warning
The Define command accepts field definitions of any combination of
byte-length and data-type. However, many combinations have limited usefulness
in Suprtool. In these cases, Suprtool prints a warning. For example:
>def field,1,1,integer
Warning: Length of 1 is of
limited use for the data-type INTEGER
Examples
The following examples show the various data-types and combinations
that are available with the Define command:
>define a,11,4,double {J2
or I2, S9(9) COMP}
>define b,21,2,int {J1
or I1, S9(4) COMP}
>define e,21,8 {character
string}
>define f,address(5) {fifth
occurrence of address}
>define g,address(5)[3],4 {relative
offset}
>define h,address(5)[4],2,byte {middle
of the address}
>define i,x[6],4 {starts
at sixth byte of X}
>define j,invoice,6,byte {redefine
field as Byte}
Absolute Example
The following example shows the most basic use of the Define command
to create a new field definition at an absolute location in the input record.
{"amt" is an integer that starts at the 11th byte of file}
>def amt,11,2,int
>if amt > 1000 {"amt"
is now a field we can select on}
>output outfile
Absolute Example
with Subcount
IMAGE and Suprtool allow fields to be repeated. In the next example,
we define an amount field that repeats twelve times (e.g., once for each month
of the year). We use a subscript when we want to refer to a specific month.
>def amt,11,2,int,12 {"amt"
is an integer that repeats 12 times}
>if amt(5) > 1000 {we
select on the 5th subfield}
>output outfile
Relative
Examples
Use the simplest form of relative definitions to rename existing
fields.
>def quantity,qty
{"quantity"
is a more readable name}
>if quantity = "100 " {selection
on the new field}
The Define command copies the byteposition, sublength, and type to
the new field, but it does not copy the subcount. Define assumes that you want the
first subfield:
>def amount,amt {amt
is 12J2}
>if amount > 1000 {amount
is 1J2 and is the same as amt(1)}
Relative Example
with Subcount
Because Suprtool defaults the subcount to one, you might want to
specify an explicit subcount when giving a new name to an existing field.
>def amount,amt,,,12 {amt
is 12J2; same length and type}
>if amount(5) > 1000 {amount
is 12J2; we are selecting for May}
Relative Example
with Subscript
Use subscripts to define a new field that corresponds to a specific
subfield.
>def may,amt(5) {amt
is 12J2}
>if may > 1000 {may
is the fifth subfield}
Relative Example
with Offset
Many applications define subfields within a larger character field.
A common example is a part-number where the first four digits are the warehouse
location, the second four digits are the bin number, and the last four digits
are a serially assigned number. Use the offset parameter to define new fields
that are relative to the start of the part number. The file INVOICES is a
self-describing file.
>in invoices {part
is 12 bytes}
>def warehouse,part,4 {warehouse
starts at part}
>def bin,part[5],4 {bin
is second four bytes}
>def release,part[9],4 {release
is the last four bytes}
>if bin = "100" {use
any field for selection}
Note that redefining the digits of a larger numeric field only works
when the field is a character field (type X, U, or A).
Relative Example
Combining Subscripts and Offsets
If we have ten part numbers combined into one field (e.g., 10X12) we
can still define a single field that corresponds to the bin number of one of the
parts.
>in invoices {allparts
is 10X12}
>def bin3,allparts(3)[5],4 {we
are checking starting at the fifth byte …}
>if bin3 = "100" {…
of the third part}
Notes
The purpose of the Define command is to tell Suprtool to look at a
portion of the input record in a certain way. For example, if the record
contains ASCII digits in the first ten bytes, Define could be used to assign a
field definition to the first six bytes. In this case, the field must be
defined as data-type Byte, Char or Display.
|
The Extract command may be used for data conversion. See the Data
Conversion section of the Extract command for
details.
|
The Define command cannot be
used to convert data from one format to another. Using the same example, the
Define command could not be used to treat the first six digits of the ten
digit ASCII field as Integer, Packed, Real, or any other numeric data format.
If the input record contains ASCII digits, Define cannot change them to
another data-type.
|
It may be helpful to think of the Suprtool Define command as similar
to a COBOL REDEFINES clause, or a FORTRAN EQUIVALENCE statement.
Deletes all entries
selected from the input Eloquence dataset.
DELETE
Delete has no parameters, and can be entered only after the source
of input records has been specified using Get or Chain. Delete causes Suprtool
to "delete" the input records after they have been read, either all
of the input records, or a subset defined by the If command. Delete is not
supported for SQL or disc files, only for Eloquence datasets.
Examples
>:comment Delete and sort old transactions, write to file.
>base store
>get d-sales
{dataset
to delete from}
>if purch-date<980101 {select
which records to delete}
>delete {ask
for deletion}
>sort cust-account {sort
by account and sort}
>sort purch-date { by date}
>output oldsales {output
file with deleted and sorted records}
>exit
Losing Records
Delete can be combined
with other operations, such as select, sort, write to output file, and even a
Put to another dataset. Care must be used when combining operations, because
such combinations cannot be restarted if the Suprtool "run" is
aborted for any reason (including hitting Control-Y and answering
"yes"). See "Suprtool and " on page 30 for more details on using
the Delete and Put commands in combination.
Suprtool deletes records during the input phase. This means that
records are deleted before they are sorted. All of the selected input records
are deleted before the first output record is written when sorting the input.
If you press Control-Y and answer "yes" before a delete task has
completed, there may be no way to recover your deleted records.
Warning Message
When deleting records from
the input dataset, Suprtool asks for permission to delete all records if there
is no If command to select the records to be deleted:
Delete all records from the D-SALES dataset [no]:
Respond Yes for the task to continue.
In batch mode, Suprtool assumes Yes and keep processing.
Note that if there is no If command, but there is some other command
to limit the number of records deleted (e.g., the Numrecs command or a
record-range on the Get command), Suprtool still asks the question, implying
that all records in the dataset will be deleted. In these cases, only the
records that are read, based on the limiting factor, will be deleted.
For interactive approval of each deletion, see the Delete command of
Dbedit.
Notes
For Eloquence manual master datasets, a DBDELETE call fails if the
entry to be deleted is a "chain-head" with related detail entries
still linked to it. When this happens, Suprtool, by default, prints an error
and stops processing the input data. If Set Dumponerror On, the record is
printed on $stdlist. If Set Ignore On has been entered, Suprtool continues
processing and prints a count of "chain-heads" at the end. Records
that cannot be deleted are not included in the output file.
The Do command repeats
(without changes) any of the previous 1000 commands.
DO [ start
[ / stop ] ]
[
string ]
[
ALL | @ ]
(Default: repeat the
previous command)
Commands are numbered sequentially from 1 as entered and the last
1000 of them are retained. Use the Listredo command to display the previous
commands. You can repeat a single command (do 5), a range
of commands (do
5/10) or the most recent command whose name matches a
string (do
list). If you want to modify the commands before
executing them, use Redo or Before.
Examples
>listredo {see
the previous 20 commands}
>do {do
previous command again}
>do 39 {do
command line 39 again}
>do 5/8 {do
command lines 5 to 8 again}
>do list {do
most recent List command}
>do grep {do
last starting with "grep"}
>do grep job * {do
last "grep job *" command}
>do @job {do
last containing "job"}
>do -2 {do
command before previous one}
>do -7/-5 {do
by relative line number}
>do 5/ {do
command lines 5 to "last"}
Notes
The Do command can be abbreviated to ,., as in MPEX
. You cannot use ";" to combine commands on the same line.
By default, Suprtool
copies all selected input records to the output file. The Duplicate command
determines what to do with duplicate output records. Duplicate records can be
discarded, producing an output file without duplicates. Alternatively, you may
be interested in seeing the duplicate records, so you can create an output file
consisting solely of the duplicate records. When deciding whether an output
record is a duplicate, Suprtool either compares the keys only or the entire output
record.
DUPLICATE NONE | ONLY
RECORD
| KEYS [num]
[
COUNT ] [ TOTAL ... ]
None
The None option removes
duplicate records from the output file. Suprtool compares each output record
with the previous output record. If they are not the same, the record is added
to the output file. This option corresponds to the former Nodup and Nodupkey
options of the Output command.
>key 1,4
>duplicate none keys
Input Output
1111 10 1111
10
2222 25 2222
25
2222 35 3333
48
3333 48
Only
The Only option is the
exact opposite of None. Only selects all output records that would not be
written by the None option. When the Only option finds a record that duplicates
a record already in the set, it writes that duplicate to the output file. Note
that the first record is not written to the output file. Here are two examples:
>key 1,4
>duplicate only keys
Input Output Input Output
1111 10 2222
35 1111 10 2222
35
2222 25 2222 25
2222 42
2222 35 2222 35
3333 48 2222 42
Record
Suprtool has two methods for comparing output records: Record and
Keys. The Record option compares the entire output record. This option can be
specified without a sort, but in that case the input file must already be
sorted. Note that there are two data fields in the records in the following
example, so that a comparison of the entire record yields no duplicates.
>duplicate none record
Input Output
1111 10 1111
10
2222 25 2222
25
2222 35 2222
35
3333 48 3333
48
Keys
The Keys option compares only the sort keys to determine whether an
output record is a duplicate. This option requires that at least one sort key
be specified.
>sort agent {sort
by agent}
>duplicate none keys
>output agents {create
roster of agents}
The Keys Num option determines the level at which Suprtool compares
sort keys. This option controls which duplicate records get included in (or
excluded from) the output file.
In the following example we sort by agent and by bill-date (in
descending order), but only check for duplicates at the agent level.
>sort agent {sort
by agent}
>sort bill-date,desc {sort
by date}
>duplicate none keys 1 {only
check for duplicate agents}
>output agents {create
roster of agents}
Count
The Count option causes
Suprtool to produce a new field in the output record with the number of
occurrences of each key value. The count field is called st-count, and is an
I2-type field. The Count option can only be used with Duplicate None Keys.
>key 1,4
>duplicate none keys count
Input Output
1111 10 1111
10 1
2222 25 2222
25 2 {two
records for key value 2222}
2222 35 3333
48 1
3333 48
Total
The Total option allows up to 15 fields to be
subtotaled for each duplicate key. Separate the fields with spaces, not commas.
The Total option can only be used with Duplicate None Keys. A new field is
created at the end of the output record for each total. Each field is called
st-total-n:
>sort customer-no
>extract customer-no
>duplicate none keys total sales-qty sales-amt
The above commands will create a self-describing file with the field
customer-no and the total by each customer of the sales-qty in the field
st-total-1. Similarly the field st-total-2 will contain the total sales-amt by
customer number.
The following data-types are chosen for each total based on the
data-type of the field:
|
Data-Type
|
Total Data-Type
|
|
IEEE
|
E4
|
|
all others
|
P28
|
Please see the P28 Fields section on how to define these fields in
Cobol and PowerHouse programs.
Note that for byte fields, there can be only digits in the field. If
there are other characters such as "+", "-", or
".", then Suprtool reports an error.
You can use the Link output option to easily see the fields that
Suprtool creates. For repeated fields (e.g., 6I2), the first subfield is
subtotaled if you don't provide a subscript. You can combine the Count and
Total options, but the Count option must appear before the Total option. You
cannot combine the Total command with the Total option of the Duplicate
command.
>key 1,4
>def field,5,2,integer
>duplicate none keys total field
Input Output
1111 10 1111
1 10
2222 25 2222
2 60 {25
+ 35 = 60}
2222 35 3333
4 48
3333 48
Deleting
Duplicate Records
There is no direct way to delete duplicate
records. Specifying both the Delete and Duplicate commands does not delete all
duplicate output records. This is because the Delete command occurs in the
input phase, as records are read and selected, but the Duplicate command occurs
in the output phase after the sort has taken place. The Duplicate command is
not part of the selection process; it is the If command that determines what
records are deleted. A common mistake is to specify the Duplicate and Delete
commands without an If command. In this case, Suprtool asks your permission to
delete all input records. Answer
"No" to this question to abort the task.
It may be possible to remove duplicates from an input dataset using
Suprtool, but only through roundabout methods. These are too case-specific to
document here. If you need to do this, call Robelle technical support for
assistance.
Self-Describing
Files
When you are using the
Count or Total options, the sort information is not retained in the output
file. This means that if your output file is in LINK format, there are no sort
keys. If you are going to use this file from Suprlink, use the BY-clause of the
LINK command to manually specify the sort keys.
Non-Self-Describing
Files
If the input file is not a
self-describing file and you are using Count or Total, you also need to extract
all the fields from the file. You can quickly extract the fields by defining a
new field that contains the entire record. For example, if your records are 56
bytes long, then you do the following to extract all the fields:
>define entire,1,56,byte
>extract entire
Output
Restrictions
When you are using the
Count and Total options, the only Output formats that you can use are Data,
Data-Num, Query, and Link. If you want to quickly see the Count or Total
results without using a second pass, use the List Standard command.
>select * from table
>sort key_field
>duplicate none keys count total data_field
>output result,link
>list standard
>xeq
Notes
The option of Only or None must be specified before the option of
Record or Keys. Reversing the order causes a syntax error in the Duplicate
command.
You cannot combine the Total command with the Total option of the
Duplicate command.
Edits an Eloquence
database.
EDIT
The Edit command of Suprtool invokes an independent module of
Suprtool called Dbedit. This module permits the user to add, change, list, or
delete individual records or "chains" of records from an Eloquence
database. This module should be useful for debugging systems, doing data entry
on simple systems, and quickly prototyping systems. The Edit command uses the
database opened previously by the Base command. Where Suprtool is primarily a
serial tool, the Edit module is primarily a tool for chained or keyed access.
Examples
>:comment Edit the STORE database.
>base store,1,writer {open
for write access}
>edit {switch
to Dbedit}
#list d-inventory {Dbedit
prompts with "#"}
#exit {returns
control to Suprtool}
> {Suprtool
prompts again}
Notes
An entire user manual has been provided to describe how to use the
Edit feature of Suprtool. See See the Dbedit section in the manual for all the
details.
Exit Suprtool in one of
two ways.
EXIT [ ABORT | XEQ ]
(Default: XEQ)
Users are often frustrated when they exit Suprtool after specifying
only part of a task because Suprtool starts processing the task. To exit
Suprtool without executing the current task, use the Abort option.
Typing Exit with no parameters means Exit Xeq. Suprtool recognizes
special command names which specify both the Exit command and an exit option
(e.g., EA means Exit ABORT).
Exit Abort [EA]
Cancels the current
operation and terminates Suprtool. The Exit command without parameters always
attempts to perform the task currently specified, while Exit Abort cancels the
task and terminates immediately. Thus, Exit Abort is similar to Reset All;Exit.
Examples
You began to specify a sort, stopped for coffee, and decided to
cancel the task on your return:
>!# You began to specify a
sort, stopped for
>!# coffee, and decided to
cancel the task
>!# upon your return.
>open oracle demo reader
>select * from customer
>sort name_last; sort name_first
...coffee break ...
>exit abort {cancel
the sort and terminate}
End Of Program
Exit Xeq [EX]
Signal the end of command
input and the start of an extract operation. After the Suprtool task completes,
Suprtool terminates. Exit Xeq is the default option (i.e., specifying Exit
starts execution of the current task).
Examples
$/opt/robelle/bin/suprtool
>exit {no
input was specified}
No action taken.
$/opt/robelle/bin/suprtool
>input rep23.newdata
>out rep23.data
>xeq {copy
one file}
>input rep24.newdata
>out rep24.data
>exit {copy
and stop}
Notes on Exit
Xeq
If you have entered
neither sort keys nor an input source, Exit terminates Suprtool without
performing any task. If you have defined an input source but without any sort
keys, Suprtool does a copy operation prior to stopping.
You cannot use Suprtool's
Export command to invoke STExport/UX, but you can run STExport/UX by itself.
/opt/robelle/bin/stexport
STExport/UX/Copyright Robelle Solutions Technology Inc. 1988-2004
(Version 5.1.02)
$
STExport/UX only accepts self-describing files created by
Suprtool/UX or the MPE SDUnix program.
Assembles output records
by stringing together fields extracted from input records. There can be up to
255 extracted fields, and the same field may be extracted more than once.
Constant values may be used instead of the value of the field from the Input
record.
EXTRACT field [(subscript)] [=value |=field2 ]
[,...]
EXTRACT field1 [(subscript1)] \ field2 [(subscript2)]
EXTRACT target-field [=expression]
(Default: subscript=entire field)
Field Parameter
Each extracted field must be an Eloquence field name,
an SQL database table column, or a field in an SD file, or a Defined field. If
the field requires an Item definition, then the Item command must precede the
Extract command. Extract specifies a rearrangement of the Input data fields to
produce the Output data record; there is no data conversion, unless
"output xxx, ascii" is specified.
The subscript parameter is valid only for compound items. The total
item is extracted if it is compound and no subscript
is specified.
>extract account {extract
the key value and}
>extract rating
{ one other field}
>output out1 {output
file has two fields}
Cumulative
Extracts
The Extract command is cumulative. If two Extracts are specified in
one run, all fields of the two Extract commands are used.
>extract status,balance,account,purchased
is equivalent to
>extract status,balance
>extract account,purchased
Extracting
Constants
The value part of the Extract command is used to place a constant in
each record of the output file. In this case, the field defines the type and length that the value occupies. The value portion
must match the type of the field.
String values will be extended with blanks to fill the entire field. If the
input data does not have a field of
the correct size and type, you can create one using the Define command.
>ext account {key
value}
>ext rating=0 {place
the value "0" in the "rating" field}
>output out2
The total number of bytes that you can extract for all constants is
5,100 bytes for MPE/iX and HP-UX, and 1,275 bytes for MPE/V.
When extracting
non-negative packed and display constants, Suprtool extracts them as unsigned
unless you use a leading plus sign. For the value zero, you can use a leading
plus or minus sign to get a positive or negative 0.
>def field,1,6,packed
>ext field = 1 {unsigned
1}
>ext field = +1 {signed
1}
>ext field = +0 {positive
0}
>ext field = 0 {unsigned
0}
>ext field = -0 {negative
0}
Decimal Places
If a field has implied
decimal places, Suprtool scales the input values according to the number of
decimal places. For example,
>item tax ,decimal,2 {two
implied decimal pts.}
>item total,decimal,2 {same}
>extract tax = 1.02 {specified
decimal pts.}
>extract total = 100 {value
stored as 10000}
>output out3
Blank Fill
If you want to create an output record that consists of fifty blanks
followed by the customer name, use:
>define filler,1,50
>ext filler=" "
>ext name
String Constants
You can specify a string constant without referring to a field. For
example, to leave a space between fields, you must do the following:
>extract account," ",rating
>output *,ascii
Suprtool uses the length of the string to determine the size of the
field. The following example extracts the same fields as the previous example,
but each output record identifies the field:
>extract "Customer Account=",account," "
>extract "Credit Rating=",rating
>output *,ascii
The output would look like:
Customer Account=04598921 Credit Rating= 5000
Customer Account=44657844 Credit Rating= 20000
Customer Account=98753198 Credit Rating= 3000
The spaces after "Credit Rating=", before the rating
value, is due to the numeric field Rating being extracted with blanks for its
leading zeros. This is the result of the Ascii option of the Output command.
Repeated Fields
If the field is an IMAGE
repeated field (e.g., 10J1), the Extract command places the value in each of the repeated fields when you do
not specify the subscript. If you
specify a subscript, only that one
repeated field will have the new constant value.
In this example, Address is a repeated field (2X20). We wish to
extract the data as it exists in the input record rather than forcing it to a
constant value.
>ext account {extract
key value}
>ext address {take
both of the repeated fields}
In the next example, we assume that the Balance field is a repeated
field (12J2). We wish to make each of the 12 repeated fields in the output
record equal to 100:
>extract name
>extract balance=100
If we only wanted to extract the sixth field of BALANCE and set it
to 100 we would do the following:
>extract name
>extract balance(6)=100
Character
Constants
Use the ^-character to
specify any ASCII character. The number (the actual ASCII value), or letter (^A
means control A), must follow immediately after the ^-character. Suprtool
treats character constants as strings. When you extract the constant to a field
longer than one byte, Suprtool pads it with spaces.
>define field,1,1 {byte
field}
>ext field = ^0 {binary
zero}
>ext field = ^G {Control-G
(bell)}
>ext field = ^27 {escape}
>ext field = ^252 {Roman-8
box}
>ext field = ^186 {Euro
currency symbol €}
You can also extract the constant directly without referring to a
defined field. This always produces a one-byte constant with no blank padding.
>ext ^0 {binary
zero}
>ext ^13,^10 {Carriage
Return, Line Feed}
>ext ^M,^J {CR,
LF again}
>ext ^27,"&dB" {escape
sequence}
Extracting
Today's Date
To extract today's date,
use the following:
>item
field,date,ccyymmdd {identify
date format of field}
>extract field=$today {today's
date}
>extract field=$today(-1) {yesterday's
date}
>extract field=$today(+1) {tomorrow's
date}
Use the Item command to qualify the field as a date. Suprtool uses
the date format to determine the output format of the date. The $today function
accepts one optional argument which is the number of days before or after
today. The maximum number of days in either direction is 9999.
Oracle dates include both the date and the time. If you extract an
Oracle date using $today, the time is always 00:00 (i.e., midnight).
Extracting
Relative Dates
The Extract command
provides the same relative date features as the If command (see "Date Selection" on page 30 for a complete
description of the options of $date). You must first use the Item command to
identify the field name as a date. Suprtool uses the field type and length
along with the date format to determine the output format of the date. Note
that the three parts of $DATE are always specified in (year/month/day) order,
regardless of the date format of the field.
>item field,date,mmddyy
>extract field=$date(*/*/*) {today's
date}
>extract field=$date(*/*-1/01) {start
of last month}
>extract field=$date(*/*-1/last) {end
of last month}
Oracle dates include both the date and the time. If you extract an
Oracle date using $date, the time is always 00:00 (i.e., midnight).
$Stddate
Similar to the If command,
the Extract command is also capable of utilizing the $stddate function. This
will allow for conversion of any of the supported Suprtool date formats to be
converted to a date in the ccyymmdd date format in a double integer container.
For example,
>in sdfile {a
self describing file}
>def new_ship_date,1,4,double
>item ship_date,date,mmddyyyy
>ext order_no / sales_amount
>ext new_ship_date = $stddate(ship_date)
>out salesinfo,link
>xeq
Invalid Dates
Because the $stddate must have a valid date in order to properly
convert the date to the ccyymmdd format, a value of 0 will be returned for any
invalid dates. An invalid date is any number of a particular date format whose
date equivalent cannot be found on the calendar.
This means that if you attempt to extract use the $stddate function
against a value that is not a valid date then the extracted value will be 0.
$Days
As with the $stddate function,
the $days function is also available to the Extract command. You can convert
any supported date to a Julian Day number in the following manner:
>in ordfile
>def ship-days,1,4,double
>def order-days,1,4,double
>def delay,1,4,double
>ext order-no
>ext ship-days=$days(ship-date)
>ext order-days=$days(order-date)
>ext delay=$days(ship-date)-$days(order-date)
>out neword,link
>xeq
IN=15, OUT=15.
CPU-Sec=1. Wall-Sec=1.
Invalid Dates
If an invalid date is encountered, the extracted value will be zero.
Therefore in the example above, if the order has not yet been shipped
(ship-date does not contain a valid date) the resulting delay value will be
negative.
Add and Subtract
Dates
With the $days function,
you can generate a date that is n days
before or after any date. In the
following example, we show you how to get the previous day's date.
>input YOURFILE
>def origdate,1,8
>def yesterday,1,8
>item origdate,date,yyyymmdd
>item yesterday,date,yyyymmdd
>ext origdate
>ext yesterday = $stddate($days(origdate) – 1) {or
+7 for next week}
>out tmpfile,link
>xeq
Sample output:
ORIGDATE YESTERDAY
19990101 19981231
19991231 19991230
19990301 19990228
Date Limits
The $date function in
Suprtool can generate dates between the years 1583 and 2583. Some date formats
have limits based on their particular format, such as 2027 for a Calendar date
and 2259 for the aammdd aamm, mmddaa, ddmmaa dates.
Range of Fields
Extracting a Range of Fields
You can specify a range of
fields to extract using the following:
Extract Field1 \ Field4
This feature only works with Eloquence fields, input files
"equated" to an Eloquence dataset and for self-describing files. If
you specify a range, Suprtool extracts all 4 of the field names between field1
and field4 inclusive. When specifying a range of a self-describing file that
has been equated to an Eloquence dataset, the Eloquence dataset definition
takes precedence.
>get d-sales {a
self-describing file}
>ext product-no\sales-qty
>out dsales
>xeq
is exactly the same as:
>get d-sales {a
self-describing file}
>ext product-no
{first
field in the range}
>ext product-price
>ext purch-date
>ext sales-qty {last
field in the range}
>out dsales
>xeq
Extracting a
Range of Subscripted Fields
Suprtool accepts a subscript on either field in a range. You can even
use this feature to extract a range from a single field. For example, if
sales_amt is a 12J2 field:
>in sales {a
self-describing file}
>ext sales_amt(4)\sales_amt(6)
>out dsales
>xeq
is equivalent to:
>in sales {a
self-describing file}
>ext sales_amt(4) {first
subscripted field}
>ext sales_amt(5) {intermediate
subfield}
>ext sales_amt(6) {last
subscripted field}
>out dsales
>xeq
Alternate Syntax
for Extracting a Range
Suprtool accepts a slash "/" in place of the backslash
"\" to specify a range. Use the slash with care, because it is a
valid character in field names. For example,
>extract a/b
would produce the error message:
Error: Field "A/B"
does not exist
To use a slash in an extract range, surround it with spaces:
>extract a / b
You can specify arithmetic
expressions for any numeric data-type in the Extract command. Arithmetic
expressions involve the operators +, -, *, / and mod. Extract arithmetic
expressions work exactly as If command arithmetic expressions. To extract an
expression, use this syntax,
EXTRACT target-field = expression
Target-Field
The target-field determines the byte-length, data-type, and
repeat-count for the expression. The expression is extracted during the output
phase and cannot be used by other Suprtool commands that accept fields (e.g.,
sort). To avoid confusion, it is best to define a new field name for the target-field instead of using an
existing field name.
Examples
>extract budget99 = actual98 + 1000
>extract total = cost * qty
>extract day = ccyymmdd-date mod 100
In the following example, the field total is used
twice. In the first case, it is used to tell Suprtool how to format the
arithmetic expression. In the second case, it is used in the sort command.
Warning: In this example, the output file is sorted by the value of total as it
appears in the input record. It is not be sorted by cost * qty.
>extract total = cost * qty
>sort total {sort
by input total}
Restrictions
You can only use one expression in each Extract command, and the
expression must be the last item. If you want to extract several expressions or
more fields after an expression, you need to use several Extract commands.
Incorrect
>extract name, i=sales + tips, c=cost + expense, dept
Correct
>extract name, i=sales + tips
>extract c=cost + expense
>extract dept
Constants vs.
Expressions
If you have an arithmetic
expression that starts with a constant, Suprtool assumes that you are
attempting to extract a single constant value and not an arithmetic expression.
To specify an arithmetic expression that starts with a constant, surround the
expression with parentheses. For example,
Incorrect
>extract c = 6000 - cost
Error: Missing comma or
invalid arithmetic expression
Correct
>extract c = (6000 - cost)
The accuracy of arithmetic computations is limited to approximately
sixteen digits. Suprtool may truncate four-word integers (quad), or large
packed-decimal numbers, or display numbers when they are converted to
floating-point. Suprtool does not produce any error or warning in this case.
$Abs function
Suprtool supports an $abs
function, which returns the absolute value of a number. For example, if a field
called Credit contains the value -547.83, the $abs function returns 547.83.
This function will work on a field or even on an expression such as:
>def newcredit,1,4,double
>ext newcredit = $abs(credit / 100 * 1.07)
This function will also work in the If command:
>if $abs(credit / 100 * 1.07) > 500.00
$Truncate
function
Suprtool supports a
$truncate function which returns the number to the left of a decimal place. For
example if the field stddev contains the value 547.83, the $truncate function
will return 547. Note that there is no rounding.
This function will work on fields and expressions. For example,
>def newdev,1,4,double
>ext newdev = $truncate(stddev / 100 * 1.07)
This function will also work in the If command:
>if $truncate(stddev / 100 * 1.07) > 200
Suprtool has the ability
to keep a running subtotal for any numeric field based on a given sort key. The
target data must be a packed field with 28 digits, in order to avoid overflow
issues.
A sample use of the
$subtotal function could be:
>def mytotal,1,14,packed
>get orders
>sort order-number
>ext order-number
>ext part-number
>ext description
>ext sales-amount
>ext mytotal = $subtotal(sales-amount,order-number)
>out sales,link
>xeq
This would result in a
file containing a running subtotal in the field mytotal for a given
order-number. You could then generate a simple report with the simple Suprtool
commands:
>in sales
>list standard
>xeq
The basic syntax for the
$subtotal function in the extract command is:
extract targetfield =
$subtotal(field,sort-field)
You must specify the
sort command before referencing the sort-field in the $subtotal function. You
can subtotal up to ten fields per pass and the $subtotal function is also
available in the if command, however, by nature it is of limited use.
Suprtool has the ability
to keep a running total for any numeric field. The target data must be a packed
field with 28 digits, in order to help avoid overflow issues. A sample use of
the total function could be:
>def mytotal,1,14,packed
>get orders
>ext mytotal =
$total(sales-amount)
>xeq
You can total up to ten
fields per pass and the $total function is also available in the if command,
however, is of limited use.
For years Suprtool has
had the ability to output a record number to an output file with the num option
of the output command:
>in mysdfile
>out myfile,num,data
The above could would
generate an output file called myfile, however, you would lose the SD
information and you can only put the number at the beginning or the end of the
data. Suprtool now has a counter function that allows you to place a $counter
at any spot as well as preserve the SD information.
>in mysdfile
>def mycount,1,4,double
>ext field1
>ext field2
>ext mycount=$counter
>out myfile,link
>xeq
The file myfile will be self-describing
and contain the fields field1, field2 and mycount. The field mycount is defined
as a double integer, since this is the only field type that the $counter
function can use. Each record will have a unique ascending number starting with
one.
You can combine byte-type
fields together and use the built-in string functions to create new fields out
of existing ones. This can reduce the number of tasks required to provide a
solution. String expressions may involve the + operator and $upper, $lower,
$trim, $ltrim or $rtrim. To extract a string expression, use this syntax:
EXTRACT target-field = expression
Target-Field
The target-field determines
the byte-length for the expression. The data-type must be Byte or Char. The
expression is extracted during the output phase and cannot be used by other
Suprtool commands that accept fields (e.g., Sort).
Examples
>extract id-no = warehouse-no + bin-no
>extract full-name = first-name + last-name
Constants vs.
Expressions
If you have an string
expression that starts with a string, Suprtool assumes that you are attempting
to extract a single string value and not an string expression. To specify a
string expression that starts with a constant, surround the expression with
parentheses. For example,
Incorrect
>extract name = " " + product-desc
Error: Missing comma or
invalid arithmetic expression
Correct
>extract name = (" " + product-desc)
Variable Length
Strings
String expressions use
variable-length strings. Suprtool keeps track of the length of every string,
and all operations are done using the actual string length. For fields, the
length of the string is the length of the field. If you do not want to retain
all the spaces in a field, use one of the built-in trimming functions.
String constants are created with the exact length of the constant.
For example, the string "abc" is three characters long and the string
"a" is one.
When assigning the string expression to the target field, Suprtool
pads the final string value with spaces to fill out the target field. String
expressions longer than the target field generate an error.
>in testfile
>def a,1,10,byte
>ext a="I'm too long for this container"
Error: String is too long for
the specified item
String
Truncation
Suprtool produces an error
if the string expression is longer than the target field. You cannot override
this error with Set Ignore On. To help avoid the error, you may want to trim
the expression of trailing spaces before assigning it to the target field. For
example,
>extract new-field = $trim(a + b + c)
Upshifting
Strings ($Upper)
Use the built-in function
$upper to upshift all the characters of a string expression into uppercase
characters. This function can be used to upshift a single field, a complicated
string expression, or any subpart of an expression. Both ASCII and Roman-8
characters are upshifted by $upper. For example,
>extract city-up = $upper(city)
>extract full-name = $upper(first + last)
Downshifting
Strings ($Lower)
If you want to downshift
all characters of a string expression to lowercase, use the built-in function
$lower. This function can be used to downshift a single field, a complicated
string expression, or any subpart of an expression. Both ASCII and Roman-8
characters are downshifted by $lower. For example,
>extract city-lower-case = $lower(city)
>extract city-state = $lower(city + state)
Trimming Spaces
Using $Trim, $LTrim, $RTrim
Use one of three built-in
string functions to remove leading or trailing spaces from a string expression.
The three functions are:
|
$Trim:
|
Remove leading and trailing spaces from the string expression.
|
|
$LTrim:
|
Remove leading spaces.
|
|
$RTrim:
|
Remove trailing spaces.
|
Suprtool can extract
portions of a byte field based on the occurence of certain characters.
Consider the following
Data:
Armstrong/ Neil/ Patrick
Green/ Bob/ Miller
Edwards/ Janine/
Armstrong/Arthur/Derek
The $split function can
extract each token into separate fields. The syntax for the $split function is:
$split(Field,Start
Character,Occurence,End Character,Occurence)
The following task will
$split the data in the wholefield into three separate fields.
>in namefile
>define lastname,1,30
>define firstname,1,20
>define middlename,1,20
>extract lastname =
$split(wholename,first,"/")
>extract
firstname=$trim($split(wholename,"/","/"))
>extract
middlename=$trim($split(wholename,"/",2," ",2))
>out names,link
>xeq
The first extract
statement tells Suprtool extract the bytes from the field wholename, starting
at the beginning (first keyword), and stopping at the "/" character.
The second extract statement, tells Suprtool to extract the bytes between the
first occurence of the "/" character to the next occurence of the
"/" character, and then that string is trimmed of spaces as it is
nested within the $trim function.
The third and final
extract statement tells Suprtool to extract the bytes beginning with the second
occurence of the "/" character to the second occurrence of the space
character.
If the target field is
not long enough to hold the data Suprtool will abort with an error. You can
easily prevent this from happening on blank fields by nesting the $split
statement within a $trim or $rtrim function.
First/Last
The $split function also
has a Last keyword, whereby you can split the field from a given occurrence of
a character to the end of the field. So in the given example from above the
extracting out of the middlename could be coded as such:
>extract
middlename=$trim($split(wholename,"/",2,last))
The above means to
extract out all the data from the second occurrence of the "/", to
the end of the field and trim all spaces. Naturally as noted above we also have
the First keyword, which indicates the start of the field.
Unprintables
You can specify an
unprintable character for Suprtool to use as the character to $split on, using
the following syntax:
>extract
middlename=$split(wholename,^9,2,last)
which means that the
split would start at the second occurrence of
Decimal Nine, or the Tab character. Please note that for specifying
unprintable characters you do not put in quotes.
In this day and age of
migrations we were looking at issues that customers have run into when
importing data into new databases. What came from this investigation where ways
to Clean up your data in any given byte type field.
We have added two
methods to clean your data, you can use Suprtool to clean an individual byte
type field, or STExport to clean all of the byte-type fields for a given file
that you are exporting.
Sometimes un-printable
or extraneous characters get stored in files or databases that have no business
being there. This may be some tab characters in an address field or perhaps and
embedded carriage return or line-feed. Suprtool now supports the clean function
which will replace individual characters for a given byte field.
There are three things
that Suprtool needs to know in order to "clean" a field. Suprtool
needs to know which characters it needs to clean, what character it needs to
change the "bad" characters to, and also what field does it need to
clean.
You can specify special
characters Decimal 0 thru Decimal 31 via the command:
You can also specify a
range or characters by using the following syntax:
Clean
"^0:^31","^240:^255"
The Clean command is
used to tell Suprtool what characters it needs to look for in a given byte type
field. For example:
will tell Suprtool to
replace the tab character (Decimal 9), Line Feed (Decimal 10), and a period to
whatever the Clean character is set to. The CLean command takes both, decimal
notation and the character itself, however, it is probably most convenient to
use the Decimal notation for the characters that you wish to clean. The Decimal
notation is indicated by the "^" character.
By default, Suprtool
will replace any of the characters specified in the clean command with a space.
You can specify what character to use to replace any of the characters that
qualify with the following set command:
This will set the
character to replace any of the qualifying "to be cleaned" characters
to be a period.
You call the clean
function, the same way you normally use other functions available to if and
extract. For example:
ext
address1=$clean(address1)
shows how to clean the
field address1. You do not necessarily need to have the target field be the
same as the source field.
def new-address,1,30
ext
new-address=$clean(address1)
An example of how easy
it would be to clean your database of certain "bad" characters in
byte-type fields would be as follows:
>base mydb,1,;
>get customer
>clean
"^9","^10","^0","^7"
>set cleanchar "
"
>update
>ext address(1) =
$clean(address(1))
>ext address(2) =
$clean(address(2))
>ext address(3) =
$clean(address(3))
>xeq
The above task will look
at the three instances of address and replace the tab, linefeed, null and bell
characters with a space.
If you want to just remove
the characters all you need to do is set the CleanChar in the following manner:
This means that the $clean function will remove the characters
specified in the clean command, but not replace with any character, which
effectively shifts the text to the left and pad the equivalent amount of spaces
at the end.
Suprtool has the ability
to load data into a table via the Table command, and extract that data out of
the table using the Extract command. The Extract command can utilize the
$lookup function to return data. The syntax for the $lookup function would look
as follows:
>extract target =
$lookup(table-name,key-field,data-field)
The Table name, key-field and data-field are all defined by the
Table command, which must be input before the Extract command. A classic
example: your boss comes to you with a list of new prices for certain parts and
asks you to update the Part-Master dataset.
Just load the new prices into a Table, index by the product number
(prodno), then Extract the price field from each record and replace it with a
$lookup on the table. Here is the code:
>table
newprices,prodno,file,bosslist,data(price)
>get part-master
>if $lookup(newprices,prodno)
>update
>extract price =
$lookup(newprices,prodno,price)
>xeq
We do the If $lookup to select only the parts which have new prices,
then do Extract with $lookup to replace the existing price with a new one. The
Update command forces a database update on each selected record and must come
before the Extract command.
Now let's see how a Table can be used to add additional useful
information to a record. Let's say we build this table of Canadian provinces
(The file prov-file is assumed to be a
Link, or self-describing, file, created by a previous pass of Suprtool.)
>table
provtab,prov-code,file,provfile,data(prov-name)
At this point the key into the Table is the prov-code item and for
each entry in the Table there is one associated prov-name. To append prov-name
to each output record, we read the
customer dataset, extracting the customer name. We also Define prov-name as a
new field and extract it for the output record, but we fill it with a value that
is based on the prov-code for each customer entry:
>get customers
>ext cust-name
>def full-prov-name,1,30
>ext
full-prov-name=$lookup(provtab,cust-prov-code,prov-name)
>out somefile
>xeq
To update a dataset, you do the same commands, but you insert an
Update command prior to the Extract from a Table. Below is an example that
shows how to update an Eloquence record using data values from a Table.
Let's assume that we have new unit cost information for each
product:
>form newcosts
File:
NEWCOSTS.NEIL.GREEN (SD Version
B.00.00)
Entry: Offset
PRODNO Z8 1
UNIT-COST P8 9
Limit: 13 EOF: 13
Entry Length: 12 Blocking: 64
We load a table with the product number key value (prod-no)and the
new unit cost data value (unit-cost):
>table
prodcost-table,prodno,file,newcosts,data(unit-cost)
We can then select that unit-cost field from the prodcost-table
using the Extract command:
>extract unit-cost =
$lookup(prodcost-table,prodno,unit-cost)
Here is the entire task, keeping in mind that Update must be
specified before the Extract command.
>base store.suprtpis
Database password [;]?
>get d-inventory
>table
prodtable,prodno,file,newcosts,data(unit-cost)
>update
>if
$lookup(prodtable,prodno)
>extract unit-cost =
$lookup(prodtable,prodno,unit-cost)
>xeq
If you did not specify the If $lookup, then records that did not
qualify under the $lookup function in the extract field, will result in zeroes
for any numeric field and spaces for any byte type fields.
You can convert numeric
fields from one data-type to another. Any nonbyte field type is considered to
be numeric. You can also lengthen or truncate character fields. The general
syntax for doing conversions is:
EXTRACT target-field = source-field
Target-Field
The target-field determines
the byte-length, data-type, and repeat-count for the expression. The expression
is extracted during the output phase and cannot be used by other Suprtool
commands that accept fields (e.g., Sort). To avoid confusion, it is best to
define a new field name for the target-field
instead of using an existing field name.
The following example shows defining a new target-field as a double integer. The Extract command target-field then takes the definition
from the Define command and extracts data from the source-field (display-field).
>in oldfile
>def salesqty,1,4,double
>ext order-no / order-date
>ext salesqty = display-field
Packed and
Display Fields
When the target of an extract conversion is a packed- or
display-type field, Suprtool always converts positive values to a neutral
packed- or display-value. To ensure that expressions with positive values have
a positive result, use the $signed function:
>extract packed_field = $signed(int_field)
>extract display_field = $signed(dbl_field / 10)
Truncation errors can occur when Suprtool converts from
nonfloating-point to floating-point. See the discussion under Numeric Truncation above.
Byte Fields
Use the Extract command to shorten or lengthen byte-type fields.
If the target-field is
longer than the source-field,
Suprtool fills the trailing space in the target-field
with spaces.
Byte to Numeric
Conversion
Suprtool cannot explicitly
convert from a byte field to a numeric field such as a double integer. The
Extract command, however, does allow conversion from a display field to a
double integer (or any other numeric field).
You can define a byte field to be a display field if all of the
characters in the field contain a number. For example if you have a
six-character byte field that looks like this:
012345
you can define it in the following manner:
>def display-field,1,6,display
This field can then be converted to any of the other numeric types
that Suprtool supports.
If the field is six characters and contains blanks, decimal, currency
or a sign symbol in the data then you can utilize the $number function.
Suprtool now has the
ability to accept free-form "numbers" as display data types. This
means numbers in the form:
1234.45-
-12345
-123.2134
12343
$123.45
can now be accepted and
converted to any other numeric data type. Consider the following data:
Item-number New-Price
12345 +123.45
34563 + 27.5
21312 +
1.545
Suprtool can now read and
convert the data in New-Price using the number function. Let's say we want
New-Price to be a double integer and currently occupies eight bytes starting in
position six. Here is the task you would use to convert the New-Price
free-format number into a double integer.
>in mynums
>def item-number,1,5,byte
>def
new-price-ascii,6,8,display
>def new-price,1,4,double
>item
new-price-ascii,dec,2
>item new-price,dec,2
>ext item-number
>ext
new-price=$number(new-price-ascii)
>out somefile,link
>xeq
The $number function
take the free-format number and make it a valid display number. It will
determine the decimal, sign and add leading zeroes. It will round the number to
the defined number of decimal places.
In the case of 1.545
number, Suprtool will round the value to be 1.55, since the given number of
decimal places is two and the preceding value is five or greater. If you have a
whole number such as 54, with no decimal point the value becomes 54.00.
Suprtool will not accept
data that has:
More than one sign.
More than one decimal
place.
Spaces in between numbers.
Signs that are in between
numbers.
Characters that are not
over punch characters.
Fields that when edited do
not fit in the defined space for the display field.
You can control the
character that defines the currency, thousand and decimal symbol for other
currencies and formats using the following commands:
>set decimalsymbol
"."
>set thousandsymbol
","
>set currencysymbol
"$"
Suprtool in the above
case will strip the currency and thousand symbols and use the decimal symbol to
determine the number of decimal places. You can set these characters to any
values you want but the defaults for each are used in the above set commands.
The Decimal and thousand symbols are only single characters. The currency
symbol allows for four characters.
Suprtool has several ways
to convert binary numbers (e.g., J4, I2, P8) into human-readable ASCII form.
You can use STExport or Suprtool's Output,Ascii or Output,Display commands.
If you want to convert only some of your numeric fields, you can use
Suprtool's numeric conversion to convert binary fields to display fields. For
example, here is a conversion of a J4 field to an Z18 field:
define mynumber
1,18,display
get dataset
extract some-fields...
extract mynumber =
binary-number
output filename
xeq
You can also use the
$Edit function to format and directly convert to byte format.
Suprtool can format
fields using edit-mask features similar
to edit-mask features of Cobol. Suprtool employs two distinct types of
edit-masks: one for byte type fields and the other for numeric fields.
The type of mask
utilized depends on the source type of the field. If the source field is
numeric, then the numeric edit-mask logic is applied, if the source field is
byte type, then the byte edit-mask logic and characters apply.
The target field must
always be a byte type field.
An edit-mask consists of
"placeholder" characters, such as "9" for a numeric column,
and "format" characters, such as "." for the decimal place.
Sometimes an edit-mask character acts as both a placeholder and a format
character, such as the "$" in floating dollar signs.
For Byte type fields
there are two placeholder characters. These are:
X ~ place the data in the matching column for
the X in the edit-mask
Z ~
place the data in the matching column unless the data is a zero; if the data is
a zero, then replace with a space
The format characters
are as follows:
B (space) / (slash) , (comma) . (period) +
(plus) - (minus) * (asterisk)
and a Space. Please note
that you can denote a space using two methods, either by putting a
"B" in the mask or a space itself. For example, suppose you have data
that is in ccyymmdd format in an X8 field. Here is how you would use a
"xxxx/xx/xx" mask to format the data:
>in mydate
>form
File: MYDATE.TEST.NEIL
(SD Version B.00.00)
Entry: Offset
A X8
1 <CCYYMMDD>
Limit: 10000 EOF: 2
Entry Length: 8
>def formatdate,1,10
>ext
formatdate=$edit(a,"xxxx/xx/xx")
>list
>xeq
>IN MYDATE.NEIL.GREEN (0)
>;OUT $NULL (0)
FORMATDATE = 2003/09/24
>IN MYDATE.NEIL.GREEN (1)
>;OUT $NULL (1)
FORMATDATE = 2003/09/24
As you see in the
example above, the placeholder character is the "x" and the
"/" is the format character. You insert a space either by specifying
a "B" or by putting an actual Space character in the edit-mask. An
example of inserting a space might be the formatting of Canadian postal codes
(e.g., V3R 7K1):
>in postal
>form
File: POSTAL.NEIL.GREEN
Entry: Offset
POSTAL-CODE X6 1
Limit: 10000 EOF: 2
Entry Length: 6
>def post1,1,7,byte
>def post2,1,7,byte
>ext
post1=$edit(postal-code,"xxx xxx")
>ext post2=$edit(postal-code,"xxxbxxx")
>list
>xeq
>IN POSTAL.NEIL.GREEN (0)
>OUT $NULL (0)
POST1 = L2H 1L2 POST2
= L2H 1L2
>IN POSTAL.NEIL.GREEN (1)
>OUT $NULL (1)
POST1 = L2H 1L2 POST2
= L2H 1L2
The Z-placeholder
character works differently for byte-fields than for numeric fields. For byte
type fields, if the Z placeholder and the corresponding data is "0",
then the zero is suppressed, regardless of the position. This is primarily for
suppression of zeroes in byte type date fields:
ext
a=$edit(date-field,"xxxx/zx/zx")
The above edit mask
would then edit a byte type date of 20031005, to be:
An edit mask is limited
to 32 characters in total for both numeric and byte type fields. If data
overflows the edit-mask, by default Suprtool will fill that field with
asterisks. There is an option to have Suprtool stop when it encounters a
formatting overflow:
will force Suprtool to
stop if there is data left over after applying the edit-mask. With byte-type
fields, leading spaces do not cause overflow. Therefore if your data consists
of:
and your edit mask is:
It is not an overflow
since there are only spaces to the left of the "L". If the data was:
an overflow exception
would occur.
Our edit-masks for
numeric fields are patterned after those in COBOL. We provide four placeholder
characters, each with a slightly different effect:
"9" - insert a digit from 0 to 9
in this position
"$" - if you specify more than one
dollar sign, you get a floating dollar sign.
This means that there can be as many numeric positions as there are
dollar signs, but if some positions are
not needed because the value is small, the $
floats to the right next to the first digit and the preceding positions
are blank.
"*" - if there are enough digits
in the value, the * position is replaced by a numeric digit; if not, an
asterisk is printed. Leading asterisks are often used for check writing, so
that no one can insert a different value.
"z" - insert a numeric digit at
this position; if the rest of the data to the left is a zero then a space will
be placed at this position. For example:
>ext
a=$edit(int-field,"$$,$$$.99-")
>ext
b=$edit(int-field,"99,999.99-")
>ext
c=$edit(int-field,"cr99999.99")
>ext
d=$edit(int-field,"-$9999.99")
>ext
e=$edit(int-field,"**,***.99+")
>ext
f=$edit(int-field,"zz,zzz.99+")
>list
>xeq
>IN FILE1SD.NEIL.GREEN
(0) >OUT $NULL (0)
A =
$11.11- B = 00,011.11-
C = CR00011.11 D
= -$0011.11
E = ****11.11- F
= 11.11-
>IN FILE1SD.NEIL.GREEN
(1) >OUT $NULL (1)
A =
$22.22- B = 00,022.22-
C = CR00022.22 D
= -$0022.22
E = ****22.22- F
= 22.22-
As shown in the example
above, there are also numerous format characters for numeric edits, including
four ways to specify the sign. You can specify a sign, with +, -, or the
typical accounting specification of "CR" and "DB". You will
note in the example above that the "cr" in the mask was up-shifted to
be "CR". This is because the entire mask is up-shifted as the mask is
being parsed.
You can specify more
than one sign in a numeric field edit, although Suprtool will give you a
warning that having two sign edit-mask characters does not really make sense.
Cobol gives a Questionable warning when compiling an edit-mask with two sign
characters. Suprtool, will apply the sign in both places.
Keep in mind that most
data has three states:
1)
Postive
2)
Negative
3)
Neutral
Any neutral data will
not display the sign. If you specify a "+" sign in the edit-mask and
the data is negative, it will of course display a "-" sign.
For numeric-type edits,
Suprtool attempts to adjust the data according to the number of decimal places
in the edit-mask, when compared to the number of decimal places defined in the
field.
For example if the data
field has one decimal place, and the edit mask has two decimal places, then the
data is adjusted:
will result in the final
data being:
Similarly, if the data
has three decimal places and the edit-mask only has two, then the data will be
rounded appropriately with the same rules as outlined in the $number function.
You can specify more
than one decimal place in an edit-mask. However, Suprtool will print a warning
and it will utilize the right-most decimal place for data alignment. The
decimal place character is defined by a set command:
If you define another
character as the decimal symbol, Suprtool will use that character as the point
to align the decimals. If you define a decimal symbol that is not an allowed
edit-mask character with Set Decimalsymbol, Suprtool will assume that the field
has zero decimal places and adjust the data accordingly.
Suprtool edit-masks
support both fixed and floating dollar signs. Logic for floating dollar-signs
will be invoked if more than two dollar signs are defined in the edit-mask.
A floating-dollar edit
mask attempts to put the dollar sign at the left most position of the
significant data. For example if you have the following data and edit mask:
the data would end up
as:
Suprtool will not
however, put the dollar sign to the right of the decimal place. If you had the
same edit mask and the data was, .09, the data would end up being formatted as:
Similarily, the $edit
function will attempt to place the dollar sign correctly in most cases. For
example Suprtool will not format data in the form of:
Suprtool, does attempt
to fixup these cases and would format the data in the following manner:
If the number of digits
in the data is equal to the number of placeholder dollar signs, then the dollar sign is dropped and not added
to the edited field.
would result in:
If Set CurrencySymbol is
not equal to "$", then after the formatting has been applied,
whatever symbol(s) are defined within the set command, are used to replace the
"$" symbol in the data. For example, if you have the Currency symbol
set as "CDN".
>set currencysymbol
"CDN"
Suprtool will replace
the "$" after the edit-mask has been applied with CDN, provided there
is room to the left of the dollar-sign.It is recommended that if you are using
multiple characters for the dollar symbol that you leave enough characters to
the left of the symbol.
For example if the CurrencySymbol
is defined as CDN, then you should leave two spaces to the left of a fixed
dollar sign definition. If there is not enough room, to put in the currency
symbol, then the dollar symbol is blank.
An edit mask is limited
to 32 characters in total for both numeric and byte type fields. If data
overflows the edit-mask, by default Suprtool will fill that field with
asterisks. There is an option to have Suprtool stop when it encounters a
formatting overflow:
will force Suprtool to
stop if there is data left over to place when applying the edit-mask. With
numeric-type fields, leading zeroes do not cause overflow.
You can only use one expression in each Extract command, and the
expression must be the last item. If you want to extract several expressions or
more fields after an expression, you need to use several Extract commands.
Incorrect
>extract name, i=sales + tips, c=cost, dept
Correct
>extract name, i=sales + commission
>extract c=cost
>extract dept
Extracting Bits
The Extract command can be
used to define individual bits from one data item as separate fields.
>def order-shipped,1,2,int
>def order-paid ,1,2,int
>ext order-shipped=status-field.(0:1)
>ext order-paid=status-field.(1:1)
This makes it easier to check the status of certain bits within a
given field.
EBCDIC
Conversions
Use the $etoa or $atoe
functions to convert specific fields from EBCDIC to ASCII or vice versa. Each
of these functions accepts a single parameter that is a byte-type field:
Extract $ETOA(char-field)
Extract $ATOE(char-field)
There are several restrictions on the $etoa and $atoe functions:
·
They do not work with either
the ASCII or PRN output options.
·
You cannot extract an EBCDIC
constant. The following example would produce an error message:
>extract
$etoa(char-field) = 'abcdef'
·
You cannot extract a range of
fields using $etoa or $atoe.
Notes
The Extract command is valid only with
·
Output xxx,data
·
Output xxx,data,num
·
Output xxx,query
·
Output xxx,link
·
Output xxx,ascii
·
Output xxx,prn
The Extract occurs logically after the sort phase, if any, but prior
to the final Output, Put, or List. An If command can refer to fields of the
input record that are not included in the extracted output record. The sort
keys can be fields that are not among those extracted.
If the extracted record length is shorter than the input record
length, Suprtool attempts to speed up sorts by doing the extract before
sorting. Suprtool can only do the extract before sorting if the output option
is DATA (the default), QUERY, or LINK, and all of the sort keys are included in
the Extracted fields.
One advantage of not using the Extract command is that
the output file from Suprtool has exactly
the same format as the input dataset which created the file. You can then
use the =setname option of the Input
command to define all of the fields in the output file. Even if you change your
database structure, many of your job streams that use Suprtool and the =setname option will not have to be
changed.
The Form command displays
information about an Eloquence or SQL database, or the current Select command,
or the fields in a self-describing file. The Form command is similar to the
Form command of QUERY on the HP e3000.
FORM [ SETS | ITEMS | PATHS | dataset | data-item | filename ]
(Default: depends)
The Form command displays the structure of a database, dataset,
table or self-describing file.
When showing the form of an Eloquence dataset or a self-describing
file, Suprtool shows the byte offset of each field after the subcount, type,
and sublength. The first field always appears at offset one. If you have
specified a date format or the number of implied decimal places with the Item
command, these attributes appear as part of the form listing.
Dataset List
>ba sample
Database: sample
TPI: Eloquence B.07.00
B.07.00.11
Set Item Entry Load
Entry
Sets: Num Type Count
Capacity Count Factor Length B/F
CUSTOMERS 1
MDX 10 1355
1177 87 % 112
0
PARTS 2
MDX 10 524
182 35 % 53
0
ID 3 MDX
1 2259 47
2 % 2
0
ORDERS 4
DDX 7 1008
47 5 %
21 0
LINEITEMS 5
DDX 7 1008
272 27 % 22
0
Suprtool shows the type of each dataset (e.g., "M" for
Manual master, "A" for Automatic master, "D" for Detail).
If you have enabled dynamic dataset expansion, Suprtool adds "DX" to
the type of the dataset (e.g., "MDX", "DDX"). Since Eloquence
has these features available by default the Type of Dataset will always be
either MDX or DDX.
Detail Datasets
If you request information
about a specific detail dataset, Suprtool prints the path information in
DBSCHEMA format. The path shows the related master dataset and the sort
item-name. When displying the form of an Eloquence dataset, Suprtool shows the
capacity in a format similar to the one in DBSCHEMA.
>form orders
Database: SAMPLE
ORDERS Detail Set# 4
Entry: Offset
ORDERNO X16 1
ORDERID I2 17
(!ID)
ORDERDATE I2 21
CUSTNO X6 25
(CUSTOMERS)
ORDERSTAT I1 31
ORDERTYPE X2 33
ORDERVALUE E4 35
Capacity: 1008 (0), 0, 0,
0 Entries: 47 Highwater: 0 Bytes: 42
Master Datasets
The Form Sets command
indicates which datasets have MDX enabled. A Form command on these datasets
shows details of their expansion setting.
>form parts
Database: SAMPLE
PARTS Master Set# 2
Entry: Offset
PARTNO X16
1 <<Search Field>>
PARTLOOKUP X10 17
DESCRIPA X20 27
DESCRIPB X20 47
PARTUNIT X2 67
PROFITGROUP X4
69
MATNUMBER X16 73
PRICEUNIT X2 89
PRICE1 E4 91
PRICE2 E4 99
Capacity: 524 (0), 0, 0,
0 Entries: 182 Bytes: 106
SQL Select
When showing the form of an SQL select, Suprtool shows the column's
name, the SQL type and the Suprtool type. When showing the form of a
self-describing file, Suprtool shows the byte offset of each field after the
subcount, type, and sublength. The first
field always appears at offset one.
>open oracle scott tiger
>select * from emp
>form
Column Name: Oracle Type: Nulls:
Suprtool Type:
EMPNO Number (4)
N Integer
ENAME Varchar2 (10) Y
Byte
JOB Varchar2 (9) Y
Byte
MGR Number (4)
Y Integer
HIREDATE Date Y Oracle Date
SAL Number (7,2)
Y Packed
COMM Number (7,2)
Y Packed
DEPTNO Number (2)
Y Integer
SQL Database
If an Allbase database is
open and no input file has been specified, the default Form command shows all
of the tables in the database. If a Select command has been specified, the
default Form command shows the columns in the Select command. The exact format
of the Form command is different for each SQL database.
Third-Party
Indexing
If the database is enabled
for indexing, the Form command shows any third-party index that corresponds to
an IMAGE/Eloquence field. When doing a Form dataset,
each field is checked to see if it is a byte-type or Z-type third-party index.
If it is, the comment "<<TPI>>" is shown. Indexes that
have a name other than an Image-item name are shown at the end of the form
listing. The Form command only shows those indexes that can be referenced by
the Chain command.
For example,
>form m-customer
M-CUSTOMER Master
Set# 1
Entry: Offset
CITY X12 1
<<TPI>>
CREDIT-RATING J2
13
CUST-ACCOUNT Z8
17 <<Search Field>>
<<TPI>>
CUST-STATUS X2
25
NAME-FIRST X10 27
<<TPI>>
NAME-LAST X16 37
<<TPI>>
STATE-CODE X2 53
<<TPI>>
STREET-ADDRESS 2X25
55 <<TPI>>
POSTAL-CODE X6
105
Capacity: 211 (7) Entries: 20
Bytes: 110
Additional Third-Party
Indexes:
SI-LAST-NAME X16
B
Self-Describing
Files
The Link output option produces an SD file with information about
how the file was sorted, what fields are compound, and the date format or the
number of implied decimal places for any fields. The Form command shows all of
this information:
File: custfile (SD Version
B.00.00) Has line feeds
Entry: Offset
CHAR_FIELD X5 1
<<Sort #1>>
REPEATED_I1 3I1 6
{compound field}
DATE_FIELD J2 12
<<YYYYMMDD>>
COST_FIELD J2 16
<< .2 >>
Entry Length: 20 Blocking: 1
Default Form
If a Chain, Get, Select,
or Input command of a self-describing file has been entered, a Form command
without parameters shows the fields in the current input source. If a Base
command has been specified, but no input source, a Form command without
parameters does a Form Sets. If an Open command has
been specified, but no input source, a Form command without parameters shows
the tables in the SQL database.
Form Keywords
The Form command shows
items, paths, and sets before it searches for a dataset or file with these
names. Use a string (e.g., "sets") to display the form of a dataset
or file that matches one of the Form keywords.
>form "paths" {paths
is the name of a dataset}
Selects an Eloquence
dataset from a previously opened Base as the input source for the next extract.
You must have read access to all fields in the dataset entry. Only one Chain,
Get, or Input command is allowed per extract task. Get always reads the dataset
serially.
GET setname [(startrecord/[endrecord]) | (#count)]
(Default: all records)
Dataset Input
The first example shows the most common use of the Get command. An
input dataset is specified as input to Suprtool. We select a subset of the
entire input dataset using the If command:
>base store
>get d-inventory {serially
read dataset}
>if unit-cost<10000 {the
UNIT-COST field is}
>output out1 { automatically defined by Get}
>xeq
FastRead
Suprtool for HP-UX can read Eloquence datasets in two modes, one is with
dbget mode-2 serially and the other is a large “blocked” fast read method. The
default method used depends on your version of Suprtool. Suprtool has two
flavours in terms of which set of
“Image” intrinsics it uses. The first or regular version loads the
Eloquence libraries by using the SHLIB_PATH or looks for the Eloquence
libraries in their default location. This “regular” version of Suprtool for
HP-UX has the FastRead option turned on by default. The version of Suprtool that uses the ROBELLELIB_IMAGE variable
to find the Image libraries has the FastRead option on by default. This setting must be turned on prior to the
Base command. See the Set command for details
Selection by
Record Number
The (startrecord/endrecord)
parameter permits selection of input records on the basis of the Eloquence
record numbers. These numbers always start with 1, and the endrecord parameter is assumed to be the last record in the dataset
if it isn't specified.
Note that you should use extreme care when you are using the record
number selection option on master datasets. This is because the record numbers
of master dataset entries can be changed as entries are added or deleted from
the dataset. For example, if there are deleted entries in the master dataset,
then you could get fewer records than expected.
|
Numrecs is another way to select only a few records.
|
When debugging software, it is convenient to scan the first few
records of a dataset. Specifying a startrecord/endrecord parameter makes this easy:
|
>get m-product(1/20) {first
twenty records}
>list {produce
a formatted list of each …}
>xeq {…
record with no output file}
This example gets any records that are in the first twenty IMAGE
locations. This may be fewer than twenty records, if there were deleted or
unused entries in the first twenty record numbers.
Random Selection
The #count parameter selects every "nth" record from the
dataset, where "n" is equal to count.
This option is designed to allow "random" selection from the dataset.
It cannot be combined with the (startrecord/endrecord)
option.
Test databases can be constructed from random samplings of
production databases. Using the #count parameter
and the Put command we build a test dataset:
>base store
>get d-inventory(#15) {every
15th record is read}
>put d-inventory,test {put
to the d-inventory dataset in …}
>exit {…
Test database}
Show what commands and
options are available in Suprtool.
HELP [ command | keyword [ ,option ] ]
(Default: browse through
the entire help file)
Command Help
If you specify any parameters, Help first assumes that you want help
on a Suprtool command. If you know the structure of the help file, you can
additionally specify one of the keywords under the command name.
>help ext {help
on the Extract command}
>help ext,notes {Notes
section of the Extract command}
Keyword Help
If Suprtool cannot find any help in the "Commands" section
of the help file, it assumes that you specified one of the outer-level keywords
in the help file. To see this list of keywords, type help with no parameters.
You see a short introduction to Suprtool and then a list of keywords. You can
specify any of these keywords on the Help command. You can also specify a
subkeyword.
>help start {Quick
Start section}
>help start,task {Task
section of Quick Start}
Quick Help - HQ
HQ asks Suprtool to look
under the keyword Quick in the help file. Quick contains the text from the
Suprtool Quick Reference Guide, offering the experienced user a quick review of
the syntax of any command.
>hq input {quick
description of Input}
>hq commands {quick
list of command names}
Notes
If no parameters are
specified, Help allows you to browse through the "help" file. The
Help Command uses the QHELP subsystem to allow you to look at the material in
the file /opt/robelle/help/suprtool (which contains most of the user manual).
For "help in help", type "?" when you see the QHELP prompt
character ("?"). The help file is organized into levels. To go back
to the previous level, press Return instead of a key name. If you press F8, you
will exit the QHELP subsystem and return to Suprtool.
Specifies a subset of
records to select from the input source during the next extract task. The If
command supports full logical expressions, with comparisons between all
data-types, between data fields and constant values, or between one data field
and another. The If command also provides partial string compares, bit field
extracts, subscripted IMAGE fields, AND-OR-NOT operators, and parentheses to
override precedence. You can use arithmetic expressions involving any numeric
data-types.
IF expression
Note: The examples below
show multiple If commands. These are for illustrative purposes only. Suprtool
does not permit multiple If commands in a single task. Instead you can combine
multiple conditions using AND and OR.
Alternatives to
the If command
There are a few selection
criteria that the If command cannot perform. In these cases, you need to use
other Suprtool commands. If you wish to select by record numbers, use the
record number options in the Input command. If you wish to limit the number of
records selected, use the Numrecs command.
There Is No Else
Clause
The If command in Suprtool
does not have an Else clause. To select the records that do not match the If
criteria, use a second task with the same criteria negated by a NOT.
>input myfile {this
task is the "If … then"}
>if expression
>output file1
>xeq
>input myfile {this
task is the "else"}
>if not (expression)
>output file2
>xeq
An expression specifies
the logical criteria that Suprtool uses to select records from the input
source.
Simple
Expressions
The simplest expression is
a single comparison between two
fields (e.g., A=B) or a field and a constant (e.g., A="XX"):
field relation field
field relation constant
Fields
A field can be a temporary, Defined field, or a field from a
self-describing file, or an Eloquence field, or a column from a database table.
Each field has a type (see "Key Command [K]" on page 30 for further details). The
constant must match the type of the field. If the field has a byte-type, you must surround the constant with quotes.
>if name="TAMMY ROSCOE" {name
is byte}
>if rating>10000 {rating
is integer}
>if balance=arrears {compare
two fields}
Constants
A constant is a value that
matches the data-type of field.
Constants are either a string constant in quotes, a numeric constant, or a date
constant specified with $date or $today. See the next section about Constants for more details.
|
Constant
|
Type
|
|
"NATHAN ARMSTRONG"
|
string constant
|
|
12345
|
numeric constant
|
|
$date(00/07/09)
|
date constant July
9, 2000
|
Relations
A relation is one of the
size comparison symbols (Suprtool does not use words like "EQUALS" as
in QUERY):
|
Relational operator
|
Means
|
|
=
|
equal to
|
|
>
|
greater than
|
|
<
|
less than
|
|
>=
|
greater than or equal to
|
|
<=
|
less than or equal to
|
|
<>
|
not equal to
|
Complex
Expressions
Complex expressions can be
made by combining the AND, OR, and NOT operators, arithmetic operators (+, -,
*, / and mod), and parentheses. The order of precedence of operators, from
highest to lowest, is
|
Operator
|
Precedence
|
|
( ... )
|
Highest.
|
|
NOT
|
Take the opposite.
|
|
AND
|
Both must be true.
|
|
OR
|
One or the other must be true.
|
|
-
|
Unary minus.
|
|
* /
|
Higher than addition and subtraction.
|
|
+ -
|
Lowest.
|
Use parentheses where necessary to change the order of evaluation.
>if status="1" and amount>100 or
purchased="000115"
>if (status="1" or status="2") and
amount>100
Multiple Values
You can check a data field
for several test values without using the AND and OR operators. After the
equals or not-equals sign, list the alternate values separated by commas.
The OR operator is = (equal sign). Instead of "IF A=5 OR A=6 OR
A=7", use "IF A=5,6,7". This selects a record if A is equal to
5, 6, or 7.
The AND operator is <>. Instead of "IF A<>5 AND
A<>6 AND A<>7", use "IF A<>5,6,7". This
selects a record if A is anything but 5, 6, or 7.
>if field = 5,6,7
>if part =
"12345","67890","39201","92308","14892"
>if delivered <> 981231,990101
This method works well if
you are searching for a small number of values. Use the $lookup function to
check a data field for many test values.
IF $LOOKUP(tablename, fieldname)
The $lookup function returns TRUE, if the specified field name
contains a value from the specified table. You can also look for values that
are not in a table.
IF NOT $LOOKUP(tablename,fieldname)
See the Table command for a complete description of how to combine
tables and the $lookup function. (Note:
Suprtool's Table command is not related to tables in databases.)
|
$lookup parameter
|
function
|
|
tablename
|
The name of a table specified in the Table command.
|
|
fieldname
|
A field from the input record. This field must be exactly the same
length as the item used in the Table command.
|
Multiple Values
and Table Data
Suprtools can use the “data” loaded into a Table in a
comparison operation. The $lookup function will return the data value from the
table to compare against another field or literal.
In file1sd
Table mytable,char-field,data,tabfile,data(id-field)
If $lookup(mytable,char-field,id-field) = int-field
So what Suprtool will do
in this case is read a record, lookup the record in the table and retrieve the
data item in the table. If Suprtool does NOT find an entry in the table, a zero
will be returned if the data type is numeric and spaces will be returned if it
is a byte type.
So using the case above,
if no entry is found in the table, zero is returned, and if int-field is equal
to zero, then the record will qualify.
If you don’t want to have any values returned from the table lookup,
you just preface the if with a standard lookup.
>get ord-details
>table cust-table,
cust-no, file, custlist,data(state-code)
>if
$lookup(cust-table,cust-no) and &
$lookup(cust-table,
cust-no, state-code) = state-code
>output orders
>xeq
When using $lookup to return data, the $lookup must always be on
then left side of the expression. If not Suprtool will stop with an error:
>if id-field=$lookup(mytable,char-field,id-field)
Error: $lookup in this
context (data comparison) must be on left side
Performance of
$Lookup
|
Short-circuit evaluation means that the If command does not always
need to evaluate all the parts of the command.
|
Due to the nature of the
$lookup function, it can be, at times CPU intensive, however, since the If
command uses short-circuit evaluation, $lookup should be specified as the
last part of the If command. For example,
|
>if status = "10" and $lookup(cust-table,account)
is faster than
>if $lookup(cust-table,account) and status = "10"
because Suprtool can evaluate status = "10" faster than $lookup. When
the status is not "10" Suprtool knows the record will not be
selected, therefore there is no need to do the $lookup.
$Null(fieldname)
The If $null(fieldname) command selects any rows that
have null values in them. This feature is available only for SQL databases and
only on columns that allow null values:
If you want to find only those values that are not null, you can add
the NOT keyword in front of $null:
>if not $null(SALESTOTAL)
This section describes
numeric and string constants. See also Date
Selection.
Numeric
Constants
Numeric constants are not
enclosed in quotes. Numeric constants may be just simple whole numbers (e.g.,
5, 0, -56, 10004) or they may have a decimal point (e.g., 5., 0.0, -.56, 99.9,
1.4). IEEE numbers may also have a scale factor (e.g., 5E-5, 0.01E+4).
"Over-punches" for the sign are not required, or recognized, in
Suprtool. Always enter -11 as -11, not 1J for a DISPLAY field.
String Constants
String constants are
delimited with double- or single-quote marks. That is, either "VANC"
or 'VANC'. Any characters within quotes are not upshifted. If the constant is
shorter than the field to which it is being compared, the constant is padded
with blanks. String constants are expected for fields of type BYTE, U, or X,
but numeric constants are expected for fields of type Z (zoned decimal).
>if field = " " {check
for all blanks}
>if field = "XX" {double-quotes
are okay}
>if field = 'XX' {so
are single-quotes}
If you want to compare for a quote itself, you include two quotes in
the string for each quote you want.
>if field = "AB""CD" {look
for AB"CD}
Use the ^-character to
specify any ASCII character. The number (the actual ASCII value), or letter (^A
means control A), must follow immediately after the ^-character. Suprtool
treats character constants as strings. When you compare the constant to a field
longer than one byte, Suprtool pads the constant with spaces.
>define field,1,1 {byte
field}
>if field = ^0 {binary
zero}
>if field = ^G {Control-G
(bell)}
>if field = ^27 {escape}
>if field = ^252 {Roman-8
box}
To look for "null
values" or "low values" in byte-fields, it is usually sufficient
to check the first byte for a binary zero:
>define first-byte,bigfield,1,byte
>if first-byte = ^0
Use subscripts to access individual items in repeated fields, or to
access substrings.
Numeric
Subscripts
For repeated numeric fields only one index is
allowed.
If Table has the form 10J2, it holds ten double integers.
·
Table(1) is the first sub-item.
·
Table is the same as Table(1).
·
Table(5) is the fifth sub-item.
>if table(5) = 23
>if table(2) = 20 or table(4) = 30
>if table(8) = 31 and table(9) = 28
Character
Subscripts
Character string fields
may have 1, 2, or 3 subscripts after them. Character string fields are allowed
more than one subscript value.
If ADDR has the form 5X30, it consists of 5 substrings of 30
characters each.
·
ADDR(1) is the first
30-character sub-item of ADDR.
·
ADDR without subscript is the
same as ADDR(1).
·
ADDR(2) is the second
30-character sub-item of ADDR.
·
ADDR(2,4) is the second
sub-item, starting with the 4th byte and extending for the remainder of the
sub-item, 27 bytes.
·
ADDR(2,4,6) starts at the same
location, but extends for only 6 bytes.
If NAME has the form X50, it is not a repeated field.
·
NAME is the same as NAME(1).
·
NAME(1,4,6) is the first (and only)
sub-item, starting at the 4th byte and extending for 6 bytes.
·
NAME(1,10) is a field that
starts at the 10th byte and implicitly extends to the end of the field (for the
remaining 41 bytes).
>if name(1,4,6) = "HAWAII"
>if addr(3) = "VANCOUVER,
B.C."
>if addr(3,11,20) == "@B.C.@" {pattern
matching}
Bit Selections
The If command can extract
and test any series of one or more contiguous bits in a field. Suprtool allows
bit extracts only on Integer or Logical fields of two bytes in length (one
16-bit word). To do a bit extract from another type of field, first use Define
to redefine the data as a two-byte Logical field.
Once Suprtool extracts a bit string, it always treats it as an Unsigned
Integer, a Logical, and never interprets it as negative. The format for bit
extracts calls for a starting bit number and a bit count. The 16 bits in a
computer word are numbered from the left, 0 to 15. The two bytes to extract
from need not be on a "word boundary" (i.e., they can start in any
byte position). See "Define Command [D]" on page 30 for how to define a
two-byte logical field.
field . (startbit : bitcount)
>define bitfield,name,2,logical
>if bitfield.(4:2)=3
How to Check a
Byte for a Numeric Value
Because Suprtool does not
have one-byte integers, it can be difficult to check a single byte for a
specific numeric value. Use a two-byte integer Define field and the bit-extract
operator to solve this problem:
>define word,transcode,2,integer
>if word.(0:8)=13
See "Character Constants" on page 30 for an alternate method.
Decimal Places
Use the Item command to
specify the number of implied decimal places in an item. If you do not do this,
you must scale all numbers in the If command. For example, let's assume that
you want to find all inventory records with a cost equal to $80.59. If you do
not use the Item command, your If command would look like this:
>if cost = 8059 {no
decimal places}
By telling Suprtool about the number of decimal places in the cost
item, your If command looks more natural (which usually means you will make
fewer mistakes):
>item cost,decimal,2
>if cost = 80.59 {decimal
places included}
Numeric
Conversion
The If command can compare two numeric fields to each other (not
just one field to a constant). All relation operators are supported: <,
<=, =, <>, >, and >=. However, you cannot compare a byte-field
to a numeric-type field.
Suprtool usually converts the field on the left side of a relational
operator to floating-point. Then the floating-point number is converted into
the type of the field on the right side of a relational operator and the
comparison is done. The exceptions to this rule are integer-to-double,
packed-to-packed, and display-to-display comparisons, which use a direct comparison
algorithm.
Truncation errors can occur when Suprtool converts from one field
type to floating-point. See also Accuracy
and Numeric Truncation.
Arithmetic
Expressions
You can specify arithmetic
expressions for any numeric data-type in the If command. Arithmetic expressions
involve the operators +, -, *, / and mod. The Mod operator returns the
remainder between a dividend and a divisor. Arithmetic expressions cannot start
with a numeric constant (e.g., if 2 + a = 10 is invalid). Arithmetic is not
allowed on byte-type fields. If you have a byte-type field that consists
entirely of numeric digits, redefine the field as display type and use the
redefined field name in the If command.
Examples
>if field + 10 = 1115 {numeric
field}
>if cost * qty > 10000
>if total < qty * price + tax
>if yymmdd-date / 100 mod 100 <= 03 {first
quarter}
Missing Features
Arithmetic overflow in computations will cause Suprtool to abort.
By default, Suprtool uses floating-point
arithmetic to compute. In some cases, there can be slight inaccuracies due to
rounding errors.
The accuracy of arithmetic
computations is limited to approximately sixteen digits. Suprtool may truncate
four-word integers (quad) or large packed-decimal or display numbers when they
are converted to floating-point. Suprtool does not produce any error or warning
in this case.
$Abs function
Suprtool supports an $abs
function, which returns the absolute value of a number. For example, if a field
called Credit contains the value -547.83, the $abs function returns 547.83.
This function will work on a field or even on an expression such as:
>if $abs(credit / 100 * 1.07) > 500.00
This function will also work in the Extract command:
>def newcredit,1,4,double
>ext newcredit = $abs(credit / 100 * 1.07)
$Truncate
function
Suprtool supports a
$truncate function which returns the number to the left of a decimal place. For
example if the field stddev contains the value 547.83, the $truncate function
will return 547. Note that there is no rounding.
This function will work fields and expressions:
>if $truncate(stddev / 100 * 1.07) > 200
This function will also work in the Extract command:
>def newdev,1,4,double
>ext newdev = $truncate(stddev / 100 * 1.07)
You can do comparisons
with byte-type fields in numerous ways using Suprtool. These powerful features
minimize the number of tasks you must execute in order to select the data you
need. The fewer the number of tasks, the faster your data is delivered to the
users and applications that need it.
You can combine byte-type fields together and use the built-in
string functions to create string expressions. String expressions involve the +
operator and the other string functions such as $lower, $upper, $trim, $ltrim
and $rtrim.
Fixed vs. Variable Length Strings
String comparisons are
done using fixed- and variable-length strings. For most users, there should be
no difference between the two types of strings. When doing string comparisons,
Suprtool always pads shorter strings with spaces, with the one exception of
comparing two fixed-length fields (see "Byte Fields" below).
String expressions involving the + operator or the $upper, $lower,
$trim, $ltrim and $rtrim built-in functions are done using variable-length
strings. Suprtool keeps track of the length of every string, and all operations
are done using the actual string length. For fields, the length of the string
is the length of the field. If you do not want to retain all of the spaces in a
field, use one of the built-in trimming functions.
When creating string expressions, string constants are created with
the exact length of the constant. For example, the string constant
"abc" is three characters long and the string "a" is one.
Byte Fields
For historical reasons,
comparing two byte-type fields to each other is a special case. If the two
fields are exactly the same length, Suprtool compares them completely. If one
field is shorter, the comparison is done for the length of the shortest field.
Suprtool does not check for spaces in the trailing characters of the longer
field. For example,
>define short, 1,10 {ten
character field}
>define long ,11,15 {fifteen
character field}
>if short = long
In this example, Suprtool compares the ten bytes in the short field
with the first ten bytes of the long field, but ignores the last five bytes of
the long field. If the expression on either side of the equal sign consisted of
more than one field (using the + operator) or involved any of the string
functions, ($upper, $lower, $trim, $ltrim or $rtrim), Suprtool would have
compared both sides of the equal sign by padding the shorter field with spaces.
It is only the case where you are directly comparing one byte-type field to
another that Suprtool uses the length of the shortest field for the comparison.
You cannot compare a byte-field to a numeric-type field. If you have
a byte-field that consists entirely of numeric digits, redefine the field as a
display-type and use the redefined field name in the If command.
Character Type
Byte-type fields can also
be checked to see whether they contain only Alpha, Numeric, Alphanumeric, or
Special characters. The complete field is compared against the specified
character types.
|
Type
|
Characters
|
|
Alpha
|
A-Z, a-z (52 characters)
|
|
Numeric
|
0-9 (10 characters)
|
|
Special
|
anything else (194 characters, including spaces, punctuation,
Roman-8 letters, binary junk)
|
|
Alphanumeric
|
A-Z, a-z, 0-9 (62 characters)
|
For the test result to be true, all
the characters in the field must be of the specified character type. To
test a substring, use the Define command to define a subfield.
>if field = alpha
>if field <> numeric
Examples:
|
String
|
Class
|
|
"1234"
|
numeric
|
|
"12.3"
|
no class, contains both numeric and special
|
|
"ABCD"
|
alpha
|
|
"B JONES"
|
no class, contains both alpha and special
|
|
" "
|
special
|
|
"A1B2"
|
alphanumeric
|
Pattern Matching
Suprtool can also select
records based on a pattern of characters, rather than an exact string of
characters. For example, use the following to select all records with
"CONNOR" anywhere in the Name field,
The double equals (==) is the operator for pattern matching. The at
signs (@) means anything before or after "CONNOR" is acceptable,
including nothing.
For character fields, there are two comparison operators for
patterns: "==" (matches), and "><" (does not match).
The pattern is specified as a quoted string, using the special characters
listed below. Embedded spaces are allowed in the pattern and must be matched in
the target field.
These are the special characters:
|
Character
|
Meaning
|
|
@
|
Zero, or more, characters of any type.
|
|
#
|
A single numeric character.
|
|
?
|
A single alphabetic or numeric character.
|
|
~
|
Zero, or more, blank characters.
|
|
&
|
Escape character to match the next character explicitly (&@
looks for the @ character).
|
|
^
|
Reserved for future use.
|
|
!
|
Reserved for future use.
|
Any other character must be matched, one for one.
>if name=="@ZANDER@" {does
name contain ZANDER anywhere?}
>if name=='@ZANDER@ARMSTRONG@' {does
name contain ZANDER perhaps …}
{…
other characters, then ARMSTRONG?}
>if name><"@#@" {does
name not contain numerics?}
>if name=='@qedit@','@suprtool@' {qedit
or suprtool?}
For more information, see Special
Characters in the Glossary.
Finding Special
Characters
With the $Clean function
you can clean "bad" characters inside of text fields, however the $Clean function does
not report back what records were "cleaned". For this reason we have the $FindClean
function. $FindClean will return true if
it finds a character defined using the Clean command. This makes it extremely
easy to find a set of Special characters that you can define.
>in cleansd
>clean
"^9","^10"
>if $findclean(nonprint)
>list
The above task will list
the record if the field nonprint has a Tab (Decimal 9) or a Line Feed (Decimal
10) anywhere in the field. You can Find and clean the "bad"
characters from a field at the same time:
>in cleansd
>clean "^9:^10"
>if $findclean(nonprint)
>extract
nonprint=$clean(nonprint)
>list
Trimming Spaces
($Trim, $Ltrim, $Rtrim)
Use one of three built-in
string functions to remove leading or trailing spaces from a string expression.
The three functions are:
|
$Trim:
|
Remove leading and trailing spaces from the string expression.
|
|
$LTrim:
|
Remove leading spaces.
|
|
|
$RTrim:
|
Remove trailing spaces.
|
|
Because Suprtool pads shorter strings with spaces when doing
comparisons, trimming spaces is most useful when creating a combined string
with several fields. For example, you might want to combine a person's first
and last name (including a space between the two):
>if $trim(first) + " " + $trim(last) = "Joe
Smith"
Mixed Case
($Upper and $Lower)
By default, Suprtool does
an exact match when comparing two string expressions. If the expressions vary
in the capitalization of characters, Suprtool finds them to be different. To do
caseless string comparisons or pattern matches, use the $upper or $lower
functions. Both ASCII and Roman-8 characters are shifted by $upper and $lower.
For example,
>if $upper(city) = "VANCOUVER"
>if $lower(city) = "edmonton"
Note that if you use the $upper or $lower functions, Suprtool does
not upshift or downshift any constants used in the comparison. You must
explicitly specify the constants in the correct case or you can use $upper or
$lower with the constant:
>if $upper(city) = $upper("vancouver")
Use the $upper or $lower functions for caseless pattern matching. As
with other comparison operators, you must specify constants in the correct case
when doing pattern matching:
>if $upper(city) == "VAN@"
>if $lower(city) == "ed@"
You can use $upper and $lower with string expressions that combine
many fields and string functions as shown in the following example:
>if $read
- $upper($trim(first) +
- "
" +
- $trim(last))
- = "JOE SMITH"
- //
The If command has four
functions to help select records based on dates: $date, $today, $days and
$stddate. The $date function works for any date. The $today function works for
the current date and dates relative to today. The $stddate and $days functions
work for almost any date. To use these date functions, you must first identify
the date format of an item by using the Item command.
The $date function makes
it easier to specify a target date for certain date formats (e.g., PHdate or
ASK). To select records based on a specific date, use this feature:
>if field=$date(year/month/day)
Suprtool checks the date's validity. To select the transactions for
January 1999, you would do the following:
>item trans_date,date,phdate
>if trans_date >= $date(1999/01/01) and &
trans_date <=
$date(1999/01/31)
Relative Dates
You can specify a relative
date using the $date function. Then you can create job streams that don't rely
on hard-coded dates. The general syntax of the $date function is:
$date(year/month/day)
The year can be a specific
number (e.g., 2000) or an asterisk "*" for the current year. To
specify a relative year, you add or subtract years from the one you specified:
>if field=$date(2000/01/01) {January 1, 2000}
>if field=$date(2000-1/01/01) {January 1, 1999}
>if field=$date(*-1/01/01) {January
1, last year}
The month can be a
specific number (e.g., 6 for June) or an asterisk "*" for the current
month. To specify a relative month, you add or subtract months from the one you
specified:
>if field=$date(2000/06-1/01) {May 1, 2000}
>if field=$date(*/*/01) {start
of current year and month}
>if field=$date(*/*-1/01) {start
of last month}
>if field=$date(*/*-18/*) {exactly
eighteen months ago}
The day can be a specific
number (e.g., 15), an asterisk "*" for the current day, the word
"first" for the first day of the month, or the word "last"
for the last day of the month. You cannot add or subtract relative days; use
$today instead.
>if field=$date(2004/01/first) {January 1, 2004}
>if field=$date(*/*/*) {today's
date}
>if field=$date(*/*-1/last) {last
day of previous month}
Combining these features makes it possible to generate batch jobs
that require no operator input. For example, to select all of the transactions
for last month you would use:
>item trans_date,date,phdate
>if trans_date >= $date(*/*-1/first) and &
trans_date <=
$date(*/*-1/last)
Month End
Suprtool is always expecting a valid date. Suppose that you have a
month-end job that contains the following If command:
>if field = $date(*/*-1/*)
When you run the job on May 31, 2000, if Suprtool were to use the literal
interpretation of $date(*/*-1/*), it would use the date April 31, 2000. In fact, there is no
such date; April has only 30 days. Whenever you specify * for the day, and the
day is greater than the last day of the month you specified, Suprtool uses the
actual last day of the month instead of the current day of the month. In our
example, Suprtool would use April
30, 2000. Suprtool will take leap years into account when
calculating the last day of February.
Today's Date
To select records based on
today's date, use the following:
>if field=$today {today's
date}
>if field=$today(-1) {yesterday's
date}
>if field=$today(+1) {tomorrow's
date}
Use the Item command to qualify the field as a date. The $today
function accepts one optional argument which is the number of days before or
after today. The maximum number of days in either direction is 9999.
yymmdd and
Beyond 1999
Because dates spanning the turn of the century will not collate
properly for the yymmdd form, you need to use $stddate to compare these dates.
>item ship-date,date,yymmdd
>if ship-date < $date(2000/12/31) {will
not work}
>if $stddate(ship-date) < $date(2000/12/31) {will work}
Finding Invalid
Dates
Use the $invalid function
to find invalid dates. An invalid date is a number in a date format whose date
equivalent cannot be found on a calendar. For example, a month value of 99
would be considered invalid.
>input sdfile {a
self-describing file}
>item deliv-date,date,ccyymmdd
>if $invalid(deliv-date)
>out baddates,link
>xeq
$Stddate
Function
The $stddate function
converts any date format in nearly any data-type container and internally
converts it to the ccyymmdd format in a double integer container.
This allows you to compare dates with dissimilar formats and
data-types. For example,
>in orddets
>item order-date,date,ccyymmdd
>item bill-date,date,mmddyyyy
>if $stddate(bill-date) <= order-date
>output badords,link
>xeq
This feature is also available for dates that have two-digit years.
The century portion of the date will be generated by $stddate, which uses the
normal cutoff rules specified by Set Date Cutoff.
>in invdets
>set date cutoff 20
>item invoice-date,date,yymmdd
>item close-date,date,mmddyyyy
>if $stddate(close-date) <= $stddate(invoice-date)
>out badinvs,link
>xeq
In this case all invoice-date values with a yy portion between 20 and 99 will have a 19 for the century. All
invoice date values with a yy portion
of less than 20 will have 20 for the date generated by the $stddate function.
Invalid Dates
A date must be valid
before $stddate can convert it to the ccyymmdd format. Otherwise, a value of 0
will be returned for any invalid dates. An invalid date is a number in a date
format whose date equivalent cannot be found on a calendar. This includes dates
selected by the $invalid function. We can eliminate the invalid dates from the
above task by changing the If command slightly.
>input sdfile
>set date cutoff 20
>item invoice-date,date,yymmdd
>item close-date,date,mmddyyyy
>if (not $invalid(close-date) &
or not $invalid(invoice-date)) &
and $stddate(close-date) <=
$stddate(invoice-date)
>out badinvs,link
>xeq
In this example, if either the close-date or the invoice-date are
invalid, then they will not be evaluated by the $stddate function and will not
be selected. Although your requirements may be different, you need to remember
that invalid dates evaluated by the $stddate function will return a 0 value.
$Days Function
Suprtool supports a $days
function, which converts any supported date to a Julian Day number (the number
of days since 4713 BC). This allows for Date arithmetic, in which you can
calculate the difference between two dates, even if they have dissimilar
formats.
For example you could find all orders that were not shipped within
30 days of being ordered.
>form ordfile
File:
ORDFILE.SALES.MFG (SD Version
B.00.00)
Entry: Offset
ORDER-DATE X8
1 <<CCYYMMDD>>
SHIP-DATE X8
9 <<MMDDYYYY>>
ORDER-NUMBER X6
17
Limit: 10000 EOF: 15
Entry Length: 22 Blocking: 16
>in ordfile
>if $days(SHIP-DATE) - $days(ORDER-DATE) >=30
>list
>xeq
Invalid Dates
As with the $stddate function, if a date is not a valid date, then
the result of the $days function will be zero. In the example above, if the
order has not yet been shipped, then the SHIP-DATE will likely be blank, or
zero, or some other special value. $Days(SHIP-DATE) will be zero, and the
resulting calculation will be a negative number.
Notes on
Relative Dates
The $date and $today functions always generate a constant from the
date, just as if you had typed it. For example, when run on February 13, 2004, the follwing task:
>item field,date,yymmdd
>if field > $today
is the same as:
Suprtool normally does no date conversion of the actual dates. Dates
that do not start with the year do not collate correctly, so Suprtool does not
allow relative comparisons with them (<, <=, >, and >=), although
you may still compare for strict equality or inequality. The following examples
will be rejected by Suprtool:
>item trans_date,date,ddmmyy
>if trans_date >= $date(*/*-1/first) and &
trans_date <=
$date(*/*-1/last)
Error: Invalid date format
for the comparison
>input myfile,reclen 80, nolf
>define mydate,1,6
>item mydate,date,ddmmyy {e.g.,
301100}
>define ....
>if mydate > $date(00/11/01)
Error: Invalid date format
for the comparison
>if mydate > $date(01/11/00)
Error: Invalid date:
Year = 1 Month = 11 Day = 00
If the date format does not allow the specification of a certain
day, such as yymm, ccyymm, yyyymm, aamm, ccyy and mmyyyy, then you do not need
to specify the entire date format, although Suprtool will allow either format
for $date.
>item trans_month,date,yymm
>item purch_date,date,yymm
>if trans_month <= $date(*/*/*) and &
purch_date >=
$date(00/01)
Because dates beyond 1999 in the yymmdd and yymm date types do not
collate correctly, relative comparisons are no longer valid. Suprtool produces
an error in the following case:
>item trans_date,date,yymmdd
>if trans_date >= $date(2004/01/01)
Error: Cannot use a date beyond 1999 for this date format.
You can override this setting by entering the Set Date Ifyy2000error
command:
>set date ifyy2000error off
>item trans_date,date,yymmdd
>if trans_date >= $date(2004/01/01)
Century and
$Date
Suprtool needs to generate
a $date or $today date in the ccyymmdd format. If you specify a two-digit year
in the $date function, Suprtool needs to assume a century for the given date:
>item trans-date,date,ccyymmdd
>if trans-date >= $date(01/01/01)
Suprtool assumes 20 for the century if the specified year is less
than the Set Date Cutoff value, and 19 if the specified two-digit year is
greater than or equal to this value.
Oracle Dates
Oracle dates contain both the date and the time. The $date and
$today functions check the date, but ignore the time.
Date Limits
The $date function in
Suprtool can generate dates between the years 1583 and 2583. Some date formats
have limits based on their particular format, such as 2027 for a Calendar date
and 2259 for the aammdd aamm, mmddaa, ddmmaa dates.
Non-Collating
Date Types
You can use the $stddate
function to convert the non-collating date format to a J2 data item with a date
format of ccyymmdd.
For example, to select the purchases by the field purch_date for
November 2000 in a ddmmyy X6 field, you would use the $stddate function as
follows:
>item purch_date,date,ddmmyy
>if $stddate(purch_date) >= $date(2000/11/first) and &
$stddate(purch_date) <=
$date(2000/11/last)
Dynamic Date Selection
|
Using a first pass to generate a Suprtool command dynamically,
then using that command in a second pass, is a powerful technique.
|
You can use the If command for dynamic date selection. Suppose you
have a control file that maintains the start and end of a range of dates in
which you are interested. You can use the control file to select records from
another file or dataset, based on this date range. This is a two-step
process, in which the first Suprtool pass creates the If command with your
dates, and the second pass does the actual selection from the dataset.
|
>input datecntl, reclen 12, nolf {read
the one_line control file}
>define start_date,1,6,byte {start
date is the first six bytes}
>define end_date,7,6,byte {end
date is the next six bytes}
>extract "if sales_date >= '" {assemble
the If command}
>extract start_date
>extract "' and sales_date <= '"
>extract end_date
>extract "'"
>output seldate,temp {write
the If command to a file}
>xeq
This task produces a usefile that looks like this:
if sales_date >= '001101' and sales_date <= '001231'
Now you can use this file named seldate to do the actual selection:
>open oracle demo reader
>select * from sales
>use seldate {use
the file that has the If command}
>output sdetail
>exit
Long If commands can use
an ampersand to continue the command over several lines:
>if status = "20" and
&
>> state =
"AZ", &
>>
"CA", &
>>
"OR"
{no ampersand on the
last line}
This is awkward to use and, for internal reasons, the maximum length
is restricted to 256 characters. The $read function makes it easier to enter
long If commands. Its maximum length is based on the complexity of the
expression, not on the number of characters.
$Read Function
The $read function reads
the If expression from $stdinx, or from the usefile if the If command is in a
usefile. $Read continues to prompt for input lines until you press Return or
enter "//." You must remember to enter all the necessary parts of the
If expression, including connectors like AND and OR and commas. You do not use
an ampersand (&) to continue from one line to the next when using $read.
>if $read {prompt
for the expression}
-status = "20" and {$read
prompts with "-"}
-state = "AZ", {the
comma is still needed}
- "CA",
- "OR" {no
comma on the last line}
- {blank
line to terminate $read}
Redoing $Read
When prompting for an expression, $read saves each line in the redo
stack and accepts the Before, Do, Listredo, and Redo commands. This provides an
easy way to specify all or part of a previous $read expression.
Error: Data
Overflow
While the $read function
permits long expressions, there are other internal limits within the If
command. The first is a limit on the amount of space for constants. Suprtool
must blank-fill all string constants to their full length. The following
example overflows the data space:
>define char-256,1,256
>if char-256 = "a","b","c"
Error: Data Overflow
In this example, Suprtool attempted to create three 256-byte
constants. There wasn't enough room for the last constant. Solutions to this
problem include:
1.
If possible, define short fields.
If you have long field names, you may want to use the Define command to define
shorter subfields.
2.
Use tables and $lookup for many
values.
3.
Split the extract task into
multiple passes. On the first pass, use an If expression that results in the
fewest possible number of output records. Use the output file from the first
pass as input to the second. Apply the remainder of your If expression during
the second pass.
Error: Code
Overflow
Suprtool translates If
commands to an internal machine representation. There is a limit on the size of
this code. When an error occurs, there is little you can do except use tables
and $lookup wherever possible, and when this fails use multiple passes.
$Read in
Usefiles
When you specify $read in
a usefile, Suprtool expects the If expression to appear in the usefile. This
provides a method for storing and executing complicated If commands.
You can also manipulate Suprtool into
prompting for portions of an If command. When the If command with $read is the
last command in a usefile, Suprtool satisfies the $read from $stdinx. The $read
function can appear anywhere in which a space can appear, so you can use this
to prompt the user for values.
>use prompt.use
>in sdfile {first
line of usefile}
>if status=$read and & {continue
the If command}
state = $read {last
line of the usefile}
-"10" {prompt
for status}
-// {end
of prompt for status}
-"AZ", {prompt
for state}
-"CA", {user
must remember comma}
-"OR" {user
also enters quotes}
-// {end
of the second read}
$-functions
Some $-functions were originally designed for if command and some
are more suited for the extract command. Because of this some $-functions don’t
work in the if command, such as $edit, and others such as $number have
interesting side effects.
Specifically with $number, when you work on byte type fields, they
will be updated internally to be treated as display:
Get dataset
Def display-field,byte-field,display
If $number(display-field) > 10000
Out somefile,link
xeq
The
field byte-field will have leading zeroes and treated as a display.
Opens the file that will
be the input source for the next extract task. The file must contain
fixed-length records with or without a line feed separator. If you are
selecting records, the selection parameters must appear after any Reclen, LF,
or NOLF parameters. The record length is the length of the data portion of each
record, not including the line feed. If you specify LF, Suprtool/UX includes
the line feed as part of the data by increasing the record length by one
character.
If you have an input file with 80-byte records, and each record is
separated with a line feed, you would use:
>input uxfile,reclen 80,lf
>list char
>xeq
Since Uxfile has line feeds, the List command shows a dot (.) as the
81st character of each record. This dot corresponds to the line feed character.
To read every fifth record in Uxfile, you would use:
>input uxfile,reclen 80,lf, (#5)
>list char
>xeq
To examine a file which has no line feeds between records (e.g., the
Suprtool object code), you would use:
>input /opt/robelle/bin/suprtool,rec 256,nolf
>num 10
>list hex,char
>xeq
Suprtool executes the Input command immediately – it does not wait
for an Xeq command before opening the Input file.
INPUT file [,RECLEN length] [, LF | NOLF]
[(startrecord/[endrecord])]
[(#count)]
(Default: all input
records)
Input File
The first example shows
the most common use of the Input command. An input file is specified as the
input source to Suprtool. We select a subset of the input data with the If
command. Before using the If command, we must define a field within the input
record:
>input invent, r 80, nolf {input
is from a disc file}
>define a,11,2,int {"A"
is an integer that starts…}
>output outfile { at the 11th byte of Invent}
>if a<10000 {records
with field "A" less than…}
>xeq { 10000 are written to Outfile}
Selection by
Record Number
The (startrecord/endrecord)
parameter specifies a range of input records by record number. The default
value for endrecord is the highest record in the file. The first record number
is 0 for disc files.
The (startrecord/endrecord) parameter must come after the
reclen and LF/NOLF parameters, if it is present. You can check your record
selections with the Verify command.
When debugging software, it is convenient to scan the first few
records of a file. The startrecord/endrecord parameter makes it easy to
scan these records:
>input invent,r 80,nolf, (0/19) {first
twenty records}
>list {produce
a list of each record}
>xeq { in "OCTAL,CHAR" format}
Random Selection
The (#count) parameter specifies that every "nth" record in the
input file should be selected. This option is designed for random sampling of
the input file. The (startrecord/endrecord) parameter cannot be used with
this parameter. Like (startrecord/endrecord), (#count) must come after the =setname,
if present.
Test files can be constructed from random samplings of production
files. We can build a test file with the #count parameter:
>input dinvent(#15) {every
15th record is read}
>output dtest {create
an output file with every}
>xeq { 15th record from Dinvent}
Notes
Only one Input, Chain, Get, or Select command is allowed per extract
task. The Input command opens the specified file immediately. The file is held open until the input is reset or the
current task completes.
Use the Item command to
specify the number of implied decimal points or the date format for an item.
The $date and $today functions of the If command work only with dates. The Item
command must precede any If or Extract commands.
ITEM itemname,DATE | DECIMAL,attribute
Itemname
The itemname must be an
Eloquence itemname, a Defined field, an SD (self-describing) field, or a column
name. If the itemname exists both as an Eloquence itemname and as a Defined
field, the attribute is associated
with the Eloquence itemname and the Defined field is deleted. If the itemname
exists both as an Eloquence itemname and as an SD field, the attribute is only associated with the
Eloquence itemname and a warning is produced. The itemname cannot be qualified
with a subscript.
For dates, the attribute must
be one of the following:
|
Attribute
|
Attribute
|
|
ASK
|
ccyymm
|
|
Calendar
|
ccyy
|
|
ddmmyy
|
aammdd
|
|
ddmmyyyy
|
aamm
|
|
mmddyy
|
mmddaa
|
|
mmddyyyy
|
ddmmaa
|
|
Oracle
|
SRNChronos
|
|
PHdate
|
mmyyyy
|
|
yymm
|
yyddd
|
|
yymmdd
|
ccyyddd
|
|
yyyymm
|
HPCalendar
|
|
yyymmdd
|
JulianDay
|
|
yyyymmdd
|
EDSDate
|
|
ccyymmdd
|
PHDate8
|
Abbreviations
When specifying the Date keyword, you can use a leading subset for
the date attribute. For example, if you want to specify the Calendar date type,
you can specify only CA.
If you do not like this feature, you can turn it off by specifying
the following command in your Suprmgr file:
>set itemabbreviatedate off
Data-Types for
Dates
Each date attribute is
compatible with certain data-types. For more information, see the table on
data-types in the Define command. The following table shows the
compatibilities:
|
Date-Attribute
|
Data-Type Compatibility
|
|
ASK
|
J1 and K1
|
|
Calendar
|
J1 and K1
|
|
ddmmyy
|
X6, Z6, J2, K2, and P8 or greater
|
|
ddmmyyyy
|
X8, Z8, J2, K2, and P10 or
greater
|
|
mmddyy
|
X6, Z6, J2, K2, and P8 or greater
|
|
mmddyyyy
|
X8, Z8, J2, K2, and P10 or
greater
|
|
Oracle
|
X7
|
|
PHdate
|
J1, K1, J2, and K2
|
|
yymm
|
X4, Z4, J1, and K1
|
|
yymmdd
|
X6, Z6, J2, K2, and P8 or greater
|
|
yyymmdd
|
J2, P8
|
|
yyyymmdd
|
X8, Z8, J2, K2, and P10 or
greater
|
|
ccyymmdd
|
X8, Z8, J2, K2, and P10 or
greater
|
|
ccyymm
|
X6, Z6, J2, K2, and P8 or greater
|
|
yyyymm
|
X6, Z6, J2, K2, and P8 or greater
|
|
aammdd
|
X6
|
|
aamm
|
X4
|
|
mmddaa
|
X6
|
|
ddmmaa
|
X6
|
|
ccyy
|
X4, Z4, J1, and K1
|
|
SRNChronos
|
X6
|
|
mmyyyy
|
X6, Z6, J2, K2, and P8 or greater
|
|
yyddd
|
X5, Z5, J2, K2, and P8 or greater
|
|
ccyyddd
|
X7, Z7, J2, K2, and P10 or
greater
|
|
HPCalendar
|
J2, K2
|
|
EDSDate
|
J2, P8
|
|
JulianDay
|
J2
|
|
PHdate8
|
J1, K1, J2, and K2
|
Date Limits
The $date function in
Suprtool can generate dates between the years 1583 and 2583. Some date formats
have limits based on their particular format, such as 2027 for a Calendar date
and 2259 for the aammdd aamm, mmddaa, ddmmaa dates.
Calendar
The Calendar attribute is provided for users who have
fields containing the 16-bit MPE Calendar date format as an unsigned, logical value with seven bits for the
year of the century (bits 0-6), followed by nine bits for the day of the year
(bits 7-15). The Calendar date format only supports dates up to the end of the
year 2027.
PHdate and
PHdate8
The PHdate and PHdate8 attributes are compatible with the
COGNOS PowerHouse date format. If the data-type
is J1 or K1, the date is stored as a LOGICAL value with seven bits for the
year of the century (bits 0-6), four bits for the month (bits 7-10), and five
bits for the day (bits 11-15). If the data-type
is J2 or K2, the date is stored as
yyyymmdd.
PHDate and PHDate8 date formats are similar, however PHDate values
for the year range from 0 - 99, whereas PHDate8 year values are from 0 - 127. A
year of 0 in PHDate could mean either 1900 or 2000 depending on user
applications. A year of 0 in PHDate8 means 1900, and 100 means 2000. The
PHDate8 date format is found in PowerHouse version 8.19 and higher.
ASK
The ASK attribute is compatible with the ASK
manufacturing software. ASK uses a special date format stored as a single
integer or a single logical (i.e., J1 or K1 in IMAGE). This date is relative to
January 1, 1973.
yyymmdd
The yyymmdd attribute is similar to yymmdd, except
that the first digit denotes the century. If the first digit is a 1 (one) then
the century is 19, and if the first digit is a 2 (two) then the century is 20.
Only data-types of P8 and J2 are supported for this date attribute.
This date format is used by some third-party software packages such
as MACS and APS.
EDSDATE
The EDSDATE date format is
similar to the yyymmdd format, in which the first digit represents the century.
The first digit in the EDSDATE is either 0 or 1: a 0 represents a century of 19
and a 1 represents a century of 20.
JulianDay
The JulianDay number is
the absolute count of the days that have elapsed since January 1, 4713 BC on the Julian
calendar.
Typically "Julian Day numbers" refer to an integer number
corresponding to whole days, while the "Julian Date" may mean an
integer plus a decimal value that resolves the Julian count to precise parts of
a day. Suprtool supports the "JulianDay" number and does not attempt
to support an hour or point in the day.
aammdd and
Related Date Formats
The aammdd attribute is similar to yymmdd, except
the aa portion of the date uses a combination of letters and numbers in order
to represent dates beyond 1999.
The aammdd date format was developed by James Overman of HP for use
in their MM3000 product. This format is available only for X6 data-type.
By substituting a letter of the alphabet in the first position of
the year, we can extend a six-digit date and also ensure that the dates collate
correctly. For example:
|
YY of AAMMDD
|
CCYY
|
|
00 - 09
|
1900 - 1909
|
|
90 - 99
|
1990 - 1999
|
|
A0 - A9
|
2000 - 2009
|
|
B0 - B9
|
2010 - 2019
|
|
C0 - C9
|
2020 - 2029
|
Because letters are greater than numbers in the collating sequence
you can ensure that aammdd dates beyond 1999 will order correctly.
Suprtool also supports other date formats with this two-character
year representation. These formats are aamm, mmddaa and ddmmaa.
Oracle
Oracle dates include both
the date and the time. The $date and $today functions only apply to the date
part of Oracle dates.
SRN Chronos
The Srnchronos date format
is used in applications from Software Research Northwest. Like Oracle dates,
this format includes the date and time, but the time portion is ignored by the
$date and $today functions.
DDD Dates
Dates consisting of ddd in
the format name use the ddd to represent the nth day in the current year. This means that January 1 will be day
001, and Dec 31 will be day 365 on non-leap years. Some people refer to these
type of dates as Julian dates.
HPCalendar
The HPCalendar date format
is supported by HP's new HPCalendar intrinsic and consists of a 32-bit integer
number, whereby the first 23 bits represent the year and the last nine bits
represent the day of the year.
The decimal attribute is the number of implied
decimal places in an item. The minimum number of implied decimal places is 0.
The maximum is based on the data-type of the item:
|
Data-Type
|
Maximum Implied Decimal Places
|
|
I1
|
5
|
|
I2
|
10
|
|
I3
|
15
|
|
I4
|
19
|
|
K1
|
5
|
|
K2
|
10
|
|
Pn
|
n-1
|
|
Zn
|
n
|
You cannot specify implied decimal places for byte-, char-, or
IEEE-type items.
Once you define a decimal place, almost every command in Suprtool is
affected. Suprtool accepts numeric values with decimal points or scales
integers according to the number of implied decimal places (e.g., specify two
implied decimal places, then enter 1,000 to represent 1,000.00). All formatting
commands format fields with a decimal point when appropriate.
Constant Values
When specifying numeric
constants for a field with implied decimal places, there are different formats
that you can use. For example, assume that we use the Item command to specify
two implied decimal places for an amount field. The following are examples of
constant values for this item:
|
Constant
|
Interpretation
|
|
0
|
zero value padded as necessary
|
|
1
|
$1.00
|
|
0.01
|
$0.01
|
|
.01
|
also acceptable for $0.01
|
SQL Columns
You must redefine any SQL columns before you can use the Item
command.
>sel * from emp
>def salary,sal
>item salary,decimal,3 {correct
scale}
>if salary > 15.275
Compound Items
When you specify a compound item, the attribute applies to all
elements of the compound item.
>item monthly_totals,decimal,2 {12
occurrences}
>if monthly_totals(5) > 1000.00
You cannot apply an attribute to only one sub-item of a compound
item:
>item monthly_totals(5),decimal,2
Error: Missing attribute for
the Item Command
When to Specify
the Item Command
The Item command affects almost all other Suprtool commands. It
should be used as follows:
·
For databases, specify it
immediately after the Select command, but before any Extract or If commands.
·
For disc files, it is best to
specify the Define and Item commands immediately after the Input command.
Usefiles
You can use a usefile as a mini data dictionary for Suprtool. For
databases, it is a good idea to put all the Item commands associated with a
database into a usefile. After the Base command has been specified, the usefile
can describe the items in the database to Suprtool. For disc files, you can put
both the Define and Item commands in a usefile and execute them right after
specifying the file with the Input command. If you use the Link output option,
both date formats and implied decimal places are saved in the self-describing
file so they never need to be specified again.
base store
use store.usefile
Specifies the next sort
field for an extract task, using an explicit byte position in the record, not a
field name. See the Sort command for specifying sort fields by table column
name or Defined field, or by field name in an SD file. Up to 20 Sort and Key
commands may be specified per extract task; the first is the major sort field.
[KEY] byteposition,bytelen [,type] [,DESC]
(Default: type=BYTE, ASCENDING order).
Parameters
Desc specifies that the
field is to be sorted in Descending order.
The byteposition is a number between 1 and the length of the input
records, specifying where the sort field begins. The bytelen parameter is a number from 1 to the length of the record,
specifying how long the sort field is.
The type is a word that gives the desired data-type of the field for
sorting purposes:
|
Type
|
Description
|
|
BYTE
|
(unsigned, straight compare)
|
|
INT/INTEGER
|
(two's complement)
|
|
DOUBLE
|
(two's complement)
|
|
IEEE
|
(IEEE floating-point)
|
|
PACKED
|
(packed-decimal)
|
|
PACKED*
|
(packed-decimal, last nibble unused)
|
|
DISPLAY
|
(zoned-decimal numeric field)
|
|
LOGICAL
|
(unsigned, like BYTE, 2 characters)
|
|
CHARACTER
|
(for Native Language Support)
|
The Key command also accepts FPOINT as the data-type for IEEE
numbers.
Examples
The first example sorts an integer (PIC S9(4) COMP) field which
starts on the 11th byte of the input record. We sort the entire input file
based on one key:
>input bigfile,r 40,lf {input
from a disc file}
>key 11,2,int {key
is an integer that starts}
>output outfile { at the 11th byte of Bigfile}
>xeq {create
Outfile and prompt for}
{ more Suprtool commands}
>input discfile,r 40,lf {another
input file}
>key 14,4,double,desc {double
integer (PIC S9(9) COMP)}
>output ofile2 {sort
input in descending order}
>exit
The following examples show the various data-types and combinations
that are available with the Key command:
>key 1,10 {byte
data-type}
>key 1,10,desc {descending
sort sequence}
>key 11,4,double {I2
or J2, S9(9) COMP}
>key 1,6;11,4,ieee {X6
string and an E2 field at byte 11}
>key 21,6,packed {P12,
S9(11) COMP-3}
>key 21,6,packed* {P12,
S9(10) COMP-3, wasted byte}
Notes
The command name, Key, is
optional. Any command that starts with a numeric character is assumed to be a
Key command. The Verify command shows all of the current key fields, and the
Reset command cancels them. If no sort fields are defined prior to the Xeq or Exit
command, Suprtool performs a copy, not a sort.
You cannot use Suprtool's
Link command to invoke Suprlink/UX, but you can run Suprlink/UX by itself.
/opt/robelle/bin/suprlink
Suprlink/UX/Copyright Robelle Solutions Technology Inc. 1988-2004
(Version 5.1.02)
+
Suprlink/UX provides high-speed data file linking based on a sort
key. Suprlink/UX only accepts self-describing files created by Suprtool/UX or
the MPE SDUnix program.
The List command is used
to produce formatted listings of the selected records. You may specify the List
command, or the Output command, or both, or neither. If List is used instead of
Output, Suprtool sets the Output to $null, so that only a listing is produced.
LIST [ OCTAL|HEX|DECIMAL ] [ CHAR ] [ NOREC ]
[ LABELS ]
[
RECORD ] [ DUPLEX ] [ ONEPERLINE ] [ LP ]
[
NONAME ] [ NOSKIP ] [ STANDARD ] [ DEVICE name
]
[
DATE format ] [ TIME format ] [ PCL format ]
[
LEFTJUSTNUM ] [ RIGHTJUSTNUM ]
[
TITLE "string" ] [ HEADING
"string" ["string" ...]]
[FILE filename | APPEND | RECLEN number]
(Default: Octal/Char or "Formatted")
If Suprtool knows about the fields in the input source (e.g.,
because you have used the Extract command), the list records are formatted with
field names, and internal binary data-types (e.g., integer) are converted to
ASCII. You cannot combine the Ask or Query,Num output-options with the List
command.
Here is a typical use of List: to find any entries in the Customer
table that do not have a valid value for "status".
>open oracle demo reader {input
from a database}
>select * from customer {read
this table}
>if status<>10,20,30,40 {the
only valid values}
>list
{print
bad entries}
>xeq
You can override the
defaults with a specification in the List command (e.g., List Hex,Char). If the
input source is not self-describing and no Extract command is specified, the
default output format is Octal,Char, which also shows both input and output record numbers.
Decimal Places
The List command formats
numbers using the implied number of decimal places. For example, the following
Suprtool commands format the unit cost with two decimal points. We specify the Rightjustnum keyword,
because numbers with decimal points are hard to read if they are left
justified:
>item cost,decimal,2 {two
implied decimal points}
>list rightjustnum {numbers
right justified}
>xeq { with decimal points}
Listing Record
Numbers
The Norec keyword prevents the
printing of the input and output record numbers. The input record numbers are
not printed if Output xxx,Data is used and the file is sorted.
Listing One
Field per Line
Suprtool normally attempts
to list more than one field on every line of list output. The Oneperline keyword causes
every field to be shown on a different line.
Listing without
Field Names (Noname)
When Suprtool knows the
record structure of the output file, it shows the name of each output field.
The Noname keyword causes the field names to be suppressed. By only extracting
a few fields, it is possible to fit the listed output for each record on one
line.
Suppressing
Blank Lines Between Records
By default, Suprtool prints a blank line
between each record. The Noskip keyword removes this blank line. If you combine the Noskip, Norec,
Noname, and Title options when extracting a few fields, Suprtool can produce a
simple report.
Numeric
Justification (Leftjustnum and Rightjustnum)
The List command normally
left justifies all numeric fields. Specifying List Standard causes all numeric
fields to be right-justified, unless you override the default with the
Leftjustnum keyword.
Use the Leftjustnum or Rightjustnum keyword to specify the alignment of the numbers. The two keywords
are mutually exclusive. The last one that appears on the command line is the
one that is applied.
There are two methods to
select different printing options for a LaserJet and other PCL-compatible
printers. You can permanently set the PCL option for all listings by using Set
List PCL, or you can use the List command to select the PCL option for just one
task. PCL stands for Printer Command Language, which is an HP standard for
printers. The following is a summary of the PCL values:
|
PCL
|
Font
|
Orientation
|
Dimensions
|
|
1
|
Lineprinter
|
landscape
|
175 cols/60 lines
|
|
2
|
Courier
|
landscape
|
100 cols/45 lines
|
|
3
|
Courier "standard"
|
portrait
|
80 cols/60 lines
|
|
4
|
Lineprinter
|
portrait
|
132 cols/80 lines
|
|
5
|
Courier A4 "tight"
|
portrait
|
80 cols/60 lines
|
|
6
|
Lineprinter legal
|
landscape
|
223 cols/60 lines
|
See the Set command for a complete description of the PCL options.
By default, Suprtool assumes that the List output device is not PCL-compatible
(List PCL 0).
If you use the List
command to your terminal with a global Set List PCL value other than zero, your
terminal screen may be cleared. To avoid this situation, you can explicitly
specify the PCL setting along with the device:
>get d-sales
>list serialp,pcl 2
>xeq
A4-Size Paper
Most of the PCL options,
with the exception of PCL 5, were designed and tested with North American
letter-size paper. This is especially true with PCL 5 for A4 paper: it reduces
the horizontal spacing between characters so that 80 columns of Courier output
fits on a single line. In addition, if you add 2000 to a PCL code, Suprtool
adjusts the number of rows and columns for that option to match A4 paper. For
example, to print Landscape on A4 paper, use PCL 2004 instead of PCL 1.
In general, selecting A4 paper gives you more space along the long
side of the paper and less space along the short side. If you are happy with
the way letter-size rows and columns work on A4 paper, simply do not add 2000
to the PCL code.
Roman-8 vs.
ASCII
The PCL option requests a
Roman-8 character set, but some combination font cartridges only supply the
ASCII character set (half as many characters means twice as many fonts in a
single cartridge). If you ask for Landscape Lineprinter and get Landscape
Courier instead, your Lineprinter font probably has the ASCII character set
instead of the Roman-8 character set. To request an ASCII font, add 1000 to the
PCL code. For example, if you have a Super Cartridge (55 fonts in one!), use
PCL 1001, 1004, and 1006. To select both ASCII and A4 paper, add 3000.
Double-Sided
Printing on LaserJets
The LaserJet IID and IIID
can print on both sides of the paper. The Duplex keyword enables
double-sided printing on these printers.
Specifying a Title in the List command
forces Suprtool to produce a formatted listing with page-headings,
page-numbers, today's date and the current time. If you want just the date and
page numbers, use an empty string. For example,
>list title " "
The following example prints a report on a LaserJet in Landscape
(sideways) mode, using the tiny Lineprinter font, including a page heading with
the title. The physical command line limit is 256 characters. As a result, the
maximum size of the heading is less than 256 characters because the List
command and heading options need to be included in the command line.
>in custs {self-describing
file}
>if status<>10,20,30,40 {the
only valid values}
>set list pcl 1 {select
LaserJet option}
>list title "Invalid CUSTOMER Records"
>xeq {include
title on listing}
Changing the
Date Format
When you select page
headings by specifying a title, each page includes today's date. By default,
this date is formatted as mmm dd, ccyy (e.g., Mar 20, 2000). You can override this format
with the Date keyword. Use the Set command to specify a different default date
format for future List commands (e.g., Set List Date 2). The valid date formats
are as follows:
|
Value
|
Format
|
Example
|
|
0 (default)
|
mmm dd, ccyy
|
Mar 20, 2000
|
|
1
|
yy/mm/dd
|
00/03/20
|
|
2
|
mm/dd/yy
|
03/20/00
|
|
3
|
dd/mm/yy
|
20/03/00
|
|
4
|
dd mmmyy
|
20 Mar00
|
>list title "Example Report" date 3
>xeq {heading
date is in dd/mm/yy format}
Changing the
Time Format
When you select page
headings by specifying a title, each page includes the current time. By
default, the time is in 24-hour format (e.g., 23:02). You can override this format with the Time keyword. Use the Set
command to specify a different default time format for future List commands
(e.g., Set List Time 2). The valid time formats are as follows:
|
Value
|
Format
|
Example
|
|
0
|
none
|
|
|
1 (default)
|
24-hour
|
23:02
|
|
2
|
AM/PM
|
11:02PM
|
>list title "Example Report" time 2
>xeq {time
will be in AM/PM format}
A Fast Method
for Producing Simple Reports
For self-describing files, datasets, and
database tables, the Standard keyword is equivalent to List Noname,Noskip,Norec,Rightjustnum with
default column headings. For data files, the Standard keyword is equivalent to
List Octal,Char. In either case, the Standard keyword provides a default title
that describes the input source. You can override the title, date format, time
format, or any other option selected by the Standard keyword, by specifying
them in addition to the Standard keyword. For example,
>select * from customer
>list standard {use
all Suprtool defaults}
>xeq
>select * from customer
>list standard,date 3 {override
the date format}
>xeq
>input uxfile,reclen 80,nolf
>list standard,char {override
the format options}
>xeq
>input uxfile,reclen 80,nolf
>list
standard,leftjustnum {left
justify numbers}
>xeq
>get m-customer
>list standard,title "Customer List" {override
title}
>xeq
>get m-customer
>list standard,heading " " {no
column headings}
>xeq
Listings with
Subheadings
When using the Title or
Standard keywords, you can also include subheadings with the Heading keyword. You can
specify multiple columns by repeating the string after the Heading option
(e.g., List Heading "First " "Second") or specify the
Heading option multiple times (e.g., List Heading "First ", Heading
"Second"). Being able to specify multiple columns makes it easier to
align column headings when using the Standard keyword. If you specify the
Heading keyword without the Title keyword, a default title is produced.
>select * from
customer {read
this table}
>extract account {Z8
}
>extract firstname {X10}
>extract lastname {X16}
>extract rating {J2
}
>extract status {X2
}
>sort lastname
>sort firstname
>list standard,title "Customer List", &
heading
"Account " " First and
Last Names" &
" " "Credit " "Status"
>xeq
By default, the List
command lists lines to $stdlist. You can also redirect output to an attached
printer. To redirect to a file on HP-UX we have added the file option.
The File keyword allows for the output from the
List command to be directed to a file. The List command also has a new option
to Append to an existing file, so you can have multiple reports in a single
file. The File option takes the next parameter as being the filename:
>in test/file1sd
>list stan file myslist
>xeq
If the file myslist
exists it will be over-written, unless you specify the Append option. If you
specify the append option the new report will be added to the file.
So if you want to
incorporate multiple reports you just need to do the following:
>in test/file1sd
>list stan file myslist
>xeq
>in test/file2sd
>list stan file myslist append
>xeq
Although the concept of
record size is not the same on HP-UX as it is on MPE it is still important in
some areas within Suprtool.
In this case the RECLEN
parm merely tells the List command where to fold the lines. The Reclen parm can
be a value from 56 to 256 and defaults to 80 bytes.
>List FILE myreport RECLEN 132
Device LP
Use the LP option to send
listings to the lp command. The LP option assumes the list device is 80 columns
wide.
User Specified
Device
Use the Device option to specify a specific logical device for the listing. The
device name must appear after the Device option. The device name is
case-sensitive so that the device "SHIPPING" is different than the
device "shipping". The Device option assumes that the list device is
80 columns wide.
>list device LP {same
as List LP}
>list device serialp {send
to device serialp}
Listing to
Attached Printer
If you wish to list to a
printer that is attached to your terminal, use List Record. Suprtool uses Record
mode on your terminal or PC to print on the attached printer. To use this
option, you must be using an HP terminal or HP terminal emulator and your data
communication settings must be setup correctly.
You can combine this
option with other listing options. You cannot interrupt Record mode with
Control-Y, but you can do a Soft Reset. This unlocks the keyboard and causes
the rest of the output to appear on the screen. You can then stop it with
Control-Y. List record may not return complete control to your PC when running
Reflection. The report printed and the keyboard unlocks, but control is not
passed to your terminal. You can get control back by doing a Soft Reset
(Alt-S). You can prevent this problem by setting DISABLE-COMP-CODES to yes.
If you are listing to an attached printer from a terminal, your
terminal may remain locked after the printout is completed. This generally
happens when you have handshaking enabled. (G-H straps set to No). You can do a
soft reset to unlock your terminal.
If handshaking is disabled (G-H straps set to Yes), the List command
works and returns control to the terminal but two "S" characters will
be printed on the terminal. There is currently no known workaround to these
problems.
Typically when printing
with the list command inside Suprtool, (or Qedit for that matter), and you are
sending the output to a printer device, the “lp” program is used to accept the
data from a pipe. In some cases third party spoolers employ their own “lp”
program.
If the ROBELLE_LP
variable is set to the name of the third-party lp program, Suprtool (and Qedit)
will use that program if the output is not to a file. This variable must be set
before Suprtool is run.
export
ROBELLE_LP=/opt/thirdpartyspooler/llp
./suprtool
in somefile
list device LP
exit
If the variable is not set then Suprtool uses /usr/bin/lp as it has
previously.
Notes
The List operation occurs logically after the sort phase, if any,
and after any Extract, but before the final Output or Put operation. A Reset
turns off the current List options.
For more examples of the List command, see Suprtool Issues and Solutions.
The Listredo command
displays any of the previous 1000 commands.
LISTREDO [ start
[ / stop ] ] [;ABS] [;OUT=file]
[
string ] [;REL]
[
ALL | @ ] [;UNN]
(Default: display previous
20 commands)
(BJ and ,, are short for
LISTREDO)
Commands are numbered sequentially from 1 as entered and the last
1000 are retained. You can display a single command, a range of commands, all
1000, or all the commands whose name matches the string. You can display the
commands with ABSolute line numbers (the default), RELative line numbers
(-5/-4), or UNNumbered. If you want to redo any of these commands, see Do,
Redo, and Before.
Examples
>listredo 5
>listredo 5/10
>listredo help {print
all Help commands}
>listredo -10 {print
last ten commands}
>listredo ALL {print
entire redo stack}
>listredo rm {print
all rm commands}
>listredo rm xx {print
all "rm xx" commands}
>listredo @rm {print
all with "rm" anywhere}
>listredo @;rel {print
ALL, relative numbers}
Saving to a File
Saving the Listredo commands to a file is not supported in
Suprtool/UX.
Notes
The :Listredo command can be abbreviated to BJ as in Qedit, or to ,,
(comma comma) as in MPEX. You cannot use a semi-colon (;) to combine commands
on the same line.
Persistent Redo
Redo commands can be saved in a permanent file and can therefore be
used from another session. You can use the Set
redo command to specify a filename to save your redo commands. Please see
the Set Redo command ("Redo" on page 30) for details.
Limits the number of
records selected and the size of the sort scratch file.
NUMRECS size | percentage%
(default: size=10,000 or EOF of input source)
Parameters
To limit the number of records selected from the input source and to
reduce the size of the sort scratch file, use the Numrecs command. If you
select more than |2size| entries, Suprtool prints a warning message, and
ignores the rest of the input records.
However, the output file will have the records that were selected. Use a
percent sign (%) to specify the Numrecs as a percentage of the input file size.
The percentage can range from 1 to 500, but values over 100 have no effect on
HP-UX.
Reducing File
Sizes
Suppose that the d-sales
dataset contains 100,000 entries, but you use the If command to select 15% of
the entries. We would specify 15 as the percentage
on the Numrecs command to reduce the size of the sort scratch file and the
output file:
>get d-sales {specify
input}
>numrecs 15% {specify
15000 as file size}
>if sales-qty<100 {select
a subset of d-sales}
>sort cust-account {sort
using the dataset path}
>output out2 {output
file will have room for}
>xeq { 15000 records}
Disc Files vs.
Datasets
When you specify a source of records using the Input command (as
opposed to reading a dataset using the Get or Chain command), Suprtool attempts
to duplicate all of the input file's attributes in the output file. This includes
the file limit. For this reason, the Numrecs value is ignored if the output
file limit is smaller than the input file limit. Numrecs is still useful when
reading disc files to reduce the size of the sort scratch file.
Specify an SQL database to
open. Only one database can be open at a time.
OPEN ORACLE username [password][remotedb@instance]
OPEN ALLBASE dbename owner
Oracle Database
Use the Open command to
connect to an Oracle database. You must specify your Oracle username and password. If you do not specify the password in the Open command,
Suprtool prompts for your password (without echoing it on the screen). To read
data from an Oracle table or view, use the Select command. Use Set Oracle Rows
to specify how many rows for Suprtool to fetch when it is reading Oracle data.
Allbase Database
Use the Open command to
connect to an Allbase database. You must specify your Allbase dbename and owner. To read data from an Allbase table or view, use the Select
command. Use Set Allbase Rows to specify how many rows for Suprtool to fetch
when it is reading Allbase data.
>open allbase inventory anne
In order to connect to the
remote database using Suprtool, you need to specify the connection parameters
as follows:
>open oracle
username/password@machine
Oracle Libraries
If the Oracle libraries have
not been loaded Suprtool will print an error on the Open command. To find out specific error messages as to why the
libraries have not been loaded then just run Suprtool with the –lw option,
which means print loader warnings.
Define the name of the
output file as one of these: a new disc file (default), an existing file
(Append or Erase option), or * for $stdlist. If you use List, Put, Update or
Total, Output defaults to $null. Output produces the same record format as the input
source (adjusted by Extract commands), unless you override it with format
keywords.
OUTPUT filename format [ERASE | APPEND]
(Default: DATA only,
"new" file)
New Files
The filename is the name of a new disc file to be built by Suprtool
(Output xxx). If Suprtool cannot Save the new file because of a duplicate file
name, you may purge the old file or give the new file a different name. If
Suprtool is running in batch mode, it renames the new file as Outputnn, where nn is the lowest number between 00 and 20 that makes a valid new
file name. The Outputnn file is built
in the same directory as the duplicate output file and not in your current
directory.
Existing Files
The filename is the name of an old disc file to erase (Output
xxx,erase) or to append to (Output xxx,append). Output xxx,erase does not purge
the existing file; it simply overwrites the contents of the file.
$Stdlist
Specify output to $stdlist
by a single asterisk (Output *). Use this filename
with the ASCII option for a quick listing of a file or database table.
The format and length of the output records is determined by which
of the following format keywords is
selected:
|
Keyword(s)
|
Format
|
|
DATA
|
Default
|
|
KEY
|
Sort keys only
|
|
NUM
|
J2 record numbers only
|
|
NUM,KEY
|
J2 record numbers plus sort keys
|
|
NUM,DATA
|
J2 record numbers plus data record
|
|
QUERY
|
Self-describing file
|
|
LINK
|
New format self-describing file
|
|
NUM,QUERY
|
Query "numbers" format
|
|
ASK
|
COGELOG ASK select file
|
|
ASCII
|
Convert numeric to ASCII
|
|
DISPLAY
|
Convert numeric to display (zoned-decimal)
|
|
PRN
|
Personal computer format
|
|
NOLF
|
Do not write out Line Feeds to the end of the record
|
|
LF
|
Write out Line Feeds to the end of the record
|
DATA is the default; output records are the same length and format
as the input records.
KEY creates output records containing only the sort keys,
concatenated from left to right (major key to minor key).
NUM creates output records of four bytes in length, containing the
double-integer record number of each input record. The record number of the
first record is 1 for database tables and 0 for disc files.
NUM,KEY creates output records containing the four-byte record
number, followed by the sort key values, concatenated from left to right (major
key to minor key).
NUM,DATA creates output records containing the four-byte record
number, followed by the full data record. This can be useful to create
"transaction" files from detail datasets that will later be updated
back to the database after a processing stage.
QUERY creates a self-describing output file. A self-describing file
is a data file plus an extra file which contains information about the
structure of each record in the data file. This extra file is created with the
output file name plus the extension ".sd". This ".sd" file
contains the name, type, length, and offset of each field in the data file.
QUERY self-describing files have no provision for repeated fields.
These fields appear with an "unknown" type in the .sd file. See the
LINK option for a better self-describing file format. The QUERY option produces
a file that is similar to the file produced by the SAVE command in the MPE
QUERY program.
The QUERY output option has some major drawbacks. Compound fields
are not handled, date and decimal point information is not saved, and sort
information is not part of the file description. The LINK option produces a
self-describing file that solves all these problems. This option is the
recommended way to generate files for Suprlink. We are also encouraging third-party
software vendors to accept this format.
To convert a self-describing file back into a non-SD file, simply
purge the corresponding ".sd" file.
NUM,QUERY creates output records in QUERY "numbers"
format. This is an undocumented feature of QUERY that is used by some
application packages. Records in a "numbers" file contain the dataset
number and the record number in ASCII format. A QUERY "numbers" file
is usually used as input to a report program. Substituting Suprtool for QUERY
in these batch jobs should improve the speed.
ASK is a QUERY-replacement tool from COGELOG. ASK creates output
records in ASK select-file format. Suprtool can be used to scan and select
records quickly from a dataset. ASK Version C can produce reports from the
resulting select-file. This option cannot be used with any other Output option.
Recent versions of ASK read self-describing files. For these
versions use the Link option instead of the Ask option.
ASCII converts all binary input fields into their equivalent ASCII
values. All binary fields are right-justified in their fields with a trailing sign.
The sign can be a blank, "+", or "-". Byte fields are not
affected by this option. The size of the ASCII field depends on the format of
the binary field:
|
Field Format
|
Output Size
|
|
I1, J1
|
6 bytes
|
|
I2, J2
|
11 bytes
|
|
I3, J3
|
16 bytes
|
|
I4, J4
|
20 bytes
|
|
K1
|
5 bytes
|
|
K2
|
10 bytes
|
|
E2
|
12 bytes
|
|
E4
|
23 bytes
|
|
Zn
|
n+1 bytes
|
|
Pn
|
n bytes
|
Any fields with implied decimal places (see the Item command) are
formatted with a decimal point in the correct position. Suprtool reserves two
additional positions for each output field that has an implied decimal point.
DISPLAY converts all binary input fields into their equivalent
display values (also known as zoned-decimal). The size of the display field
depends on the format of the binary field:
|
Field Format
|
Output Size
|
|
I1, J1
|
5 bytes
|
|
I2, J2
|
10 bytes
|
|
I3, J3
|
15 bytes
|
|
I4, J4
|
19 bytes
|
|
K1
|
5 bytes
|
|
K2
|
10 bytes
|
|
Pn
|
n-1 bytes
|
|
P*n
|
n-2 bytes
|
The last digit of the number is replaced with a letter corresponding
to positive or negative values. See the following table.
|
Units Digit
|
Positive
|
Negative
|
No Sign
|
|
0
|
{
|
}
|
0
|
|
1
|
A
|
J
|
1
|
|
2
|
B
|
K
|
2
|
|
3
|
C
|
L
|
3
|
|
4
|
D
|
M
|
4
|
|
5
|
E
|
N
|
5
|
|
6
|
F
|
O
|
6
|
|
7
|
G
|
P
|
7
|
|
8
|
H
|
Q
|
8
|
|
9
|
I
|
R
|
9
|
Positive values for I- and J-type fields are converted into neutral
(i.e., no sign) display values. The sign is preserved when converting packed
fields to display.
DISPLAY is not supported for Real or IEEE fields. Byte fields are
not affected by this option. Display fields in the input record are not
converted into display.
Many PC software packages import PRN files (these files are also
called delimited in some PC documentation). A PRN file has quotes around
character-fields and a comma between each field. Binary values are output in
ASCII with an optional leading sign. Not all applications accept PRN files; for
more precise conversion of data, use STExport.
PRN converts each input-field to a fixed-width output-field, filling
with trailing spaces where necessary. All binary values are converted into
their equivalent ASCII value, left-justified in their fields. The sign precedes
the ASCII value for the number and can be missing, "+", or
"-". See the ASCII output-option for the field width of each
data-type.
Output fields with implied decimal places (see "Decimal Places" on page 30) are formatted with a
decimal point in the correct position. Like the ASCII option, Suprtool reserves
two extra columns for each output field with implied decimal places.
Lotus 1-2-3
accepts records only up to 240 bytes long. Because the PRN option leaves room
for the maximum value of any field, you may need to restrict the number of
output fields using the Extract command.
While some PC software allows alternate characters to be used to
delimit character fields, Lotus 1-2-3
accepts double quotes only. Since Lotus 1-2-3 rejects character fields that contains a double
quote, Suprtool removes all double
quotes from character fields when generating the PRN format. Suprtool removes
quotes by replacing them with a space.
See STExport for a method of including header lines in the file to
be down-loaded.
If you need to ensure that line feeds are not written to the end of
each record, then you should specify the NOLF option. It is usually preferable
to specify the LF option.
If you need to ensure that line feeds are written to the end of each
record, then you should specify the LF option. When extracting from SQL
databases, Suprtool writes out records without line feeds. Files with line
feeds are usually processed more easily by most other applications or import
programs, so it is advisable to use the LF option if you are uncertain.
By default, whether Suprtool writes out a line feed depends on the
input source. For example, if the input source has line feeds, then line feeds
will be written out at the end of each record.
When filling up PowerHouse subfiles, some versions of Quiz will
abort if no line feeds are found at the end of the record. It is recommended
that when you write to a PowerHouse subfile, you should always use the LF
option on the Output command.
Examples
One reason to use $stdlist as the output file is to obtain a quick
listing of the ASCII fields in the input source. The following example lists
the Account, Lastname, and Firstname columns of the Customer table and
separates them by two spaces:
>open ora demo reader {input
from a database}
>select * from customer {use
the Customer table}
>extract account {account
number will be first}
>extract "
" {two
spaces}
>extract lastname
{the
customer's last name}
>extract "
" {two
more spaces}
>extract firstname {the
customer's first name}
>output * {output
the records to $stdlist}
>sort account {sorted
by the account number}
>exit
The following examples demonstrate other combinations of options on
the Output command. The entire Issues chapter
of the manual should be reviewed for extended examples using the Output
command. Many Output options were intended for specific application areas.
>output newfile
>output accum,append
>output keyfile,key
>output transf,num,data
>output querynum,num,query
>output $null
If you want to find out
how many records are qualified by some selection criteria, without producing an
output file, send the output to $null. The Out= count on $stdlist displays the
number of qualifying records.
Notes
The output file must be an
"old", existing file if the Append or Erase option has been
specified.
Directs output records to
be DBPUT into an Eloquence dataset. Put can be combined with Output to a file,
but if no Output command is entered, Suprtool defaults the output file to
$null. It is your responsibility to ensure that the output records match the
format of the target dataset. The DATA option of the Output command is the only
valid output option when Put is specified.
PUT setname [,[host][:service]/]database]]
(Default: database=Base)
Parameters
If database is not specified, setname
must be a valid dataset of the Base previously opened. You must have write
access to the dataset selected.
If database is included, the specified database is opened. This Put
database is closed after the task is completed, unlike the database opened with
Base. It is possible to copy records from one database to another with
Suprtool.
Examples
For the first example, we assume that the D-SALES dataset is
designed to contain a week's worth of transactions. Each night, the
transactions from a week ago are moved to the monthly dataset: D-SALES-MON. The
D-SALES and D-SALES-MON datasets have exactly the same field declarations. The
following Suprtool task would move one day's transactions from D-SALES to
D-SALES-MON.
>base store
>get d-sales {read
the weekly dataset}
>if purge-date=000401 {select
one day's transactions}
>put d-sales-mon {adding
them to the monthly dataset}
>exit
For the next example, we assume that the D-SALES-MON dataset is in a
different database.
>base store
>get d-sales
>if purch-date=000401 {select
one day's transactions}
>put d-sales-mon,ostore {add
to OSTORE database}
>exit {the
output file defaults to $null}
This example shows how Suprtool can read a disc file and Put each
record in a database:
>input dsales {"dsales"
has exactly the same format}
>put d-sales,store { as the d-sales dataset}
>exit
Notes
If the dataset selected
for output is a master dataset, it is possible that some of the output records
may be duplicate key values. If this happens, Suprtool prints an error message
and terminates the task, unless you have enabled Set Ignore, in which case the
duplicates are counted and reported at the end of the task. Duplicate records
are not written to the output file.
Prints a message on
$stdlist.
Q [ "string" ]
(Default: print a blank
line)
The string of up to 253
characters is printed on $stdlist. The string is truncated to the record width
of $stdlist.
The string must be embedded in quotes. Either single-quotes (') or
double-quotes (") are permitted. The quotes are not printed on $stdlist.
Examples
The Q command is often combined with the Userpause command. The
example is a usefile that provides an explanation of how long a task takes:
>q
>q "We will select all transactions over $10,000. Since"
>q "there are many transactions, this task will take"
>q "some time (usually more than fifteen minutes)."
>q
>userpause "Press any key when you are ready to start."
Enables you to modify and
repeat any of the previous 1000 command lines.
REDO [ start
[ / stop ] ]
[
string ]
[
ALL | @ ]
(Default: redo the
previous command)
(Comma "," is
short for REDO)
The Redo command allows you to modify the commands before it
executes them. If you don't need to change them, use the Do command. Commands
are numbered sequentially from 1 as entered and the last 1000 are retained. Use
the :Listredo command to display the previous commands. You can redo a single
command, a range of commands, or the most recent command whose name matches a
string.
The Redo command uses MPE-style editing logic (D, I, R, U and >).
The default mode is to replace characters. To delete, type DDDD under the
characters to be removed. To insert, type I under the insertion spot, then the new
characters. To undo your changes, type U. To append to the end of the line, use
>xxx. To delete from the end of the line, use >DD. To replace at the end
of the line, use >Rxxx. And to erase the rest of the line, use D>. If you
prefer Qedit-style editing (Control-D, etc.), use the Before command instead of
the Redo command.
Examples
>ll *.fd {".sd"
is not spelled right}
*.fd not found
>redo {redo
most recent command}
ll *.fd {last
command is printed}
s {you
enter changes to it}
ll *.sd {the
edited command is shown}
{you
press Return}
>listredo all
>redo 5 {redo
5th command in stack}
>redo {redo
previous command}
>redo -2 {redo
command before previous}
>redo 8/10 {redo
8th through 10th}
>redo -10/ {redo
-10 through last}
>redo rm {redo
last "rm" command}
>redo rm temp {redo
last "rm temp"}
>redo @temp {redo
last containing "temp"}
Notes
The Redo command can be
abbreviated to a comma, as in MPEX. You cannot use ";" to combine
commands on the same line.
Hpmodify Keys –
Reference
Here are the MPE-style REDO sub-commands:
|
Directive
|
Effect
|
|
i
|
INSERT. If text follows the i, this text is inserted in the
current line starting at the i position.
|
|
r
|
REPLACE. If text follows the r, this text replaces the same number
of characters in the current line beginning at the r position.
|
|
d
|
DELETE. Deletes a character from the current line for each d
specified in the edit line. Note that "d d" does not specify a
range as it does in MPE V but simply deletes one character above each d.
Multiple d's may be followed by an INSERT or REPLACE operation.
|
|
d>
|
DELETE. Deletes to the end of the current line from the position
specified by d>. May be followed by an INSERT or REPLACE operation.
|
|
>
|
APPEND. If text follows the
>, this text is appended to the end of the current line. If a > without
text is positioned beyond the end of the current line, then a simple
replacement is performed instead.
|
|
>d
|
DELETE. Deletes from the end of the current line, right-to-left.
Multiple d's and INSERT and REPLACE strings may be specified after >.
|
|
>r
|
REPLACE. Replaces characters at the end of the command line. The
last (rightmost) character of the replacement string is at the end of the
line.
|
|
c
|
CHANGE. Changes all occurrences
of one string to another in the current line starting at the c. The search
string and replace string must be properly delimited. A proper delimiter is a
non-alphabetic character (such as ' " or /). The substitution is
specified as cdelim search-string delim
[replace-string [delim]]. Omitting the replace-string causes occurrences of search-string to be deleted, with no
substitution.
|
|
u
|
UNDO. A single u in column one
cancels the most recent edit of the current line. Using the Undo command
twice in a row cancels all edits for the current line and re-establishes the
original, unedited line. If u is placed anywhere other than column one of the
current line, then a simple replacement is performed. Undo makes sense only
if you have a line on which you have performed some editing that can be
"undone."
|
|
other
|
Simple replacement. Any other character (not i, r, d, d>, >,
>d, >r, c, or u) will be put into the current line at the position
above where it is placed, replacing any existing character. Simple
replacement also occurs for the editing characters i, r, c, or > if they
are not followed by text; or if > appears at or beyond the current end of
line.
|
Hpmodify
Examples
Here are examples of the MPE-style REDO sub-commands in action:
|
Edit
|
Action
|
|
u
|
First occurrence undoes the previous edits. The u must be in column one.
|
|
u
|
Second occurrence undoes all edits on the current line. The u must be in column one.
|
|
rxyz
|
Replaces the current text with xyz starting at the position of r.
|
|
xyz
|
Replaces the current text with xyz starting at the position of x.
|
|
ixyz
|
Inserts xyz into the current line, starting at the position of the
i.
|
|
ddd
|
Deletes three characters, one above each d.
|
|
d
xyz
|
Deletes a single character above the d, skips one space, then replaces the current text with xyz
starting at the position of x.
|
|
ddixyz
|
Deletes two characters, then inserts xyz in the current line
starting at the position of the i.
|
|
d d
|
Deletes one character above the first d, skips two spaces and deletes a second character above the
second d. It does not delete a
range of characters, making it unlike the MPE V version of Redo.
|
|
d d>xyz
|
Deletes a single character above the first d, skips two spaces and deletes to the end of the line beginning
at the second d, and then places
xyz at the end of the line.
|
|
>xyz
|
Appends xyz to the end of the current line.
|
|
>ddxyz
|
Deletes the last two characters from the end of the current line
and then places xyz at the end of the line.
|
|
>rxyz
|
Replaces the last three characters in the current line with xyz.
|
|
>ixyz
|
Appends xyz to the end of the line. In this case, the i command is superfluous, because >
accomplishes the same result. Using >xyz would be sufficient.
|
|
c/ab/def
|
Changes all occurrences of ab to def.
|
|
c"ab"
|
Deletes all occurrences of "ab".
|
|
cxyz
|
Replaces the current text with cxyz, starting at c. Because delimiters have not been
specified (as they were in the previous two examples), this is a simple
replacement with the four characters.
|
Persistent Redo
Redo commands can be saved in a permanent file and can therefore be
used from another session. You can use the Set
redo command to specify a filename to save your redo commands. See "Redo" on page 30 for details.
Resets aspects of the
current task.
RESET [ ALL | @ | command [...] ]
(Default:
Delete/Sort/Key/If/List)
Parameters
More than one command can be Reset at once by entering several commands separated by a space or a
comma. If no parameters are specified, Suprtool cancels the previous Sort, Key,
If, Delete, and List commands. The other commands remain unchanged.
If ALL is specified, all of the Input and Output commands are
canceled and database/files are closed. In fact, the only options that are not
reset to the initial condition are Define, Item, Open, and Set options.
Examples
You began to specify a sort, but then you discovered that you
specified the wrong database so you decided to start all over:
>base ostore
>get d-sales
>sort cust-account
>reset all {oops,
wrong database}
>base store {now
we have correct one}
In the next example, you entered an incorrect If command:
>if delivered>000401
{wrong
field used}
>reset if {only
reset the If command}
>if purchased>000401 { and specify it again}
This time both the If command and the Extract commands are
incorrect:
>if delivered>000401
{wrong
field used}
>extract delivered { in both commands}
>reset if,extract {only
reset the If and Extract}
>if purchased>000401 { commands and start again}
>extract purchased,account
Notes
By resetting certain commands, other commands are also reset. For
example, resetting the Base command resets almost all other commands, except
the Define and Output commands. Resetting the Put command closes the output
database when the database for the Put command is different from the input
database. Resetting the Chain, Get, or Input command resets everything except
the Base, Define and Table commands. Resetting the Table command resets
everything except the Base and Define commands. Resetting either the Define or
Item command resets both Define and Item settings.
Specify a select statement
for the currently open SQL database. The select command supports all of the features
of the select command of the open SQL database. Only one select command can be
specified at a time.
SELECT select-command
Allbase sorts data:
>select * from user.account@emp order by ename
Suprtool sorts data:
>select * from user.account@emp
>sort ename
The select-command can
contain any expression or clause that is supported by the SQL database. Some
features (e.g., ORDER BY) may be done faster by Suprtool (e.g., the Sort
command).
Some Select commands can
exceed the 256-character command line limitation. The Select command, however,
can be considerably larger if you use the $read feature of the Select command.
This feature is similar to the If command $read feature and is invoked by
entering the Select command on a line by itself (unlike If, you do not specify
$read explicitly).
>select
-ename,salary,tax_paid
-from scott.employee
-order by ename
-//
>
The Suprtool prompt changes from ">" to "-"
after entering the Select command by itself on a line. The entire command gets sent
to the Select command parser after terminating with two slash marks (//) or a
blank line.
You might realize greater
performance gains with the Select command if you specify only the columns that
you need in your output file for either tables with many items or when you need
only a couple of items from a given table.
The following Select command
>select col1,col2,col3 from user.account@emp
may be faster than
>select * from user.account@emp
Your mileage may vary.
Enables or disables
certain operating options within Suprtool. These options are not reset by Xeq
or Reset commands.
SET ALLBASE ROWS number
SET ARITHMETIC CLASSIC|IEEE (has no effect
in Suprtool/UX)
SET BASECLOSE ON|OFF (not supported in
Suprtool/UX)
SET BLOCKSIZE [size] (has no effect in Suprtool/UX)
SET BUFFER [size]
SET CLEANCHAR <string>
SET CURRENCYSYMBOL <string>
SET DATE CUTOFF [number]
SET DATE FORCECENTURY ON|OFF
SET DATE IFYY2000ERROR ON|OFF
SET DATE MAPTOPHDATE8 ON|OFF
SET DECIMALSYMBOL <string>
SET DEFER ON|OFF (has no effect in
Suprtool/UX)
SET DUMPONERROR ON|OFF
SET EDITSTOPONERROR ON|OFF
SET EOFREAD ON|OFF (has no effect in
Suprtool/UX)
SET FASTREAD
ON|OFF
SET FILECODE number (not supported in Suprtool/UX)
SET FILENAME
Help|Link|Edit|Hint|Export|Outcount filename
SET FIRSTREC [0|1] (has no effect in
Suprtool/UX)
SET HINTS ON|OFF (has no effect in
Suprtool/UX)
SET HPUXCmdErr <string>
SET IFCHECK ON|OFF
SET IGNORE ON|OFF (has some effect in
Suprtool/UX)
SET ITEMABBREVIATEDATE ON|OFF]
SET ITEMLOCK <fieldname>
SET INTERACTIVE ON|OFF
SET LABELLEDTAPEREWIND ON|OFF (has no effect
in Suprtool/UX)
SET LIMITS [Mpe ON|OFF] [ReadOnly ON|OFF]
[Tablesize size]
SET LIST DATE number
SET LIST PCL [0|1|2|3|4|5|6]
SET LIST TIME number
SET LOCK [number] (has no effect in Suprtool/UX)
SET MAKEABSENT ON|OFF (has no effect in
Suprtool/UX)
SET NLS [number]
SET NUMBUG ON | OFF
SET OPENMODE [number] (has no effect in Suprtool/UX)
SET ORACLE ROWS number (not supported in Suprtool/MPE)
SET ORACLE INTEGER ON | OFF (not supported
in Suprtool/MPE)
SET ORACLE OPENFIX ON|OFF (not supported in
Suprtool/MPE)
SET ORACE ZERONULL ON | OFF (not supported in
Suprtool/MPE)
SET PATTERN NEW|OLD
SET PREFETCH [number] (not supported in Suprtool/UX)
SET PRIVMODE ON|OFF (has no effect in
Suprtool/UX)
SET PROGRESS Percent [number] Minimum [number]
SET PROMPT character
SET REALMAP ON|OFF
SET RECOVER ON|OFF (has no effect in
Suprtool/UX)
SET REDO filename
SET SDEXTNAME ON|OFF
SET SORTFAST ON|OFF (has no effect in
Suprtool/UX)
SET SQUEEZE [ON|OFF] (has no effect in
Suprtool/UX)
SET STATISTICS ON|OFF
SET SUBSYSTEM ON|OFF (has no effect in
Suprtool/UX)
SET SUSPEND ON|OFF (has no effect in
Suprtool/UX)
SET THOUSANDSYMBOL <string>
SET USERLABELS ON|OFF (has no effect in
Suprtool/UX)
SET VARSUB ON|OFF
SET VARSUBCOMPAT ON | OFF
SET VARSUBDEBUG ON | OFF
SET WARNINGS ON|OFF
Each option is its own Set command. That is, you cannot specify
multiple options in the same command. Instead, use multiple Set commands. For
example, to Set Statistics On and to define a PCL format for the List command,
you would specify two Set commands:
>set stat on
>set list pcl 1
or
>set stat on;set list pcl 1
|
Add system-wide Set commands to the /opt/robelle/suprmgr
configuration file.
|
When Suprtool starts running, all the options are set to initial
"factory settings". The Suprmgr file may contain Set commands to
override the initial values. Set commands remain set until the end of the
Suprtool run, or until changed by another Set command.
|
Some commands have optional parameters (e.g., the numeric value of
Set Date Cutoff). If the command is specified without a value, the default that
Suprtool uses may be different from the program's initial value. When that is
the case, the command description will show the initial value and the
default-when-omitted value.
SET
ALLBASE ROWS number
(Initially: 100)
If you open an Allbase
database, Suprtool reads more than one row at a time when processing the input
source. By default, Suprtool fetches 100 rows at a time. You can vary the
number of rows that Suprtool fetches with Set Allbase Rows. The minimum number
of rows is 1 and the maximum number is 990. You must specify Set Allbase Rows
before entering the Select command.
SET
ARITHMETIC Classic | IEEE
This command has no effect
in Suprtool/UX.
SET
BASECLOSE ON | OFF
This command is not supported in Suprtool/UX.
SET
BLOCKSIZE [size]
This command has no effect
in Suprtool/UX.
SET
BUFFER [ size ]
(Initially: depends;
Default: no change)
Set Buffer varies the
maximum number of words that Suprtool allocates for input and output buffers.
This buffer size limits the number of data blocks that Suprtool reads at a
time.
Suprtool overrides the maximum buffer size specified, if that is
necessary to get the task done. For example, when the blocks size of the file
is greater than buffer maximum specified.
The maximum value is 14,336 words in Suprtool/V and 24,576 words in
Suprtool/iX. The default value used by Suprtool is the largest size that fits
in the available data structures and still allows Suprtool to get the job done.
Using Set Buffer to reduce the size of the buffer reduces the size of the stack
that Suprtool uses for copy operations. Suprtool/V always uses a buffer size of
4096 words when sorting. This leaves the maximum amount of room in the stack
for the sorting operation.
SET CleanChar " "
(Default: space)
By default, Suprtool will
replace any of the characters specified in the clean command with a space. You
can specify what character to use to
replace any of the characters that qualify with the following set command:
This will set the character to replace any of the qualifying
"to be cleaned" characters to be a period.
If you want to Clean a field and not replace with any character you
just need to set the clean character in the following manner:
SET CurrencySymbol "$"
(Default: period)
This setting is used to
change the Currency character which is used to edit the data in a field used by
the $Number function. The defined currency symbol(s) is stripped from the field
prior to converting to number, in the
$number function. The CurrencySymbol can be up to our characters.
The default character for the Currency Symbol is the Dollar sign.
SET
DATE CUTOFF [ number ]
(Initially: 10; Default:
00)
Date Cutoff tells Suprtool
what century to use when Suprtool generates the date value from the $date and
$stddate functions. This setting only affects the date values generated by the
$date and $stddate function in the If and Extract commands. This does not
affect user data.
Versions of Suprtool without Set Date Cutoff would assume 19 for the
century for any user-specified $date with a two-digit year.
Now with Set Date Cutoff xx,
Suprtool assumes the following: a value of 20 for the century if the two-digit
year specified in the $date or $stddate functions is less than the value of Set
Date Cutoff; a value of 19 for the century if the two-digit year is greater
than or equal to Set Date Cutoff.
The initial value of Set Date Cutoff is 10. Therefore the default
behavior in $date and $stddate is to treat the two-digit years with values of
00..09 as 2000..2009, and the two-digit years with values of 10..99 as
1910..1999.
|
yy Value in $date
|
With Cutoff 10
|
With Cutoff 25
|
|
00
|
2000
|
2000
|
|
…
|
…
|
…
|
|
09
|
2009
|
2009
|
|
10
|
1910
|
2010
|
|
11
|
1911
|
2011
|
|
…
|
…
|
…
|
|
24
|
1924
|
2024
|
|
25
|
1925
|
1925
|
|
26
|
1926
|
1926
|
|
…
|
…
|
…
|
|
99
|
1999
|
1999
|
We recommend that you always provide a four-digit year when using
$date. However, for reasons of backward compatibility, we introduced Set Date
Cutoff. See "Date ForceCentury" on page 30 for more information.
$Stddate and Set
Date Cutoff
When $stddate has to convert from a date in only a two-digit format,
the conversion to the four-digit date will use the value in Set Date Cutoff.
For example,
>input salesdetail {a
self-describing file}
>set date cutoff 15 {range
is 1915-2014}
>def new-ship-date,1,4,double
>item ship-date,date,mmddyy
>ext order-no / sales-amount
>ext new-ship-date = $stddate(ship-date)
>out salesinfo,link
>xeq
In this example, if any ship-date has a year of 14 or less, then the
century applied to the new-ship-date field will be 20. Ship-dates with a year
of 15 or more will have a century of 19 applied.
SET
DATE FORCECENTURY ON | OFF
(Initially: OFF)
Set Date ForceCentury On
will not allow a yy date to be entered in the $date function; it will force the
user to enter a full ccyy date.
>set date forcecentury on
>item date-field,date,ccyymmdd
>if date-field >= $date(00/12/10)
Error:You must specify the century or Set Date ForceCentury off
The default value for Set Date ForceCentury is off.
SET
DATE IFYY2000ERROR ON | OFF
(Initially: ON)
By default Suprtool
considers dates with a two-digit century component from the $date and $today
functions to be invalid when the dates resolve to be greater than 1999 and the
If operation is a relative operation (e.g., greater than or equal to). You can
control whether Suprtool considers this condition an error by using the
following Set command:
>set Date Ifyy2000Error Off
The following example shows what is considered to be an error by the
If command and how the Set command can turn off the error check:
>def a,1,6
>item a,date,yymmdd
>if a >= $today
^
Error: Cannot use a date
beyond 1999 for this format
>set date ifyy2000error off
>if a >= $date(2000/01/03)
We have chosen this condition to be an error by default because when
the $date function in the If command resolves a date in a yymmdd format to a
value beyond 1999, the result is not always a useful value. For example, a December 10, 2000 date in
a yymmdd format would have a value of 001210, and comparisons to this value
could be logically incorrect.
If you would have included a Delete command in a dataset selection
task, you could have removed all of your records.
SET
DATE MAPTOPHDATE8 ON | OFF
(Initially: OFF)
This set command will
change any item command reference to phdate to mean phdate8, for assistance in
converting to the newer phdate format found in PowerHouse version 8.19 and
higher.
The set command:
>set date MapToPhdate8 on
changes only the reference to phdate8 in the Item command. It does
not change references that already exist in self-describing files nor does it
change the data.
With this setting enabled, any Item command reference, such as:
will actually mean phdate8.
SET DecimalSymbol " "
+30(Default: period)
This setting is used to
change the Decimal character which is used to edit the data in a field used by
the $Number function.
The default character for the Decimal Symbol is a period.
SET
DEFER ON | OFF
This command has no effect
in Suprtool.UX.
SET
DUMPONERROR ON | OFF
(Initially: ON)
With DUMPONERROR, Suprtool
attempts to produce a formatted listing of records that cause a database error.
The information printed may include the input record number, the output record
number and the data values of the record. Suprtool uses current options of the
List command to print the data values. If no List command is specified, Suprtool
uses the List defaults.
SET
EDITSTOPONERROR ON | OFF
(Initially: OFF)
An edit mask is limited
to 32 characters in total for both numeric and byte type fields. If data
overflows the edit-mask, by default Suprtool will fill that field with
asterisks. To have Suprtool stop when it encounters an overflow when applying
the edit-mask, just turn on editstoponerror:
This will force Suprtool
to stop if there is data left over to place when applying the edit-mask. With
numeric-type fields, leading zeroes do not cause overflow. With byte-type
fields, spaces do not cause overflow.
SET
EOFREAD ON | OFF
This command has no effect
in Suprtool/UX.
SET
FASTREAD [ ON | OFF ]
(Initially: ON (some
versions))
Regular Suprtool for HP-UX (version
without Dynamic Image Loading) will initially have the Fastread option on. The
Dynamic Loading version has the Fastread option initially off.
Testing has shown that the CPU time can be improved by anywhere from
two to five times and Wall time has improved anywhere from two to six times
faster. You can enable or disable this feature for all runs of Suprtool on your
system by putting the command:
Or
into the file /opt/robelle/suprmgr. This means that Suprtool will
use the faster reads for all runs of Suprtool.
SET
FILECODE [ number ]
This command is not
supported in Suprtool/UX.
SET FILENAME Help | Link |
Edit | Hint | Export | Outcount filename
See "
Installing Suprtool" on page 22 for a complete
description of this Set command.
SET
FIRSTREC [ 0 | 1 ]
This command has no effect
in Suprtool/UX.
SET
HINTS ON | OFF
This command has no effect
in Suprtool/UX.
SET
HPUXCmdErr “<string>”
(Initially: Spaces)
HP-UX and MPE are
different in terms of whether or not a file operation is an error or a warning.
With file operations such as rm or mv, the shell that executes these commands
returns an error condition to Suprtool which impacts scripts that are converted
from MPE. For example, on MPE a purge command on a file that does not exist was
only considered a warning. On HP-UX, an rm command on a file that does not
exist is considered an error, which halts Suprtool when run in batch .
For example the ksh
returns an error code of 2 if you attempt to remove a file that does not exist.
rm file1x
rm: file1x non-existent
echo $?
2
We have added Set HPUXCmdErr command which will tell Suprtool to
ignore errors from certain OS commands. Please note that this does not impact
Suprtool’s internal checking of Suprtool commands.
For example if you want Suprtool to ignore the common occurrence of
stopping a script when an “error” occurs you just need to set the string in
HPUXCmdErr as follows:
/opt/robelle/bin/suprtool
<< \!EOD
set hpuxcmderrs
"rm,:rm,!rm"
:rm file1x
rm file1y
!rm file1y
exit
!EOD
If the command returns an error Suprtool will check to see if it was
an rm,:rm or !rm command and ignore the error.
SET
IFCHECK ON | OFF
(Initially: ON)
With Set Ifcheck On, the
If command produces an error if any field used in the If command is not
contained entirely within the input file record. For compatibility reasons,
users may wish to disable this error checking by turning Set Ifcheck Off.
SET
IGNORE ON | OFF
(Initially: OFF)
This command has some
effect in Suprtool for HP-UX and Suprtool for AMXW. IGNORE tells Suprtool to
continue processing if there are errors in these situations:
"duplicate-key" errors in writing to an IMAGE master dataset,
"chain-head" errors in deleting entries from an input dataset or
putting records to a detail dataset, a record changed before Suprtool could
delete it. Traps on divide by zero or bad numeric data are not available as yet
SET
INITEXTENTS ON | OFF
(Initially: OFF)
Set InitExtents has no effect on Suprtool for HP-UX.
SET
ITEMABBREVIATEDATE ON | OFF
(Initially: ON)
The specification of the Date format within
the Item command by default expects the entire keyword. For example for the
date format of Calendar, you would have to specify the entire token of
Calendar. If you Set ItemAbbreviateDate On, you would only have to specify CAL for the Calendar
date format.
SET
ITEMLOCK <fieldname>
(Initially: Spaces)
Item Level locking on
Deletes and Updates can be invoked during a task with the Set itemlock command. For example
!run suprtool.pub.robelle
base order,1,;
get dline
set itemlock item-num
del
out save,link
exit
The Set command must be
specified after the Base and Get/Chain have been specified. This field/setting
is reset after each task. Item-Level
locking is not invoked for PUT operations.
There are some cases
where Suprtool needs to use the "@" lock descriptor, when doing a
dblock-mode 5 which is an unconditional Item Level lock, however it may appear
as if it is doing a set level lock, however, since Suprtool for HP-UX could be
working against different Image call "interpreters".
SET
INTERACTIVE ON | OFF
(Initially: depends)
If you run Suprtool from a
session, Set Interactive is On. If you run Suprtool from a batch job or with
Stdin or Stdlist re-directed, Set Interactive is Off. When it is On, Suprtool
waits for answers to questions and continues processing even if there are
errors. When it is Off, Suprtool aborts on any error, assumes the
"correct" answer to any question, and generally acts as if there is
not an intelligent being typing in the command. Suprtool chooses the "correct"
answer, which allows the task to continue. In most cases, this is the default
answer. However, there are cases where Suprtool picks a different answer from
the default. For example, an "output filename,erase" command has a
default answer of "no," but with Interactive Off, Suprtool uses the
answer "yes."
However, if you run Suprtool on a Remote Session that was created
from a batch job, Set Interactive is On even though you are NOT interactive. If
you wish to have proper batch error processing, your first command after
starting Suprtool should be Set Interactive Off. Set Interactive Off is also
useful when automating on-line tasks with usefiles:
Suprtool –c"set interactive off;use usefile"
SET
LABELLEDTAPEREWIND ON | OFF
This command has no effect in Suprtool/UX.
SET LIMITS [MPE ON|OFF]
[READONLY ON|OFF] [Tablesize size]
(Initially: MPE ON,
ReadOnly OFF, Tablesize 1 megabyte)
When Set Limits MPE is
Off, you cannot execute any HP-UX
command (e.g., !rm). This is an irreversible option -- once disabled, it cannot
be enabled again by the user.
Table Size
On HP-UX you can control
the size of a table with the Set Limits TableSize command. By default an
individual Table will be 50 Megabytes in size and you can have up to 10 tables.
The Global limit for all tables is up to 500 Megabytes. You can control the
size of a given table with the command:
If you enter the command
Set Limits TableSize 100 and the next table command that you build will have a
limit of 100 Megabytes.
Read Only
Suprtool normally allows any user with the proper access
capabilities to add records to a database. To prevent users from accidentally
updating their database, we provide the following setting within Suprtool:
The ReadOnly setting, once turned on, cannot be turned off for the
current run of Suprtool. This disables all commands that potentially change
data for the specified database.
If Set Limits ReadOnly is enabled, then the Add command in Suprtool
will return an appropriate error message.
You can Set Limits Readonly on the command line using the -c option.
For example the following command file can be used to restrict who has write
access to a given database. In this example only the root user is allowed write
access:
if [ $USER = "root" ]
then
/opt/robelle/bin/suprtool
else
/opt/robelle/bin/suprtool
-c'set limits readonly on'
fi
SET LIST option value
Use Set List to configure default values for the List command. You
can configure the default date, time, and format for LaserJet listings.
SET
LIST Date number
(Initially: 0)
When you select page
headings with the List command by specifying a title, each page includes
today's date. By default, this date is formatted as mmm dd, ccyy (e.g., Mar 20, 2000). Use Set List
Date to specify a different default date format for future List commands (e.g.,
Set List Date 2). The valid date formats are as follows:
|
Value
|
Format
|
Example
|
|
0 (default)
|
mmm dd, ccyy
|
Mar 20, 2000
|
|
1
|
yy/mm/dd
|
00/03/20
|
|
2
|
mm/dd/yy
|
03/20/00
|
|
3
|
dd/mm/yy
|
20/03/00
|
|
4
|
dd mmmyy
|
20 Mar00
|
SET
LIST PCL [ 0|1|2|3|4|5|6 ]
(Initial & Default: 0)
Use Set List PCL to
configure the default format for LaserJet listings. This option defines the
List device as a PCL device and indicates the orientation and font for the
report. Set List PCL affects only the List command; it is ignored by the Output
command. PCL stands for Printer Command Language, which is an HP standard for
printers. The LaserJet is one of the first PCL devices to be released by HP.
By default, Suprtool assumes that your List output device is not
PCL-compatible (List PCL 0).
PCL 1. To print the Suprtool List output in Landscape mode (across the wide
part of the paper) with the tiny Lineprinter font (16.66 pitch or 8 lines per
inch), you should do the following (this setting prints 175 columns per line):
>:comment Maximum of 175
columns with this font
>set list pcl 1
>:comment You will need
LaserJet with proper font cartridge
>list device laser123
PCL 2. To print the listing in Courier font, Landscape mode, 6 lines per
inch, and 100 columns wide, use:
>set list pcl 2
>list device laserjet
PCL 3. This option selects the "standard" Portrait orientation
with the Courier font of the LaserJet (80 columns across by 60 lines). You
would use Set List PCL 3 when you insert a Font cartridge that overrides the
default font (e.g., 92286F cartridge).
PCL 4. Selects Portrait orientation and Lineprinter font of the L cartridge
(and others). This option prints 132 columns across the page by 80 lines.
PCL 5. Prints 80 columns on A4 paper by slightly narrowing the space
between columns.
PCL 6. Prints tiny letters in Landscape mode on legal-size paper. This
gives you 223 columns per line.
The PCL options, with the exception of PCL 5, were designed and
tested with North American letter-size paper. Suprtool can adjust the number of
rows and columns for each option to match A4 if you add 2000 to the PCL code.
You can also select the ASCII character set (instead of the default Roman-8
character set) by adding 1000 to the PCL code. See "List Command [L]" on page 30 for more details.
Here is a complete table of the PCL codes:
|
PCL
|
L/P
|
Font
|
A4 paper Rows x Columns
|
Letter-size Rows x Columns
|
Notes
|
|
1
|
L
|
lp
|
58 x 188
|
60 x 175
|
|
|
2
|
L
|
courier
|
43 x 110
|
45 x 100
|
|
|
3
|
P
|
courier
|
64 x 77
|
60 x 80
|
"standard"
|
|
4
|
P
|
lp
|
85 x 128
|
80 x 132
|
|
|
5
|
P
|
courier
|
64 x 80
|
60 x 80
|
A4-squeeze
|
|
6
|
L
|
lp
|
60 x 223
|
60 x 223
|
legal-size
|
L and P mean Landscape or Portrait orientation.
SET
LIST Time number
(Initially: 1)
When you select page
headings with the List command by specifying a title, each page includes the
current time. By default, the time is in 24-hour format (e.g., 23:02). Use Set List Time to specify
a different default time format for future List commands (e.g., Set List Time
2). The valid time formats are as follows:
|
Value
|
Format
|
Example
|
|
0
|
none
|
|
|
1 (default)
|
24-hour
|
23:02
|
|
2
|
AM/PM
|
11:02PM
|
SET
LOCK [ number ]
This command has no effect
in Suprtool/UX.
SET
MakeAbsent [ On|Off ]
This command has no effect
in Suprtool/UX.
SET NLS
[number]
(Initially: 0 or
NLDATALANG JCW)
Use Set NLS with files
from MPE systems to specify the language to be used for sorting Character-type
fields (see Native Language Support). The number
corresponds to an NLS language; you cannot use the NLS language name. The
common language numbers are:
|
Number
|
Language
|
|
00
|
Native-3000
|
|
01
|
American
|
|
02
|
Canadian-French
|
|
03
|
Danish
|
|
04
|
Dutch
|
|
05
|
English
|
|
06
|
Finnish
|
|
07
|
French
|
|
08
|
German
|
|
09
|
Italian
|
|
10
|
Norwegian
|
|
11
|
Portuguese
|
|
12
|
Spanish
|
|
13
|
Swedish
|
SET
Numbug [ On|Off ]
The $number function
had a bug whereby it would add on two zeroes and or bad data if the input
number did not have a decimal point. We have fixed the bug so that the number function no longer adds the two digits
on the end in error.
However, some users
worked around this issue by doing the following:
>extract target =
$truncate($number(conv-field) / 100)
Since some users, used
this work around, the fix to the $number function will then return incorrect
results. Therefore, we added the set numbug command to have Suprtool revert
from the correct behaviour to continue to have the bug.
By default, Suprtool
will just convert the number and not add on the data at the end, however, if
you have used the work around then you
can add the command:
to the script directly
or globally in your suprmgr file.
SET
OPENMODE [ number ]
This command has no effect
in Suprtool/UX.
SET
ORACLE ROWS number
(Initially: 100)
If you open an Oracle
database, Suprtool reads more than one row at a time when processing the input source. By default, Suprtool fetches 100 rows at a time. You can
vary the number of rows that Suprtool
fetches by using Set Oracle Rows. The
minimum number of rows is 1 and the maximum is 990. You must specify Set Oracle Rows before
entering the Select command.
SET
ORACLE INTEGER ON|OFF
(Initially: OFF)
Suprtool by default maps
certain numeric fields into packed-decimal data types when they have more than
one decimal place:
|
Precision
|
Decimal Places
|
Suprtool Data-Type
|
|
None
|
Any
|
8-byte IEEE
|
|
1-4
|
Zero
|
2-byte Integer
|
|
5-9
|
Zero
|
4-byte Integer
|
|
1-9
|
Non-zero
|
Packed-decimal
|
|
10-27
|
Any
|
Packed-decimal
|
|
28-38
|
Any
|
8-byte IEEE
|
The new setting:
changes the Suprtool
format from packed-decimal to Integer based on the size of the Number:
|
Precision
|
Decimal Places
|
Suprtool Data-Type
|
|
1-4
|
Any
|
2-byte Integer
|
|
5-9
|
Any
|
4-byte Integer
|
|
10-27
|
Any
|
8-byte Integer
|
SET
ORACLE OPENFIX ON|OFF
(Initially: OFF)
In order to fix a problem
introduced by a patch to Oracle 9, we had to change to a new Oracle call
interface call. You can invoke this new call in one of two methods, the first
is to use the following Set command:
The second method is to specify the username/password in the
following manner:
However, this option should not be needed any longer due to how we
load the Oracle routines and utilize them.
SET
ORACLE ZERONULL ON|OFF
(Initially: OFF)
Set Oracle ZeroNull On
will change any fields that are "null" (in the SQL sense of the
word), will become zeroes for the appropriate number type.
In order to turn this
feature on for all accesses you can put the command:
into the file
/opt/robelle/suprmgr.
Previous to version 4.6
in Suprtool used to return nulls, but Suprtool 4.6 and Suprtool 4.7 would
return zeroes. We have decided to make this optional and make the default to
return Nulls, due to problems when using the to_char function in the select
statement.
SET
PATTERN NEW | OLD
(Initially: NEW)
Prior to Suprtool for MPE
version 3.1, there was no method of checking for the "@",
"#", "?", or "~" characters in a pattern. Version
3.1 introduced a new pattern-matching routine, adding an escape character
"&", and two new reserved characters "^" and
"!". Old Suprtool tasks that look for the specific characters &,
^, or ! will not work with the new pattern-matching routine. Users who are
concerned about this can add the following command to their
/opt/robelle/suprmgr file:
SET
PREFETCH [ number ]
This command is not supported in Suprtool/UX.
SET
PRIVMODE ON | OFF
This command has no effect in Suprtool/UX.
SET PROGRESS Percent [ number ] Minimum [ number ]
(Initial & Defaults:
Percent 5, Minimum 50000)
The Set Progress command
is used to turn the Suprtool progress report feature on or off. The PERCENT
value specified tells Suprtool by which percentage increment to report the
progress messages of any given input or output phase. The allowed range for set
progress is from 0 to 25, the default is every 5 percent. If the PERCENT
parameter is not specified, then the next parameter is considered to be the
PERCENT value. This is to remain compatible with some earlier versions of
Suprtool.
The MINIMUM value is the minimum number of records that an input
file must have in order for the progress reports to be printed out. If the
MINIMUM value is set to 15000, then the input file must have at least 15000
records or else progress messages are not printed out for the entire task. This
value allows the user to turn off progress messages when reading smaller files.
The default value is 50000 records. To always print progress messages, just set
the minimum value to 0.
Suprtool does not produce any progress messages under the following
conditions:
1.
Set Progress is zero.
2.
Output is to $stdlist via the
Output * or List commands.
3.
The input source is an SQL
database.
4.
The number of records from the
input source is less than the minimum value.
Suprtool checks whether or not to print a progress message at the
end of each buffer. Consequently, not all progress increments are reported for
small files or datasets.
Suprtool reports the phase that it is in: whether input phase, sort
phase, output phase or combined input/output phase (not sort).
The content of the progress messages is as follows:
·
Percentage complete
·
Phase and the total number of
records processed
·
Delta-Sec(Min) - the time
elapsed from the previous message
·
Wall-Sec(Min) - the total
elapsed time
·
CPU-Sec - the total CPU-Seconds
at this point
When using the record selection feature of the Input command,
Suprtool cannot be absolutely certain of the total number of records.
Therefore, the percentage calculation is estimated.
SET
PROMPT character
(Initially: > )
PROMPT tells Suprtool
which character to use for prompting. Any special character can be used as the
prompt character. For example:
/opt/robelle/bin/suprtool
>set prompt %
%open oracle demo reader
SET
RealMap ON| OFF
(Initially: ON)
Previously, Suprtool would treat an “R” type field in an Eloquence
database as an R type while the data inside Eloquence was stored and treated as
IEEE therefore incorrect results would occur with coercions and arithmetic
operations. Suprtool now by default maps all Real and Long fields to their
respective IEEE fields. You can change Suprtool back to the previous
behaviour with Set RealMap Off.
A form command will still show the fields as being “R2” or “R4”, but
internally Suprtool will treat as IEEE, which is how Eloquence stores and
treats the numbers.
This will also include Self-Describing files as being the input
source. Suprtool will still not allow the definition of a Real or Long
datatype.
Consequently STExport will now support items in SD files that are
condidered R type, however it correctly will map them to IEEE.
SET
RECOVER ON | OFF
This command has no effect in Suprtool/UX.
SET
REDO filename
(Initially: none)
Commands that you enter at
the Suprtool prompt are saved in something called the redo stack. You can
recall commands from the redo stack using other commands such as Before, Do and
Redo. By default, the redo stack is stored in a temporary file and discarded as
soon as you exit Suprtool. This temporary stack is not preserved across
Suprtool invocations.
Set Redo allows you to assign a permanent file as the redo stack.
The redo stack is then available for future Suprtool invocations. To assign the
Myredo file as a persistent redo stack, enter:
>set
redo myredo
If the file does not exist, Suprtool creates it. If it already
exists, Suprtool uses it. All subsequent commands are written to the persistent
redo stack. The setting is valid for the duration of the Suprtool session. As
soon as you exit Suprtool, the setting is discarded. Next time you run
Suprtool, you will get the temporary stack.
If the filename is not qualified, the redo stack is created in the
current working directory. This may be desirable if you wish to have separate
stacks. If you wish to always use the same persistent stacks, you should
qualify the name.
The Verify command shows which stack is currently in use. If it
shows <temporary>, it means Suprtool is using the default stack. Anything else is the
name of the file used on the Set Redo command.
Concurrency
When Suprtool uses the default temporary stack, it is only
accessible to that particular instance of Suprtool. You can run as many
Suprtool instances as you need and each one gets its own redo stack. With
temporary stacks, you will never get into concurrency problems.
If you start using a persistent redo stack, you might start running
into concurrency problems. A persistent redo stack can only be used by one
Suprtool instance at any one point in time. If you try to use a persistent redo
stack that is already in use, you will get the following message:
>set redo myredo
The redo file is already in use.
Unable to open file for REDO stack
In this situation, Suprtool continues to use the redo stack active
at the time and lets you continue to work as normal.
Qedit can also have permanent redo stacks. To prevent products from
writing to each other's redo stack, it is advisable to have separate stacks for
each product by giving them different file names. For example if you use
you will have a redo stack called myredo for your Suprtool commands.
If you exit Suprtool and run Qedit and supply the same Set Redo command, your
Qedit commands will be written to the same file that was used for your Suprtool
commands.
SET SDExtname ON
| OFF
Suprtool can create SD
files with “extended names” when you set
SDEXtname on. By default Suprtool for HP-UX will behave as normal and truncate
field names at 16 characters. If SDEXtname is on, Suprtool will write out the
fully defined field name or if the input source is Oracle the full field name,
(up to 32 characters), to the end of the .sd file. Suprtool will use the
“extended” names whereever possible.
The Suprtool List
command does not take advantage of the new extended names at this time.
Suprlink will merge the
extended names and create the proper information in the output SD file, but
will not use the extended name when linking two files.
SET
SORTFAST ON | OFF
This command has no effect
in Suprtool/UX.
SET
SQUEEZE [ ON | OFF ]
This command has no effect
in Suprtool/UX.
SET
STATISTICS ON | OFF
(Initially: OFF)
STATISTICS causes Suprtool
to print statistics at the end of each task. This can be useful for determining
the effectiveness of Suprtool's If and Sort command versus similar options on
the Select command.
SET
SUBSYSTEM ON | OFF
This command has no effect
in Suprtool/UX.
SET
SUSPEND ON | OFF
This command has no effect
in Suprtool/UX.
SET ThousandSymbol " "
(Default: comma)
This setting is used to
change the Thousand character which is used to edit the data in a field used by
the $Number function.
The default character for the Thousand Symbol is a comma.
SET
USERLABELS ON | OFF
This command has no effect
in Suprtool/UX.
SET
VARSUB ON | OFF
(Initially: OFF)
This option tells Suprtool to resolve any
environment variables in any command. The default value for VarSub is Off for
backward compatibility. Please note that Suprtool will not resolve any of its
internal $options, such as $LOOKUP, $DATE etc. If you are using Suprtool for
AMXW, Suprtool will try to resolve CI variables with “!” and then any
environment variables left over.
SET
VARSUBCOMPAT ON | OFF
(Initially: OFF)
The Set VarsubCompat
flag has been added to have variable substitution be more flexible. On MPE
variable substitution would pass the name of the variable thru to be parsed
even if the variable was not set. On HP-UX the default behaviour was to return
spaces if the environment variable was not set.
This is still the default behaviour, however if you set varsubcompat
on, Suprtool will return the environment
variable name similar to how MPE works with unresolved variables.
SET VARSUBDEBUG ON | OFF
(Initially: OFF)
Suprtool, now has a
setting called Set VarsubDebug on which will print out the line after the
variable substitution has occurred. This setting only works if Set Varsub is on
and Set VarsubDebug is on.
export outfile &
:"/GREEN/SUPRTEST/filename90123456789012345678901234567890123456789012345678901"
/opt/robelle/bin/suprtool
SUPRTOOL/UX/Copyright Robelle
Solutions Technology Inc. 1981-2007.
(Version 5.1.02 Internal) TUE, OCT 30, 2007, 2:58 PM Type H for he
>set varsub on
>set varsubdebug on
>in file1sd.suprtest
vd:in file1sd.suprtest
>output !outfile,link,temp
vd:output
/GREEN/SUPRTEST/filename90123456789012345678901234567890123
vd:2345678901,link,temp
The output is formatted into 74 byte chunks and printed with a
preceding “vd:” so the “substituted” line is clear.
SET WARNINGS ON | OFF
(Initially: ON)
Suprtool normally prints warning messages out to $stdlist. You can
turn off these messages when you are running from batch by issuing a Set
Warnings off command. If you are simulating batch mode with the Set Interactive
Off command, you must do the Set Warnings off after the Set Interactive Off.
The default for this setting is On.
Specifies the next sort
key via an Eloquence field, a table column name, or a field in a
self-describing file, or a Defined field. See "Key Command [K]" on page 30 for sort keys specified
by explicit byte position. Up to 20 Sort and Key commands can be specified per
extract task. The first key entered is the major sort key.
SORT field [(subscript)] [DESCENDING]
(Default: Ascending order)
Field
The field specified must
be an Eloquence data item that is a field of the input source, a selected item
from the selected table, or a defined field, or a field from a self-describing
file.
Subscript
If the field is a compound
item (e.g., 2X25), the first sub-item is the default if no subscript is specified. You can sort on any sub-item by specifying
the subscript. For example,
>sort address(2) {sorts
on 2nd sub-item}
Descending vs.
Ascending Order
By default, sorts are done
in ascending order. Descending specifies
that the field is to be sorted in descending order.
Examples
The most common use of the Sort command is to specify a sort field
of a database field. You may use the Key command to specify all sorts. We
recommend that the Sort command be used wherever possible. If the structure of
your database changes, your Suprtool tasks still work if sort fields are
specified with the Sort command:
>open oracle demo reader
>select * from sales {input
from a table}
>sort account
{primary
sort field}
>sort purchased,desc {newest
transactions first}
>output dsales {write
the sorted records to a disc file}
>exit
In the next example we sort a disc file. We create a field using the
Define command. Rather than using the Key command, we use the Sort command to
specify the sort field. If the disc file changes, only the Define command must
be changed:
>input invent {input
is from a disc file}
>define a,11,2,int {"A"
is an integer that starts…}
>output outfile { at the 11th byte of Invent}
>sort a {sort
the input records by the "A" field}
>exit
With the =dataset form of
the Input command, we can have even greater flexibility to use the Sort
command. We assume that the MPE file Mcust has the same structure as the
m-customer dataset. We sort the file using the first of the two street
addresses in m-customer:
>base store
>input mcust=m-customer {same
format as m-customer}
>sort street-address {a
repeated field, but only}
>exit { the first address is used}
Notes
The Verify command shows
all of the current command values and the Reset command cancels them. If you
have not defined any sort fields before the Xeq or Exit command, Suprtool
performs a copy only, no sort.
Suprtool uses some
temporary files during a sort. It creates the files in the directory specified
by the TMPDIR environment. The size of the files will be equal to the size of
the output file. If Suprtool runs out of disc space during a sort, you can try
to specify another directory for TMPDIR.
Builds a table of values
for testing in the If or Chain command. There can be up to ten different
tables.
TABLE tablename, itemname, table-keyword,
table-values [,HOLD][,DATA(field,…)
Tables are used by the $lookup function of the If command and as
input to the Chain command. The table keywords are Item, File, and Sorted. The
total amount of table space is restricted by Set Limits Tablesize. Use the
following scheme to select input records based on many data values:
1.
Load a table with the values
you are interested in.
2.
Use the $lookup function of the
If command to search the table.
3.
Or, use the table with the
Chain command to read a selected set of key values.
To add a value for an item to a table, use:
TABLE tablename, itemname, ITEM, value [,value]
When you start entering
the values for a table, you must enter all the values for that table before
starting another table. Once you switch to another table, the previous table is
"closed" and you cannot enter anymore values into it.
Parameters
tablename
Any identifier name up to sixteen characters long. This name can be
the same as the name of a Define field or database itemname, but we recommend
that you choose a unique name.
itemname
An item from the database specified in the Base or Open command or a
Define field. This cannot be a real-type item.
value
A specific value that must
match the type of the item. String
values are extended with blanks to the length of the item.
Examples
Suppose that you wanted to look for several part numbers. You could
use the following If command:
>if part =
"12345","67890","39201","92308","14892"
You could also load a table with the part numbers:
>table part-table,part,item,"12345"
>table part-table,part,item,"67890"
>table part-table,part,item,"39201"
>table part-table,part,item,"92308"
>table part-table,part,item,"14892"
and use a different If command:
>if $lookup(part-table,part)
Sometimes you need to look for all records that do not have any of a set of values,
>if part <>
"12345","67890","39201","92308","14892"
You would use the same Table commands, but a slightly different If
command,
>if not $lookup(part-table,part)
Values with
Decimal Places
If the itemname for the table has implied
decimal places, the Table command accepts decimal points and scales input
values. For example,
>item cost,decimal,2 {two
implied decimal points}
>table cost-table,cost,item,10,10.5,10.75
>if $lookup(cost-table,cost)
>out out3 {select
records for 1000, 1050, and 1075}
>xeq
You may need to look for hundreds of part numbers. The Table command
accepts the table values from a file. The file must contain lookup values in
exactly the same format as the itemname which describes the data. Duplicates
are eliminated as they are loaded into the table. For a table consisting of
values from a file use:
TABLE tablename,
itemname, FILE | SORTED, filename
[,HOLD][,DATA(field1,field2,field3…)]
Parameters
itemname
The item determines the data-type and length of the key values in
the table. You can only load a table from a self-describing file. Suprtool
first checks for the field in the self-describing file.
FILE vs. SORTED
The File option assumes that the file of table values is not sorted.
Sorting a large file of values is slow. If the file is already sorted, use the
Sorted option: Suprtool checks the records to make sure they are in ascending
order.
filename
A valid HP-UX file name; the file must be self-describing.
Hold
By default, the Xeq
command resets all tables. Use the Hold option when using the same table in
more than one extract task. When Hold is specified, the Xeq command does not
reset the table. Hold applies to individual tables, not all tables.
>table part-table,part,file,partin,hold
Data
The Table allows for data
to be loaded along with matching key values.
>table
partab,part,file,partin,data(cost,desc)
You can specify up to 20 data fields as long as the total size of
the key fields and data does not exceed 256 bytes. The Table file must be
Self-Describing to use the data option.
When loading data into a table, Suprtool will eliminate the
duplicate entries based on the key value, so some data values may not be loaded
into the table.
For information on how to retrieve data from the table, please see
the Extract command, or the Examples section of the Table command.
Examples
If all of your part numbers are in the file Partin, you use:
>table part-table,part,file,partin
>if $lookup(part-table,part)
The following example uses Suprtool to create a file of sales orders
for customers in arrears. The orders data is in the database, but the customer
information is in a disc file. Suprtool reads the disc file and creates a new
self-describing file of customer numbers that are in arrears. This SD file is
then used to select the orders for these customers from the orders table in the
database. The account item occurs in both the disc file and the database. When
the Suprtool table is loaded, the account field information is obtained from
the self-describing arrears file.
>input customers,r 60,nolf {disc
file}
>def account,1,8,display
>def status,40,2
>if
status="30" {customers
in arrears}
>extract account, status
>out arrears,link {self-describing
output}
>xeq {for
the Table command}
>open oracle demo reader
>select * from orders {sales
orders}
>table cust-table,account,file,arrears
>if $lookup(cust-table,account)
>output badorders
>xeq
In this next example, low inventory items from the Inventory table
are saved in the SD file Invent. We use this file to load a Suprtool table and
select the records from the Product database table. On the table command, we
use the "sorted" table-keyword instead of "file" because
the Invent file is already sorted. We then create a new file Lowprods with all
the product information of the low inventory items.
>select * from inventory
>if on_hand_qty <
10 {select
records}
>sort product_no {sort
by key value}
>out invent,link {later,
use this file}
>xeq {in
the Table command}
>sel * from product {contains
product description}
>table product-table,product_no,sorted,invent
>if $lookup(product-table,product_no)
>sort product_no
>output lowprods
>xeq
Suprtool can load up to ten tables, either from separate files or
the same file. The following example assumes that the files are
self-describing.
>input customer
>table cust-table,custno,file,custfile
>table zip-table,zipcode,file,custfile
>if $lookup(cust-table,custno) and $lookup(zip-table,zipcode)
>output newcust,link
>xeq
Keep in mind that using multiple tables may be more memory intensive
and require more resources.
Data Example
Your boss comes to you with a list of new prices for certain parts
and asks you to update the Part-Master dataset.
Just load the new prices into a Table, index by the product number
(prodno),then Extract the price field from each record and replace it with a
$lookup on the table. Here is the code:
>table
newprices,prodno,file,bosslist,data(price)
>get part-master
>if
$lookup(newprices,prodno)
>update
>extract price = $lookup(newprices,prodno,price)
>xeq
We do the If $lookup to select only the parts which have new prices,
then do Extract with $lookup to replace the existing price with a new one. The
Update command forces a database update on each selected record and must come
before the Extract command.
If you did not do the If $lookup then the price field would contain
zeroes for those fields that did not have a matching record.
Notes
The Xeq command clears any tables that are not held. Set Limits Tablesize restricts the maximum
size of tables, so you can limit the total amount of table space to a specified
number of megabytes. There is a total of 500 megabytes available for all
tables. To control the size of the table, you can issue the Set Limits
Tablesize command. The default Table limit is 50 megabytes for each Table.
Totals specified fields in
the selected input records.
TOTAL field [(subscript)] [decimal-places]
$file filename [ APPEND | ERASE | TEMP ]
$file
$list
(Default: subscript=first sub-item, decimal-places=0)
Parameters
Each totaled field must be an Eloquence field, a
database column name, or a field from a self-describing file, or a Defined
field. Total specifies that a total value for the field be printed after
processing the records. There does not have to be any output file (i.e., it can
be $null) for a total to be printed. There can be up to 15 totaled fields.
The subscript is valid only for compound items. If no subscript is specified, the first field
of a compound item is totaled. The decimal-places provides a decimal point when the
final total is printed. If the Item command specifies the number of implied
decimal places, the decimal-places parameter
is not needed. The values within each field are assumed to be aligned.
$File Options
By default, totals are
written to $stdlist. Use the $file option to have the totals written to a file
or to the List device. When writing to a file, the default is to create a new
file. If Suprtool cannot save the file, it produces an error. The Append,
Erase, and Temp options are the same as in the Output command, although the
TEMP option on HP-UX is simply ignored and a new file is created.
If you want the totals written to the end of the List device (the
output of the List command), specify $list as the $file file name. All other
options are ignored when $list is specified.
To write totals to the output file, use Total $file xxx,Append,
where xxx is the name of your output file. Appending totals to the output file
only works if the output file is a disc file.
Examples
The first example prints the totals for a single field.
>in file1, r 40, nolf
>def amount,1,5
>total amount
>xeq
Totals (TUE, OCT
10, 2000, 4:30 PM):
AMOUNT
611105+
The next example is identical to the previous one, except that we
qualify the total with the number of decimal places.
>in file1, r40, nolf
>total amount,2
>xeq
Totals (TUE, OCT
10, 2000, 4:31 PM):
AMOUNT 6111.05
The previous example specified the number of decimal places by using
the Total command. The next example is the preferred way to specify decimal
places because it qualifies the balance
field with two decimal places for all Suprtool
commands. This example also totals two fields.
>input file1, r 40, nolf
>def balance,11,4,integer
>def overdue,21,4,integer
>item balance,decimal,2
>item overdue,decimal,2
>total balance
>total overdue
>xeq
Totals (TUE, OCT
10, 2000, 4:32 PM):
BALANCE
143598.16
OVERDUE
17399.73
Reading Total Files
The default size for the file created by TOTAL $file needs to be
opened with 48 bytes wide and with linefeeds:
>in file1sd
>tot int-field
>total $file file82a
>xeq
>in file82a,rec 48,lf
You can also send the totals to a list file for simple reports:
>in file1sd
>tot int-field
>list standard file file82a
>total $file $list
>xeq
Sort Break
Totals
Please refer to the
Duplicate command on how to generate sort break totals.
Notes
You cannot combine the Total command with the Total option of the
Duplicate command.
The Total command prints out a date and time stamp on the title
line. This is for audit purposes.
Update one or more
noncritical fields in an Eloquence dataset.
UPDATE [
CIUPDATE ]
Specify the fields to be updated and their new values with the
Extract command. The Update command must be specified after the Chain or Get
command, but before the Extract command(s). You can update part of an Eloquence
field by defining the part you are interested in updating and then using the
defined field name in the Extract command.
The Update command can change values in critical fields (Eloquence
search or sort fields). To update critical fields, you must specify the
Ciupdate option, and CIUPDATE must be On or Allowed in the database.
Example
This example selects all inventory items with a unit-cost less than
$10.00 and increases the unit-cost by five percent.
>get d-inventory {input
dataset}
>item
unit-cost,decimal,2 {implied
decimal places}
>if unit-cost <
10.00 {selection
criteria}
>update {Update
must come before Extract}
>extract unit-cost = & {calculate
the new …}
unit-cost * 1.05 {…
unit-cost value}
>xeq
This next example selects all inventory items with a part number of
12345677 and changes it to 12345678.
>get d-inventory {input
dataset}
>if product-no =
12345677 {selection
criteria}
>update ciupdate
>extract product-no = 12345678 {new
unit-cost value}
>xeq
You can set CIUPDATE by using the DBUTIL Utility. To set CIUPDATE on
just run Dbutil and use the Set command:
:run dbutil.pub.sys
>>set dbname ciupdate=on
>>exit
Notes
The only commands that can be combined with Update are selection
commands (e.g., the If command). The following commands are not allowed:
Delete, Duplicate, Key, List, Output, Put, Sort, or Total. You cannot update
critical fields in master datasets. Update does not work with disc files or SQL
databases.
If you are updating a packed or display field, remember that
Suprtool uses unsigned values for non-negative numbers unless you add a leading
plus sign to the number. See "Packed and Display
Constants" on page 30 for more details.
Specifies a file of
commands to be executed as a group.
USE[Q] filename
Database Date
Items
A usefile makes your task
easier by allowing common commands to be specified once in an external file. A
common reason for usefiles is to isolate Define and Item commands for a
database in one place. This makes future changes easier and prevents mistakes.
In this example, we isolate all Item commands for dates from our database in a
Suprtool usefile.
>use store.suprtool
define delivered,deliv_date
define purchased,purch_date
item delivered ,date ,yymmdd
item purchased ,date ,yymmdd
Dataset Field
Definitions
In the store database, the
street-address is a 2X25 item. Suppose that you always wanted to refer to the
first and second part of the address with different names. The following
usefile would access the m-customer dataset and define the two necessary
fields:
>use mcust.suprtool
get m-customer
define street-address-1,street-address(1)
define street-address-2,street-address(2)
Quiet Execution
By default, Suprtool displays the commands in a usefile as they are
executed. The quiet option is not used in the examples above so that you could
see the actual commands inside each usefile. Suprtool can execute commands quietly using the Useq command:
>useq store.use {no
commands are listed}
Nested Usefiles
Usefiles may be nested. In other words, a usefile may use another
usefile to a depth of ten files. For example if the contents of the Usedef
usefile has a references to Useext, both usefiles would be executed:
>in dsales
>use usedef
define delivered,deliv_date
define purchased,purch_date
item delivered ,date ,yymmdd
item purchased ,date ,yymmdd
use useext
ext cust-account
ext deliv-date
ext product-no
ext product_price
ext purch_date
ext sales-qty
ext sales-tax
ext sales_total
>xeq
Care must be taken when entering Use commands with a stacked command
after a usefile reference. For example, if you enter
use usedef;def j,1,6,byte
the Define command will not be executed until after the Usedef and any other nested Use commands are finished.
Notes
The usefile may be an unnumbered, fixed-length file or a Qedit
workfile, but no more than 256 characters per record will be processed. For
compatibility with Qedit, Useq can be abbreviated to UQ.
If a Use file ends with an ampersand, Suprtool will assume that you
are continuing the current command on the next line, outside of the use file.
The Userpause command
prints a prompt message on the screen and waits for the user to press a key.
USERPAUSE [ "string" ]
(Default: read without a
prompt)
Prints the string and
waits for any key. Leading spaces in the string are printed.
Examples
In this example, we have a usefile that displays a message and then
waits for the user before starting the task.
>q
>q "We will select all transactions over $10,000. Since"
>q "there are many transactions, this task will take"
>q "some time (usually more than fifteen minutes)."
>q
>userpause "Press any key when you are ready to start."
Displays the
specifications that you have entered so far.
VERIFY [ ALL | @ | VERSION | command [...] ]
(Default: Input, Output,
Sort, Numrecs, changed Set values)
Parameters
More than one command can be verified at once by entering several command names separated by a comma or a
space. The format of the Verify output is organized into columns wherever
possible.
For Verify All, Suprtool prints all of the information concerning
the current invocation of Suprtool, including the value of the Set options and
the Suprtool version number.
For Verify Version, Suprtool prints out the version information.
Verify with no parameters prints the current values for Chain, Get,
Input, Output, and Key or Sort commands. It also prints those Set options which
are not currently at their default setting.
Examples
>v
>verify
>verify input
{current
input file}
>verify if {selection
criteria}
>verify all {all
current options}
>verify version {version
number of Suprtool}
Suspends entry of commands and
begins the extract from the input source.
XEQ
Notes
After the Xeq, Suprtool
processes the task and accepts commands to specify another task. Compare this
with the Exit command, which stops Suprtool after processing the input. After
an Xeq command, all parameters of Suprtool are reset to their initial values,
except any database that is left open, the Set options, and the Defined fields
even though their calculated offsets are not guaranteed to be correct for the
next file processed.
Examples
>open oracle demo reader
>select * from customer
>output mcstfile
>xeq {copies
Customer to Mcstfile}
>select * from orders
>output allorders
>xeq
{copies
Orders to Allorders}
>exit {terminate,
no task to do}
{last
Xeq could have been Exit}
Evaluates an expression
and prints the result in one of several formats.
=expression [,O | D | B | H | A | # | % |
$]
Any command that begins with an equal sign (=) is treated as an expression to be evaluated. An
expression consists of numbers and operators, followed by an optional display
format.
The operators can be addition (+), subtraction (-), multiplication
(*), division (/), or exponentiation (**). The value of the expression is
printed immediately on $stdlist.
=20+15 {add
two numbers together}
Result=35.0
=20*15 {multiply
the same numbers}
Result=300.0
=20-15 {subtraction}
Result=5.0
=20/15 {divide,
print precise result}
Result=1.33333333333
=20**15 {20
raised to the 15th power}
Result=.327680000000E+20
Order of
Evaluation
Unlike most programming languages, the calculator always evaluates
the calculation from left to right. This is similar to an electronic
calculator, where each keystroke is operated on immediately. You can use
parentheses to force the calculator to evaluate the expression in a different
order.
=14+16+15/3 {compute
an average}
Result=15.0
=14+16+(15/3) {add
14, 16, and the result of 15/3}
Result=35.0
=14+((16+15)/3) {add
16 + 15, divide by 3, then add to 14}
Result=24.3333333333
Percentages
A number in the calculator expression
may be followed by a percent sign (%). The calculator assumes that you want
to qualify the number as a percentage.
=125*5% {what
is 5% of 125}
Result=6.25
=125+125*5% {add
5% of 125 to 125}
Result=12.5
=125+(125*5%) {oops,
we needed to change the order}
Result=131.25 {this
looks like the answer we wanted}
The last two examples show the importance of the order in which
calculator evaluates the expression. We needed to use parentheses to force
calculator to evaluate our expression in
the correct order.
Display Formats
A calculator expression may
be followed by a comma and a display letter. The default is decimal (#) and the
options are hex ($ or H), octal (% or O), double (D), ASCII (A) and binary (B).
With these options, the result is treated as a 32-bit integer.
=10,o {standard
octal format}
Result=%000012
=-10,o {negative
number in octal}
Result=%37777777766
=100,h {hexadecimal}
Result=$0064
In Double format, calculator prints the double result as two octal
numbers (the way they appear in DEBUG). The first number represents the
high-order 16-bits and the second number represents the low-order 16-bits.
=10,d {treat
result as two 16-bit octal words}
Result=%000000 %000012
=1000000000,d {high-order
16-bits are no-zero}
Result=%035632 %145000
=-10,d {note
negative value, 2's complement}
Result= %177777 %177766
In ASCII format, up to four characters are printed in Hex, Decimal,
and ASCII display format.
=$2020,a
Result=$2020: 32,32 :"
"
=%20161 %72145,a
Result=$2071: 32,113:" q"
$7465:116,101:"te"
In binary format, the high-order 16-bits are examined. If these bits
are not zero, they are printed as two groups of eight bits. A one (1) means
that the bit is on and a zero (0) means that the bit is off. The low-order
16-bits are always printed as two groups of eight bits.
=10,b {high-order
16-bits suppressed}
Result=%(2)00000000 00001010
=-10,b {note
negative value, 2's complement}
Result=%(2)11111111 11111111 %(2)11111111 11110110
=1000000000,b {high-order
16-bits are non-zero}
Result=%(2)00111011 10011010 %(2)11001010 00000000
Input Format
The calculator supports different input formats for numbers. Octal
values are prefixed with a percent sign (%) and hex values with a dollar sign
($). An ASCII string of up to 4 characters is entered in quotes. The result of
the last calculation is referred to using #.
=%12 {octal
12 or decimal 10}
Result=10.0
=%12,o {octal
input and octal display format}
Result=%000012
=$10
Result=16.0
=%177766 {octal
number that is really negative}
Result=-10.0
="abcd",h
Result=$61626364
=#,a {use
result of last calculation}
Result=$6162: 97,98 :"ab"
$6364: 99,100:"cd"
Programmers who make use of the MPE DEBUG software are often
frustrated with the format that Double Integer numbers are printed. DEBUG
prints them as two octal numbers. Calculator accepts two octal numbers as input
and prints the result in standard decimal format.
=%35632 %145000 {treat
as one double integer value}
Result=1000000000.0
=%177777 %177766 {negative
double integer value}
Result=-10.0
Calculator Help
It may be difficult to remember all of the various options that the
calculator offers. For this reason, you can obtain a short description of the
calculator by entering the following:
=? {?
gives help}
{prints
a summary of = functions}
Use
STExport to produce a formatted output file that can be used to import data
into databases and applications. Other databases have different requirements
for the format of input data. You will have to experiment with the various
STExport formatting options to find a format that your particular database tool
accepts.
STExport reads one input file and formats each input record into one
record in the output file. The Input file must be a self-describing file (use
the Output-Link option in Suprtool).
Dates and Decimal Places
Use Suprtool's Item command to specify
date formats and the number of implied decimal places when you create the
self-describing file. STExport uses this information to correctly format the
information in the output file. See Appendix A for a complete example of how to
use Suprtool's Item command and Output-Link option to create an input file for
STExport.
Each STExport formatting command applies to all fields of a specific
data-type (i.e., you cannot specify formatting field by field, only by type).
For example, all numeric-type fields can be formatted the same.
The main data-types that STExport
identifies are
|
Byte-Type:
|
STExport assumes that character
information is stored in byte-type fields. By default, all byte-type fields
are surrounded by quotes and trailing spaces are removed.
|
|
Numeric-Type:
|
The numeric data-types are integer,
logical, floating-point, packed, and display. STExport converts the internal
representation of each data-type into a string of ASCII digits. By default,
all numeric-type fields have a leading sign and are variable length. Where
appropriate, numeric-type fields are converted with a decimal point.
|
|
Floating-Type:
|
All commands that affect numeric-type
fields also affect floating-type fields. In addition, you can use the
Floating command to specify the format and decimal places for floating-type
fields (i.e., Classic or IEEE floating-point numbers).
|
|
Date-Type:
|
If a field has a date format, STExport
does extra formatting. By default, dates are formatted into yyyymmdd (e.g.,
20001125).
|
Use
the following table to determine which command applies to which data-type:
|
Command
|
Data-Type
|
|
Date
|
date-type
|
|
Floating
|
floating-type
|
|
Quote
|
byte-type
|
|
Sign
|
numeric-type
|
|
Spaces
|
byte-type
|
|
Zero
|
numeric-type
|
Many of STExport's commands, such as the formatting commands above, once
set will retain their settings between tasks. Several other non-formatting
commands will also retain their settings:
|
Command
|
|
Columns
|
|
DElimiter
|
|
HEAding
|
|
HTML
|
Each command and its options will remain
in effect between any STExport task, unless specifically turned off.
For example, if a previous task has had
custom Headings set with the Heading and Heading Add options, the Headings will
remain in effect for each subsequent task until a new Heading option is
entered.
On average, STExport is three-to-five times slower than Suprtool.
This is the price we pay for having all of STExport's formatting features.
You can make STExport faster by doing the
following:
1.
Pre-select only the records you
need with Suprtool. The fewer records STExport has to process, the faster it
runs.
2.
Use Suprtool's Extract command
to select only the fields that you need to import in your final application.
The fewer the number of fields in the input file, the faster STExport can
format each record.
When you run STExport, it prompts for
commands on stdlist with a "$" character and reads command lines from
stdin. STExport commands contain a command name followed by one or more
parameters, and are patterned after the same commands in Suprtool.
In this chapter, we describe the STExport
commands in alphabetical order. Following each command name in brackets is the
minimal abbreviation for the command. For example: [I] for Input and [O] for
Output.
You may shorten the command to the first letter of the command name.
You may enter the letters in either uppercase
or lowercase, because STExport upshifts everything in the command line except
literal strings within quotes ("abc") and file names. These two
commands are identical:
Comments may appear at the end of any command line, when they are
surrounded by braces. Many of the examples in this manual show comments at the
end of each command line. You can enter a comment as the only item in a
STExport command line. When continuing command lines, the comment can appear
before or after the continuation character.
${ format reals
with two decimal places. }
$input invoices
$floating fixed 2 {Floating option}
$output invfile {produces the file we
want}
$exit
STExport accepts HP-UX commands, with or without an exclam.
For commands that are the same in both
STExport and HP-UX, STExport executes the HP-UX command only if you type the
exclam. For example:
$set {you get STExport set
command}
$!set {you get HP-UX set
command (ksh)}
STExport/UX executes any HP-UX command
(e.g., ll), or script file.
STExport's Input and Output commands
accept any valid HP-UX file name. File names are currently limited to 240
characters.
Any command line beginning with an equal sign (=) is treated as a
calculator expression. This feature can be used to do other calculations
without the need of an electronic calculator.
You can obtain a short description of the
calculator by entering the following:
=? {? gives a summary of
= functions}
For a detailed description of the
calculator and its options, see the Suprtool manual.
You can interrupt a STExport task with the Control-Y key (hold down
Control while striking Y). STExport responds by telling you how far it has
gotten (IN=, OUT=, etc.), and asking if you wish to stop. Hit the Return key to
continue or type YES to stop the
task.
Many HP-UX sites use Control-C as the
interrupt key instead of Control-Y. Use the HP-UX "stty" command to
display your 'intr' setting.
Repeat any combination of the previous 1000 command lines, with or
without editing.
BEFORE [ start [ / stop ] ]
[
string ]
[
ALL | @ ]
(Default:
redo previous line)
(BQ=redo
without change)
The Before command allows you to modify
the commands before it executes them. If you don't need to change them, use BQ
or Do.
The Before command uses Qedit-style
control characters for modifying the commands. The default mode is to replace
characters. To delete, use Control-D; to insert, use Control-B. If you prefer
HP-style modify (D, R, I, and U), use the Redo command instead of Before.
Examples
$ll *.fd {".sd" is
not spelled right}
*.fd not found
$Before {redo most recent
command}
ll *.fd {last command is
printed}
s {you enter changes to
it}
ll *.sd {the edited command is
shown}
{you press Return}
$listredo -10/
$before 5 {redo 5th command in
stack}
$bef 8/10 {redo 8th through
10th}
$b ls {redo last ls command}
$b ls * {redo "ls *"
command}
$b @* {redo last containing
"*"}
$before -2 {redo command before
previous}
$before -5/-2 {redo by relative
lines}
Modify Operators
If you wish to change any characters within the line, the modify
operators are the regular Control Codes used in Qedit:
·
Any printing characters replace
the ones above.
·
Control-D plus spaces deletes
columns above.
·
Control-B puts you into
"insert before" mode.
·
Control-A starts appending
characters at the end of line.
·
Control-A, Control-D, plus
spaces, deletes from the end.
·
Control-T ends Insert Mode,
allowing movement to a new column.
·
Control-G recovers the original
line.
·
Control-O specifies
"overwrite" mode (needed for spaces).
Persistent Redo
Redo commands can be saved in a permanent
file and can therefore be used from another session. You can use the Set redo command to specify a filename
to save your redo commands. Please see the Set Redo command for details.
Specifies what characters to clean from a byte type field.
CLEAN [ SPECIAL | <string> <range> ]
(Default:
None)
STExport will automatically clean all the
byte type fields for a given SD file. To define what characters that need to be
replaced you use the clean command with the character you want to clean in
quotes. Since most of the characters that you will need to clean are
unprintable, you can enter the decimal equivalent of the character. This is
denoted by entering the "^" character in quotes preceding the decimal
number of the character you wish to clean.
You can set the character with the
command set cleanchar as shown below.
$ in mysdfile
$set cleanchar " "
$out myexport
$xeq
Since the Cleanchar is by default set to
space, the above task could simply be:
$in mysdfile
$clean
"^9","^10","^0","^7"
$out myexport
$xeq
The SPECIAL keyword automatically defines
Clean characters of Decimal 0 thru to Decimal 31.
$in mysdfile
$clean special
$out myexport
$exit
You can also specify a range of
characters with the following syntax:
$in mysdfile
$clean "^0:^10"
$out myexport
$exit
The above task would clean all byte type
fields of any characters from Decimal 0 (Null) to Decimal 10. (Line Feed)
You can have the Clean function clean the
field, and instead of replacing with a space, STExport will essentially shift
characters to the left by Setting the CleanChar in the following manner:
STExport will pad the field that was
cleaned with the appropriate amount of characters with a space at the end of
the field.
Specify whether fields are formatted into variable- or fixed-length
columns.
COLUMNS FIXED | NONE
(Default:
None)
Most PC software expects imported data to
be in variable-length columns. Other database systems prefer data to be aligned
in fixed columns. Use the Columns command to specify whether the output file
has variable- or fixed-length columns.
Output File
The Columns command also affects the format of the Output file. If
you specify Columns None, the output file will have variable-length records. If
you specify Columns Fixed, the output file will have fixed-length records.
Specify a specific date-format for all dates.
DATE NONE | date-format
[ "separator" ]
INVALID
ASTERISKS | NULL | "string"
(Default:
yyyymmdd Invalid Asterisks)
Use the Date command to specify an output
format for dates. Use the Invalid option to specify how invalid dates should be
formatted in the output file. The advantage of the None option is that it
formats all dates, whether they are valid or not. If you select a date-format, the default Invalid option
replaces invalid dates with asterisks "*".
STExport must know which fields are dates
and the format of each date. Use Suprtool's Item command and Output,Link option
to specify the date information.
Date Format
The date-format can be one
of:
·
ccyymmdd
·
yyyymmdd
·
ddmmyyyy
·
mmddyyyy
·
yymmdd
·
ddmmyy
·
mmddyy
·
aammdd
STExport converts each date field from
its internal date format into the format that you specify.
Separator Character
By
default, STExport formats all dates without a separator between the day, month,
and year. Specify your own separator by enclosing it inside quotes after you
specify the date format. The separator must be one character long. For example,
to specify dates in ddmmyyyy format with a slash separator, use
To specify dates in yymmdd format with a
dash separator, use
Oracle Dates
Oracle dates contain both the date and the time. STExport formats
the date, but not the time. If you specify Date None, Oracle dates will be
treated as byte-type fields. Since Oracle dates actually contain binary data,
the output is often unusable by other applications, unless you specify a
specific date-format.
Invalid Dates
By
default, all invalid dates are formatted as asterisks. STExport treats any date
that does not have a valid century, year, month, or combination (e.g., February
29, 2000) as invalid. You can specify how you want STExport to format invalid
dates by using the Invalid option of the Date command.
If you specify,
STExport will produce a zero-length field
if you specify Column Variable and spaces if you specify Column Fixed. If you
want to specify an explicit string for all invalid dates, do so after the
Invalid option. For example,
will cause STExport to produce a string
of five percent signs for any invalid date.
Example
First, use Suprtool to create the input
file with the appropriate date attributes:
>get d-sales
>item deliv-date,date,mmddyyyy
>item purch-date,date,mmddyyyy
>output dsales,link
>xeq
Then use STExport to read the dsales
file. Specify Date ddmmyyyy "-" which causes all valid dates to be
formatted in day-month-year format with a dash as the separator:
$input dsales
$date ddmmyyyy "-"
$output dexport
$xeq
Specify the format for the decimal place in numeric fields.
DECIMAL PERIOD | COMMA
(Default:
Period)
|
The fields in the input file must have
been created with decimal places, using Suprtool's Item command.
|
The Decimal
command specifies what separator will be used to indicate the decimal place
in numeric fields. In North America, the
custom is to indicate the decimal place in numbers with a period (.). Outside
North America, the custom is to indicate the
decimal place with a comma (,). If the decimal place indicator is incorrect,
it is harder to import files into other applications.
|
The Decimal command does not apply to
floating-point fields.
Specify a delimiter, if any, that appears between each field in the
output record.
DELIMITER NONE | COMMA | TAB | SPACE | "string"
(Default:
Comma)
Use Delimiter Comma to create an output
file in "comma-delimited" format (this is common for PC database
applications). Use Delimiter Tab to tell STExport to insert the tab character
between fields, instead of a comma.
If you have selected Columns Fixed, you
will likely want to remove the delimiter by specifying Delimiter None. If you
want some white space between fixed-length columns, specify Delimiter Space
instead.
String Parameter
You can put anything inside quote characters to specify your own
Delimiter. For example, Delimiter " , " would insert a space, a
comma, and another space between each field in the output record. You can use
either single- or double-quote characters to specify the delimiter (e.g.,
Delimiter " " and Delimiter ' ' are the same). The maximum length of
the delimiter string is three characters.
The Do command repeats (without changes) any of the previous 1000
commands.
DO [ start
[ / stop ] ]
[
string ]
[
ALL | @ ]
(Default:
repeat the previous command)
Commands are numbered sequentially from
one as entered; the last 1000 of them are retained. Use the :Listredo command
to display the previous commands. You can repeat a single command (do
5), a range of commands (do
5/10) or the most recent command whose name matches a
string (do list). If you want to modify the
commands before executing them, use Redo or Before.
Examples
$listredo
$do {do previous command
again}
$do 39 {do command line 39
again}
$do 5/8 {do command lines 5 to
8 again}
$do input {do most recent Input
command}
$do -2 {do command before
previous}
$do -7/-5 {do by relative line
number}
$do 5/ {do command lines 5 to
"last"}
Notes
The Do command cannot be abbreviated.
Persistent Redo
Redo commands can be saved in a permanent
file and can therefore be used from another session. You can use the Set redo command to specify a filename
to save your redo commands. Please see the Set Redo command for details.
Specifies what character to escape the defined Delimiter, Quote or
End of Line character.
ESCAPE DELIM |
QUOTE | EOL |"string"|
(Default:
None)
Many SQL importers allow you to add an
escape character in front of characters that may mean something else to the
import program. For example if the import program thinks that the delimiter
character is a comma, the importer may treat a comma in an address field as an
indication to move to the next field, which will throw of the import.
Some import programs, will treat the next
character as data as opposed to a delimeter if the character is preceded by an
escape character, such as a slash. Thus when the field is analyzed by STExport
the data that originally started as:
"Niagara
Falls,Ontario, Canada"
would be transformed to be:
"Niagara
Falls/,Ontario/,
Canada"
This function will not work on fixed
columns and can be invoked with the escape command:
escape delimeter quote eol "/"
The above command will take the defined
delimeter, quote and Eol and escape with a "/", if found in any byte type field.
Exit STExport in one of three ways. By default, perform the current
task, if any, then leave STExport. Users are often frustrated when they exit
STExport after specifying part of a task and STExport starts processing the
task. To avoid this situation, use the Abort or Suspend options to exit
STExport conveniently without executing the current task.
EXIT [ ABORT | SUSPEND | XEQ ]
(Default:
Xeq)
Typing Exit with no parameters means Exit
Xeq. STExport recognizes special command names which specify both the Exit
command and an exit option (e.g., ES means Exit Suspend).
Cancels
the current operation and terminates STExport. The Exit command without
parameters always attempts to perform the task currently specified, while Exit
Abort cancels the task and terminates immediately. Should STExport be executed
as a son process, Exit only suspends STExport, while Exit Abort actually
terminates the process.
Examples
$:comment. You began to specify an input file, stopped
for
$:comment. coffee, and decided to cancel the task
$:comment. upon your return.
$input invoices
... coffee break ...
$exit abort {cancel the task and
terminate}
End Of Program
This feature is not currently available in STExport/UX.
To
perform the current task, you can either use Xeq (which leaves you inside
STExport, ready to define another task) or Exit Xeq (which leaves STExport when
done with the task).
Exit Xeq is the default option (i.e.,
specifying exit starts execution of the current task).
Examples
/opt/robelle/bin/stexport
$exit {no input was
specified}
/opt/robelle/bin/stexport
$input invoices
$floating fixed 2
$output invdata
$exit {format and stop}
Specify
the format and the number of decimal-places for floating-point fields.
FLOATING DEFAULT |
FIXED decimal-places |
SCIENTIFIC
decimal-places
(Default:
Default)
By default, STExport formats
floating-point fields into either a fixed number or into scientific notation.
Which notation STExport chooses, depends on the value of each field in each input
record. You can force STExport to choose either scientific or fixed notation
and the number of decimal places for all floating-point numbers. You cannot
specify these options for a specific field or make them different for 32-bit
versus 64-bit floating-point numbers.
Fixed Format
Use Floating Fixed to force all floating-point numbers to appear in
a fixed format. You specify the maximum number of digits to the right of the
decimal point. If you specify Floating Fixed, STExport does not remove trailing
zeros from the formatted numbers. If you specify Columns Fixed, all
floating-point values will be aligned along the decimal point.
Scientific Format
Use Floating Scientific to force all floating-point numbers to
appear in scientific notation. You must specify the number of digits to the
right of the decimal point. The Scientific option formats the number with all
significant digits to the right of the decimal-point followed by the exponent
(e.g., "0.47832E-10").
Notes
Both the Fixed and Scientific options
attempt to round the number to the specified number of decimal-places within
the maximum width for each floating-point data-type. If STExport cannot format
a floating-point field in the specified number of decimal-places, the number
appears as asterisks "****".
Display the fields in a self-describing file.
FORM [filename]
If no file name is specified, the fields
in the input file are displayed. The display shows the field type and field
length in IMAGE notation. An I1-field is a single integer. Packed-fields show
the number of nibbles (subtract one to obtain the number of digits). Byte and
zoned-decimal fields show the byte length.
When showing the form of a
self-describing file, STExport shows the byte offset of each field after the
subcount, type, and sublength. The first field always appears at offset one.
There are two types of self-describing
files. One type is produced with Suprtool's Query output option. You produce the
other type with the Link output option. The Form command shows the internal
self-describing version number, enabling you to tell the difference.
A.00.00 - Query Output Option
Compound fields have a question mark for
the type, and the length is the number of bytes in the field. Sort information
about the file is missing. Here is an example form listing:
$form custfile
File: custfile (SD Version A.00.00) Has linefeeds
Entry: Offset
CHARACTER X5
1 {length is five bytes}
ZONED Z5 6
{room
for five digits}
INTEGER I1
11 {single integer}
DOUBLE I2
13 {double integer}
PACKED P6
17 {room for five digits}
QUAD
I4 20
{eight-byte
integer}
REPEATINT ?6
28 {compound field}
LOGICAL K1
34 {single logical}
DBLLOG K2
36 {double logical}
Entry Length: 44 Blocking: 1
B.00.00 - Link Output Option
These self-describing files contain
information about how the file was sorted. Compound fields are handled
correctly, so the Form command shows compound fields just as you would see them
in IMAGE. The Item command in Suprtool identifies the date format or the number
of decimal places of an item. The Link output option saves the date and decimal
attributes as part of the field description:
$form custfile
File: datafile (SD Version B.00.00) Has Linefeeds
Entry: Offset
CHARACTER X5 1
<<Sort #1 >>
REPEATINT 3I1
6 {compound field}
DATE J2 12
<<YYYYMMDD>>
DOLLAR P6
16 << .2 >>
Entry Length: 16 Blocking: 1
Specify a heading, if any, that appears as the first record of the
output file.
HEADING NONE | FIELDNAMES |
string | ADD string | COLUMN string
(Default:
None)
When importing data into other
applications the first line of the import file is often treated as field names
or headings. Use the Heading command to specify what STExport should write as
the first line of the output file.
Field Names
If you
specify Heading Fieldnames, STExport creates a default heading. This heading is
constructed by using the field name of each field in the input file. The
Fieldname option uses the formatting options that apply to byte-type fields to
determine the final format (e.g., the Quote command).
STExport produces multiple field names
for compound fields. For compound fields, the repeat count is used to determine
the number of field names. The repeat count is appended to the field name,
starting with one, until all the field names have been generated.
User Specified Heading
You
can specify your own heading line by doing:
Because the maximum length of an STExport
input line is 256 characters, you may not be able to specify a long heading
with a single Heading command. Use Heading Add to add additional strings to
your heading:
Heading "Account" {Note no Add in first string}
Heading Add
"First Name "
Heading Add "Last
Name "
Heading Add "City
"
Heading Add
"State "
If you specify your own heading, STExport
does not attempt to apply any formatting options. If you need each field in the
heading line to be surrounded by quotes and separated by commas, you have to
supply these yourself. For example,
Heading '"Account"' {Note no Add in first string}
Heading Add ','
Heading Add
'"First Name"'
Heading Add ','
Heading Add
'"Last Name"'
Heading Add ','
Heading Add
'"City"'
Heading Add ','
Heading Add
'"State"'
Column Headings
It is difficult to get headings right
when you have to specify all the quotes and delimiters with the Heading Add
option. Instead, use Heading Column to specify individual column headings
without having to type formatting information. STExport then uses the current
quote and delimiter settings in the heading.
For example, if you specify:
Heading Column
'Account'
Heading Column 'First
Name'
Heading Column 'Last
Name'
Heading Column 'City'
Heading Column 'State'
and Quote Double and Delimiter Comma are
in effect, then the heading STExport produces will be:
"Account","First
Name","Last Name","City","State"
Notes
You cannot combine the Add and Column
options. You must specify one or the other. If you start with Heading Add and
then later specify Heading Column, STExport erases the heading you created with
Heading Add and starts over with the first column that you specify with Heading
Column. Similarly, if you start with Heading Column, a Heading string or Heading Add will start over
with a new heading.
Show what commands and options are available in STExport.
HELP [ command
| keyword [ ,section ] ]
(Default:
browse through the entire help file)
Command Help
If you specify any parameters, Help first
assumes that you want help on a specific STExport command. If you know the structure
of the help file, you can specify one of the keywords under the command name.
$help sign {help on the Sign
command}
$help
sign,trailing {trailing section of
the Sign command}
Keyword Help
If we cannot find any help in the
"Commands" section of the help file, we assume that you specified one
of the outer-level keywords in the help file. To see this list of keywords,
type help with no parameters. You see a short introduction to STExport and then
a list of keywords. You can specify any of these keywords on the Help command.
You can also specify a subkeyword.
$help
intro,input {input section of
Introduction}
Quick Help - HQ
HQ asks STExport to look under the keyword Quick in the help file.
Quick contains the text from the STExport Quick Reference Guide, offering the
experienced user a quick review of the syntax of any command.
$hq input {quick description of
Input}
Notes
If no parameters are specified, Help allows you to browse through
the help file, /opt/robelle/help/stexport. The Help command uses the Qhelp
subsystem from the QLIB. For "help in help", type "?" when
you see the Qhelp prompt character ("?"). The help file is organized
into levels. To go back to the previous level, press Return. Press F8 to exit
the Qhelp subsystem and return to STExport.
Use HTML to produce Web pages for either Internet or Intranet
applications.
HTML NONE | PREFORMATTED | TABLE |
TITLE
"string" |
HEADING
"string"
(Default:
None)
Web applications expect data in a special
format called the Hypertext Markup Language (HTML). Use the HTML option to
request that STExport format the input file into HTML format.
Example
$html table title
"Product Listing"
Maximum Size of HTML Files
Web
browsers often cannot process large documents. The maximum size depends on the
browser, the version of that browser, the operating system it is working on,
and how much physical memory is present on the client machine. We suggest that
you limit your Web pages to less than 1,000 lines and restrict the number of
columns, unless you are certain that your users can handle larger files. This
advice reflects not so much a limitation of STExport, but a limitation of how
Web browsers work.
Preformatted Format
To preserve the columns and spacing of each output line, use the
HTML Preformatted option. This option puts an HTML <pre> tag around all
the data in the input file. Most Web browsers will display preformatted text in
a fixed-width font such as Courier. Therefore, if you specify HTML
Preformatted, you should also select Columns Fixed.
Table Format
Use HTML Table to create output in HTML table format. STExport
creates tables with a border between each column and row. Tables make it easier
to read tabular information, but some older browers do not support tables.
If you specify HTML Table, all byte-type
fields are left-justified and all other fields are right-justified. If you use
Heading Column or Fieldnames, the column headings are specified with HTML table
heading tags. Most browsers highlight the column headings in some way, such as
bold text centered over the column.
Title
All HTML documents must have a title. By default, STExport uses the
title "This is the Title". You should specify your own title using
the Title option.
Heading
The heading appears before the column headings and data from your
input file. By default, there is no heading. Use the Heading option to specify
your own heading.
Column Headings
If you specify HTML Table, use the
Heading command to specify column headings for HTML output. The Heading
Fieldnames option will produce acceptable column headings, but it is better to
use Heading Column to specify a string for each of the fields in your input
file.
Roman-8 Characters
HP e3000 and HP 9000 computers use the Roman-8 character set. Web
pages must use the ISO-8859-1 character set. The characters in the Roman-8 set
are similar to, but not identical with, the ISO-8859-1 character set.
When formatting byte-type fields,
STExport attempts to convert any Roman-8 input character into the corresponding
ISO-8859-1 character.
STExport also tries to make reasonable
conversions such as:
|
Symbol
|
Converted To
|
|
>
|
>
|
|
<
|
<
|
|
&
|
&
|
Those characters that cannot be converted
are dropped from the output. The following characters cannot be converted:
|
Symbol
|
Roman-8 value
|
name
|
|
`
|
169
|
grave mark
|
|
^
|
170
|
circumflex
|
|
~
|
172
|
tilde
|
|
ƒ
|
190
|
function symbol
|
|
ß
|
222
|
beta symbol
|
|
Š
|
235
|
capital-S, Icelandic
|
|
š
|
236
|
small-S, Icelandic
|
|
Ÿ
|
238
|
capital-Y, umlaut
|
Notes
If you specify HTML Table, STExport sets:
·
Quotes None
·
Delimiters None
If you specify HTML Preformatted,
STExport sets:
·
Quotes None
·
Delimiters Space
·
Columns None
In either case, any changes cause
STExport to print a warning to let you know that these options have changed. If
you do want quotes around byte-type fields or delimiters between fields,
specify those options after selecting the HTML option.
The Common Gateway Interface (CGI) feature of your Web server allows
you to execute custom programs or scripts, and to dynamically generate, then
display Web pages. These custom programs and scripts can be written in almost
any programming language. Perl is probably the most commonly used language, but
you could use C or C++, Applescript on Macintosh, or Visual Basic.
First, your Web server software must be configured to allow CGI
scripts. On the NCSA server, you need to change the srm.conf file to
include
ScriptAlias /cgi-bin/
/usr/local/httpd/server/cgi-bin
This indicates to the server where the
CGI scripts are located. If a user enters "cgi-bin" in the Uniform
Resource Locator (URL), the Web server executes the program specified out of
the directory specified, e.g.,
http://www.mycompany.com/cgi-bin/myscript.pl
will actually execute
/usr/local/httpd/server/cgi-bin/myscript.pl
On the CERN Web server, you need to enter
the following in the httpd.conf configuration file:
Exec /cgi-bin/*
/usr/local/httpd/server/cgi-bin
Of course, the alias name and directory
can be anything you want them to be.
A script can be coded to perform the same
task every time it is run. There are different ways you can pass parameters to
a script so that it can do different things. We will try to keep it simple and
focus our attention on a specialized program.
Our application will display a list of
all sales records created yesterday. The information is stored in an Allbase
database. The table is called demo.sales and has the following columns:
|
Column Name
|
Allbase Type
|
Nulls
|
Suprtool Type:
|
|
CUSTOMERNUM
|
Decimal
(8)
|
N
|
Packed
|
|
DELIVERYDATE
|
Decimal
(8)
|
Y
|
Packed
|
|
PRODUCTNUM
|
Decimal
(8)
|
N
|
Packed
|
|
PRICE
|
Decimal
(8)
|
Y
|
Packed
|
|
PURCHASEDATE
|
Decimal
(8)
|
N
|
Packed
|
|
SALESQTY
|
Decimal
(4)
|
Y
|
Packed
|
|
SALESTAX
|
Decimal
(8)
|
Y
|
Packed
|
|
SALESTOTAL
|
Decimal
(8)
|
Y
|
Packed
|
DeliveryDate and PurchaseDate are in
yyyymmdd format. Price, SalesTax and SalesTotal have two implied decimals.
Before you go any further, you will have
to decide where the new HTML file will reside. When someone connects to your
Web site, the server software spawns child processes using a userid and groupid
defined in the srm.conf (NCSA) or httpd.conf (CERN) configuration file. This
user must have read and write access to the directory specified in STExport's
Output command. This directory must also be accessible by the server software
as defined in the configuration file. For security reasons, it is not
recommended that you create these files in the server's root directory.
You can configure a default html
directory (for example, userdir entry in CERN) for individual users. When the
URL contains a user construct,
the server knows it has to look for the default directory under the user's home
directory. Let us assume the default is public_html.
You could create a public_html directory
under the home directory for the userid specified in the configuration file.
Another option is to create a new user on
your system with the same directory structure, whose sole purpose would be to
hold these dynamic HTML files. For example, create a user called htmluser whose home directory would be /users/htmluser. Create a
/users/htmluser/public_html directory. Directory permissions should be
read/write for user, group and others. The URL to read these would then be:
http://www.mycompany.com/~htmluser/filename.html
Suprtool and STExport will be executed from a Korn shell script. Let
us call it sx_orders.ksh. It can reside in any directory that has appropriate
permissions to execute. Do not forget to assign eXecute permission to the file
(chmod +x sx_orders.ksh). You can run this script manually from the $ prompt to
see if there are any problems.
#!/bin/ksh
#
# Make sure the PATH
variable includes /opt/robelle/bin
# where Suprtool and
STExport usually reside.
#
PATH=$PATH:/opt/robelle/bin
#
# Create a temporary
logfile
# and get a file name
for the temporary extract file
#
temp_sxlog=`mktemp`
touch $temp_sxlog
temp_sxdata=`mktemp`
#
# Run Suprtool and
extract the data.
# - Read commands
using "here-is"
# - write messages to
temporary logfile
#
suprtool
<<!EOD >> $temp_sxlog
Open Allbase
/users/orders/db/OrdersDBE clerk
Select * From
clerk.sales
Item purchasedate,
date, yyyymmdd
Item deliverydate,
date, yyyymmdd
Item price, decimal, 2
Item salestax,
decimal, 2
Item salestotal,
decimal, 2
If purchasedate =
\$today(-1)
Sort customernum
Output
$temp_sxdata,Link
Exit
!EOD
#
# Check return code in
case Suprtool had a problem
# If so, send the
"failed" return string to the CGI script
# including the name
of the logfile
#
if [ $? -eq 1 ]
then
echo failed=$temp_sxlog
exit 1
else
#
# Suprtool task worked
correctly.
# Can go on with
STExport.
#
# Must go to the
target directory
# because of file name
limit in STExport
# and get a file name
to store HTML output
#
cd /users/htmluser/public_html > /dev/null
temp_stexpdata=`mktemp -d .`
#
# Execute STExport to
create the html file
#
stexport <<!EOD >> $temp_sxlog
Input $temp_sxdata
HTML
Table Title "Orders Created Yesterday" \
Heading "Orders Created Yesterday
(sorted by customer)"
Heading Fieldnames
Date YYYYMMDD "/"
Output $temp_stexpdata.html
Exit
!EOD
#
# Check return code in
case STExport had a problem.
# If so, send the
"failed" return string to the CGI script
# including the name
of the logfile
#
if [ $? -eq 1 ]
then
echo failed=$temp_sxlog
exit 1
else
#
# Everything worked
fine.
# Send the
"OK" return string to the CGI script
# including the name
of the HTML file name.
#
echo OK=$temp_stexpdata.html
rm $temp_sxlog > /dev/null
rm $temp_sxdata > /dev/null
exit 0
fi
fi
With such a simple example, we could have written the shell script a
bit differently and then used it as a CGI script. However, shell scripts do not
have enough features to easily handle parameters or complex forms.
Instead, it is typical to use another
language as an intermediate step. One of the most popular CGI scripting
languages is Perl. Perl has a full set of string handling functions and can be
combined with graphics libraries available from various sources.
Let us call this one sx_orders.pl. It
must reside in the directory defined in the server configuration file.
#!/usr/local/bin/perl
#
# Execute shell script
and capture returned string
#
$return_string =
`/users/orders/scripts/sx_orders.ksh`;
#
# Return string can be
OK=html file name
# or failed=log file name
# Split function separates
return_string's 2 components
#
($status_word,
$html_file) = split (/=/, $return_string);
if ($status_word eq
"failed") {
#
# If the script
failed, print an HTML error page
# including the
logfile
#
error_page
}
else {
#
# If the script is successful,
display the HTML file
# created by STExport.
# This URL
automatically looks for the configured directory
# under htmluser's
home directory.
#
print "Location:
http://www.hp.com/~htmluser/$html_file", "\n\n"
}
# Format an error
message for the user
sub error_page {
print "Content-type:
text/html\n\n";
print "<HTML>\n";
print "<HEAD>\n";
print "<TITLE>Comment Form
Error</TITLE>\n";
print "</HEAD>\n";
print "<BODY>\n";
print "<H1>Comment Form
Error</H1>\n";
print "<HR>\n";
print "<P>\n";
print "Form input was not
proccessed. Please mail your ";
print "remarks to
<b>$webmaster</b>";
print "<P>\n";
print "<b>Content of the
Suprtool/STExport logfile</b>";
print "<pre>";
print `cat $html_file`, "\n";
print "</pre>",
"\n";
print "</BODY>\n";
print "</HTML>\n";
}
The CGI script can be invoked explicitly when you type the URL in
your browser:
http://www.mycompany.com/cgi-bin/sx_orders.pl
The script is executed either from an
input form,
<FORM METHOD="POST"
ACTION="/cgi-bin/sx_orders.pl">
or invoked through a link in a regular
Web page
Just click <a
href="/cgi-bin/sx_orders.pl">run script</a>
If you enter the URL, choose the
"submit" button on a form, or click on a link, the server will start
execution of the Perl script. In turn, Perl will run the shell script. Suprtool
and STExport will finally be executed. A status code and a file name will be
returned to Perl. It will print either an error page or the extracted
information, depending on the status code.
There is a lot more you can do with CGI
scripting and Suprtool. You could pass parameters to extract information out of
different tables in Oracle and Allbase, or specify the sort sequence and the
selection criteria.
Specifies
the primary input file.
INPUT filename
There can be only one Input file per
task. The Input file must be a self-describing file, which should be created by
Suprtool using the Output-Query or Output-Link option. If you want STExport to
format date-fields and implied decimal places, you must use the Output-Link
option of Suprtool when you create the file for input to STExport.
Every record in the input file is
formatted into a corresponding record in the output file. It is best to have
Suprtool Extract only the fields you actually need. Only those fields needed
for import into the final application should be present in the Input file.
The Listredo command displays any of the previous 1000 commands.
LISTREDO [ start
[ / stop ] ] [;ABS] [;OUT=file]
[
string ] [;REL]
[
ALL | @ ] [;UNN]
(Default:
display previous 20 commands)
(BJ
and ,, are short for LISTREDO)
Commands are numbered sequentially from
one as entered; the last 1000 are retained. You can display a single command, a
range of commands, all 1000, or all the commands whose name matches the string.
You can print the commands with ABSolute line numbers (the default), RELative
line numbers (-5/-4), or UNNumbered. You can write the commands to your
terminal. The Out option is not currently supported on STExport/UX. If you want
to redo any of these commands, see Do, Redo, and Before.
Examples
$listredo 5
$listredo 5/10
$listredo help {print all Help
commands}
$listredo -10 {print last ten
commands}
$listredo ALL {print entire redo
stack}
$listredo @;rel {print ALL, relative
numbers}
$listredo rm {print all rm
commands}
$listredo rm xx {print all "rm
xx" commands}
$listredo @rm {print all with
"rm" anywhere}
Notes
The Listredo command cannot be
abbreviated, but BJ and ,, (comma comma) are accepted as a short forms.
Persistent Redo
Redo commands can be saved in a permanent
file and can therefore be used from another session. You can use the Set redo command to specify a filename
to save your redo commands. Please see the Set Redo command for details.
Specifies the Output file.
OUTPUT * | filename [ERASE] [LF] [NOLF]
By default,
the Output file is named "Output". If you specify Columns None, the
output file will have variable-length records. When Columns Fixed is specified,
STExport creates the output file with fixed-length records.
Line Feeds
STExport's Output command allows the user to specify whether the
output file has line feeds. Normally STExport determines whether to write out
line feeds from the self-describing file. If the self-describing file does not
have line feeds, then the resulting file from the STExport task will not have
line feeds. This caused problems for some programs that import the file or for
some browsers that use the HTML option. You can now explicitly specify line
feeds in the output file by using the LF option.
$in ora.customer
$out file1ex,lf
$exit
To specify that line feeds are not
written out to the file, you can use the NOLF option.
$in ora.customer
$out file1ex,nolf
$exit
Stdlist
If the output file name is *, each output
record is written to stdlist. This is useful for trying out different
formatting combinations until you find the one that best fits the application
that you want to import data into. For example,
$input sdfile
$output *
$xeq
$floating fixed 2 {change one option}
$input sdfile
$output *
$xeq {view the result}
$sign none {change a different
option}
$input sdfile
$output *
$xeq {and so on}
Specify which quote character, if any, is to be used around
byte-type fields.
QUOTE NONE | DOUBLE | SINGLE
(Default:
Double)
Most software packages expect byte-type
fields to be in one of two formats:
1.
Fixed-column (see the Column
command).
2.
Surrounded by single- or
double-quotes. In this case, you may also need to remove trailing spaces (see
the Spaces command).
No Quotes for Fixed Columns
Use
Quote None to cause byte-type fields to be output as a group of characters. In
many cases, you would combine this option with Columns Fixed.
Single or Double Quotes
By
default, all byte type fields are surrounded by double quotes. Specify single
quotes using the Single option. If a byte type field contains the quote
character specified in the quote command, it is replaced with a space. For
example, if the input was:
and Quote Single had been specified, then
the output would be:
Enables you to modify and repeat any of the previous 1000 command
lines.
REDO [ start
[ / stop ] ]
[
string ]
[
ALL | @ ]
(Default:
redo the previous command)
The Redo command allows you to modify the
commands before it executes them. If you do not need to change them, use the Do
command. Commands are numbered sequentially from one as entered; the last 1000
are retained. Use the :Listredo command to display the previous commands. You
can Redo a single command, a range of commands, or the most recent command
whose name matches a string.
The Redo command uses MPE-style editing
logic (D, I, R, U and >). The default mode is to replace characters. To
delete, type DDDD under the characters to be removed. To insert, type I under
the insertion spot, then the new characters. To undo your changes, type U. To
append to the end of the line, use >xxx. To delete from the end of the line,
use >DD. To replace at the end of the line, use >Rxxx. And to erase the
rest of the line, use D>. If you prefer Qedit-style editing (Control-D,
etc.), use the Before command instead of the Redo command.
Examples
$ll fille {'fille' is a typo}
fille not found
$redo {redo most recent
command}
ll fille {last command is
printed}
d {you enter changes to
it}
ll file {edited command is
shown}
{you press <return> }
$listredo all
$redo 5 {redo 5th command in
stack}
$redo {redo previous
command}
$redo -2 {redo command before
previous}
$redo 8/10 {redo 8th through
10th}
$redo -10/ {redo -10 through
last}
$redo rm {redo last rm command}
$redo rm temp {redo last "rm
temp"}
$redo @temp {redo last containing
"temp"}
Cancel the current task.
RESET
Reset closes the current Input file, then
resets the Output file name to "Output". Formatting options are not
reset, only the task-related commands are reset. If you try to reset an
individual command, STExport prints a warning.
Enables or disables certain operating options within STExport. These
options are not reset by Xeq or Reset commands.
SET [CLEANCHAR <string> ]
[MAPPED ON|OFF]
[REDO filename]
[STATISTICS ON|OFF]
[VARSUB ON|OFF]
[VARSUBCOMPAT
ON|OFF]
[VARSUBDEBUG ON|OFF]
[WARNINGS ON|OFF ]
[XMLTAGCHAR ] "." | "_" | "-"
SET
CleanChar <string>
(Initially:
set to space)
Sets
what character is used to replace a Clean character. If you just want to clean
the fields and replace the “bad” character with no character then you need to
set the CleanChar in the following manner:
See the Clean command for more details.
SET
MAPPED ON | OFF
Mapped has no effect within STExport/UX.
SET
REDO filename
(Initially:
unnamed temporary file)
Commands
entered at the STExport prompt are saved in something called the redo stack.
You can recall commands from the redo stack by using other commands such as
Before, Do and Redo. By default, the redo stack is stored in a temporary file
and discarded as soon as you exit. This temporary stack is not preserved across
STExport invocations.
The new Set Redo command assigns a
permanent file as the redo stack, allowing the stack to become available for
future STExport invocations. For example, to assign the Myredo file as a
persistent redo stack, enter
If the file does not exist, STExport
creates it. Otherwise, STExport uses the existing file. All subsequent commands
are written to the persistent redo stack. The setting is valid for the duration
of the STExport session. As soon as you exit STExport, the setting is
discarded. Next time you run STExport, you will get the temporary stack.
If the file name is not qualified, the
redo stack is created in the current working directory. This may be desirable
if you want to have separate stacks. If you want to always use the same
persistent stacks, you should qualify the name.
The Verify command shows which stack is
currently in use. If it shows <temporary>, then STExport is using the
default stack. Anything else is the name of the file used on the Set Redo
command.
Concurrency
When STExport uses the default temporary
stack, it is only accessible to that particular instance of STExport. You can
run as many STExport instances as you need and each one gets its own redo
stack. With temporary stacks you will never get into concurrency problems.
If you start using a persistent redo
stack, however, you might start running into concurrency problems. A persistent
redo stack can only be used by one STExport instance at a time. If you try to
use a persistent redo stack that is already in use, you will get the following
message:
$Set Redo Myredo
The redo file is
already in use
Unable to open file
for REDO stack
In this situation, STExport continues to
use the redo stack active at the time and lets you continue working as normal.
Qedit can also have permanent redo
stacks. To prevent products from writing to each other's redo stack, it is
advisable to have separate stacks for each product by giving them different
file names. For example, if you use the command
you will have a redo stack called Myredo
for your STExport commands. If you exit STExport, then run Qedit and supply the
same command Set Redo command, your Qedit commands will be written to the same
file that was used for your STExport commands.
SET
STATISTICS ON | OFF
(Initially:
OFF)
Statistics
causes STExport to print statistics at the end of each task.
SET
VARSUB ON | OFF
Setting Variable Substitution causes STExport to resolve any
variables in a command before processing.
Set VarsubCompat On | Off
The Set VarsubCompat
flag has been added to STExport for HP-UX to have variable substitution be more
flexible. On MPE variable substitution would pass the name of the variable thru
to be parsed even if the variable was not set. On HP-UX the default behaviour
was to return spaces if the environment variable was not set. This is still the default behaviour, however
if you set varsubcompat on, Suprtool
will return the environment variable name similar to how MPE works with
unresolved variables. You can invoke
this option from the command line with the –cv option.
SET VARSUBDEBUG ON | OFF
(Initially: OFF)
Suprtool and STExport and Suprlink,
now has a setting called Set VarsubDebug on which will print out the line after
the variable substitution has occurred. This setting only works if Set Varsub
is on and Set VarsubDebug is on.
export outfile &
:"/GREEN/SUPRTEST/filename90123456789012345678901234567890123456789012345678901"
/opt/robelle/bin/suprtool
SUPRTOOL/UX/Copyright
Robelle Solutions Technology Inc. 1981-2007.
(Version 5.1.02
Internal) TUE, OCT 30, 2007, 2:58
PM Type H for he
>set varsub on
>set varsubdebug on
>in
file1sd.suprtest
vd:in file1sd.suprtest
>output
!outfile,link,temp
vd:output
/GREEN/SUPRTEST/filename90123456789012345678901234567890123
vd:2345678901,link,temp
The
output is formatted into 74 byte chunks and printed with a preceding “vd:” so
the “substituted” line is clear. The above example shows Suprtool, however the
same commands apply in STExport and Suprlink.
SET
WARNINGS OFF
(Initially: ON)
Suprtool normally prints warning messages out to $stdlist. You can
turn off these messages when you are running from batch by issuing a Set
Warnings off command. If you are simulating batch mode with the Set Interactive
Off command, you must do the Set Warnings off after the Set Interactive Off.
The default for this setting is On.
SET
XMLTAGCHAR "." | "-" |"_"
(Initially: ".")
In XML the tags that surrounded the data can not have any special
characters other than hyphen, underscore and period
("-","_", "."). So STExport replaces any of the
invalid special characters with a "." by default. You can change the
default character To be something else with the following set command:
STExport will only allow the hyphen,
underscore and period to be set with this command.
Specify what should be done with the sign character for
numeric-fields.
SIGN NONE | FLOATING | LEADING | TRAILING
(Default:
Floating)
All numeric-type fields, except logical
fields, have a sign. Integer and floating-point fields can have either a space
" " (for positive values) or a negative sign "-". Packed-
and display-type fields can have a space " " (neutral), a plus sign
"+" (for positive values), or a negative sign "-".
Specify Sign None to cause STExport to
completely ignore the sign. If you specify Sign None, no error or warning
message appears if any numeric-types have a negative value.
Leading vs. Floating
If you
specify Columns Fixed, it is easy to see the difference between a leading
versus a floating sign. A leading sign always appears in the same column
whereas a floating sign always appears before the first digit of a number. For
example,
Sign Leading Sign Floating
- 22415 -22415
- 207 -207
- 16600 -16600
- 21910 -21910
- 8411 -8411
- 42 -42
- 16713 -16713
- 7970 -7970
Trailing Sign
Specify Sign Trailing to cause the sign character to appear after
each formatted number. Remember that for many numeric-types the sign for
positive numbers is a space. STExport always leaves room for the sign, even if
it is a space.
Specify whether trailing spaces are to appear in byte-type fields.
SPACES NONE | TRAILING
(Default:
None)
If byte-type fields are surrounded with
quotes (see the Quote command), the Spaces command determines whether trailing
spaces in byte-type fields appear within the quotes. Use Spaces Trailing if you
want to retain all of the spaces in a byte-type field.
Software packages that store
variable-length character data treat trailing spaces as data. Use Spaces None
to remove trailing spaces for data that is imported into these applications.
Specifies a file of commands to be executed as a group.
USE[Q] filename
Examples
A usefile makes your task easier by
allowing common commands to be specified once in an external file. For example,
the following usefile contains all the commands for creating the Invcust file:
$use invuse
input invoices {input file to format}
floating fixed 2 {formatting option}
output invdata {produces the file we want}
exit
STExport prints the lines in the usefile,
including the comment lines. This allows you to include instructions and
reminders in the usefile. In the example above, there were no commands for the
user to enter.
Notes
Usefiles cannot be nested in STExport.
The usefile may be any unnumbered text file or a Qedit workfile, but no more
than 256 characters per record are processed.
By default, STExport displays the
commands in a usefile as they are executed. STExport can execute commands quietly using the Useq command. For compatibility
with Qedit, Useq can be abbreviated to UQ.
Print the definition of the current task.
VERIFY
Verify prints the current Input and
Output files and all export specifications; in other words, it is a Verify All
command.
Perform the current task.
XEQ
Xeq checks that you have specified an Input file and an Output file.
Then it performs the task and creates the Output file. Finally, it closes the
files, ready for you to specify another task or Exit. If you also wish to leave
STExport after completing the task, use Exit instead of Xeq.
Use XML to produce XML Documents for either Internet or Intranet
applications.
XML
VERSION "string"
DOCTYPE "string"
FILE "string"
RECORD "string"
Example
STExport can generate
"well-formed" XML output with just a few commands.
$input file1sd
$xml
$output myxml
$xeq
These four simple commands will generate
the following file that packages such as XMLSpy will consider to be
"well-formed" XML. The result of such an STExport task will look as
follows:
<?xml
version='1.0'?>
<file>
<record>
<CITY>Los
Altos</CITY>
<CREDIT-RATING>100000</CREDIT-RATING>
<CUST-ACCOUNT>4003302</CUST-ACCOUNT>
<CUST-STATUS>20</CUST-STATUS>
<NAME-FIRST>Ralph</NAME-FIRST>
<NAME-LAST>Perkins</NAME-LAST>
<STATE-CODE>CA</STATE-CODE>
<STREET-ADDRESS>Room
655</STREET-ADDRESS>
<STREET-ADDRESS>Los
Altos
040033022</STREET-ADDRESS>
<ZIP-CODE>93002</ZIP-CODE>
</record>
</file>
Notes
By default STExport will add the simplest
version tag at thebeginning of the file, then it inserts a <file> and
matching </file> at the beginning and the end of the file. Then STExport
encloses each record from the input file in a <record> and
</record> tag. Finally, the Self-Describing tags are added around each
field's data values and edited appropriately.
Naturally users would want options to
customize and specify the various options and tags themselves, in order to
generate a file that is acceptable to their tools.
Version
You can specify the "version"
tag at the beginning of the XML file with the following command:
xml version "?xml version='1.0'
encoding='ISO-8859-1'?"
STExport will put the "<"
and ">" around what is specified in the version string.
Doctype
A Document Type Declaration can be made
at the beginning of the file via the !DOCTYPE specification. This typically
tells whatever tool that is parsing the xml file where the DTD for the file
resides.
In STExport you can specify simple
one-line doctype specs with the following command:
xml doctype
'!DOCTYPE address-book SYSTEM "address-book.dtd"'
This will write the doctype specification
at the top of the output file, directly after the XML version specification.
File
You can customize the "file"
tags with the following command commands:
STExport will put the "<"
and ">" around what is specified in the File string.
Record
You can customize the "record"
tags with the following command commands:
STExport will put the "<"
and ">" around what is specified in the Record string.
Example
You can enter multiple XML commands per
task to set the XML options you require.
$in file1sd
$xml version
"?xml version='1.0' encoding='ISO-8859-1'?"
$xml file "Orders"
record "Details"
$out myfile
An example of the output generated by the
above commands is as follows:
<?xml
version='1.0' encoding='ISO-8859-1'?>
<Orders>
<Details>
<CITY>Los
Altos</CITY>
<CREDIT-RATING>100000</CREDIT-RATING>
<CUST-ACCOUNT>4003302</CUST-ACCOUNT>
<CUST-STATUS>20</CUST-STATUS>
<NAME-FIRST>Ralph</NAME-FIRST>
<NAME-LAST>Perkins</NAME-LAST>
<STATE-CODE>CA</STATE-CODE>
<STREET-ADDRESS>Room
655</STREET-ADDRESS>
<STREET-ADDRESS>Los
Altos 040033022</STREET-ADDRESS>
<ZIP-CODE>93002</ZIP-CODE>
</Details>
</Orders>
Tags
In XML the tags that surrounded the data
can not have any special characters other than hyphen, underscore and period
("-","_", "."). So STExport replaces any of the
invalid special characters with a "." by default.
You can change the default character to
be something else with the following set command:
STExport will only allow the hyphen,
underscore and period to be set with this command.
Quotes
All of STExport's XML command options
(version, doctype, file and record) allow for a string to be passed via
surrounding quotes. The quotes may be either single or double, but keep in mind
that if the string is to contain double quotes, then you should surround the
entire string with single quotes.
Specify whether leading zeros are to appear in numeric fields.
ZERO NONE | LEADING
(Default:
None)
Use Zero None to force all numeric fields
to have leading zeros removed. If a numeric field has implied decimal places,
STExport always formats the number with at least one digit to the left of the
decimal place, even if it is zero.
Use Zero Leading to force all numeric
fields to be zero-filled. In this case, Sign Leading and Sign Floating both
cause the sign to appear in the same place (in front of the leading zeros).
In this example we show you how to use Suprtool and STExport. We
start with an SQL table, identify the fields that are dates and the number of
implied decimal places in other fields. We then produce a self-describing file
using the dataset as input and show the default output from STExport.
The Form command displays the fields in a
dataset or a self-describing file. For files, this information is stored in a
file with an extension of ".sd" and is not accessible with other
tools. Use the Form command to obtain the record layout of STExport input
files.
Sales File
We will be formatting data from an Oracle
table that has the following form:
>op oracle
custdb dbpass
>sel * from sales
>form
Column Name: Oracle Type: Suprtool Type:
CUSTOMERNUM Number (8)
Double
DELIVERYDATE Number
(8) Double
PRODUCTNUM Number (8)
Double
PRICE
Number (10)
Packed
PURCHASEDATE Number
(8) Double
SALESQTY Number (10)
Packed
SALESTAX Number (10)
Packed
SALESTOTAL Number (10)
Packed
Dates and Decimal Places
We use Suprtool's Define and Item
commands to identify which of the fields in the sales table are dates and which
fields have implied decimal places:
>def
deliv_date,DELIVERYDATE,8,display
>def
purch_date,PURCHASEDATE,4,double
>def
product_price,PRICE,4,double
>def
sales_tax,SALESTAX,4,double
>def
sales_total,SALESTOTAL,4,double
>item
deliv_date ,date ,yyyymmdd
>item
purch_date ,date ,yyyymmdd
>item product_price
,decimal ,2
>item
sales_tax ,decimal ,2
>item
sales_total ,decimal ,2
Salefile
We now produce a file called
"salefile" using Suprtool's Output,Link option. The Link option
produces a self-describing file, complete with the date and decimal-place
information:
>open oracle
custdb dbpass
>select * from
sales
>def
deliv_date,DELIVERYDATE,8,display
>def
purch_date,PURCHASEDATE,4,double
>def
product_price,PRICE,4,double
>def
sales_tax,SALESTAX,4,double
>def
sales_total,SALESTOTAL,4,double
>item
deliv_date ,date ,yyyymmdd
>item
purch_date ,date ,yyyymmdd
>item product_price
,decimal ,2
>item
sales_tax ,decimal ,2
>item
sales_total ,decimal ,2
>extract
customernum
>ext deliv_date
>ext PRODUCTNUM
>ext product_price
>ext purch_date
>ext SALESQTY
>ext sales_tax
>ext sales_total
>output
salefile,link
>xeq
IN=8, OUT=8.
CPU-Sec=1. Wall-Sec=1.
>form salefile
File: salefile (SD Version B.00.00) No linefeeds
Entry: Offset
CUSTOMERNUM I2 1
DELIV_DATE Z8 5
<<YYYYMMDD>>
PRODUCTNUM I2 13
PRODUCT_PRICE I2
17 << .2 >>
PURCH_DATE I2 21
<<YYYYMMDD>>
SALESQTY P12 25
SALES_TAX I2 31
<< .2 >>
SALES_TOTAL I2
35 << .2 >>
Entry Length: 38 Blocking: 1
Notice how the Form command correctly
identifies which fields are dates and which fields have implied decimal places.
STExport uses this information to format the file.
STExport Output
We then use STExport to read the
self-describing Salefile to produce our sample output on stdlist. To
demonstrate how dates are handled, we insert a separator in each date field:
/opt/robelle/bin/stexport
$input salefile {self-describing input
file}
$date yyyymmdd "-" {dates with a dash separator}
$output * {output to stdlist}
$xeq
10020,1993-10-05,50511501,98.31,1993-10-01,0.02,27.53,224.15
10003,1993-10-15,50511501,98.31,1993-10-15,0.01,13.76,112.07
10003,1993-10-15,50512501,145.62,1993-10-15,0.01,20.39,166.00
10003,1993-10-15,50513001,192.20,1993-10-15,0.01,26.91,219.10
10016,1993-10-21,50521001,24.59,1993-10-21,0.03,10.33,84.11
10016,1993-10-21,50532001,139.85,1993-10-21,0.01,19.58,159.42
There are no byte-type fields in the
input file, so all fields are converted from their internal numeric
representation to a string of digits. All date fields were converted from their
internal yyyymmdd format to the external yyyymmdd format with a dash separator
between day, month, and year. All fields with implied decimal places have been
converted with a decimal point.
Load Data Into Oracle
If you need to load the export file into
an Oracle database, you can use Oracle's own SQL*Loader. Files created with
STExport can be processed immediately with SQL*Loader. Suppose we want to load
the data extracted in Salefile. We would use STExport to format the information
and store the results in Expsale.
:run
stexport.pub.robelle
$input salefile {self-describing input
file}
$date yyyymmdd "-" {dates with a dash separator}
$output expsales {output to a file}
$xeq
If the Oracle database resided on an HP
9000, we would need to transfer Expsale. How you transfer the file is not
important as long as it gets there in the same format, including line
separators. Also note that the file should have an extension. SQL*Loader
expects a .dat extension by default.
The Oracle table should have all the
necessary columns. To create a table with the fields in Salefile, you could use
the following:
create table
sales_details (
CUST_ACCOUNT dec(8),
DELIV_DATE date,
PRODUCT_NO dec(8),
PRODUCT_PRICE dec(8,2),
PURCH_DATE date,
SALES_QTY dec(6),
SALES_TAX dec(8,2),
SALES_TOTAL dec(8,2)
) tablespace USERS;
SQL*Loader requires what is known as a
control file. It contains the load specifications such as the data file, the
destination table, the field delimiter, the text field delimiters and the
column specifications. In this case, the control file (expsales.ctl) looks like
this:
load data
-- Specify input datafile. dat extension is assumed. --
Infile expsales
-- Name of the table where the data is
loaded. --
-- Append new rows to existing data, if
any. --
Append Into Table sales_details
-- Fields are separated by commas --
Fields Terminated By ','
-- Character fields are enclosed in
double-quotes --
Optionally Enclosed By '"'
-- Specify the column names as they appear --
-- in the data records. --
-- For a Date-type column, specify the input
format --
-- Example:
column Date "YYYYMMDD" --
(CUST_ACCOUNT,
DELIV_DATE date "YYYYMMDD",
PRODUCT_NO,
PRODUCT_PRICE,
PURCH_DATE date "YYYYMMDD",
SALES_QTY,
SALES_TAX,
SALES_TOTAL)
In its simplest form, SQL*Loader is
invoked with the following command:
$ sqlload
userid=username/password
control=expsales.ctl
log=expsales.log
The username
and password are valid Oracle
connect information. SQL*Loader reads the load specifications from the file
specified in the control keyword. It
writes operation information and statistics to the file specified in the log keyword. It also creates a number of
files to report data problems etc. SQL*Loader has many other options to control
the load task. Refer to the appropriate Oracle documentation for details.
' means string........................................................... 385
! for HP-UX commands.......................................... 385
! for O/S commands................................................ 385
" means string.......................................................... 385
"closed" tables......................................................... 218
# as the Dbedit prompt character...................... 296, 384
# changing the prompt character.............................. 318
# matches number.................................................... 383
# means every n-th record........................ 138, 160, 384
$abs function................................................... 117,
147
$atoe, Extract function............................................. 133
$Clean function........................................................ 149
$Clean Function, Extract command......................... 122
$Counter Function, Extract command...................... 119
$date function.................................................. 114,
151
$date, how it works................................................... 74
$days....................................................................... 153
$days function......................................................... 114
$Edit function.......................................................... 127
$etoa, Extract function............................................. 133
$file, Total command............................................... 222
$invalid.............................................................. 75,
152
$lookup data, If command....................................... 142
$lookup function...................................................... 142
$lookup, Extract command...................................... 123
$lookup, performance.............................................. 143
$lower.............................................................. 120,
150
$ltrim............................................................... 121,
150
$null file................................................................... 184
$null, SQL............................................................... 143
$number function............................................. 197,
200
$Number, Extract Function...................................... 126
$read function.......................................................... 156
$rtrim............................................................... 121,
150
$signed function...................................................... 125
$Split Function, Extract command........................... 121
$stddate............................................................ 114,
152
$stdinx file............................................................... 382
$stdlist file....................................................... 180,
382
$SubTotal Function, extract command..................... 118
$today function................................................ 113,
152
$today, how it works................................................. 74
$Total Function, Extract command.......................... 118
$trim................................................................ 121,
150
$truncate function............................................ 118,
147
$upper.............................................................. 120,
150
% means percentage................................................. 386
& continuation character.......................... 296, 335, 384
& means escape (pattern)......................................... 384
( means start parameter............................................ 385
) means end parameter............................................. 386
* means $stdinx / $stdlist / file command................ 382
*, file name................................................................ 50
, means a list............................................................ 385
/ means range of records.......................... 137, 159, 386
: for O/S commands................................................. 384
: for shell commands.................................................. 47
? (prompt for database password).............................. 87
? means alphanumeric (pattern)................................ 384
@ matches anything................................................. 383
\ means range of fields............................................. 115
^ means character constant............................... 113, 144
{ start command line comment................. 241, 297, 336
} end command line comment.................. 241, 297, 336
< means less than..................................................... 382
<> means not equal to.............................................. 383
= means calculator........................................... 297,
382
= means equal to...................................................... 382
= set name parameter....................................... 133,
382
== means matches pattern........................................ 383
> changing the prompt character.............................. 211
> is the prompt character.......................................... 383
> means greater than................................................ 383
>< means doesn't match pattern............................... 383
4GLs.......................................................................... 69
A4-size paper........................................................... 172
aammdd date format........................................... 75,
164
abbreviating commands..................... 83,
241, 296, 335
Abort option on Exit................................ 108,
253, 341
absolute field definition.............................................. 95
absolute value function.................................... 117, 147
accuracy in numeric expressions.............................. 146
Add command................................................... 86,
303
Add command, locking............................................ 294
Add Dates................................................................ 115
adding records to a dataset....................................... 186
All option, Dbedit.................................................... 300
Allbase applications................................................... 61
Allbase database...................................................... 179
alphanumeric string test........................................... 148
alternate values................................................. 142,
218
alternatives to the If command................................. 140
AMXW Externalsd, Set............................................. 58
AMXW Perfwrite, Set............................................... 58
analyzing performance data........................................ 82
AND operator.......................................................... 141
appending to a file................................................ 57,
59
appending, Hpmodify.............................................. 190
APS, date format..................................................... 163
arithmetic expressions...................................... 116,
146
arithmetic trap.......................................................... 233
Arithmetic, Set option.............................................. 196
ascending order................................................ 167,
216
ASCII option..................................................... 40,
182
ASK MANMAN date selection.............................. 163
ASK option.............................................................. 182
asterisk................................................................... see
*
at sign (@) in patterns.............................................. 383
attached printer......................................................... 175
backslash................................................................. 386
Base command........................................................... 87
Base command, default mode.................................. 208
base name parameter.......................................... 87,
186
batch........................................................ 238,
326, 378
batch passwords........................................................ 87
batch vs online........................................................... 46
Before command................................ 89,
243, 304, 338
bit extracts................................................................ 145
block size................................................................. 378
Blocksize, Set option............................................... 196
BOT and BACKSPACE error................................. 204
Bourne shell............................................................... 43
braces....................................................... 241,
297, 336
Buffer, Set option.................................................... 196
BY-part of the Join command.................................. 346
BY-part of the Link command................................. 348
byte fields, comparing.............................................. 148
Byte to Numeric Conversion................................... 126
bytelen parameter............................................... 95,
167
byteposition parameter....................................... 95,
167
-c cmdstring option.................................................... 46
C invocation of Suprtool.......................................... 372
C shell........................................................................ 43
Calculator................................. 230,
242, 297, 336, 379
Calendar intrinsic, date format................................. 163
Calling Suprtool....................................................... 365
Century and $date.................................................... 155
CGI script................................................................ 266
Chain command......................................................... 91
chained access............................................................ 91
Change command.................................................... 306
Change command, locking....................................... 294
character constants........................................... 113,
144
Chronos................................................................... 164
CI variables.............................. 214,
215, 276, 355, 356
CIUPDATE, see critical-item update....................... 295
Clean........................................................................ 197
Clean Command................................................ 93,
274
Clean command, STExport...................................... 245
CleanChar................................................................ 197
CleanChar, Set......................................................... 274
Cleaning data Suprtool............................................. 122
COBOL invocation of Suprtool............................... 369
code overflow error................................................. 157
Cognos, date fields.................................................. 163
colon.......................................... 84,
242, 297, 336, 384
column headings, List command................................ 41
Columns command.................................................. 246
combining commands on same line........................... 83
comma............................................................. 296,
385
command line................................................... 296,
335
Command Line.......................................................... 46
command line options.............................................. 326
command line, STExport......................................... 238
commands................................................ 240,
292, 296
commands, formatting............................................. 240
commands, multiple................................................... 83
comments................................................. 241,
297, 336
Comparing against Key and Data............................. 142
comparing strings as numbers................................... 29
Complex criteria......................................................... 29
compound items............................................... 111,
216
configuring Suprtool.................................................. 46
constants.......................................................... 111,
143
constants in arithmetic expressions.................. 117, 119
constants in the output file....................................... 111
continuing commands...................................... 296,
335
control break............................................................ 223
control characters..................................................... 379
control record for Suprtool2.................................... 366
Control-D in modify.................................................. 45
Control-Y.......................................... 85,
242, 297, 336
conventions........................................................ 17,
322
convert from binary to ASCII.................................... 36
Converting dates........................................................ 75
copying files.............................................................. 26
copying to another database..................................... 186
count duplicate records............................................ 104
count parameter................................................ 138,
160
count qualifying records.......................................... 184
Count, output restrictions......................................... 106
critical fields, changing............................................ 301
critical-item update................... 295,
301, 306, 315, 321
data conversion........................................................ 125
Data option.............................................. 181,
270, 351
Data option, Table.................................................... 220
data overflow error.................................................. 157
database editing........................................................ 107
database parameter................................................... 379
database, open mode................................................ 208
database, opening....................................................... 87
database, output....................................................... 186
database, password............................................ 87,
186
dataset, end-of-file................................................... 200
dataset, highwater mark........................................... 200
dataset, input...................................................... 91,
137
dataset, output.......................................................... 186
data-types........................................................... 96,
239
data-types, Oracle...................................................... 62
Date command......................................................... 247
Date command, invalid dates................................... 248
Date command, separator character.......................... 247
date constants........................................................... 150
date format in List............................................ 173,
205
date format, Date command..................................... 247
date function of Extract............................................ 114
date function of If.................................................... 150
date limits................................................. 115,
155, 162
Date option.............................................................. 203
date selection............................................................ 150
date selection with ASK MANMAN...................... 163
Date, Set List........................................................... 205
Date, Set option............................................... 197,
198
dates in the output file...................................... 113, 114
dates, defining.......................................................... 161
dates, relative........................................................... 151
days function................................................... 114,
153
DBCONTROL intrinsic.......................................... 200
Dbedit, decimal points............................................. 294
ddd dates.................................................................. 164
ddd, date format....................................................... 164
Decimal command................................................... 249
decimal places.................................................... 36,
164
decimal places, Chain command................................ 91
decimal places, constant values................................ 165
decimal places, Dbedit............................................. 294
decimal places, defining........................................... 161
decimal places, Extract command............................. 112
decimal places, If command..................................... 145
decimal places, List command.................................. 170
decimal places, Table command............................... 219
default field filling in Suprlink......................... 347, 349
default processing.................................................... 109
Defer, Set option...................................................... 200
deferred output in IMAGE...................................... 200
Define command................................................ 95,
225
Defining fields........................................................... 26
definition parameter................................................... 95
delete all records warning........................................ 100
Delete command...................................... 100,
207, 307
Delete command, locking......................................... 294
deleting duplicate records......................................... 105
deleting entries......................................................... 100
deleting entries, recovery......................................... 100
delimited output files.......................................... 68,
183
Delimiter command.................................................. 250
Delimiter, maximum length...................................... 291
Desc parameter................................................ 167,
216
descending order.............................................. 167,
216
differences, MPE vs. HP-UX.................................... 49
disc space................................................................... 59
disc space, reduced............................................ 57,
178
display constants...................................................... 112
display fields, maintaining the sign.......................... 125
Display option......................................................... 182
Do command................................... 102,
251, 308, 340
documentation............................................................ 17
double quotes........................................................... 271
double-sided printing............................................... 172
downshifting strings................................................ 120
Dumponerror, Set option......................................... 200
Duplicate and non-SD files...................................... 105
Duplicate command................................................. 103
duplicate field names................................................ 351
duplicate keys, order of sort....................................... 68
duplicate output file.................................................... 49
duplicate records.............................................. 103,
186
Duplicate records....................................................... 33
duplicates, removing................................................ 103
duplicates, saving..................................................... 103
dynamic dataset expansion............................... 134, 135
dynamic Web pages................................................. 262
EBCDIC conversions.............................................. 133
Edit command.......................................................... 107
Edit masks............................................................... 127
editing databases...................................................... 107
EditStoponerror, Set option..................................... 200
EDSdate................................................................... 163
Eloquence.................................................................. 81
Eloquence, Ciupdate option..................................... 295
Else clause of the IF command................................ 140
end-of-file, IMAGE................................................. 200
endrecord parameter......................................... 137,
159
Environment variables, Suprtool2............................ 366
Eofread, Set option.................................................. 200
equal to sign..................................................... 379,
382
Erase option of Output..................................... 333,
351
erasing files.............................................................. 180
error block size........................................................ 378
error messages in Suprtool.............................. 233, 380
error messages, Suprtool2....................................... 376
error, code overflow................................................ 157
error, data overflow................................................. 157
escape character....................................................... 144
Escape Command.................................................... 252
Euro currency symbol.............................................. 113
example of Suprlink................................................. 328
exclam...................................................................... 242
exclamation mark..................................................... 336
Exit command.......................... 108,
229, 253, 282, 309
Exit command, importance of.................................. 365
Exit command, Suprlink.................................. 341,
359
exit with verify................................................... 47,
325
exiting from batch jobs............................................ 108
Export command...................................................... 110
Extract command............................................... 39,
111
Extract command, decimal places............................. 112
Extract from a table.................................................. 123
extracting a range..................................................... 115
extracting bits........................................................... 132
extracting dates........................................................ 113
extracting records..................................................... 140
Fastread, Set option................................................. 201
field list.................................................................... 293
field parameter................................... 95,
111, 222, 380
field type.................................................................. 167
Fieldname, Heading command................................. 257
File command.......................................................... 310
file name parameter.......................................... 159,
180
file names, hardcoded................................ 48,
237, 323
file parameter, Dbedit............................................... 298
file system error....................................................... 233
Filecode, Set option........................................... 58,
201
filename parameter................................................... 380
filling unmatched join fields..................................... 347
filling unmatched link fields..................................... 349
finding invalid dates................................................. 152
Firstrec, Set option................................................... 202
fixed columns.......................................................... 271
fixed-length, output file............................................ 246
Floating command................................................... 255
floating point, classic................................................. 49
floating sign............................................................. 278
floating-point numbers............................................. 255
Form command........................................ 256,
311, 342
Form Command....................................................... 134
Form command, default........................................... 136
Form command, keywords.............................. 136,
311
formatting commands.............................................. 240
Formout file............................................................. 343
four-digit years.......................................................... 71
FROM-part of Join command................................. 347
FROM-part of Link command................................. 349
Get command........................................................... 137
greater than (>)........................................................ 383
Heading command................................................... 257
heading, HTML option............................................ 261
heading, maximum length........................................ 291
Help command......................................... 139,
259, 312
Help command, Suprlink......................................... 344
highwater mark, reading to...................................... 200
holding tables for re-use.......................................... 219
How to run................................................................ 25
HPCalendar, date..................................................... 164
HPCalendar,date format........................................... 163
Hpmodify editing, examples.................................... 190
HP-UX commands.................................... 84,
242, 336
HP-UX vs. MPE....................................................... 49
HTML command..................................................... 260
HTML files, maximum size..................................... 260
IEEE numbers.......................................................... 255
If $lookup................................................................ 142
If command.............................................................. 140
If command too long, use $read............................... 156
If command too long, use Table............................... 218
If command, combining with Chain........................... 91
If command, decimal places..................................... 145
If command, prompting for values........................... 157
Ifcheck, Set option........................................... 202,
203
Ignore, Set option.................................................... 203
illegal digits (packed or zoned)................................ 331
IMAGE, end-of-file................................................. 200
initial command line................................................... 46
initializing a field...................................................... 111
input choices.............................................................. 60
Input command........................................ 159,
268, 345
input file................................................................... 239
input file, maximum block size................................ 363
input file, maximum fields............................... 291, 363
input file, maximum record length................... 291, 363
input files................................................................. 327
input key fields................................................ 268,
345
input, from Stdlist...................................................... 50
input, line feeds.......................................................... 49
installation, AMXW.................................................. 22
installation, HPUX.................................................... 22
installing STExport.................................................. 235
installing Suprlink.................................................... 323
Interactive, Set................................................. 203,
204
interrupt........................................................... 242,
336
Introduction............................................................... 16
introduction to Dbedit.............................................. 292
introduction to STExport......................................... 239
introduction to Suprlink........................................... 327
invalid dates............................................... 75,
152, 248
Invalid Dates............................................................ 153
ISO-8859-1 characters, HTML output.................... 261
Item command......................................... 161,
203, 225
Join command.......................................................... 346
Join command, example........................................... 329
join key fields.......................................................... 346
Julian dates.............................................................. 164
Julian day number.................................................... 114
JulianDay data format.............................................. 163
Key command.......................................................... 167
key fields, input file......................................... 268,
345
key fields, join file................................................... 346
key fields, link file................................................... 348
Key option............................................................... 181
Key option, Dbedit................................................... 300
Korn shell.................................................................. 43
KSAM files............................................................. 159
KSAM, order of sort................................................. 68
labelled tapes............................................................ 204
landscape output...................................................... 206
Large files, HP-UX................................................... 61
LaserJet............................................................ 171,
206
leading sign.............................................................. 278
less than (<)............................................................. 382
Limit option, Dbedit................................................. 300
limits within Suprlink.............................................. 363
Limits, Set................................................................ 204
line feeds.................................................... 49,
184, 270
Link command......................................... 169,
325, 348
Link file, maximum block size................................. 363
Link file, maximum fields........................................ 363
Link file, maximum number of................................ 364
Link file, maximum record length............................ 363
link key fields.......................................................... 348
Link option.............................................................. 181
linking files.............................................................. 327
list clears screen....................................................... 172
List command.................................................. 170,
313
list device................................................................. 174
List File.................................................................... 174
List, Char option...................................................... 170
List, Column Headings............................................ 174
List, Date default...................................................... 205
List, Date option...................................................... 173
List, Decimal option................................................. 170
List, Duplex option.................................................. 172
List, Heading option................................................ 174
List, Hex option....................................................... 170
List, Leftjustnum option........................................... 171
List, Noname option................................................ 171
List, Norec option.................................................... 171
List, Noskip option.................................................. 171
List, Octal option..................................................... 170
List, Oneperline option............................................ 171
List, Record option.................................................. 175
List, Rightjustnum option........................................ 171
List, Standard option................................................ 173
List, Time default..................................................... 207
List, Time option...................................................... 173
List, Title option....................................................... 172
listing......................................................................... 39
listing formats.......................................................... 170
listing one per line.................................................... 171
listing with subheadings.......................................... 174
listing without field names....................................... 171
listing, producing simple reports.............................. 173
listing, suppressing blank lines................................ 171
Listredo...................................................................... 27
Listredo command........................... 177,
269, 314, 350
literals in the output file............................................ 111
Loading Eloquence.................................................... 45
Loading Oracle.......................................................... 45
Lock, Set option....................................................... 207
locking, IMAGE.............................................. 207,
294
long expressions...................................................... 156
Lotus 1-2-3.............................................................. 183
low values................................................................ 144
lower-case........................................................ 120,
150
LP device................................................................. 175
LP, Set option.......................................................... 318
MACS, date format................................................. 163
mailing labels............................................................. 41
MakeAbsent, Set option.................................. 207,
208
Mapped, Set option.................................................. 354
master dataset expansion.......................................... 135
match pattern............................................................ 383
maximum block size in Suprtool.............................. 378
maximum delimiter length........................................ 291
maximum heading length......................................... 291
maximum input block size....................................... 363
maximum input record length.......................... 291, 363
maximum link block size......................................... 363
maximum link fields................................................ 363
maximum link files.................................................. 364
maximum link record length.................................... 363
maximum output fields............................................ 364
maximum output record length........................ 291, 364
maximum size, HTML files..................................... 260
MDX....................................................................... 135
means range of fields............................................... 386
missing comma, error...................................... 117,
119
mixed case comparisons.......................................... 150
mode parameter.................................................. 87,
186
Modify command.................................................... 315
Modify command, locking....................................... 294
modulo operator............................................... 116,
146
MPE commands, disabling access........................... 204
MPE vs. HP-UX....................................................... 49
MPE, restricting....................................................... 204
multidataset access..................................................... 17
multiple commands per line....................... 83, 296, 385
multiple search values.............................................. 218
native language support........................................... 207
negative value.......................................................... 125
NLS option, Set command....................................... 207
no quotes................................................................. 271
NOLF...................................................................... 184
Non-Collating Date Types....................................... 155
nonprinting characters.............................................. 144
non-SD Files and duplicate...................................... 105
not equal to (<>)...................................................... 383
NOT operator.......................................................... 141
null values................................................................ 144
Num option.............................................................. 181
Num,Data option..................................................... 181
Num,Key option...................................................... 181
Num,Query option................................................... 182
number sign (#) in patterns...................................... 383
numeric bytes, Suprtool........................................... 145
numeric constants.................................................... 143
numeric expressions........................................ 116,
145
numeric justification................................................. 171
numeric string test.................................................... 148
Numeric to Byte conversion.................................... 127
numeric truncation................................................... 146
Numeric-value option, Dbedit.................................. 299
Numrecs command............................................ 57,
178
O/S commands.......................................................... 84
-oc option................................................................... 46
offset parameter......................................................... 95
Open command........................................................ 179
option parameter, Dbedit.......................................... 299
optional command name.......................................... 168
optional Join option................................................. 347
optional Link option................................................. 349
OR operator............................................................. 141
Oracle applications..................................................... 62
Oracle database........................................................ 179
Oracle data-types....................................................... 62
Oracle date format.................................................... 164
Oracle dates............................................................. 247
Oracle Integer, Set................................................... 209
Oracle Number Conversion....................................... 63
Oracle OpenFix, Set................................................ 209
Oracle Rows, Set..................................................... 208
Oracle ZeroNull, Set................................................ 209
Oracle, performance................................................... 81
OS commands......................................................... 297
out of disc space................................................ 57,
178
outcount, default file name......................................... 46
outcount, Set Filename............................................... 48
output choices............................................................ 60
Output command..................................... 180,
270, 351
output file format..................................................... 246
output file name duplicated...................................... 378
output file, maximum fields..................................... 364
output file, maximum record length................. 291, 364
output file, Suprlink................................................. 328
output filecode................................................... 58,
201
output format........................................................... 287
output limits with Count and Total........................... 106
output record format................................................ 361
Output, Append option............................................ 180
Output, ASCII option........................................ 40,
182
Output, ASK option................................................. 182
Output, Data option................................. 181,
270, 351
Output, Display option............................................ 182
output, duplicate file................................................... 49
Output, Erase option................................................ 180
Output, Key option.................................................. 181
Output, Link option................................................. 181
Output, Num option................................................. 181
Output, Num,Data option........................................ 181
Output, Num,Key option......................................... 181
Output, Num,Query option...................................... 182
Output, PRN option................................................. 183
Output, Query option............................................... 181
overpunches, not used............................................. 143
overview of Dbedit.................................................. 292
packed constants...................................................... 112
packed fields, maintaining the sign.......................... 125
packed-decimal fields................................................. 97
packed-decimal, illegal digits................................... 331
page headings in List............................................... 172
parameters, Dbedit commands................................. 298
parentheses...................................................... 141,
385
Parm=64 in Suprlink............................................... 325
password in batch...................................................... 87
password parameter........................................... 87,
186
password upshifted.................................................... 87
path, default for Suprtool........................................... 44
paths, IMAGE detail datasets.................................... 91
pattern matching....................................... 149,
210, 383
pausing for user....................................................... 227
PC files.............................................................. 68,
183
PCL option, Set List........................................ 171,
206
percent sign...................................................... 379,
386
Performance considerations, Suprlink..................... 330
Performance Eloquence........................................... 201
performance of Dbedit............................................. 293
performance of STExport........................................ 240
Perl script................................................................. 265
Permanent redo........................................ 212,
274, 354
Persistent redo......................................... 212,
274, 354
personal computers.................................................... 68
PHdate option, Item command................................. 163
positive value........................................................... 125
PowerHouse.............................................................. 69
PowerHouse applications.......................................... 69
PowerHouse dates................................................... 163
PowerHouse subfiles................................. 70,
333, 351
Prefetch............................................................ 207,
208
preformatted, HTML option.................................... 260
Printer Command Language.................................... 206
printer, attached to terminal...................................... 175
printing reports.......................................................... 40
PRN option........................................................ 68,
183
processing selections................................................. 60
progress messages................................................... 210
prompt character...................................................... 383
Prompt, Set option........................................... 211,
318
prompting using Quiz................................................ 71
pseudo-batch tasks................................................... 378
Put command................................................... 186,
207
Q command..................................................... 188,
316
Qedit program...................................... 68,
89, 243, 304
Qedit program and Suprlink............................ 338, 341
Qhelp............................................... 139,
259, 312, 344
QTP for subfile.......................................................... 70
QTP, Cognos........................................................... 333
QUERY "numbers" format..................................... 182
Query option............................................................ 181
question mark, database password............................. 87
question, delete all records....................................... 100
Quick help....................................... 139,
259, 312, 344
Quiet, Set option...................................................... 318
Quiz report writer.............................. 69,
333, 349, 351
quote characters....................................................... 143
Quote command....................................................... 271
quotes, double.......................................................... 271
quotes, none............................................................. 271
quotes, single........................................................... 271
random sampling............................................. 138,
160
range of fields.......................................................... 115
range, extracting....................................................... 115
read only mode........................................................ 204
reals, classic............................................................... 49
record format, output................................................. 39
record length.............................................................. 49
Record Mode, List option........................................ 175
record number.......................................................... 159
record number selection................................... 137, 159
record number, IMAGE.......................................... 137
record number, Output............................................. 181
record number, XSORT.......................................... 202
records, number of qualifying.................................. 184
Redo command................................ 189,
272, 317, 352
Redo, number of commands.................................... 189
Redo, Set................................................. 212,
274, 354
reduced output......................................................... 206
Reflection................................................................... 68
Related option, Dbedit............................................. 300
relative dates............................................................ 151
relative field definitions.............................................. 95
Remote Oracle Database.......................................... 179
removing spaces.............................................. 121,
150
repeated fields.......................................................... 144
reports........................................................................ 40
Reset command........................................ 192,
273, 353
Reset, Set option...................................................... 319
Resolving Variables................................. 215,
276, 356
Resolving Variables like MPE......................... 276, 355
restrictions in Dbedit................................................ 292
ROBELLE variable.................................... 48,
237, 323
Roman-8 characters, HTML output......................... 261
Roman-8 vs. ASCII................................................. 172
running out of disc space in sort.............................. 217
running STExport.................................................... 237
running Suprlink...................................................... 325
running Suprtool........................................................ 43
running, supramxw.................................................... 53
scientific format....................................................... 255
SD files............................... 26,
see self-describing files
SD files, date formats................................................ 67
SD files, decimal places............................................. 67
SD files, extended names........................................... 67
SD files, Input........................................................... 67
SD files, listing.......................................................... 67
SD files, restrictions.................................................. 68
SDExtname, Set......................................................... 67
SDUnix..................................................................... 64
search criteria........................................................... 298
Select by list of values............................................... 31
Select command....................................................... 193
Select command, Allbase rows................................ 196
Select performance................................................... 193
Select, Long commands........................................... 193
Selecting by date........................................................ 29
selecting multiple values.......................................... 142
Selecting non-matches,Suprlink............................... 332
selecting records...................................................... 140
Selecting records........................................................ 28
selection by date....................................................... 150
selection logic.......................................................... 328
selection using arithmetic......................................... 146
self describing files, field name limit.......................... 66
self-describing file format................................ 287, 361
self-describing files...................... 64,
66, 105, 181, 328
semicolon................................................................. 296
semicolon means multiple commands...................... 385
separator, dates........................................................ 247
serial vs. chained read................................................ 91
session....................................................................... 68
session mode........................................................... 378
Set Allbase............................................................... 196
Set Arithmetic.......................................................... 196
Set Blocksize........................................................... 196
Set Buffer................................................................ 196
Set command, Dbedit............................................... 318
Set command, STExport.......................................... 274
Set command, Suprlink............................................ 354
Set command, Suprtool............................................ 194
Set CurrencySymbol................................................ 197
Set Date................................................................... 199
Set Date Cutoff.................................................. 72,
197
Set Date Forcecentury........................................ 72,
198
Set DecimalSymbol................................................. 200
Set Defer.................................................................. 200
Set Dumponerror..................................................... 200
Set EditStoponerror................................................. 200
Set Eofread.............................................................. 200
Set Fastread............................................................. 201
Set Filecode....................................................... 58,
201
Set Firstrec............................................................... 202
Set Hints.................................................................. 202
Set Ifcheck....................................................... 202,
203
Set Ignore................................................ 186,
203, 233
Set Itemabbreviatedate............................................. 203
Set Labelledtaperewind............................................ 204
Set Limits................................................................. 204
Set List PCL.................................................... 171,
206
Set Lock................................................................... 207
Set LP, Dbedit......................................................... 318
Set Mapped.............................................................. 354
set name parameter..................................... 91,
137, 186
Set NLS................................................................... 207
Set Openmode......................................................... 208
Set Progress............................................................. 210
Set Prompt, Dbedit.................................................. 318
Set Prompt, Suprtool............................................... 211
Set Quiet, Dbedit..................................................... 318
Set Reset, Dbedit..................................................... 319
Set Sortfast...................................................... 213,
214
Set Squeeze................................................................ 59
Set Statistics, STExport........................................... 275
Set Statistics, Suprlink............................................. 355
Set Statistics, Suprtool............................................. 213
Set ThousandSymbol............................................... 214
Set Underline, Dbedit.............................................. 319
Set VarSub.............................................................. 214
Set Varsub, STExport...................................... 275,
355
Set VarSubCompat.................................. 214,
276, 355
Set VarSubDebug.................................... 215,
276, 356
Set Verify, Dbedit.................................................... 319
shell commands......................................................... 47
shell script................................................................ 263
Sign command......................................................... 278
signed function........................................................ 125
Simple selection......................................................... 29
single quotes............................................................ 271
slash, range of records............................................. 386
Software Research Northwest................................. 164
son process.............................................. 108,
253, 341
sort break totals........................................................ 223
Sort command.......................................................... 216
sort information not retained.................................... 105
sort keys.................................................................. 328
Sortfast, Set option.......................................... 213,
214
sorting files........................................................ 68,
167
Sorting records.......................................................... 32
Spaces command..................................................... 279
spaces, removing............................................. 121,
150
special characters..................................................... 382
Special Characters.................................................... 149
special string test...................................................... 148
specifying input......................... 91,
137, 159, 268, 345
spool file errors........................................................ 233
SQL database, Allbase rows.................................... 196
SQL database, inserting records................................ 86
SQL database, Select command............................... 193
SQL database, specifying........................................ 179
SQL database, structure........................................... 135
Squeeze, Set option.................................................... 59
SRN, Chronos date.................................................. 164
startrecord parameter........................................ 137,
159
Statistics, Set option................................. 213,
275, 355
stddate function................................................ 114,
152
Stddate, Set date cutoff.............................................. 72
Stdlist, input from...................................................... 50
STExport................................................... 16,
110, 183
string constants................................................ 143,
385
string conversion..................................................... 119
string expressions.................................................... 147
string of digits............................................................ 29
string replacement, Hpmodify.................................. 190
string truncation....................................................... 120
string, as a delimiter................................................. 250
string, heading command......................................... 257
strings...................................................................... 380
stty, terminal settings................................................. 45
sub totaling................................................................ 38
subcommands, Dbedit............................................. 301
subfile script.............................................................. 70
subfiles, PowerHouse........................................ 70,
333
subscript parameter.................................. 111,
222, 381
subscript parameter, character.................................. 144
subscript parameter, Define....................................... 95
subscript parameter, numeric................................... 144
substrings................................................................ 144
subtotals............................................................. 37,
104
Subtract Days.......................................................... 115
sum of field values................................................... 222
summary of STExport............................................. 239
summary of Suprlink............................................... 327
Super Cartridge........................................................ 172
Supramxw differences............................................... 54
Suprhint.Help.Robelle............................................. 202
Suprlink............................................................. 17,
181
Suprlink commands................................................. 335
Suprlink, using from Suprtool................................. 325
Suprlist file.............................................................. 318
Suprmgr files....................................................... 46,
48
Suprtool dynamic loading.......................................... 45
Suprtool in Suprlink................................ 328,
346, 348
Suprtool package....................................................... 16
Suprtool Road Map................................................... 23
Suprtool2 error messages........................................ 376
Suprtool2 routine..................................................... 365
Suprtool2, Installation.............................................. 374
SuprtoolOutCount JCW.......................................... 368
Suspend option on Exit.................................... 253,
341
Table command........................................................ 218
Table command, decimal places............................... 219
Table, $lookup........................................................... 31
table, HTML option................................................. 260
tables........................................................................ 381
tables in Chain command........................................... 91
tables, holding between Xeqs.................................. 219
tables, maximum size............................................... 204
tape files................................................................... 159
tape files of large size................................................. 57
Target field, Extract command................................. 116
task, what is a task............................................... 25,
60
terminology.............................................................. 322
third-party indexing......................................... 136,
234
ThousandSymbol, Set option................................... 214
time format in List............................................ 173,
207
Time, Set List........................................................... 207
title, HTML option................................................... 260
TMPDIR................................................................... 81
TMPDIR variable.................................................... 217
today function of Extract.......................................... 113
today function of If.................................................. 152
Total command........................................................ 222
Total, output restrictions.......................................... 106
totaling....................................................................... 38
totaling duplicate records......................................... 104
totals to a file............................................................ 222
totals,running............................................................. 38
trailing sign.............................................................. 278
trimming spaces............................................... 121,
150
truncate function.............................................. 118,
147
truncation, numeric.................................................. 146
truncation, strings.................................................... 120
two-digit years........................................................... 73
type parameter.............................................. 95,
96, 167
Under option, Dbedit............................................... 301
Underline, Set option............................................... 319
Undo edit, Hpmodify............................................... 190
unsigned value......................................................... 125
Update command............................................. 207,
224
Updatekey option, Dbedit........................................ 301
upper-case........................................................ 120,
150
upshifting strings..................................................... 120
Use command.................................. 225,
280, 320, 357
Use command with If $read..................................... 157
user specified heading.............................................. 257
Userpause command................................................ 227
-v option.................................................................... 47
value tests................................................................ 141
variable length strings...................................... 120, 147
Variable substitution.................................................. 82
Variable Substitution, Set option............................. 214
variable-length, output file....................................... 246
Varsub, Set option................................................... 355
Verify command...................... 217,
228, 281, 321, 358
Verify, Set option.................................................... 319
warning messages............................................ 234,
381
warning, delete all records....................................... 100
Warnings, Set.......................................................... 276
Web server............................................................... 262
Web, html................................................................ 260
What is AMXW........................................................ 53
Xeq command, STExport................................ 253,
282
Xeq command, Suprlink.................................. 341,
359
Xeq command, Suprtool.................................. 108,
229
Xeq option on Exit................................... 108,
253, 341
XML command....................................................... 283
Xmltagchar, Set....................................................... 277
XSORT................................................................... 202
Year 2000................................................................ 199
Year 2000 testing....................................................... 80
yes answer to questions................................... 233, 382
yes response in pseudo-batch.................................. 378
yyymmdd date format.............................................. 163
Zero command......................................................... 286
zoned constants........................................................ 112
zoned-decimal, illegal digits..................................... 331
