7 24 1 DEF_REPORT Parameters

LANSA Technical

7.24.1 DEF_REPORT Parameters

COPIES

FORMSIZE

FORMTYPE

LAST_LINE

OTHER_OVR

OUTQ

OVERFLOW

PRT_FILE

REPORT_NUM

RET_LENGTH

RET_LINE

RET_OVERF

RET_PAGE

RET_WIDTH

REPORT_NUM

Specifies the report which is to be defined by this command. Up to 8 reports can be produced by a function at one time. Each report is identified by a number in the range 1 to 8. The default value for this report is report number 1.

PRT_FILE

IBM i use only

Specifies the name and library of residence of the IBM i printer file that should be used to produce this report.

QSYSPRT.*LIBL, which is the default value, indicates that the IBM supplied default printer file QSYSPRT (which is to be located by using the job's library list) should be used to produce this report.

Optionally, specify the name of an IBM i printer file and either *LIBL or the library in which the file resides. Printer files must be created using CRTPRTF command and are used to describe various attributes of the printer file. Refer to the appropriate IBM manual for details of the CRTPRTF command.

Printer files other than QSYSPRT are usually only required when some "special" printer file attributes are required for the report. An example might be when the lines per inch, characters per inch or printer quality attributes are different to those in the IBM supplied default printer file QSYSPRT.

When a printer file is specified, spool file User Data must be specified in the printer file or, for RDMLX, the OTHER_OVR parameter.

FORMSIZE

Specifies the length and width of the form that the report is to be produced on.

Not supported in RDMLX.

*DEFAULT/*DEFAULT, which are the default values, indicate that the formsize parameters should be extracted from the LANSA system definition block. Refer to The System Definition Data Areas in the LANSA for i User Guide for details of the system definition block and how it can be changed. In the shipped LANSA system definition block the form length is set at 66 and the form width at 132.

*FILE/*FILE, indicate that the form size parameters should be extracted from the values specified on the printer file. These values are only taken at execution time.

Otherwise nominate the length and width of the form on which the report is to be produced.

LAST_LINE

Specifies the last line upon which report detail lines (DEF_LINE and DEF_BREAK lines) should be allowed to be printed.

Not supported in RDMLX.

*DEFAULT, which is the default value, indicates that the value used should be calculated as 3 less than the overflow line specified in the system definition block. In the shipped version of LANSA the overflow line number is set at 60, so the default last print line number is 57.

*FILE, indicates that the value used should be calculated as 3 less than the overflow line specified on the printer file.

Otherwise, specify the last print line number required.

OVERFLOW

Specifies overflow line number to be used for the report. No print line (no matter what type) can be printed beyond the overflow line on a report.

Not supported in RDMLX.

*DEFAULT, which is the default value, indicates that the overflow parameters should be extracted from the LANSA system definition block. Refer to The System Definition Data Areas in the LANSA for i User Guide and how it can be changed. In the shipped LANSA system definition block the overflow line number is set to 60.

*FILE, indicates that the overflow parameters should be extracted from the printer file.

Otherwise nominate overflow line number required.

Note: Report footlines can only be defined on lines beyond the last print line and up to and including the overflow line. Thus if LANSA shipped values are used, report footlines can only be defined on lines 58 to 60.

OUTQ

Specifies the output queue name for the spooled output file. Note that library name cannot be specified for the OUTQ parameter.

*FILE indicates that the output queue name should be taken from the default output queue name for the printer file.

COPIES

Specifies the number of copies that are to be produced for the report. A value from 1 to 255 is allowed.

*FILE indicates that the number of copies should be taken from the default value for the printer file.

FORMTYPE

Specifies the type of forms used in the printer for the report. If a form type other than the default is used, the system (when the output is produced) sends a message that identifies the form type to the system operator and requests that the specified type of forms be put in the printer.

*FILE indicates that the form type should be taken from the default value for the printer file.

OTHER_OVR

Additional IBM i printer file override options can be specified in this parameter, for example HOLD(*YES). Refer to the IBM Control Language Reference Manuals for additional overrides. The following overrides cannot be specified in this parameter as they are already handled within the DEF_REPORT command:

FILE

LVLCHK   - (specified as *NO)

TOFILE

SECURE   - (specified as *NO)

OVRFLOW   

SHARE    - (specified as *NO)

OUTQ       

PAGESIZE - (on the IBM i)

FORMTYPE  

COPIES

*NONE indicates that there are no additional overrides.

Note - this parameter allows entry of additional printer file overrides which rely heavily on IBM i features - this must be taken into consideration when future use on other platforms may be likely.

RET_LENGTH

Specifies whether the form length should be returned into the field named in the parameter. The field must be defined as a numeric field.

*NONE indicates that the form length will not be returned.

RET_WIDTH

Specifies whether the form width should be returned into the field named in the parameter. The field must be defined as a numeric field.

*NONE indicates that the form width will not be returned.

RET_OVERF

Specifies whether the overflow value for the printer file should be returned into the field named in the parameter. The field must be defined as a numeric field.

*NONE indicates that the overflow value will not be returned.

RET_LINE

Specifies whether the current line number for the printer file should be returned into the field named in the parameter. The field must be defined as a numeric field.

*NONE indicates that the current line number will not be returned.

RET_PAGE

Specifies whether the current page number should be returned into the field named in the parameter. The field must be defined as a numeric field.

Note that the page number is always returned after the first line of a page is printed. This means that the page number in RET_PAGE is always 1 page behind the printed page.

*NONE indicates that the current page number will not be returned.