Information
Space announcement: BMC provides limited support for this version of the product. As a result, BMC no longer accepts comments in this space. If you encounter problems with the product version or the space, contact BMC Support.

FORM (F)


The FORM parameter has five syntax forms that control five File-AID processing options:

JCL Format Control:

FORM=JCL

Printing Format Control:

FORM={LONG }
     {SHORT}

Multiple-Pass Processing Control:

FORM={NOMULTI}
     {MULTI}

Audit Trail Print Format Control:

FORM={HEX}
     {CHAR}

COMPARE Format Control:

FORM=(print format,report format,data format,report style)

More than one FORM parameter can be used per control card. The use of each syntax is described below.

JCL format  control

When JCL format is specified, File-AID internally strings together and logically processes DD, EXEC, JCLLIB, JOB, OUTPUT, PROC, SET, and XMIT statements. All continuations for a JCL statement can be processed as if they were contained in a single record. JCL format control is only valid for PDSs with LRECL=80. When using a length element in a scanning parameter (IF, EDIT, REPL), specify a length of 0 to scan to the end of the logical JCL statement.

FORM=JCL


Warning

Important

File-AID does not check JCL syntax.

File-AID ignores data beyond physical location 71 of each record. File-AID looks for a double slash ( // ) in locations 1 and 2 to distinguish between JCL statements and data or comments ( //* ). Comments ( //* in locations 1, 2, and 3) are ignored, even when embedded in a continued JCL statement. Other embedded comments ( //* not in locations 1, 2, and 3) are processed.

FORM=JCL handles JCL statements that span multiple records and must be treated as a single logical record. It is useful when multiple search criteria could be found on different physical records within the same logical JCL statement. You can also use FORM=JCL to make changes to JCL with the EDIT parameter when the lengths of the compare-data and the new-data are not the same.

FORM=JCL is not always necessary when processing JCL. It is unnecessary when searching for a single string, or when the changes do not affect the length of the statement. If you specify FORM=JCL in these cases, File-AID performs extra unneeded processing.

Editing JCL records with the EDIT parameter may shift or truncate data when it is replaced with data of another length. When editing JCL and expansion of data is required due to a larger length replace data value, File-AID adjusts the JCL statement as follows:

  • If the data on one record does not fit between the original starting location (four through 16) and location 71, the data is shifted left as far as location 4 until it does fit. Commas remain to adjust the JCL to fit as needed.
  • When the COPY or USER function is used, JCL expansion that extends beyond physical location 71 of the last physical record of the JCL statement, is placed on a new continuation line. New or expanded records are aligned with location 16 if possible.
  • When the UPDATE function is used, new records are not inserted. If the JCL expansion cannot be accommodated within the physical records of the JCL statement, truncation occurs and a warning message is printed.

When scanning JCL with the FORM=JCL, and you want to scan until the end of the record, use a length element of 0. If you use any other value, you cannot be sure that you are scanning to the end of the record.

When JCL format is specified, it is effective until a new $$DDxx statement is referenced. A single JCL statement can continue across 255 records.

Warning

Important

The FORM=JCL parameter cannot be used when referencing the input record data with the MOVE parameter.

Printing format control


The FORM parameter changes the print format of File-AID when used with the DUMP, LIST, or PRINT functions and parameters. Two options are available: long and short. The long form causes a column scale to print under each line. The short form causes the column scale to appear only at the top and bottom of each page. The syntax for printing format control is:

FORM={LONG}
     {SHORT}

LONG (L)

(Default) Long form of print output.

SHORT (S)

Short form of print output.

Examples of short- and long-form print formats are given in SYSLIST Output.

The FORM parameter may be used at any time. It remains in effect until changed by another FORM parameter.

Warning

Important

When the LIST function or parameter is used, a column scale is only printed when FORM=SHORT.

Multiple-pass processing control


If you must process more than one function on a given file, use FORM to specify one pass to that file for each function. The FORM parameter is coded on the first function card that references the file. This eliminates the need for multiple DD statements pointing to the same dataset name. The syntax for multiple-pass processing control is:

FORM={NOMULTI}
      {MULTI}

MULTI (M)

Allows reprocessing of an input file after end-of-file (EOF) is reached. At EOF, the input file is closed and reopened. Processing continues with the next function at the beginning of the input file.

Warning

Important

  • FORM=MULTI only occurs when EOF is reached by the current function. If EOF is not reached, processing continues with the next function, at the next record in the input file.
  • FORM=MULTI is not compatible with the COMPARE function.

NOMULTI (N)


(Default) Does not allow reprocessing of the input file, and gives a message when EOF is reached.

Audit trail print format control

Use the FORM parameter with the APRINT function to specify the format of the printed audit trail report. The default format is usually hexadecimal. However, if the audit trail was created with record layouts, the report is printed in a formatted mode according to the COBOL or PL/I record layout. You can override formatted mode by specifying either the HEX or CHAR value on the FORM parameter. The syntax for audit trail print format control is:

FORM={HEX}
     {CHAR}

HEX

(Default) Prints the audit trail report in hexadecimal format.

CHAR

Prints the audit trail report in character format.

Example:

$$DD01 APRINT FORM=CHAR

This example prints the audit trail file in character format.

COMPARE format control

You may use the FORM parameter with the COMPARE function to specify the print, report, and data format, and report style. The syntax order must be specified as print format, report format, data format, and report style. The Compare Criteria dataset can override these options.

The syntax for COMPARE format control is:

FORM=(print format,report format,data format,report style)

print format

The values for print format are:

H

Hexadecimal

F

Formatted

C

(Default) Character.

report format

The values for report format are:

D

(Default) Differences

S

Summary

L

Long.

Warning

Important

The PRTRECS parameter, if coded, overrides the report format setting of the FORM parameter. See PRTRECS.

data format

The values for data format are:

E

(Default) Single-byte character set (EBCDIC).

M

Mixed format (EBCDIC and DBCS).

D

Double-byte character set (DBCS).

report style

The values for report style are:

S

(Default) Standard. This is the full compare report.

C

Condensed. The condensed report style has reduced heading lines and enables you to specify additional options for condensed report style (valid for only Character or Hexadecimal print format). See  COPTNS for a description of these additional print options.


Warning

Important

These four options for the FORM parameter are positional. However by coding the trailing comma to maintain positioning of the options, you may omit an option and accept its default setting. For example, FORM=(,,,C) uses the default setting for print format, report format, and data format, but specifies the Condensed report style (C). Also, you may omit the parenthesis if you want to change only the print format default setting. For example, FORM=H.

See  COMPARE  for information on the COMPARE function. For more information, see COMPARE function.

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*

BMC Compuware File-AID/MVS 21.01