Fill-In Descriptions › Heading/Footing Definition Fillin

Heading/Footing Definition Fillin

The report Heading/Footing definition fill‑in specifies a more elaborate report page heading or footing than can be defined on the report Parameters fill‑in. The Heading/Footing fill‑in is optional and is shown in the following screen.

Definitions specified with the Heading/Footing fill‑in override those specified on the report Parameters fill‑in. For example, the standard control break heading parameter on the report Parameters fill‑in is ignored for a break level if a <<BH>> label is specified on the Heading/Footing fill‑in.

You can use field names, literals, functions, and arithmetic expressions as part of a heading or footing. The position or location of the heading or footing is also specified on this fill‑in.

You can define the following types of headings and footings on the Heading fill‑in:

• A report heading, identified by the group label <<RH>>, prints once at the beginning of the report on a separate cover page.

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

• A report footing, identified by the group label <<RF>>, prints once at the end of the report. It can print on the same page as the last detail or on a separate page.
• A page heading, identified by the group label <<PH>>, prints at the top of every page.
• A page footing, identified by the group label <<PF>>, prints at the bottom of every page.
• One or more control break headings, identified by the group label <<BH>> LEVEL n, prints before the first detail of a control break group. Control break headings specified here override the default headings.
• One or more control break footings, identified by the group label <<BF>> LEVEL n, prints after the last detail of a control break group. Control break footings specified here override the default footings.
• To display the report Heading fill‑in, enter the command HEADING on the command line or press the F5 key.

 =>
‑‑‑‑‑‑‑‑‑‑‑‑‑‑‑‑‑‑‑‑‑‑‑‑‑‑‑‑‑‑‑‑‑‑‑‑‑‑‑‑‑‑‑‑‑‑‑‑‑‑‑‑‑‑‑‑‑‑‑‑‑‑‑‑‑‑‑‑‑‑‑‑‑‑‑‑‑‑‑‑
 IDEAL   : RPT HEADING/FOOTING   RPT CUSTRPT  (001) TEST       SYS: DOC  FILL‑IN

          Field Name, Literal, Function,                   Column
 Command  or Arithmetic Expression                         Wid Tab Edit Pattern 
 ‑‑‑‑‑‑   ‑‑‑‑‑‑‑‑‑‑‑‑‑‑‑‑‑‑‑‑‑‑‑‑‑‑‑‑‑‑‑‑‑‑‑‑‑‑‑‑‑‑‑‑‑‑‑‑ ‑‑  ‑‑‑ ‑‑‑‑‑‑‑‑‑‑‑‑‑
 ======   ==================== T O P ===================== ==  === =============
 ______   ________________________________________________ __  ___ _____________
 ______   ________________________________________________ __  ___ _____________
 ______   ________________________________________________ __  ___ _____________
 .
 .
 .
 ______   ________________________________________________ __  ___ _____________
 ======   ===================== B O T T O M ============== ==  === =============

A series of literals and field names specifies a heading or footing on the report Heading fill‑in. Although you enter the pieces of the heading or footing vertically on the fill‑in, they are arranged horizontally across the top of each page of the report. A heading wider than the report width wraps around to the next line.

To define a heading or footing, enter the information in the following fields on the Heading fill‑in:

Command

An area where the user can enter CA Ideal editing line commands. You can position the command area on the right or left of the screen using the SET EDIT MARGIN command. For more information, see the Command Reference Guide.

Field Name, Literal, Function, or Arithmetic Expression

The group‑identifier, field name, literal, function, or arithmetic expression used as a part of the heading or footing. This area must be left blank if Lnn is specified in the TAB column.

To modify the specification, the ERASE EOF key or the DELETE key can delete this value. When a value in this field is deleted, CA Ideal deletes corresponding options specified in that line.

Group Identifiers

Identify all headings and footings with a group label, which indicates the function of the heading or footing in the report. Valid group identifiers are:

• <<RH>> Specifies that the following lines define a report heading that prints on a separate page at the beginning of the report. You can include the report date in the heading by using report functions.
• <<RF>> Specifies that the following lines define a report footing that prints at the end of the report. You can use the TAB field to define the footing lines to print on the same page or a separate page. You can include summary information in the report footing by using report functions.
• <<PH>> Specifies that the following lines define a page heading that prints at the top of each page of the report. If no group identifiers are specified, any lines defined on the Heading fill‑in are assumed to be part of a page heading. You can include the report date and page in the heading by using report functions.

  If multiple page headings <<PH>> are specified, the first page heading encountered is the one that appears on the report. If both a page title (on the Parameter fill‑in) and a page heading (on the Heading fill‑in) are specified, the page title from the Parameter fill‑in appears on the report.

  When a TAB of Lnn is specified for the first line of a page heading, the heading text is moved nn lines down from where the heading would have started. The TAB does not affect the automatic date and page number. They continue to print on the original first line.

• <<PF>> Specifies that the following lines define a page footing that prints at the bottom of each page of the report. You can include summary information in the page footing by using report functions.
• <<BH>> Specifies that the following lines define a control break heading to print whenever the value of a control break field changes. See the section titled Detail Definition Fill‑in later in this chapter for the definition of a control break field. The heading text specified here overrides the default control break heading for the designated level.

  The control break heading identifier is specified with a level number to identify the control break level for which the heading is printed. The format for the control break group identifier is <<BH>> [LEVEL] n. The keyword LEVEL is optional. If no level is specified, the heading applies to all control breaks defined. You can specify more than one level, as in:

  <<BH>> LEVEL 1 2 3
  

  You can suppress an individual control break heading for any level by creating a <<BH>> group for that level with no lines following.

  You can include the report date and page in the heading by using report functions.

• <<BF>> Specifies that the following lines define a control break footing printed whenever the value of a control break field changes. See the section titled Detail Definition Fill‑in later in this chapter for the definition of a control break field. The footing text specified here overrides the default control break footing for the designated level.

  The control break footing identifier is specified with a level number to identify the control break level for which the footing is printed. The format for the control break group identifier is <<BF>> [LEVEL] n. The keyword LEVEL is optional. If no level is specified, the footing applies to all control breaks defined. You can specify more than one level, as in:

  <<BF>> LEVEL 1 2 3
  

  You can suppress an individual control break footing for any level by creating a <<BF>> group for that level with no lines following. Specify LEVEL 0 as the <<BF>> group level to print grand totals at the end of the report.

  You can include summary information in the control break footing by using report functions. See the section titled Functions later in this appendix. If a <<BF>> group is defined, any of these functions specified on the Detail fill‑in is ignored. The function must be defined in the <<BF>> group.

  Note: A double‑space is automatically generated before a control break footing is produced.

• <<EMPTY>> Specifies that the following text prints when no PRODUCE statements execute for the report. The text to print must be composed of literals. No page or report headings print. If an <<EMPTY>> group is not specified and no PRODUCE statements execute, there is no output.
• <<ABORT>> Specifies that the following text prints when the value of the return code is equal to or greater than the value specified in the group identifier, which is specified as <<ABORT>> RC x. If the <<ABORT>> group is printed, the final control break, page, and report footings do not print. If an <<ABORT>> group is not specified, a standard message prints.

  The lines defining the output in an <<ABORT>> group are printed automatically when the program terminates abnormally. To force the <<ABORT>> group to print when releasing a report dynamically, use the statement RELEASE REPORT WITH ABORT.

  You can use the <<ABORT>> group with user‑defined error procedures. Although you can code only one <<ABORT>> group, you can specify one or more working data variables to define the output, provided that the variables are current for the last PRODUCE REPORT statement executed. These variables can then be assigned in the error procedure based on the value of the return code ($RC). Variables set after the last PRODUCE REPORT statement was executed are not available for the <<ABORT>> group.

  The group identifier must appear on a line by itself. It is followed by lines that define the specified heading or footing. If only one heading is specified, no group identifier is required and the heading is assumed to be the page heading.

Field names

Field names must be the names of fields in dataviews, panels, working data, or parameters. You can continue field names for a total of up to three lines by terminating the name with a semicolon. For more information, see the section Considerations for Continuation later in this chapter.

Literals

You must enclose literals in single quotes. You can specify literals on consecutive lines with a TAB specification of 0 or 1. They are concatenated in the page heading. If spaces are required between the two literals, you can use the TAB specification to provide them or include them in the quotes. You cannot continue a heading literal with a semicolon.

Functions

Report functions entered in a heading or footing return a value when the heading or footing is produced. The following report functions are available:

• $RPT‑DATE Specifies the current date as part of the heading. The date value is obtained from an ASSIGN REPORT statement, if one is specified. Otherwise, the current date is used. You can use this function for report, page, and control break headings.
• $RPT‑PAGE Specifies the current page number as part of the heading. The page number value is obtained from an ASSIGN REPORT statement, if one is specified. Otherwise, a value of 1 is used. You can use this function for report, page, and control break headings.
• $TOT(field) Computes the total value for all occurrences of the specified field in the range covered by the footing. If $TOT is specified in the page footing, the value is the total value of all occurrences on the page. If it is specified in the control break footing, the value is computed based on all occurrences in the control break group. You cannot use this function in the report footing.

The $TOT function provides the same value as the TOT function on the Detail fill‑in.

• $AVG(field) Computes the average value of all occurrences of the specified field in the range covered by the footing. You can use this function in all footings. The $AVG function provides the same value as the AVG function on the Detail fill‑in.
• $MIN(field) Determines the minimum value of all occurrences of the specified field in the range covered by the footing. You can use this function in all footings. It provides the same value as the MIN function on the Detail fill‑in.
• $MAX(field) Determines the maximum value of all occurrences of the specified field in the range covered by the footing. You can use this function in all footings. It provides the same value as the MAX function on the Detail fill‑in.
• $OCC[(field)] Counts the non‑null occurrences of a primary or secondary field if a field name is specified. If no field name is specified, $OCC counts the primary produce statements in the range covered by the footing. You can use this function in all footings. When specified with a field name, it provides the same value as the OCC function on the Detail fill‑in.
• $CTOT(field) Accumulates the total value for all occurrences of the specified numeric field in the range of the report. You can use this function in all footings, but it always shows the total for the entire report.

The value entered for field in any of the above functions must be a unique name or label on a line in the Detail fill‑in. If the field name is a qualified name (for example, EMPLOYEE.SALARY) in the Detail definition, then it must also be qualified when used with these functions in either the Heading or Footing definition. You can continue the function specification on a total of up to three lines by ending each line except the last with a semicolon.

Arithmetic Expressions

You can specify an arithmetic expression with or without a label. However, you cannot use the value computed for the expression as the operand of a report function if the expression is not labeled. You can continue an expression for a total of up to three lines by ending the Field Name entry in each line except the last with a semicolon.

Considerations for Continuation:

• Anything entered to the right of the semicolon, but in this column (Field Name, Literal, Function or Arithmetic Expression), is ignored.
• Leading blanks are ignored on subsequent lines.
• Continuing a function follows the same rules as in Program Definition Language.
• You can use a semicolon to indicate that the entry's edit pattern is continued.
• You must enter any other specifications for a multiple‑line entry on the first line in the appropriate column.

Column

Specifies the width of the column and its placement on the report line.

Width

A number from 0 through 99 that specifies the width of the column. An entry here overrides the default column width. If no value is specified here (the default), the width is equal to the longest of the following:

• The width of the source field
• The width of the column head
• If a summary total is specified, then a width of four characters longer than the source field width is used
• The width that results from the edit pattern

If the field value is longer than the space allotted, it is truncated. Alphanumeric fields are truncated from the right. Numeric fields are truncated from the left.

If an alphanumeric function is specified, a WIDTH specification is required. See the PDL chapter in the Programming Reference Guide for a definition of terms.

Tab

Specifies the column and line where this field in the heading or footing starts. If omitted, the Spacing Between Columns option in the report Parameters fill‑in determines the spacing. You can use the following entries:

• +nn Specifies relative spacing, where nn is the number of columns to skip from the current position.
• nnn Specifies absolute spacing, where nnn is a specific column number.
• MAX Specifies absolute spacing, where the field is positioned all the way to the right of the heading line (right justified).
• Lnn Specifies vertical spacing, where nn refers to the number of vertical spacing units. The Spacing Between Lines option in the Parameter fill‑in determines the number of lines in a vertical spacing unit. The default value for nn is 1.

Lnn must be a separate tab entry with all other columns blank. In the following example, it is necessary to leave the second line in the field name column blank because the TAB value is L05.

FIELD NAME   ...   TAB
X                   50
                   L05
Y                   50

Leaving the field name blank when Lnn is specified in the TAB column is useful for skipping extra lines without producing a field on the report in that position.

Edit Pattern

Specifies an override to the default edit pattern for the entry. Refer to the edit pattern description in the section titled Detail Definition Fill‑in later in this chapter. You can continue the edit pattern for a total of up to three lines by ending the field name column with a semicolon. You can also specify date patterns here; however, $RPT‑DATE uses the date format specified in the Parameters fill‑in. Be sure that the edit pattern is large enough to accommodate the largest possible value and provide a sign if negative values are possible.