Report Parameters Fillin

Fill-In Descriptions › Report Parameters Fillin

Report Parameters Fillin

Report parameters are specified on the report parameter fill‑in. It is an optional form that selects general report layout options such as a report's length and width on a page, the spacing between lines and columns, column headings, control breaks, heading definition, summary information, and date and page specification. If this fill‑in is not completed, default values are used for any required parameters. There are three ways to display the report parameters fill‑in, as follows:

To display the parameters fill‑in for a report that is not the current entity, enter

DISPLAY REPORT name PARAMETER

on the command line

To display the parameters fill‑in for the current report, either enter the command PARAMETER on the command line, or press the F4 key.

The following screen shows the Parameters fill‑in.

 =>
‑‑‑‑‑‑‑‑‑‑‑‑‑‑‑‑‑‑‑‑‑‑‑‑‑‑‑‑‑‑‑‑‑‑‑‑‑‑
 IDEAL   : RPT PARAMETERS        RPT CUSTRPT  (001) TEST       SYS: DOC  FILL‑IN
 Lines per page on printout           ___  (0 thru 250)
 Report width                         ___  (40 thru 230)    
Spacing between lines                 _    (1 thru 3)  
Spacing between columns               __   (0 thru 66 OR A=Automatic) 
Spacing after page and column hdgs    _    (0 thru 9)  
Summaries only                        _    (Y=Yes,N=No)
 Column headings desired              _    (Y=Yes,N=No)
 Column headings indication           _    (U=Underscore,N=None,D=Dashes)  
Control break heading                 _    (Y=Yes,N=No)
 Control break footing                _    (Y=Yes,N=No)
 Automatic page footing summaries     _    (Y=Yes,N=No)
 Group continuation at top of page    _    (Y=Yes,N=No)
 Annotated count in break footings    _    (Y=Yes,N=No)
 Report final summary title           _    (Y=Yes,N=No)
   Spacing before summary             _    (1 thru 9 = Lines,P=New Page)   
   Title    __________________________________________ 
 Date
   Position           __   (NO=None, BR=Bot.Right, BL=Bot.Left, BC=Bot.Ctr.,    
                            TR=Top Right, TL=Top Left, TC=Top Center)
   Format             MM/DD/YY
 Page Numbers  
   Position           __ 
   Format             _    (D=Digits Only, H=With Hyphens, P= Page       nnn)   
Page Heading  
   Heading            __________________________________________ 
   Position           _    (C=Center, L=Left Justify, R=Right Justify)

Enter the following information on the Parameter fill‑in:

Lines per page on printout

Specify number from 0 to 250 that indicates the total number of lines for each page of the report. This includes all headings, footings, details, and blank lines. Specify 0 to suppress page breaks.

The Lines per page parameter determines when a page break occurs. RDF first determines the number of lines required for the page after the page heading, column headings, page footing, and associated spacing. This value is subtracted from the Lines Per Page specification. The remaining lines are available for the page body, which consists of the details and the control break headings and footings.

If a complete detail does not fit on the page, a page break occurs. When a detail that causes a control break is produced, a page break occurs if the appropriate control break heading and footing do not fit on the page. In this case, the detail and the footing for the current control break group print on the next page.

You can set a session default for this parameter with the command SET RPT LINES. If a default was set, it appears on the Parameters fill‑in when it first displays. You can change the default by typing over the displayed value.

Report width

A number from 40 to 230 that specifies the number of characters per line.

You can set a session default for this parameter with the command SET RPT WIDTH. If a default was set, it appears on the Parameters fill‑in when it first displays. You can change the default by typing over the displayed value.

Spacing between lines

A number from 1 to 3 that specifies the number of blank lines left between printed detail lines:

Single spacing, no blank lines.
Double spacing, one blank line.
Triple spacing, two blank lines.

You can set a session default for this parameter with the command SET RPT SPACING. If a default was set, it appears on the Parameters fill‑in when it first displays. You can change the default by typing over the displayed value.

Spacing between columns

A number from 0 to 66 or the code A. This value specifies the number of blank characters left between columns on detail lines. A number indicates the exact number of spaces between columns. A value of 0 means that columns are concatenated.

The value A indicates that spacing is automatic. The total number of spaces left after subtracting all column widths from the report width is proportionally distributed among the columns and the right and left margins. When you use automatic spacing, if a column does not fit on a line, a warning message occurs during the compile.

You can set a session default for this parameter with the command SET RPT GAP. If a default is set, it appears on the Parameters fill‑in when it first displays. You can change the default by typing over the displayed value.

Spacing after page and column headings

A number from 0 to 9 that specifies the number of blank lines after the page heading detail line, column heading detail line, or continuation line and before the first body line of the report.

Note: You must specify a minimum value of 1 in the REPORT PARAMETER under “spacing after page and column headings” to generate the correct carriage control for reports that do not have any DETAIL lines and, therefore, no COLUMN headings and no PAGE headings defined.

A value of 1 for one blank line is the default. To change the default value, type a new value over the current value.

Summaries only

Specifies whether detail lines print:

Y Only the summary lines at each control break print.
N Detail lines print (default).

Column headings desired

Specifies whether column headings print:

Y Defined column headings are included in the report (default).
N Column headings do not print.

Column heading indication

Specifies how column headings are highlighted:

U Column headings are underscored.
D A series of dashes print on a separate line beneath the column heading (default).
N No highlighting.

Control break heading

Specifies whether standard headings print when a control break occurs. The default control break heading consists of asterisks followed by the control field column heading and the control field value. Two asterisks are added for each level of the control break. A level‑1 control break is preceded by two asterisks. A level‑2 control break is preceded by four asterisks, and so on.

Y Control break headings are printed at the beginning of each control group.
N Suppresses the printing of default control break headings. User‑specified control break headings are not suppressed.

Control break footing

Specifies whether standard footings print when a control break occurs. The default control break footing consists of the control field column heading and the control field value.

Y Control break footings are printed at the end of a control group.
N Suppresses the printing of control group footings.

Automatic page footing summaries

Specifies whether summary and annotated value functions (TOT, MIN, MAX, AVG) in Detail fill‑in print in the page footing. The page footing contains the requested values for only the current page.

Y Summary and annotated lines print as part of the page footing on the line below the footing title.
N Summary and annotated lines do not print as part of the page footing (default).

Group continuation at top of page

Specifies whether control headings print at the top of a new page when a control break did not occur.

Y Control headings, if any, print at the top of the page followed by (CONT.). The continued indicator (CONT.) prints for every line of the control heading. However, if the control heading uses the entire width of the line, the continued indicator is truncated. Control field values, if any, print at page breaks, regardless of whether the value changed.
N Control fields do not print after a page break when there is no change in the control value.

If control breaks are set for the fields STATE (level 1) and CITY (level 2) and a page break occurs in the middle of details from San Francisco, California, the following headings appear at the top of the page when Group Continuation is set to Y:

** STATE CA (CONT.)
**** CITY SAN FRANCISCO (CONT.)

If Group Continuation is set to N, the next detail line appears at the top of the page with no control break heading.

Annotated count in break footings

Specifies whether to print an annotated count in standard footings. This is a count of the number of primary detail groups generated from executing the PDL PRODUCE statement since the last control break at the same level. Control footings affected by this parameter are control break footings, page footings, and report footings. User‑defined footings are unaffected.

Y Annotated count appears (default).
N Count does not appear.

Report final summary title

Specifies whether to print a final summary line (equivalent to control break footing level 0) when summary functions are specified for a detail field.

Y Final summary (grand total) line prints (default).
N Final summary line does not print.

Note: A value of Y can generate blank lines if no count or summaries are accumulated.

Spacing before summary

1‑9 Specifies how many lines are skipped before the report final summary title. The default is 2, which skips 2 lines.
P Specifies that the final summary title prints on a new page.

If you specify a larger value for the first line of the LEVEL 0 control break in the Heading fill‑in, the spacing specified in the Heading fill‑in overrides that specified in the Parameters fill‑in.

Title

A title for the final summary control break footing, which appears on a separate line at the end of the report preceding the final summary information. If nothing is specified here, the default is FINAL TOTAL.

Date

Specifies the position and format in which the date prints.

Position

Specifies the location of the date on the page. You can set a default for this parameter with the SET RPT DATEPOS command. Any of the following are valid:

To place the date in	Specify	Position
The page footer	BR	Bottom right
	BL	Bottom left
	BC	Bottom center

The page heading	TR	Top right
	TL	Top left
	TC	Top center

To suppress	NO	None

If you specify NO here, you can still place the date in a user‑defined heading or footing specified on the Heading fill‑in.

Note: You cannot specify the same position for page number, date, and heading if all are requested. If you also specify a page heading or footing on the Heading fill‑in, leave this position blank in the first line of that page heading or footing.

Format

Specifies the format of the date. You can use any logical combination of the date patterns shown in the following table to specify a date format.

Note: You can specify the $RPT‑DATE function as a field name on the Heading and Detail fill‑ins to produce the report date at another location. You must specify a format for the date here when you use $RPT‑DATE. However, you can set a default for this parameter with the command SET RPT DATEFOR. This default date format applies only to the date in the page heading, page footing, and $RPT‑DATE. The default format for dates in the Detail fill‑in is controlled by the command SET CMD DATEFOR.

The following specifications give the corresponding results when a report is produced, assuming that, at the time of production, the date is January 12, 1993.

Component Notation	Meaning	Example assuming (January 12, 1993)
YEAR	Year in full	1993
YY	Year without century	93
Y	Year without decade	6
MONTH	Month spelled out (upper case)	JANUARY
LCMONTH	Month spelled out (initial letter uppercase)	January
MON	Month abbreviation (uppercase)	JAN
LCMON	Month abbreviation (initial letter uppercase)	Jan
MM	Month number, with leading zero if necessary	01
M	Month number with no leading zero	1
DD	Day with leading zero if necessary	12
D	Day with no leading zero	12
DDD	Julian day, numeric day of the year (1‑366)	012
WEEKDAY	Day spelled out (uppercase)	SUNDAY
LCWEEKDAY	Day spelled out (initial letter uppercase)	Sunday
DAY	Day abbreviation	SUN
LCDAY	Day abbreviation (initial letter uppercase)	Sun

The following are examples of completed date format specifications.

Specification          Result
MM/DD/YY               01/02/93
M/D/YY                 1/2/93
DD‑MM‑YY               02‑01‑93
DD/MM/YY               02/01/93
DD MON YEAR            02 JAN 1993

Any characters except uppercase alphabetic in the date pattern remain unchanged.

The site administrator defines the actual text indicated by the keywords MONTH, LCMONTH, MON, LCMON, WEEKDAY, LCWEEKDAY, DAY, and LCDAY in the file DATETBL.IDL. For more information about defining this text, see the Working in the Environment Guide.

Page numbers

Specifies the location and format in which the page number prints.

Position

Specifies the location of the page number on the page. You can set a default for this parameter with the SET RPT PAGEPOS command. Any of the following are valid:

To place the date in	Specify	Position
The page footer	BR	Bottom right
	BL	Bottom left
	BC	Bottom center
The page heading	TR	Top right
	TL	Top left
	TC	Top center
To suppress	NO	None

If you specify NO here, you can still place the page number in a user‑defined heading or footing, specified on the Heading fill‑in.

Format

Specifies the format of the page number.

D Digits only; for example, 15
H Hyphens; for example, ‑15‑
P Digits with a one‑ to eight‑character prefix defined by the user. PAGE is the default prefix if the user does not specify one.

You can set the default for the page number with the command SET RPT PAGEFMT. You must specify the page format on the Parameter fill‑in or by default if you use the $RPT‑PAGE function on the Heading or Detail fill‑in.

Page heading

Specifies the literal to use as the page heading and its position on the page.

You should not define both a heading report parameter and a report page heading definition. If you specify date and page as report parameters, the first line of a multiple line heading should be positioned so that it does not conflict with the date and page positions.

Heading

Specifies the 1 to 42‑character literal that appears as a page heading at the top of every page of the report. When this field is blank (the default), no literal text appears, even if page numbers or the date are specified using the Parameter fill‑in.

Position

Specifies the location of the page heading as:

C Centered (default).
L Flush left margin.
R Flush right margin.