HP 3000 Manuals HP 3000 Manuals
The Header Specification Fields
The fields you can use in the Header Specification are described in the
sections which follow in this chapter. Each field has a unique name and
occupies specific positions (columns) in the specification.
Sequence Number (Columns 1-5)
The Sequence Number Field contains the source record sequence number,
described in Chapter 2.
Specification Type (Column 6)
This field contains an H to identify this line as a Header Specification.
Error Dump File Name (Columns 7-14)
This field identifies the file to which Error Dumps are written.
--------------------------------------------------------------------------------------------
| | |
| Columns 7-14 | Description |
| | |
--------------------------------------------------------------------------------------------
| | |
| File name | Valid file name. (File names contain from one to eight |
| | characters, beginning with a letter. The remaining characters |
| | can be letters or digits. Embedded blanks are not allowed.) If |
| | the file does not exist at run time, the Error Dump is written |
| | to the standard list device ($STDLIST). |
| | |
| blank | Write the Error Dump to the standard list device ($STDLIST). |
| | |
--------------------------------------------------------------------------------------------
Debug (Column 15)
This field determines whether or not Calculation Specification DEBUG
operations will be executed.
--------------------------------------------------------------------------------------------
| | |
| Column 15 | Description |
| | |
--------------------------------------------------------------------------------------------
| | |
| 1 | Execute all DEBUG operations. |
| | |
| blank | Suppress all DEBUG operations; the compiler treats DEBUG |
| | operations as comments. |
| | |
--------------------------------------------------------------------------------------------
The DEBUG Calculation Specification operation lets you monitor the status
of various indicators while the program is executing. This is very
helpful when debugging the program. You can use as many DEBUG operations
as you wish, and this field acts as a switch to allow or disallow their
execution.
USWITCH Source (Column 16)
This field lets you specify where to get the initial values for the user
indicators (U1-U8). You only need to specify the source for those
indicators actually used in the program.[REV BEG] When the program ends,
it updates the JCW to reflect the condition of the indicators that were
actually used; the others are left unchanged.[REV END]
--------------------------------------------------------------------------------------------
| | |
| Column 16 | Description |
| | |
--------------------------------------------------------------------------------------------
| | |
| F | Initialize user indicators from USWITCH records contained in the |
| | file whose formal designator is USWITCH. |
| | |
| blank | If running a job stream, initialize user indicators from USWITCH |
| (job stream) | records contained in the job file. |
| | |
| J | Initialize user indicators from the job or session Job Control |
| | Word (JCW). |
| | |
| blank | If running an interactive session, initialize user indicators by |
| (interactive) | prompting for their initial settings. |
| | |
--------------------------------------------------------------------------------------------
F (USWITCH File)
USWITCH records are read from the file whose formal designator is
USWITCH. USWITCH records can have either a long or short format (see
"Long Format USWITCH Records" and "The Short Format USWITCH Record" which
follow).
When the program is executed from a job stream, initial settings of the
user indicators are written to the job stream listing.
Run-time USWITCH errors are listed separately in appendix B.
Blank (Job Stream)
USWITCH records are read from the batch job stream immediately following
the command that executes the program. USWITCH records can have either a
long or short format (see "Long Format USWITCH Records" and "The Short
Format USWITCH Record" which follow).
When the program begins, the initial settings of the user indicators are
written to the job stream listing.
Run-time USWITCH errors are listed separately in appendix B.
Long Format USWITCH Records
Long Format records are used with USWITCH Source codes F and blank (job
stream). You can use as many Long Format records as necessary. Enter
them in the following format:
{ON } {ON } {ON }
USWITCH: [Ui={OFF}],[Ui={OFF}]...[Ui={OFF}]
{JCW} {JCW} {JCW}
Start USWITCH: in column 1 and end it in column 8. The Ui parameters can
appear in any order (for instance, U3=ON,U4=ON,U1=ON...). If you omit a
user indicator, that indicator is turned OFF. If you enter U1 only, or if
you use an entry other than ON, OFF, or JCW, the corresponding user
indicator is turned OFF. If the same indicator is entered twice, the
second parameter overrides the first. For instance, U1=ON,U3=OFF,U1=OFF
is equivalent to U1=OFF,U3=OFF.
You can enter Long Format records in free format; that is, blanks can
appear between USWITCH: and the parameter list, or between individual
parameters or subparameters. You can continue the parameter list onto
one or more USWITCH records without using a continuation character, but
do not split a parameter between records.
If Long Format USWITCH records reside in a job file, end them with a line
containing two asterisks (columns 1-2).
The Short Format USWITCH Record
The Short Format USWITCH record is compatible with other implementations
of RPG and it is easy to use. Enter settings for all eight user
indicators in this format:
{1} {1} {1} {1}
USWITCH: {0} {0} {0}...{0}
{X} {X} {X} {X}
Enter USWITCH: in positions 1-8. Each parameter after USWITCH: stands
for the settings of user indicators U1-U8. Do not include blanks between
user indicator parameters. One (1) turns the corresponding user
indicator ON, zero (0) turns the corresponding user indicator OFF, and X
initializes the corresponding indicator to the value previously
established for it in the JCW.
If you use the short format record in a USWITCH file, you may follow it
with a line containing asterisks in positions 1-2 (this is optional). If
you use the short format record in a job stream, do not follow the record
with asterisks in positions 1-2.
Examples
The following example shows how to enter a job file containing a program
that reads user indicators from a USWITCH file (the contents of the
USWITCH file are listed after the job file):
!JOB USER.ACCT (Begin job)
.
.
.
!FILE USWITCH=SWITCH2 (USWITCH recs read from file SWITCH2)
!RUN PROG3 (Execute PROG3: Header column 16 = F)
(No USWITCH recs read from job stream)
!EOJ (Terminate job)
The contents of the file, SWITCH2, are:
USWITCH: U1=ON
USWITCH: U2=JCW
USWITCH: U8=ON
**
The next example is the same as the previous one except that it is run in
a session, not in a job stream:
:HELLO USER.ACCT (Begin session)
.
.
.
:FILE USWITCH=SWITCH2 (USWITCH recs read from file SWITCH2)
:RUN PROG3 (Execute PROG3: Header column 16 = F)
. (No prompting for USWITCH values)
.
.
:BYE (End session)
The following example shows how to enter Long Format USWITCH records in a
job file:
!JOB USER.ACCT (Begin job)
.
.
.
!RUN PROG1 (Execute PROG1: Header column 16 = blank)
USWITCH: U1=ON,U2=JCW (Set U1 ON and U2 to previous setting)
USWITCH: U8=ON (Set U8 ON; U3-U7 default to OFF)
** (Terminate reading of USWITCH records)
!EOJ (Terminate job)
The last example shows how to enter the Short Format USWITCH record in a
job file:
!JOB USER.ACCT (Begin job)
.
.
.
!RUN PROG2 (Execute PROG2: Header column 16 = blank)
USWITCH: 1X000001 (Set U1, U8 ON; U2 to previous setting)
(No ** record after Short Format record)
!EOJ (Terminate job)
J (JCW)
[REV BEG]
Entering a J in column 16 initializes the user indicators with the values
in the system JCW. The JCW may have been set by another program running
in the same job or session, or by the system command SETJCW. You can pass
indicator settings from one RPG program to another through the JCW. RPG
always updates the JCW with the final settings of any user indicators
actually used in the program, regardless of the entry in column 16. Just
specify a J in column 16 of the Header Specification in the second
program, and the user indicators are set the same as when the first
program ended.[REV END]
The user indicators occupy bits 8-15 of the JCW. For example, if bit 8 is
ON, user indicator 1 is ON. If bit 9 is ON, user indicator 2 is ON and so
on.
If the RPG program is executed from a job stream, the initial settings of
all user indicators are printed in the job listing after the command that
executes the program.
Example
The following session dialogue shows how to turn ON user indicators U1,
U2, and U8 in the JCW. This is accomplished by the SETJCW command. The
JCW is set to the octal value, 301. Since the binary equivalent of octal
301 is 00000000 11000001, bits 8, 9, and 15 are turned ON. The session
then executes PROG6 and PROG7 which are RPG programs that contain a J in
column 16 of the Header Specification. User indicators are passed
automatically from PROG6 to PROG7.
:HELLO USER.ACCT (Begin session)
.
.
.
:SETJCW JCW=%301 (JCW = %301 = Binary [11000001])
:RUN PROG6 (Execute PROG6: Header col 16 = J)
(no prompting for USWITCH values)
:RUN PROG7 (Execute PROG7: Header col 16 = J)
.
.
:BYE (End session)
Blank (Interactive)
If column 16 contains a blank and the program is run from a session, RPG
prompts you as follows to enter the initial user indicator settings:
PLEASE INPUT USER SWITCH Ui=?
Enter ON, OFF, or JCW (typing RETURN is the same as OFF). JCW directs RPG
to get the user indicator settings from the JCW (see the discussion of
the value J for this field). Entering some other value turns the user
indicator OFF. The above prompt is repeated for each user indicator in
the program. When all of the indicators are entered, the program begins.
Example
The following session dialogue shows how to turn ON user indicators U1
and U2:
:HELLO USER.ACCT (Begin session)
.
.
.
:RUN PROG5 (Execute PROG5)
PLEASE INPUT USER SWITCH U1=?ON (Turn ON user indicator U1)
PLEASE INPUT USER SWITCH U2=?ON (Turn ON user indicator U2)
.
.
.
:BYE (End session)
UDATE Source (Column 17)
This field lets you determine where to get the initial values for the
predefined fields: UDATE, UDAY, UMONTH, and UYEAR.
--------------------------------------------------------------------------------------------
| | |
| Column 17 | Description |
| | |
--------------------------------------------------------------------------------------------
| | |
| F | Initialize UDATE, UDAY, UMONTH, and UYEAR using the date record |
| | in the file whose formal designator is RPGUDATE. |
| | |
| blank | Initialize UDATE, UDAY, UMONTH, and UYEAR using the system date. |
| | |
--------------------------------------------------------------------------------------------
F (Date Record)
Before running the program, enter an operating system :FILE command to
equate the formal file designator RPGUDATE to the actual file that holds
the date record. Equating RPGUDATE to $STDIN lets you enter the date
record interactively or include it in a job file. Using a date record in
the job file simulates the IBM //DATE OCL command.
You can enter the date (in the date record) in a flexible manner. The
first number begins the date (the number does not have to start in column
1). Enter the date as six consecutive digits (mmddyy) or in three sets
of two digits (mm, dd, and yy). Enter the month number (mm), the year
(yy) then the day (dd).
If mm, dd, and yy are all equal to zero, or the file RPGUDATE is equated
to $NULL, RPG uses the system date (this is a technique for defaulting to
the system date without removing the F from column 17 and recompiling the
program).
The following lines show valid ways to enter date records. Assuming the
system date is 04/10/88, all of the examples produce this date. Since
the first and last dates are zeros, they default to the system date:
000000
041088
//DATE 041088
DATE is 041088
FORMAT OF DATE IS MMDDYY = 041088
4/10/88
MONTH IS 4; DAY IS 10; YEAR IS 88
0 0 0
The following are examples of invalid date records:
4/10 (the year is missing)
4/10/1988 (the year must be 00 to 99)
040088 (the day must be 01 to 31)
If the date file does not exist, is empty, or contains invalid records,
the program ends immediately and an error message is displayed.
Example
The following job file executes the program, MYPROG, which reads the
current date from the job file. The date is 041088:
!FILE RPGUDATE = $STDIN
!RUN MYPROG
USWITCH: U1 = ON
**
//DATE 041088
Line Number Option (Column 20)
This field determines whether the source program line number is displayed
when run-time errors occur. When this option is enabled, RPG keeps track
of each source line number that is executed. Disabling this option
results in a smaller executable program and faster execution.
--------------------------------------------------------------------------------------------
| | |
| Column 20 | Description |
| | |
--------------------------------------------------------------------------------------------
| | |
| N | Do not keep track of source program line numbers. |
| | |
| blank | Keep track of source program line numbers. |
| | |
--------------------------------------------------------------------------------------------
Inverted Print (Column 21)
This field determines how numeric literals, edit code data, and UDATE
dates are formatted. (UDATE and numeric literals are used in
Calculation and Output Specifications. Edit codes are used in Output
Specifications.)
--------------------------------------------------------------------------------------------
| | |
| Column 21 | Description |
| | |
--------------------------------------------------------------------------------------------
| | |
| D | United Kingdom format. |
| | |
| I | European format. |
| | |
| J | European format with leading zero. |
| | |
| blank | Domestic format. |
| | |
--------------------------------------------------------------------------------------------
D (United Kingdom Format)
Periods are used as decimal points; the thousands positions are separated
by commas. Leading zeros are suppressed. Dates are printed in the
format dd/mm/yy.
I (European Format)
Commas are used as decimal points; the thousands positions are separated
by periods. Leading zeros are suppressed. Dates are printed as
dd.mm.yy.
J (European Format with Leading Zero)
Commas are used as decimal points; the thousands positions are separated
by periods. Leading zeros are suppressed up to one position before a
decimal point. Dates are printed in the format dd.mm.yy.
Blank (Domestic Format)
This format is used in the United States. Periods are used as decimal
points in numeric literals and edited data; thousand-units are separated
by commas. Leading zeros are suppressed. When used with Edit Code Y,
dates are printed in the format mm/dd/yy.
Table 3-1 shows the various Inverted Print options and the different
results they produce.
Table 3-1. Results of the Inverted Print Options
-------------------------------------------------------------------------------------------------------
| | | | | | |
| Column | Format | Numeric Literal, | Edit Code Field, | Zeros | UDATE |
| 21 | | Period or | Period or | Suppressed | Slash or |
| | | Comma as | Comma as | Left of | Period |
| | | Decimal Point | Decimal Point | Decimal | |
| | | | or Separator | Point | |
| | | | | | |
-------------------------------------------------------------------------------------------------------
| | | | | | |
| D | United | 1986.19 | 9,762.55 | .14 | 24/06/86 |
| | Kingdom | | | | |
| | | | | | |
| I | European | 1986,19 | 9.762,55 | ,14 | 24.06.86 |
| | | | | | |
| J | European | 1986,19 | 9.762,55 | 0,14 | 24.06.86 |
| | (w/lead | | | | |
| | zero) | | | | |
| | | | | | |
| blank | Domestic | 1986.19 | 9,762.55 | .14 | 06/24/86 |
| | | | | | |
-------------------------------------------------------------------------------------------------------
Record Number Adjust (Column 22)
This field gives the adjustment to relative record numbers before they
are used to retrieve records in direct-access MPE and Keyed Sequential
Access Method (KSAM) files (the KSAM/3000 Reference Manual discusses the
use of relative record numbers with KSAM).
This field has no effect for TurboIMAGE files.
--------------------------------------------------------------------------------------------
| | |
| Column 22 | Description |
| | |
--------------------------------------------------------------------------------------------
| | |
| 1 | RPG subtracts one from all relative record numbers obtained from |
| | an ADDROUT file, chaining file, or chaining operation before |
| | using the numbers for direct file access. This option is |
| | ignored for KSAM files built with the FIRSTREC=1 option. |
| | |
| + | RPG adds one to all relative record numbers obtained from an |
| | ADDROUT file, chaining file, or chaining operation before using |
| | the numbers for direct file access. This option does not apply |
| | to KSAM files built with the FIRSTREC=1 option. |
| | |
| 0 or blank | RPG does not adjust relative record numbers before using them |
| | for direct file access. |
| | |
--------------------------------------------------------------------------------------------
Program Name Logging (Column 25)
This field determines whether a program identification line is written to
the standard list device ($STDLIST) when the program begins and when it
ends normally.
--------------------------------------------------------------------------------------------
| | |
| Column 25 | Description |
| | |
--------------------------------------------------------------------------------------------
| | |
| L | Write a program identification line on $STDLIST when the program |
| | begins and when it ends. |
| | |
| blank | Do not write program identification lines. |
| | |
--------------------------------------------------------------------------------------------
The beginning identification line lists the source program name entered
in columns 75-80 of the Header Specification (or entered in the NAME=
parameter of the $CONTROL compiler subsystem command) and the date and
time.
Example
The program, AP320P, in the group PROGRAM and account AP is executed.
Its source program name is AP320S. The beginning identification line
looks like this:
Program: AP320S = AP320P.PROGRAM.AP Wed, Nov 02, 1988, 07:40 AM
The ending identification line looks like this:
Pgm-End: AP320S = AP320P.PROGRAM.AP Wed, Nov 02, 1988, 08:10 AM
Alternate Collating Sequence (Column 26)
This field lets you use a collating sequence other than the ASCII
Collating Sequence (or JIS-Japanese Industrial Standard-Katakana) for
certain comparison operations. Alternate collating sequences do not
affect control levels, numeric comparisons, table look-up operations, or
the SORTA operation.
--------------------------------------------------------------------------------------------
| | |
| Column 26 | Description |
| | |
--------------------------------------------------------------------------------------------
| | |
| E | EBCDIC (Extended Binary Coded Decimal Interchange Code) |
| | collating sequence applies. |
| | |
| K | EBCDIK collating sequence applies. |
| | |
| O | Alternate collating sequence, specified in octal format, |
| | applies. |
| | |
| S | Alternate collating sequence, specified in hexadecimal format, |
| | applies. |
| | |
| blank | Normal ASCII (JIS) collating sequence applies. |
| | |
--------------------------------------------------------------------------------------------
E (EBCDIC)
An E in the Alternate Collating Sequence field selects the Extended
Binary Coded Decimal Interchange Code (EBCDIC). Use this when you need to
read data prepared on EBCDIC-based computer systems or when the data must
be interpreted in that sequence.
In EBCDIC, alphabetic characters are lower than numeric characters. In
ASCII sequence, numbers are lower than alphabetic characters. Codes for
special characters are also different for the two collating sequences.
O (Alternate Collating Sequence - Octal)
You must enter one or more ALTSEQ records that specify (in octal) the
alternate sequences for specific characters. (Refer to Appendix D for
ASCII and octal equivalences.) You can enter ALTSEQ records in a job
stream or in a separate disk file. Placing them in a separate file means
that other programs can use them also.
Table 3-2 shows the format for ALTSEQ records in octal.
Table 3-2. ALTSEQ Record Description for Octal Format
-----------------------------------------------------------------------------------------------
| | | |
| Column | Value | Description |
| | | |
-----------------------------------------------------------------------------------------------
| | | |
| 1-6 | ALTSEQ | This is an ALTSEQ record. |
| | | |
| 7-8 | blank | None. |
| | | |
| 9-14 | Two ASCII (JIS) | The first character (columns 9-11) replaces |
| | characters, specified by | the second character (columns 12-14) in the |
| | sequence number in octal. | ASCII (JIS) Collating Sequence. |
| | | |
| 15-80 | Two ASCII (JIS) | Same meaning as columns 9-14, repeated as |
| | characters, specified by | needed. |
| | sequence number in octal. | |
| | | |
-----------------------------------------------------------------------------------------------
Example
Assume that the letter A (octal 101) must be changed to the letter Z
(octal 132) and the letter B (octal 102 must be changed to the letter Y
(octal 131). Y and Z retain their normal values. The upper case
alphabetical character set would look like this using the alternate
collating sequence:
Z Y C D E . . . W X Y Z
The following ALTSEQ record specifies this alternate sequence for A and
B:
ALTSEQ 132101131102
Figure 3-2 shows how to enter specifications that use an alternate
collating sequence expressed in octal. Line 1 contains an O in column 26
to select the alternate collating sequence in octal. Line 2 contains an
Array/Table File Name Specification (A) to name the file (FILEB)
containing the ALTSEQ record shown above.
___________________________________________________________________________________
| |
| 1 2 3 4 5 6 7 |
| 678901234567890123456789012345678901234567890123456789012345678901234|
| _______________________________________________________ |
| |
| 1 H O |
| . |
| . |
| . |
| |
| 2 AFILEB |
| |
| |
___________________________________________________________________________________
Figure 3-2. Specifying an Alternate Collating Sequence in Octal Code
S (Alternate Collating Sequence - Hexadecimal)
You must enter one or more ALTSEQ records that specify (in hexadecimal)
the alternate sequences for specific characters. (Refer to Appendix D
for ASCII and hexadecimal equivalences.) You can enter ALTSEQ records in
a job stream or in a separate disk file. Placing them in a separate file
means that other programs can use them also.
Table 3-3 shows the format for ALTSEQ records in hexadecimal.
Table 3-3. ALTSEQ Record Description for Hexadecimal Format
-----------------------------------------------------------------------------------------------
| | | |
| Column | Value | Description |
| | | |
-----------------------------------------------------------------------------------------------
| | | |
| 1-6 | ALTSEQ | This is an ALTSEQ record. |
| | | |
| 7-8 | blank | None. |
| | | |
| 9-12 | Two ASCII (JIS) | The first character (columns 9-10) replaces |
| | characters, specified by | the second character (columns 11-12) in the |
| | sequence number in | ASCII (JIS) Collating Sequence. |
| | hexadecimal. | |
| | | |
| 13-80 | Two ASCII (JIS) | Same meaning as columns 9-12, repeated as |
| | characters, specified by | needed. |
| | sequence number in | |
| | hexadecimal. | |
| | | |
-----------------------------------------------------------------------------------------------
Example
(This is the same example as shown for Alternate Collating Sequence code
O except that hexadecimal notation is used to specify the alternate
sequence.)
Assume that the letter A (hexadecimal 41) must be changed to the letter Z
(hexadecimal 5A) and the letter B (hexadecimal 42) must be changed to the
letter Y (hexadecimal 59). Y and Z retain their normal values. The
upper case alphabetical character set would look like this using the
alternate collating sequence:
Z Y C D E . . . W X Y Z
The following ALTSEQ record specifies this alternate sequence for A and
B:
ALTSEQ 5A415942
Figure 3-3 shows how to enter the specifications that process an
alternate collating sequence in hexadecimal. Line 1 contains an S in
column 26 to select the alternate collating sequence in hexadecimal.
Line 2 contains an Array/Table File Name Specification (A) to name the
file (FILEA) containing the ALTSEQ record shown above.
___________________________________________________________________________________
| |
| 1 2 3 4 5 6 7 |
| 678901234567890123456789012345678901234567890123456789012345678901234|
| _______________________________________________________ |
| |
| 1 H S |
| . |
| . |
| . |
| |
| 2 AFILEA |
| |
| |
___________________________________________________________________________________
Figure 3-3. Specifying an Alternate Collating Sequence in Hexadecimal Code
BUFCHK Defaults (Column 28)
This field lets you specify the BUFCHK options to apply to all files.
The options are: Current Data Checking (CDC), No-Read Checking (NRC),
and Update-Protect Checking (UPC). You can override these values for
individual files by using the Option Type Field of the File Description
Continuation line (see the BUFCHK entry for the Option Type Field in
Chapter 4).
--------------------------------------------------------------------------------------------
| | |
| Column 28 | Description |
| | |
--------------------------------------------------------------------------------------------
| | |
| B | Enable both CDC and NRC. |
| | |
| C | Enable CDC for all Sequential MPE and KSAM files that specify a |
| | LOCK File Description Continuation line and that are linked to |
| | another file at run time by MPE FILE equations. |
| | |
| N | Enable NRC for all update files. |
| | |
| U | Enable UPC and NRC for all update files. |
| | |
| X | Enable CDC, NRC, and UPC. |
| | |
--------------------------------------------------------------------------------------------