IAMDRCC — Control statements

IAM Dynamic Reorganization has the following control statements: BEGIN, END, REORG, COPY, RESET. REORG is the primary command to perform reorganizations. Two commands are used for the High Activity Toleration feature which are BEGIN and END, which will surround the REORG commands that are to be performed with the High Activity Toleration Feature. COPY provides a non-fuzzy backup of a data set while it is open to for update to CICS. RESET is usually only needed when BMC support advises to use it.

BEGIN command

Start High Activity Toleration (HAT) mode Dynamic Reorganizations. This command will enable CICS Exits to help monitor the CICS I/O for unavailable status errors. All REORG commands entered between the BEGIN and END commands will be processed using these exits. When the exits are active and a data set has an unavailable status during the short period of time that the data set needs to be closed, the exits will delay the I/O until the reorganization process for that data set ends. If no END command is entered, the exits will be active in the CICS region until all SYSIN commands have been processed.

If the data sets to be reorged are under IAM/RLS control, use RLSID=xxxx instead of CICS=applid. The CICS regions involved will be obtained from the IAM/RLS address space and the CICS HAT GLUE exits will be activated there.

If you use the BEGIN command to activate the HAT CICS exits then you do not need to include CICS= or RLSID= keywords on the REORG statements between the BEGIN and END statements.

Only 1 job using BEGIN/END can be active in any CICS region at one time, and within a reorg job, only 1 CICS region at a time will be subject to the High Activity Exits.

Dynamic Reorganization BEGIN Command

BEGIN CICS=applid | RLSID=rlsid
[,ENQACT= WAIT | END]

The following table describes the BEGIN command operands:

Operand	Description:
CICS=	(Required) Specifies the APPLID of the target CICS Region which will have the High Activity Toleration Exits started.
ENQACT=	(Optional) Specifies the action to take if there is already another BEGIN/END using IAMDRCC job running against the same CICS region. Values are WAIT for the ENQUE to be available, or END to terminate the reorganization job immediately with a return code of 4. Default if not specified is WAIT.
RLSID=	For data sets that are under IAM/RLS control supply the RLSID that controls the data set that is being reorganized. If you supply the RLSID then don’t include the CICS keyword. The CICS region APPLID involved will be obtained from the IAM/RLS region.

END command

The END command has no operands. It will terminate the High Activity Toleration exits under the CICS region specified by the preceding BEGIN command and will allow either another High Activity Toleration reorganization to be done under a different CICS region, or reorganizations without the use of the High Activity Toleration Feature.

If the END statement is not specified, then the exits will remain active until the end of the job step.

REORG command

The following shows the keywords and valid values for Dynamic Reorganization:

REORG [AUTO=(NO | CLOSE, |RENAME, | OPEN)]
          [,CICS=applid | RLSID=rlsid]
          [,DATACLAS= SMS Data Class Name]
          [,FROMDSN= Name of IAM data set to reorganize]
           [,IFEXTENDED]
          [,IFOVERFLOW>nnnnnnnnn]
          [,MGMTCLAS= SMS Management Class Name]
          [,MSGPRT=]
          [,SAVEDSN= New dsn for the original data set]
          [,SAVESFX= New Suffix for original dsn]
          [,STORCLAS= SMS Storage Class]
          [,SUFFIX= mmddyy | ddmmyy | yyddd | yyyyddd]
          [,TODSN= Initial Reorganized IAM data set name]
          [,TRANID=cccc]
          [,VOLUMES=(volser1,volser2,.....)

The following table describes the REORG command operands. The operands are presented in alphabetic sequence.

Required operands include FROMDSN, TODSN, and CICS or RLSID. Other operands are optional. We recommend you to not override the default of AUTO=(CLOSE,RENAME,OPEN) unless there is a special circumstance to do so.

Operand	Description
AUTO=	(Optional) Controls if any actions are to be performed automatically. If not specified all three operations are automatically performed. If AUTO= IS is specified, only the options specified is performed automatically. The valid values are: NO—None of the three actions identified below are automatically performed. They all need to be done by the user manually. If you do not reply to message IAML0318 with a C then the reorganization is incomplete, and the output file of the reorg does not have all of the updates done to it that were performed during the reorganization. CLOSE—Automatically requests CICS to close the IAM file when it has finished the initial reorganization copy process. If the close is not performed automatically, then IAMDRCC issues an IAML0318 WTOR message requiring you to respond with a C that indicates the file has been closed and allow IAMDRCC to enter the synchronization phase, or a T to terminate. If terminated at this point the reorganization is incomplete, it is not safe to use the copy of the data set. We highly recommend that you should allow IAMDRCC to automatically close the data set that has been reorganized so IAMDRCC completes applying all of the changed, inserted, and deleted records while the reorganization was in progress. RENAME—Automatically performs the renames of the original old data to the specified name value and rename the new copy to the original data set name. If this is not specified, then IAMDRCC issues an IAML0319 WTOR. When the operator replies with a C to continue, IAMDRCC resumes the processing and performs the rename. The operator can reply with a T to terminate the reorganization process. If terminated at this point, the IAMDRCC reorganization process has been completed and the new copy is ready to be used. OPEN—Automatically requests CICS to open the reorganized copy of the IAM data set that has been renamed to the original data set name. If open is not performed automatically then message IAML0320 will be displayed indicating that IAMDRCC has completed, however the newly reorganized data set has not yet been opened under CICS. DEFAULT—Performs all three of the above actions automatically. Recommendation—Unless there is a compelling reason not to do so, users are highly encouraged to run with the default which eliminates the need for any operator action for the reorganization process to complete. Important If you decide to manually rename the original and new reorged data sets and these data sets are IAM Linear Encrypted data sets, then make sure to rename both the Linear data set Cluster Name and the Linear data set Data Component Name.
CICS=	Parameter that specifies the applid of the CICS region that has the IAM data set that is to be reorganized. If CICS was supplied on an enveloping BEGIN command, then you do not need to include it on the REORG command. Either CICS or RLSID must be included but not both.
DATACLAS=	(Optional) Specifies the data class for the new reorganized copy of the data set if a different Data Class than what the original data set has is desired. Only applicable when the dynamic reorganization process will be defining the data set. DEFAULT—If the data set (TODSN) will be defined by the reorganization process, the default Data Class is the one which is assigned to the original data set (that is, the DSN coded on the FROMDSN parameter).
FROMDSN=	(Required) Specifies the data set name of the IAM data set that is to be reorganized. The data set must be opened for update in the specified CICS region and have data in the overflow and/or prime extension areas of the file. It is advisable that the data set not be in use by other jobs or address spaces during the reorganization process.
IFEXTENDED	(Optional) Specifies that IAMDRCC only performs the reorganization if the IAM data set is using the Extended Data area of the data set, which includes the Overflow area and the Prime Extension (PE) area. Default is that no explicit criteria is used to control whether or not the REORG is performed.
IFOVERFLOW>	(Optional) Specifies that IAMDRCC only performs reorganization if the number of records in the overflow area exceed the specified quantity. Default is that no explicit criteria is used to control whether or not the REORG is performed.
IFPCTOV>nn	(Optional) Specifies that IAMDCC only perform the reorganization if the file has more than the specified percentage of the total records in the overflow area. Some suggested values of 10 or higher are suggested. Default is to reorganize any file. Overflow record conditions will not be checked.
MGMTCLAS=	(Optional) Specifies the Management Class for the new reorganized copy of the data set if a different Management Class than what the original data set has is desired. Only applicable when the dynamic reorganization process will be defining the data set. DEFAULT—If the data set (TODSN) will be defined by the reorganization process, then the default Management Class is the one which is assigned to the original data set (i.e. the DSN coded on the FROMDSN parameter).
MSGPRT=	(Optional) Specifies what printed output for the SORT to produce to the SYSOUT DD statement. Up to two values can be specified. ALL—Specifies that all operational sort messages and the control cards will be printed. Equivalent to specifying (ALL,LIST). if (ALL,NOLIST) is specified then the control cards passed to the SORT are not printed. CRITICAL—Specifies that only critical messages are printed, primarily when the sort encounters an error or failure. NONE—Specifies that no sort messages will be written to SYSOUT DD. LIST—Specifies that the control cards passed to the SORT will be included in the listing. NOLIST—Specifies that the control cards will not be included in the list. Default—(CRITICAL,NOLIST) No output will be printed unless there is an error during the SORT processing.
RLSID=	For data sets that are under IAM/RLS control supply the RLSID that controls the data set that is being reorged. If RLSID was supplied on an enveloping BEGIN command, then you do not need to include it on the REORG command. Either CICS or RLSID must be supplied but not both.
SAVEDSN=	(Optional) Specifies the full data set name to be used as the new name of the original IAM data set (FROMDSN) when the reorganization process is completed and the rename is performed. DEFAULT—None. If not specified, then a suffix will be added to the end of the original data set name when it is renamed. If the IAM data set is a Linear Encrypted data set, then both the Cluster and Data Component will be renamed.
SAVESFX=	(Optional) Specifies the date mask for the suffix that IAMDRCC will append to the original input IAM data set name on completion of the reorganization. The suffix will consist of .D appended with the date or .T using one of the following specified mask values: MMDDYY—Numeric month, day, and 2-digit year. DDMMYY—Day, numeric month and 2-digit year. YYDDD—Two digit year followed by 3-digit Julian day of the year. YYYYDDD—Four digit year followed by 3-digit Julian day of the year. HHMMSS—Six digit time stamp. DEFAULT—A suffix with a mask of MMDDYY will be used.
STORCLAS=	(Optional) Specifies the Storage Class for the new reorganized copy of the data set if a different Storage Class than what the original data set has is desired. Only applicable when the dynamic reorganization process will be defining the data set. DEFAULT—If the data set (TODSN) will be defined by the reorganization process, then the default Storage Class is the one which is assigned to the original data set (i.e. the DSN coded on the FROMDSN parameter).
SUFFIX=	(Optional) Specifies the 1 to 8 character suffix to add to the end of the original input data set name, preceded by a “.” when IAMDRCC performs rename processing. The value specified must be valid characters for the data set name. DEFAULT—None, unless otherwise specified IAMDRCC will use the date for the suffix.
TODSN=	(Required) Specifies the name of the IAM data set that will be created to contain the reorganized copy of the original input data set specified by the FROMDSN parameter. It is highly recommended that this data set be a new data set, particularly if it is expected to reside on multiple volumes. If the data set does not exist at the time of execution, it will be defined based upon information from the original input data set. When it is being defined by the Dynamic Reorganization program, you can also specify the DATALCAS, MGMTCLAS, STORCLAS, or the VOLUMES parameter to be used instead of the values from the original data set. Upon completion of the reorganization process, this data set will be renamed to the name of the original input data set and opened under the connected CICS region. DEFAULT—None, this is a required parameter.
TRANID=	(Optional) Specifies the four-character name of the IAM Dynamic Reorganization transaction. Only needs to be specified if it is different from the default. The default is IDRS.
VOLUMES=	(Optional) Specifies the volumes for the new reorganized copy of IAM data set. Up to 59 6-character volume serials can be specified. DEFAULT—(Optional) If the data set (TODSN) will be defined by the reorganization process, then the default volume list are the volumes that the original IAM data set specified by the FROMDSN parameter resides on.

COPY command

   COPY [CICS=applid | RLSID=rlsid]
         [,DATACLAS= SMS Data Class Name]
         [,FROMDSN= Name of IAM data set to reorganize]
         [,MGMTCLAS= SMS Management Class Name]
         [,MSGPRT=]
         [,STORCLAS= SMS Storage Class]
         [,TODSN= Initial Reorganized IAM data set name]
         [,TRANID=cccc]
         [,VOLUMES=(volser1,volser2,.....)

The following table describes the Dynamic Reorganization COPY command operands. The operands are presented in alphabetic sequence. Required operands include FROMDSN, TODSN, and CICS or RLSID. Other operands are optional.

Operand	Description
CICS=	Parameter that specifies the applid of the CICS region that has the IAM data set that is to be copied. Either CICS or RLSID must be included but not both.
DATACLAS=	(Optional) Specifies the Data Class for the new reorganized copy of the data set if a different Data Class than what the original data set has is desired. Only applicable when the dynamic reorganization copy process will be defining the data set. DEFAULT – If the data set (TODSN) will be defined by the reorganization process, the default Data Class is the one which is assigned to the original data set (that is, the DSN coded on the FROMDSN parameter).
FROMDSN=	(Required) Specifies the data set name of the IAM data set that is to be copied. The data set must be opened for update in the specified CICS region and have data in the overflow and/or prime extension areas of the file. It is advisable that the data set not be in use by other jobs or address spaces during the copy process.
MGMTCLAS=	(Optional) Specifies the Management Class for the new reorganized copy of the data set if a different Management Class than what the original data set has is desired. Only applicable when the dynamic reorganization copy process will be defining the data set. DEFAULT – If the data set (TODSN) will be defined by the reorganization process, then the default Management Class is the one which is assigned to the original data set (that is, the DSN coded on the FROMDSN parameter).
MSGPRT=	(Optional) Specifies what printed SORT output is produced to the SYSOUT DD statement. You can specify up to two values. ALL—Specifies that all operational sort messages and the control cards will be printed. Equivalent to specifying (ALL,LIST). If (ALL,NOLIST) is specified then the control cards passed to the SORT are not printed. CRITICAL—Specifies that only critical messages are printed, primarily when the sort encounters an error or failure. NONE—Specifies that no sort messages will be written to SYSOUT DD. LIST—Specifies that the control cards passed to the SORT will be included in the listing. NOLIST—Specifies that the control cards will not be included in the list. DEFAULT—(CRITICAL,NOLIST) No output will be printed unless there is an error during the SORT processing.
RLSID=	For data sets that are under IAM/RLS control supply the RLSID that controls the data set that is to be copied. Either CICS or RLSID must be supplied but not both.
STORCLAS=	(Optional) Specifies the Storage Class for the new reorganized copy of the data set if a different Storage Class than what the original data set has is desired. Only applicable when the dynamic reorganization process will be defining the data set. DEFAULT – If the data set (TODSN) will be defined by the reorganization process, then the default Storage Class is the one which is assigned to the original data set (i.e. the DSN coded on the FROMDSN parameter).
TODSN=	(Required) Specifies the name of the IAM data set that is created to contain the reorganized copy of the original input data set specified by the FROMDSN parameter. It is highly recommended that this data set be a new data set, particularly if it is expected to reside on multiple volumes. If the data set does not exist at the time of execution, it will be defined based upon information from the original input data set. When it is being defined by the Dynamic Reorganization program, you can also specify the DATALCAS, MGMTCLAS, STORCLAS, or the VOLUMES parameter to be used instead of the values from the original data set. DEFAULT – None, this is a required parameter.
TRANID=	(Optional) Specifies the four-character name of the IAM Dynamic Reorganization transaction. You must specify this keyword only if it is different from the default. The default is IDRS.
VOLUMES=	(Optional) Specifies the volumes for the new reorganized copy of IAM data set. You can specify up to five-to-six-character volume serials. DEFAULT – Optional keyword. If the data set (TODSN) will be defined by the reorganization copy process, then the default volume list are the volumes that the original IAM data set specified by the FROMDSN parameter resides on.

The RESET command may need to be used if a Dynamic Reorg job does not run to completion. IAM Dynamic Reorg has recovery routines that will perform the below Reset operations automatically, but it might be necessary to run one or both types of Resets manually. IAM Technical Support might request that you run these Reset operations.

Warning

Do not run the RESET command if an

IAM

Dynamic Reorg job is currently running.

Dynamic Reorganization RESET command

RESET CICS=applid | DRT

The following table describes the RESET command operands. Either the CICS or DRT keyword must be coded.

Operand	Description
CICS=	Specifies the applid of the CICS region that will get its tokens and flags cleared and have its IAM HAT exits disabled if they are still active.
DRT	Specifying a keyword of DRT instructs the IAMDRCC utility to clear the internal Dynamic Reorg Table. The Dynamic Reorg Table holds the data set names that are actively being reorganized by the IAMDRCC utility.