Allocate component

The Allocate component functions (options AK, AB, AE, AR, AZ, AL, AJ, and AI) are used to allocate online or in batch new VSAM components and IAM data sets. See Allocate-IAM for information on allocating IAM data sets.

The VSAM utility displays the appropriate allocation screen based on the option used.

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, scroll down to access many additional attributes for VSAM cluster definition.

To allocate a new VSAM component, fill in the following fields on the VSAM Utility screen (VSAM Utility Screen):

  • Enter the appropriate option type.
  • Enter the new component name in the “Dataset name” field.
  • Set processing option to O (online), B (Batch), or I (Batch IDCAMS).
  • Enter a Model Dataset Name if the new data set is to have the same allocation characteristics as an existing dataset. The model data set 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.

When you press Enter, File-AID displays the appropriate allocate screen based on the option selected. A KSDS allocate screen is shown in the following figure as an example. If a value was specified in the Model data set name field, the displayed attributes are those of the model data set. 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

.  File-AID ------------  Allocate VSAM Cluster KSDS ----------------------------  .
.  COMMAND ===>                                                                    .
.                                                                                  .
.                                                                                  .
.  Component names:                                                                .
.  Cluster:                 'USERID9.TEST.VSAMALL'                                 .
.  Data component      ===> 'USERID9.TEST.VSAMALL.DATA'                            .
.  Index component     ===> 'USERID9.TEST.VSAMALL.INDEX'                           .
.  Dataset type        ===> KSDS                                                   .
.  Owner ID            ===>                                                        .
.  Specify SMS Class Information:                                                  .
.  Storage             ===> STDDODFW                                               .
.  Data                ===>                                                        .
.  Management          ===> SAMPLE@S                                               .
.                                                                                  .
.  Space Allocation:   DATA Component  INDEX Component (Blank for default)         .
.  Volume serial       ===> PRD914     ===> PRD914                                 .
.  Units               ===> TRKS       ===> TRKS      (TRKs; CYLs; RECs; K; M)     .
.  Primary             ===> 1          ===> 1         (Amount in above units)      .
.  Secondary           ===> 1          ===> 1         (Amount in above units)      .
.                                                                                  .
.  Key length                     ===> 5         (1-255)                           .
.  Key position                   ===> 0         (0-max)                           .
.  Average Recordsize             ===> 198                                         .
.  Maximum Recordsize             ===> 198                                         .
.  Data  Control Interval Size    ===> 2048                                        .
.  Index Control Interval Size    ===> 2048                                        .
.  Buffer Space                   ===> 6144                                        .
.  Control Interval Percent Free  ===> 0                                           .
.  Control Area Percent Free      ===> 0                                           .
.                                                                                  .
.  Allocation Options:                                                             .
.   Expiration date         ===>            (YYYY/MM/DD or blank)                  .
.   Reusable                ===> YES        (Y = Yes; N = No)                      .
.   Region share option     ===> 3          (1; 2; 3; 4)                           .
.   System share option     ===> 3          (3; 4)                                 .
.   Write check             ===> NO         (Y = Yes; N = No)                      .
.   Erase on delete         ===> NO         (Y = Yes; N = No)                      .
.   Extended Attributes     ===>            (EATTR: O = Opt; N = No)               .
.   Exception-Exits                                                                .
.    Data Component         ===>                                                   .
.    Index Component        ===>                                                   .
.   Load option             ===> RECOV      (S = Speed; R = Recovery)              .
.   Spanned records         ===> NO         (Y = Yes; N = No)                      .
.   RLS                     ===>            (E=RLSENABLE; Q=RLSQUIESCE)            .
.   LOGREPLICATE            ===>            (L=LOGREPLICATE; N=NOLOGREPLICATE)     .
.   LOG                     ===>            (N=NONE; U=UNDO; A=ALL)                .
.   LOGSTREAMID                                                                    .
.   (Fully Qualified Name)  ===>                                                   .
.   Encryption:                                                                    .
.   Keylabel   (Name of the Key Label to be used for encryption)                   .
.   ===>                                                                           .
.   Account Information     ===>                                                   .
.   FRLOG (Batch Logging)   ===>            (N=NONE; U=UNDO; R=REDO; A=ALL)        .
.   BWO (Backup While Open) ===>            (C=TYPECICS; I=TYPEIMS; N=NO)          .
.                                                                                  .
.  Multiple Volumes    ===> NO              (Y = Yes; N = No)                      .
.                                                                                  .
. Use ENTER to Allocate Dataset, END to cancel request                             .

Important

The above figure is scrollable on the smaller screen display.

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

The field descriptions below may or may not be displayed on the allocate screen depending on which allocate option you selected. Some are used for all component types while others are only used for specific types. For additional information, see online help.

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 data set name generated by File-AID. This field is modifiable.

Index component

Index component data set name generated by File-AID. This field is modifiable. (Index component used for BSON, JSON, VRRDS, and KSDS clusters.)

Dataset type

Shows the dataset type based on the allocate option selected. This is not changeable. The example shows KSDS as though the AK option was specified.

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.

Important

Any SMS data set allocation problems are indicated with an IDCAMS Error Message Display screen.

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.

Important

  1. If an installation option for a default VSAM unit has been supplied, it will override any VOLSER or Unit specified here.
  2. In some situations you are only allowed to enter eligible volumes even when specifying the volume serial. In other situations you may enter any mounted volume. This is an installation option.
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 recordsize 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.

Keyname 

Specify one of the following options:

N—No KEYNAME required

E—File-AID/MVS presents a panel to enter a KEYNAME for this JSON/BSON allocation

D—File-AID/MVS presents a panel to enter a Dataset Name that contains the KEYNAME for this JSON/BSON allocation. The dataset must be Sequential F/B LRECL = 255 or V/B LRECL=259.

A KEYNAME can be up to 255 bytes.

After you have entered a valid KEYNAME or provided them in a dataset, File-AID/MVS changes this field to Y to indicate that KEYNAME are used in the allocation.

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.

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 the following figure, for you to enter the volume information for your DATA and INDEX component.

Allocate VSAM Cluster screen (continued)

.  File-AID ------------  Allocate VSAM Cluster (continued)  --------------------- .
.  COMMAND ===>                                                                    .
.                                                                                  .
.   - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -* .
.  DATA COMPONENT: 'USERID9.TEST.VSAMALL.DATA'                                     .
.  Enter number of volumes here ===>     or specific VOLSERs below:                .
.     1. ______  2. ______  3. ______  4. ______  5. ______  6. ______  7. ______  .
.     8. ______  9. ______ 10. ______ 11. ______ 12. ______ 13. ______ 14. ______  .
.    15. ______ 16. ______ 17. ______ 18. ______ 19. ______ 20. ______ 21. ______  .
.    22. ______ 23. ______ 24. ______ 25. ______ 26. ______ 27. ______ 28. ______  .
.    29. ______ 30. ______ 31. ______ 32. ______ 33. ______ 34. ______ 35. ______  .
.    36. ______ 37. ______ 38. ______ 39. ______ 40. ______                        .
.   - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -* .
.  INDEX COMPONENT: 'USERID9.TEST.VSAMALL.INDEX'                            .
.  Enter number of volumes here ===>     or specific VOLSERs below:                .
.     1. ______  2. ______  3. ______  4. ______  5. ______  6. ______  7. ______  .
.     8. ______  9. ______ 10. ______ 11. ______ 12. ______ 13. ______ 14. ______  .
.    15. ______ 16. ______ 17. ______ 18. ______ 19. ______ 20. ______ 21. ______  .
.    22. ______ 23. ______ 24. ______ 25. ______ 26. ______ 27. ______ 28. ______  .
.    29. ______ 30. ______ 31. ______ 32. ______ 33. ______ 34. ______ 35. ______  .
.    36. ______ 37. ______ 38. ______ 39. ______ 40. ______                        .
.                                                                                  .
.  End to continue allocation, use  Cancel to cancel multiple volumes.             .
.                                                                                  


Specify control interval characteristics.

Important

If any control interval field is left blank or has a value of 0 (zero), VSAM supplies a value based on the record attributes.

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 (BSON, JSON, VRRDS, and KSDS)

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.

 

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