CA Earl Statements

The following list consists of CA Earl command statements. These statements are exclusive to the CA Earl program language. Use them only in the context intended by CA Earl. This list can help you understand the sample reports in this chapter. For a more complete list, see the CA Earl Reference Guide.

CALL (D)(T): A data manipulation statement, also called a processing statement. Invokes a user‑supplied routine. CALL is used without a suffix to determine operations performed on input data before output selection or with the suffix (D) at detail print time or with suffix (T) at total time.
CONTROL: A report specification statement. Specifies data sequence and automatic subtotal control‑breaks.
COPY: A library retrieval statement. Retrieves CA Earl source modules from the CA Earl library.
DECODE (D)(T): A data manipulation statement like CALL. Translates a set of specified values for a given field.
DEFINE: A declaration statement. Defines file data fields or working storage fields.
END: A termination statement. Signifies the end of the CA Earl source statements.
ENDIF: A logic flow statement. Signifies the end of a group of statements covered by an IF statement.
ENDPROC: A logic flow statement. Signifies the end of a group of statements covered by a PROC statement.
EXITPROC: A logic flow statement. Returns control from a procedure to the statement following the PERFORM statement that invoked the procedure without executing the following statements in the procedure.
FILE: A declaration statement. Identifies and describes input and output files.
GET (D)(T): A file handling statement. Reads a record from and input file or database.
IF (D)(T): A logic flow statement. Executes one or more data manipulation, file handling, or logic flow statements conditionally.
NOTE: A comment statement.
OPTION: A function that overrides default compile and execute functions.
PRINT: A report specification statement. Determines the format and contents of a report. You must supply to CA Earl in the above sequence.
REPORT: A report specification statement. Provides the heading lines for a report.
SELECT: A report specification statement. Selects the data records to include in a report.

The following is a brief explanation of the categories that are presented in this chapter. Not all of these categories appear in each report input. These categories are presented here for a brief explanation of their content.

NOTE

Specifies comment lines. These lines are ignored during processing.

OPTIONS

Specifies run options for processing. These options can include:

PRINTER=—Specifies the width of the printed line on the output. CA Earl uses this value to determine the spacing of columns and to center the title of the report.
LIST OFF|ON—Produces or suppresses a listing of the CA Earl report program that process the report. This lets you examine the record descriptions used in the report or, if you have written your own report program, to examine it for errors. LIST OFF suppresses this listing. LIST ON prints it.
SORT=—Specifies the sort method CA Earl uses to process the report. The default sort method for VM reports is SRAM.

INPUT FILE

Defines the file exit name.

FIELD DEFS

Defines the names, positions, field types, default titles, and other criteria for the fields CA Earl uses for processing reports. COPY statements imbed copybook files containing field descriptions used in the various reports. The "CA‑ACF2 File Layouts" appendix describes these copybooks. You can also define work fields for customizing reports here.

READ FILE

Defines the files to read for processing.

PROCESS LOGIC

Defines special processing of data. The DECODE statements translate values, such as numeric reason codes, into more useful data, such as text.

SET UP

Selects the title, column headers, and records to print in the reports. You can use the REPORT and SELECT statements, described in the previous section, to add a line below the report title on each page. The EXCLUDE parameter of the REPORT statement suppresses the default column headers. This lets you define your own headers in the PRINT statement (described in the following).

PRINT LOGIC

Formats the records for printing. This section uses the CA Earl CONTROL and PRINT statements to sort and format records for printing.

The CONTROL statement sorts the records according the values of the fields specified in the statement. The following parameters are also used in this statement:

SKIP—Skips a space when the value of the header it appears after changes.
Parentheses—Subtotals the header to print every time the value of the associated field changes.
BREAK—Prints the value of the field associated with the header preceding the BREAK statement only when that value changes. The field is then suppressed until the next time its value changes.
ONE—A counter used for accumulating the subtotals for each header.

The PRINT statement prints the headers listed. If you did not specify column placements, CA Earl automatically spaces the headers across the page based on the width of the report, specified in the PRINTER= option (see above). Parameters used can include:

DOUBLE SPACING—Skips a line before printing the current line.
@nnfieldname—Prints the header at column nn (absolute placement). If you did not specify column values for headers, CA Earl spaces them automatically.
' '—Prints a blank line.
IFTAG&x.—If the records processed were assigned to groups (see SELECT above), this statement prints the record only if it was assigned to a specific group, indicated by the letter replacing x.
TOTALS ONLY—Prints only the total number of occurrences for each combination of values reported, plus a grand total for all events.
(ONE)—Prints subtotals for each record.

VARIATIONS

Contains statements you can precede by NOTE. To use the statements, remove NOTE.