DSALLOC—Allocate Data Sets for Group/Type

The DSALLOC service allocates a ddname that corresponds to a hierarchy view specified by the user. The hierarchy view is a concatenation of the PDS data sets, beginning with the PDS data set for the first_group and adding the PDS for each group above it in the hierarchy. If the ddname already exists, the old ddname is replaced with the new ddname. If unallocated data sets are contained in the hierarchy view, then only the allocated data sets are associated with the ddname. The list of data sets allocated to the ddname does not include extended types.

Command invocation format


>>-FLMCMD--DSALLOC,project--,-+---------+--,first_group--------->
                              '-prj_def-'                 

     .-P-.                                  
>--,-+---+--,total_groups--,type--,ddname----------------------><
     '-A-'

Call invocation format


>>-lastrc--:=--FLMLNK('DSALLOCb',sclm_id--,first_group---------->

>--,-+-A-+--,total_groups--,type--,ddname--,$msg_array);-------><
     '-P-'

ISPF interface panel

Figure 1. DSALLOC Service panel

   Menu  SCLM  Utilities  Help
 ──────────────────────────────────────────────────────────────────────────────
                   SCLM FLMCMD DSALLOC Service - Entry Panel

 SCLM Library To Allocate:
    Project . . . SCLMTEST
    Alternate . .         
    First Group   DEV1    
    Type  . . . . SOURCE  

 Total number of groups  . . . . . .      (Zero for entire hierarchy)
 Type of hierarchy to be allocated      1. All groups
                                        2. Primary groups only

 DD Name for output data set:
    DD Name to allocate . .          





 Command ===>                                                                  
  F1=HELP      F2=          F3=END       F4=DATASETS  F5=FIND      F6=CHANGE
  F9=SWAP     F10=LEFT     F11=RIGHT    F12=SUBMIT

Parameters

project

The project name. The maximum parameter length is 8 characters. This parameter is used for FLMCMD only.

prj_def

The project definition name used for the allocate. It defaults to the project parameter. The maximum parameter length is 8 characters. This parameter is used for FLMCMD only.

sclm_id

The SCLM ID associated with a given project. The INIT service generates the SCLM ID. Maximum parameter length is 8 characters. This parameter is used for FLMLNK only.

first_group

The first group in the hierarchy to be allocated to the ddname. Maximum parameter length is 8 characters. This group defines the desired view of the hierarchy. DSALLOC allocates the data sets SCLM uses to search the hierarchy from the group specified.

A|P

A 1-character value indicating the type of hierarchy to be allocated to the ddname. Acceptable values are:

A: All groups
P: Primary groups only.

For FLMCMD, the default value is P. There is no default value for FLMLNK.

total_groups

The numeric value corresponding to the number of groups for which the allocation is performed. This number includes the first_group. Specify a zero ( 0 ); if the entire hierarchy view is wanted. The default value is zero. If this value is greater than the number of groups in the view, all groups in the view are allocated and a warning occurs. The maximum parameter length is 3 characters.

type

The name of the type for which the allocation is performed. Maximum parameter length is 8 characters.

ddname

The ddname for the allocated physical data sets corresponding to the desired hierarchy view. The physical data set names are dynamically allocated to the ddname. You can specify the ddname to be used or leave it blank for the FLMLNK interface. If the ddname already exists, the old ddname is replaced with the new ddname. A blank value is not allowed for FLMCMD. If the ddname is blank, SCLM creates a ddname and uses it to allocate data sets; this name is returned to the user. Maximum length of this field is 8 characters.

$msg_array

An output parameter pointing to the message array. See Pointer parameter descriptions for more information about $msg_array. This parameter is used for FLMLNK only.

Return codes

Additional special services messages are written to the FLMMSGS ddname. See SCLM service messages for more information.

Other return codes might be produced by the FLMCMD or the FLMLNK processor. See SCLM service return codes for more information.

Possible return codes are:

0: Normal completion.
4: Warning condition. The $msg_array parameter contains the warning message associated with this condition. A warning occurs if the number of data sets allocated to the ddname is less than the number requested in the total_groups parameter.
8: Error condition. The $msg_array parameter contains the error message associated with this condition.

Example of command invocation

FLMCMD DSALLOC,PROJ1,,USER1,P,4,SOURCE,APPL

This service invocation returns the ddname APPL with the physical data set names corresponding to the hierarchy view specified by the first_group and the total number of groups. If the hierarchy consisted of 4 groups (USER1, INT, TEST, and RELEASE), these 4 physical data set names would be allocated to ddname APPL. A user wanting a ddname corresponding to a single group would specify the same group for the first_group and 1 for the total number of groups.

Example of call invocation

Note: This example shows general syntax. Call invocations are language-specific. See Sample programs using SCLM services, for specific examples.

lastrc := FLMLNK ('DSALLOC ',       (* service               *)
                  sclm_id,          (* SCLM ID               *)
                  'USER1   ',       (* first group           *)
                  'P',              (* hierarchy             *)
                  4,                (* total groups          *)
                  'SOURCE  ',       (* type                  *)
                  ddname,           (* ddname to allocate    *)
                  $msg_array);      (* message array pointer *)

Assume that the ddname for the preceding example is APPL. This service invocation returns the ddname APPL with the physical data set names corresponding to the hierarchy view specified by the first_group and the total number of groups. If the hierarchy consisted of 4 groups (USER1, INT, TEST, and RELEASE), these 4 physical data set names would be allocated to ddname APPL. Note the project is determined by the sclm_id that is obtained by the INIT service call. A user wanting a ddname corresponding to a single group would specify the same group for the first_group and 1 for the total number of groups.