File-AID/MVS additional parameters (FAMVALL)

 

Important

Review the ALL PARMLIB member to see which of the additional parameters require site specific changes. You only need to copy those individual parameters to your site PARMLIB member that require non-default parameter values.

Batch Parameters

The following parameters are batch processing parameters.

MAX_RECORDS_TO_PRINT

Description: Record print default. Max. length 4.
(0-9999) Default=250
The number of records that File-AID prints if no form of output control is placed on functions that cause printing on SYSLIST. The value can be any number from 0 through 9999. When all zeros (F0F0F0F0) are entered, all records in the file are printed.

Batch Override Displacement: 0F

Default: 0250

BATCH_BUFFER_SPACE

Description: Batch buffer space. Max. length 2.
(5-99)
Controls the amount of memory assigned for buffer space. The number of buffers assigned is calculated by multiplying this option number by 10 kB, then dividing the total by the block size of the data set.
The minimum allowed entry is 05 (50 kB) and the maximum is 99 (990 kB). The default for this option is 6 which is multiplied by 10 kB = 60 kB. Accordingly, the default for File-AID/Batch buffers is 60kB divided by the block size of the data set.
This space is assigned to each open data set. This option can be overridden by coding the BUFNO parameter in the DCB entry on DD statements.
The REGION size required at File-AID/Batch execution time may need to be increased depending on the value of BATCH_BUFFER_SPACE and BUFNO coded in the JCL.
For VSAM data sets, this option multiplied by 10 kB becomes the buffer space option. It is then used to dynamically compute the number of buffers to assign for VSAM processing. In the case of the USER function where more than two data sets are open at the same time, memory may be a problem if a region parameter is not entered on the EXEC or JOB card.
The minimum number of buffers File-AID allows is five for MVS and three for non-MVS to allow support for chained scheduling.

Batch Override Displacement: 15

Default: 06

TSO_BUFFER_SPACE

Description: TSO buffer space. Max. length 2.
(5-99)
Controls the amount of storage used for buffers by each open data set when File-AID is executed in a TSO environment. The description for Batch Buffer Space also applies to this option.

Batch Override Displacement: 17

Default: 06

PRINT_UPPERCASE_OR_MIXED

Description: Character set. Max. length 1.
(0=Upper Case,1=Upper/Lower/Kana)
0 Upper case only.
1 Upper case and lower case.
To change or add special characters, see the Character Translation Table option at the end of this table.

Batch Override Displacement: 1A

Default: 1

ALLOW_USER_FUNCTION

Description: User function. Max. length 1.
(0=NO,1=YES)
Specifies whether the USER function will be allowed. The value 0 indicates No; 1 indicates Yes.

Batch Override Displacement: 2B

Default: 1

NO_RECORDS_COPIED_RETURN_CODE

Description: No records copied return code. Max. length 2.
(00-99)
Specifies the return code that File-AID is to issue when records are not selected for copying to any output data set in a copy operation. The value 08 reflects the current return code issued. Any number from 00 (issue no return code) through 99 is valid. File-AID always reflects the highest return code issued during an execution.

Batch Override Displacement: 2C

Default: 08

ALLOW_MULTIPLE_PASSES_THROUGH_DATASET

Description: Multiple file pass. Max. length 1.
(0=Single Pass,1=Multiple)
Indicates if more than one pass through a data set is to be made.
0 Single pass.
1 Multiple passes.
Normal processing does not reposition at the beginning of a data set for multiple functions. This option allows those multiple passes to be made. This option can also be changed with the FORM parameter.

Batch Override Displacement: 2E

Default: 0

PAD_CHAR_WHEN_REC_LENGTH_CHANGES_IN_COPY

Description: Pad character. Max. length 2.
(hexadecimal value)
Sets a default For File-AID to use to pad when the record length changes during COPY processing.

Batch Override Displacement: 2F

Default: 00

RDW_USAGE

Description: RDW parameter explanation. Max. length 1.
(0-3)
Parameters can be set to the following values:
0 Include and print RDW.
1 Include and do not print the RDW.
2 Do not include and print RDW.
3 Do not include and do not print the RDW.
This option can be overridden with the RDW parameter.

Batch Override Displacement: 33

Default: 0

COPY_EMPTY_MEMBERS

Description: Copy empty members. Max. length 1.
(Y=YES,N=NO)
Allows the user to copy members without records. the default is No, do not copy empty members. Change to Yes to copy empty members.

Batch Override Displacement: 36

Default: N

SUPPORT_SYSTEM_DETERMINED_BLOCK_SIZE

Description: Support system-determined blocksize. (Blocksize=0). Max. length 1.
(Y,N,I)
If your operating system supports this installation option, it allows you to have your system determine the blocksize of new output PS and PO data sets allocated for File-AID/Batch if the RECFM is not undefined (=U). The following settings are valid:
Y Enables your system to determine the blocksize when the blocksize is not coded or BLKSIZE=0 is coded.
I Uses the IBM process for determining blocksize. File-AID allows the system to determine the blocksize when BLKSIZE=0 is coded. File-AID uses the blocksize of the input data set when a blocksize is not coded.
N Disables this support. File-AID uses the blocksize of the input data set when a blocksize is not coded or BLKSIZE=0 is coded.

Important

Note for option I and N:

If the output blocksize is not coded, then the output LRECL must be equal to the input LRECL in order for File-AID to use the blocksize of the input data set. If the LRECLs are not equal, then File-AID assigns the output LRECL as the output blocksize.

Important

  • File-AID ignores the setting of this Product option unless you have IBM’s Data Facility Product (DFP) Version 3 Release 1 or greater (for DASD), DFP Version 3 Release 2 (for tape) or IBM’s DFSMS installed.
  • Modifying this option may change default allocations of existing batch jobs.

Batch Override Displacement: 38

Default: N

PRINT_COPYBOOK_FROM_ALTERNATE_LIBRARY

Description: Formatted print copybook alternate library. Max. length 1.
(' ',L,P)
Allows the user to specify CA Librarian or CA Panvalet data sets for your formatted print copybook library.
blank PDSs and PDSEs only.
L CA Librarian data sets.
P CA Panvalet data sets.

Batch Override Displacement: 39

Default: blank

RECORD_TRUNCATION_RETURN_CODE

Description: Return code for record truncation. Max. length 1.
(00-FF)
Specifies the return code that File-AID is to issue when records are truncated in a copy operation. The value X'04' is default to issue RC=4. X'0C' would issue RC=12, X'10' would issue RC=16. Any HEX value X'00' through X'FF' is valid.

Batch Override Displacement: 3A

Default: 04

REPLACE_LIKE_MEMBERS

Description: PDS replace like members. Max. length 1.
(Y=YES,N=NO)
Yes, replaces like-named members in a PDS.
No, do not replace like-named members.
This option can be overridden at execution time with the RLM parameter.

Batch Override Displacement: 3F

Default: Y

MAINTAIN_PDS_STATISTICS

Description: Maintain PDS statistics. Max. length 1.
(Y=YES,N=NO,A=ADD)
No, do not maintain PDS statistics.
Yes, maintain PDS statistics.
Add, maintain PDS statistics and add when they previously did not exist.
This option can be overridden at execution time with the MAINTAIN_PDS_STATISTICS parameter.

Batch Override Displacement: 41

Default: N

Important

Common parameter COMMON_PDS_STATISTICS deprecates and overrides the MAINTAIN_PDS_STATISTICS parameter, unless the COMMON_PDS_STATISTICS=D (default) value is specified.

UNEQUAL_COMPARE_RETURN_CODE

Description: Unequal compare return code. Max. length 1.
(Hex Value 00-FF)
Specify the return code to issue when the Compare function (File-AID option 10) finds any differences in the data that you specify to compare from the old to the new data set. Valid entries are hexadecimal values 00 through FF.

Important

We recommend that a non-zero value should NOT be a multiple of 4 to distinguish it from other usual return codes. Depending of the perceived severity of an unequal compare, set the value to either 03, 07, 0B (11), or 0F (15).

The options preceding this message can be modified at execution time. See Modify Batch Options at Execution .

The options following this message cannot be modified at execution time.

Batch Override Displacement: 43

Default: 00

COMPARE_EMPTY_FILE_RETURN_CODE

Description: Compare empty file return code. Maximum length: 2.

Valid values are D, 00, 01, 02, 03, 04, 08, 12, 16, 20, 24, 28, 32, 36, 40, 44, 48, 52, and 56

Specify the return code issued when both input files are empty.

Default values are as follows:

  • 00 for the READ-AHEAD compare option
  • 04 for the SORTED and 1-TO-1 compare options

If the return code is not 00, the following error message appears:

U325 - NO RCDS WERE SELECTED FOR COMPARE IN EITHER THE OLD OR NEW FILES

Important

The following conditions apply to this parameter:

  • The SELECT0RC=nn batch control card parameter overrides this parameter.
  • This compare return code for empty files does not apply to multi-member compares.

Default: D (C440)

Modify Batch Options at Execution

The OPT parameter in the PARM field is used to override or change batch options with displacements of 0F through 43. These HEX displacements correspond to OPT parameter positions 1 through 53.

The OPT parameter also includes the following common parameters with their displacement values in the following table. Refer to File-AID-Common-Components-Additional-Parameters-FACMALL for their descriptions.

Common BATCH Product Option Variables Displacements

Variable Name

Displacement

1D

1E

3B

File-AID processes the option fields as one contiguous data field, so all options to the left of the option being changed must be specified as well. The data entered in the OPT parameter overlays the installation option area from left to right.

Example

Change the Batch buffer space option from the default value 06 to 12.

// EXEC PGM=XFAFAID,PARM='OPT=02501012'

Important

FILEAID is an alias of XFAFAID.

Environment 1

The following parameters are the Environment 1 parameters.

IO_EXIT_USAGE

Description: User-written I/O exit. Max. length 8.
(YES/NO/EXITNAME)
This option is used in conjunction with user-written I/O exits (see also I/O Exit). Valid entries include:
NO Do not display I/O exit fields on the File-AID panels.
YES Display fields on the panels enabling the user to enter the name of an I/O exit program module.
EXITNAME Display fields on the panels with a prefilled name of an I/O exit program module.

Default: NO

TEMPORARY_DSN_FORMAT

Description: Customizes the temporary DSN's used by File-AID. Max. length 8.
The variables TEMPORARY_DSN_FORMAT , TEMPORARY_DSN_LITERAL , and TEMPORARY_DSN_SUFFIX allow you to customize the temporary data set name used by File-AID/Data Solutions.
TEMPORARY_DSN_FORMAT is a six-character string defining the node sequence of the temporary data set name. Each character represents the contents of a node as follows:
U - Your TSO prefix, or user ID when a prefix is not set. 
To set your TSO prefix in a batch execution, add the batch parameter TSOPREFIX (TPX) on the same line as the batch function. Refer to the TSOPREFIX parameter for more information.
L - Literal, up to eight characters, defined by the TEMPORARY_DSN_LITERAL variable. The default is FILEAID.
I - Two-character identifier that is assigned by File-AID to identify the type of temporary data set. This character is required.
D - Date in Dyyddd (Julian) format.
T - Time in Thhmmss format.
S - Suffix, up to eight characters, defined by the TEMPORARY_DSN_SUFFIX variable. The defaults is blanks.
X - TSO user ID.

Important

U and X are not mutually exclusive. However, if both are coded and no TSO prefix is active/specified, the resulting DSN will contain user ID twice.
You may rearrange the order of the nodes.

Important

It is possible to specify these variables so that the temporary data set name exceeds 44 characters. If this happens, File-AID detects it on startup, stops, and issues the message: MAX data set name exceeds 44 characters.

Example

File-AID names a compare criteria data set created according to the TEMPORARY_DSN_FORMAT  variable default, ULIDTS, as follows: userid.FILEAID.CC.Dyyddd.Thhmmss.

If you change the TEMPORARY_DSN_FORMAT  variable to USILTD, TEMPORARY_DSN_LITERAL  to FA, and TEMPORARY_DSN_SUFFIX  to TEMP, File-AID names the same compare criteria data set: userid.TEMP.CC.FA.Thhmmss.Dyyddd.

Default: ULIDTS

TEMPORARY_DSN_LITERAL

Description: String for the literal node of a temp data set. Max. length 8.
TEMPORARY_DSN_FORMAT specifies a string, up to eight characters, for the LITERAL node of the temporary data set name. See TEMPORARY_DSN_FORMAT .

Default: FILEAID

TEMPORARY_DSN_SUFFIX

Description: String for the suffix node of a temp data set. Max. length 8.
TEMPORARY_DSN_SUFFIX specifies a string, up to eight characters, for the SUFFIX node of the temporary data set name. See TEMPORARY_DSN_FORMAT .

Default: none

Environment 2

The following parameters are the Environment 2 parameters.

ABR_IN_USE

Description: ABR allocation. Max. length 1.
(0,1)
0 - ABR is not used.
1 - If your installation uses Innovation Data Processing, Inc.’s Automatic Backup and Recovery (ABR) for archival and retrieval, allocation of data sets will be forced when an attempt to find them on a volume fails.

Default: 0

DATASET_RESERVE_OR_ENQUEUE

Description: Dataset Reserve/Enqueue. Max. length 1.
(Valid values used to be: 0=Reserve,2=Enqueue)
0 - Always do reserves.
2 - Always do enqueues. 2 is intended for sites that do not have shared DASD or have software packages such as MIM (Multi-Image Manager) or GRS.

Important

This parameter is ignored. It is always processed as though the value is a 2.

OPEN_DATASET_FOR_UPDATE_OR_INPUT

Description: Edit 1st open. Max. length 1.
(0,1)
0 - File-AID Edit (by default) opens data sets for UPDATE processing when loading the data set into storage. This allows File-AID to inform the user of any edit limitations at the beginning of the session. It also may cause your installation’s security package to issue security violation messages when you attempt to edit read-only data.
1 - Open the DSN for input when loading into storage.

Important

  1. The Edit 1st Open product option does not apply to VSAM data sets.
  2. The EDITOPEN parameter is ignored when trying to do an open for update on a compressed data set.

Default: 0

LOG_FA_FUNCTIONS_TO_ISPF_LOG

Default: ISPF log data set access. Max. length 1.
(0,1)
All File-AID functions may be logged to the ISPF log data set. When this option is enabled (1), all functions are logged including data set destructs. In addition, interactive functions are logged.
0 - File-AID functions ARE NOT logged to the ISPF log data set.
1 - All File-AID functions are logged including data set destructs. In addition, interactive functions are logged. 0

Data set Update

USE_MINUS_OPTION_ALLOWED

Description: Use Minus. Max. length 1.
(0=Not Allow,1=Allow)
The USE Minus Option allows negative relative offsets in the USE primary command that causes the layout to precede the actual data. Valid entries are:
0 - Do not allow access.
1 - Allow access in Browse and Edit mode.

Default: 0

BATCH_REGION_SIZE

Description: Region size (in M) for creation of batch JCL. Max. length 2.
(0,8-99)
Default REGION size used within generated BATCH jobs.

Default: 08

Other Options

The following parameters are the Other Option parameters.

COMPARE_MAX_DIFFERENCES_TO_REPORT

Description: Limit on number of difference to report in Compare. Max. length 7.
(0-9999999, 0=All)
Compare Report Limit - Set limit for maximum number of differences to report in Formated and Unformated Batch Compare. 0 = no limit, report ALL different records.

Default: 0000000

VSAM Record Level Sharing (RLS) Parameters

The following parameters are the VSAM Record Level Sharing parameters.

VSAM_RLS_PROCESSING_FOR_EDIT

Description: Enable VSAM RLS processing for File-AID EDIT. Max. length 1.
(Y=YES,N=NO)
Y - Enable VSAM RLS processing for File-AID EDIT
N - Do not enable VSAM RLS processing for File-AID EDIT

Default: Y

VSAM_RLS_PROCESSING_FOR_BROWSE

Description: Enable VSAM RLS processing for File-AID BROWSE. Max. length 1.
(Y=YES,N=NO)
N - Do not enable VSAM RLS processing for File-AID BROWSE
Y - Enable VSAM RLS processing for File-AID BROWSE
If this option is set to Y user will be prompted with ability to override for an individual data set.

Default: N

Related topics

BMC AMI DevX File-AID/Data Solutions

 

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