Allocate cluster (A)
The Allocate cluster function (option A) is used to allocate online or in batch new VSAM clusters and IAM data sets. See Allocate-IAM-A for information on allocating IAM data sets.
The VSAM utility displays one or two allocation screens, depending on the setting of the Extended allocate field on the first allocation screen. If Extended Allocate is set to Y (Yes), a second allocation screen is displayed when you press Enter.
When allocating VSAM datasets for use in testing where performance is not critical, the standard allocation options may be selected and the remaining options allowed to default to the system defaults. When allocating production data sets, or where performance is an important consideration, the Extended allocate screen provides access to many additional attributes for VSAM cluster definition.
To allocate a new VSAM cluster, fill in the following fields on the VSAM Utility screen (VSAM Utility screen):
- Enter A in the select option field.
- Enter the new Cluster Name in the dataset name field.
- Set processing option to O (online) or B (Batch)
- Enter a Model Dataset Name if the new data set is to have the same allocation characteristics as an existing data set. The model dataset must be cataloged and must be accessible through a normal catalog search. The model does not have to be VSAM.
- If the data set is cataloged in a catalog which is not connected to the master catalog through the high level qualifier, enter the catalog name in the catalog name field and the catalog Password in the catalog password field (if necessary).
When you press Enter, File-AID displays the first Allocate New VSAM Cluster screen as shown in the following figure. If a value was specified in the Model dataset name field, the displayed attributes are those of the model dataset. If a Model dataset name was not specified, the attributes are those of the last referenced data set. You can accept the displayed values or change them by overtyping.
Allocate New VSAM Cluster Screen 1
Press Enter to process the allocation after entering values in the fields on the allocation screens. If File-AID detects an error in field entry, it displays an error message in the upper-right corner of the Allocate New VSAM Cluster screen. If the allocation values are correct, the message: DATASET ALLOCATED is displayed in upper-right corner of the VSAM Utility screen.
Use the END command (PF3) to cancel the allocation request.
Field Descriptions
Component names:
File-AID uses user-defined variables to append the data or index last-level qualifier to the cluster name to create the dataset names of the data and index components, respectively. See VSAM data set naming conventions. Thus, File-AID generates three names when a cluster is allocated, such as the following names for the previous example:
- ABC.USERID9.NEW.VSAM (Cluster name)
- ABC.USERID9.NEW.VSAM.DATA (Data component dataset name)
- ABC.USERID9.NEW.VSAM.INDEX (Index component dataset name).
Cluster:
Fully qualified name of the new VSAM cluster is displayed for verification. If you entered an unqualified name on the VSAM utility screen, a File-AID VSAM cluster name is constructed.
Data component
Data component dataset name generated by File-AID. This field is modifiable.
Index component
Index component dataset name generated by File-AID. This field is modifiable. (Index component only used for KSDS clusters.)
Dataset type
Specify the data set type as one of the following values:
KSDS - Key sequence
ESDS - Entry sequence
RRDS - Relative record
LINEAR - Linear dataset (LDS)
ZFS - (z/OS 2.4 and up) Linear VSAM cluster that is a zFS file system.
Owner ID
The default is your TSO user ID. You may overtype this field. A value of $IAM identifies this cluster as an IAM file.
Specify SMS Class Information:
(These fields are displayed for SMS sites only.) If you are allocating an SMS data set, specify or verify the following SMS allocation class information:
Storage
Specify the SMS storage class to use for the allocation of the data set. The storage class describes the hardware requirements of the data set.
Data
Specify the SMS data class to use for the allocation of the data set. The data class describes the attributes of the data set such as RECORG, KEYLEN, KEYOFF, SPACE, etc.
Management
Specify the SMS management class to use for the allocation of the data set. The management class describes the migration, backup, and retention for the data set.
Space Allocation: DATA Component KSDS INDEX Component
Specify the required storage space for the data set components in both the DATA Component and INDEX Component columns. The default values are used when you leave these fields blank. The INDEX component can be specified on a generic unit or volume that is different from the DATA component.
Volume Serial or Generic Unit: (Data component (and Index for KSDS))
- The volume serial or generic group name or unit of the direct access volume you wish to contain the data set, or
- if blank, eligibility is determined by the "UNIT" information in your user entry in the TSO "User Attribute Dataset" (UADS) or by SYSDA.
Generic unit
Generic unit address for the direct access volume to contain the data set.
This field is displayed on a non-SMS system.
Specify a data set location in either a Volume serial or Generic unit field. File-AID uses the authorized default volume if both fields are left blank.
Volume serial
Specify the volume serial of the direct access device that contains the data set.
When using SMS and allocating a non-SMS managed data set, a Volume serial is required.
Units
Specify one of the following storage unit types depending on how the data set size is expressed:
TRKS - Tracks
CYLS - Cylinders
RECS - Records.
K - Kilobytes
M - Megabytes.
If the RECS value is specified, File-AID uses the value specified in the Average record size field for the unit quantity.
Primary
Specify the primary allocation quantity as specified in the space units field.
INDEX Component space is only allowed for KSDS.
Secondary
Specify the secondary allocation quantity as specified in the space units field.
Reuseable
Specify whether the cluster is to be reusable with a value of Y (Yes) or N (No).
Key length
For keyed data sets, specify a value. For KSDS clusters, this value must be between 1 and 255. For RRDS clusters, any number 0-255 is valid. Otherwise this should be zero.
Key position
For keyed data sets, specify a value.
For KSDS clusters, the relative position of the key field. Any number from 0 through record length - 1 is valid. For RRDS, if key length is zero then key position must also be zero, otherwise same as for KSDS.
Average Recordsize
Specify a value, in bytes, for the average record length to be stored in the cluster. If the records are fixed length, the average and maximum should be the same.
Maximum Recordsize
Specify a value for variable length records, the length of the longest record expected in the cluster.
Expiration date
(Optional) Specify a date after which deletion or update of data set is permitted in the format: YYYY/MM/DD.
Extended allocate
Specify either a Y (Yes) or N (No) value. When this field is set to Y, File-AID displays a second Allocate VSAM Cluster screen, as shown in the following figure. If you want to allocate a multi-volume data set, specify a Y to display the second allocation screen.
Entering N does not display the second screen of allocation attributes. All other attributes are initialized to either the SMS default values or those of the model data set. These values are not displayed when a value of N is specified.
Allocate New VSAM Cluster Screen 2
Field Descriptions
Specify Multiple Volumes
Specify whether you want to allocate the data set on multiple volumes. Valid entries are Y (Yes) or N (No). When you specify Y, File-AID displays the Allocate VSAM Cluster (continued) screen, as shown in Allocate New VSAM Cluster Screen 3, for you to enter the volume information for your DATA and INDEX component.
Specify control interval characteristics.
Control Interval
Specify a number (0 to 100) representing the percentage of space free in a control interval for later processing. If omitted, 0 is assumed.
Control Area
Specify a number (0 to 100) representing the percentage of space free in a control area for later processing. If omitted, 0 is assumed.
Data C/I size
Specify a numeric value representing the control interval size for the DATA component of the cluster. It must be a multiple of 512 (the minimum value allowed). If not entered, File-AID will calculate a value based on record length.
Index C/I size (KSDS only)
Specify a numeric value representing the control interval size for the INDEX component of the cluster. It must be a multiple of 512 (the minimum value allowed). If not entered, File-AID will calculate a value based on record length and Data C/I size.
Buffer space
Specify a numeric value representing the minimum amount of buffer space to be used by a processing program. This value should be a multiple of 512. If not entered, File-AID will calculate a minimum default value.
Specify Allocation Options:
Region share option
Specify the type of sharing among regions:
1 - Multi-user: read only; single user: read/write
The data set can be shared by any number of users for READ processing. VSAM ensures data integrity.
2 - Multi-user: read; single user: write
The data set can be shared by any number of users for read processing, and can also be accessed by one user for update processing. ENQ/DEQ required for read integrity.
3 - Multi-user: read/write
The data set can be shared by any number of users for read or update processing. Each user is responsible for integrity.
4 - Multi-user: read/write, requires ENQ and DEQ.
The data set can be shared by any number of users for read or update processing, and buffers used for direct processing are refreshed for each request.
System share option
Specify the type of sharing among systems:
3 - Fully-shared system
The data set can be fully shared by all users on all systems. Each user is responsible for read and write integrity.
4 - User is responsible for system integrity.
The data set can be fully shared by all users on all systems. Buffers used for direct processing are refreshed for each request. Reserve/release macros required.
Write check
Enter Y for yes or N for no to specify whether each write operation should be checked for correctness.
Erase on delete
Enter Y for yes or N for no to specify whether a record should be erased from a Control Interval when it is deleted.
Extended Attributes (EATTR):
O - Specifies that extended attributes are optional for this data set.
N - Specifies that the data set cannot have extended attributes.
Exception-Exits (Data and Index components):
The name of a user-written exception-exit routine that receives control when an exceptional I/O error occurs for the Component.
Load option
R - Requests the Recovery option, which will cause Data Control Intervals to be preformatted before data records are inserted.
S - Requests the Speed option, which will not preformat Control Intervals.
Spanned records
Enter Y for yes or N for no to specify whether data records can be longer than the Control Interval Length and can cross (span) Control Intervals.
Account Information
Defines up to 32 bytes of accounting information and user data for the data set.
Encryption
Keylabel
(z/OS 2.3 and up) Identifies the name, up to 64 bytes, of the key label to be used to encrypt the new data set.
RLS
(z/OS 2.1 and up)
RLSENABLE - The cluster component is defined in RLS enable mode.
RLSQUIESCE - The cluster component is defined in RLS quiesce mode.
LOGREPLICATE
(z/OS 2.1 and up)
LOGREPLICATE - VSAM dataset is eligible for VSAM replication. When LOGREPLICATE is specified then LOGSTREAMID must also be specified.
NOLOGREPLICATE - The data set is not eligible for VSAM replication.
LOG
NONE - This option declares the data set to be nonrecoverable.
UNDO - This option declares the data set to be backward recoverable.
ALL - This option declares the data set to be both backward recoverable and forward recoverable.
LOGSTREAMID
Gives the name of the forward recovery log stream.
FRLOG (BATCH LOGGING)
ALL - Enables the changes made to your VSAM dataset to be both backed out and forward recovered using the VSAM logging.
NONE - Indicates that the data set can be used for VSAM batch logging. However, the function should be disabled.
REDO - Enables the changes made to your VSAM dataset to be forward recovered using VSAM logging.
UNDO - Enables the changes made to your VSAM dataset to be backed out using VSAM logging.
BWO (Backup while open)
TYPECICS - Used to specify BWO in a CICS environment. For RLS processing, this activates BWO processing for CICS or DFSMStvs, or both. For non-RLS processing, CICS determines whether to use this specification or the specification in the CICS file control table (FCT).
TYPEIMS - Used to enable BWO processing for IMS data sets.
NO - Used when BWO does not apply to the cluster.
Allocate New VSAM Cluster Screen 3
Field Descriptions
DATA COMPONENT:
Enter number of volumes here or specific VOLSERs below:
Specify either the number of generic volumes or specific volume serial numbers for the data component.
INDEX COMPONENT:
Enter number of volumes here or specific VOLSERs below:
For a KSDS data set, specify either the number of generic volumes or specific volume serial numbers for the index component.
Use the END command (PF3) to cancel the multi-volume processing. Press Enter to continue the allocation.