Utility control statements for the Online Structure Change utility
Utility control statements for the Online Structure Change utility define the user description of the GLOBAL command, RESTRUCTURE command, ALLOCATE subcommand, JCLPARM subcommand, and optional LOADCTL subcommand, all of which control the OSC process.
Utility control statements must be specified in the HFPSYSIN data set. This control statement data set usually resides in the input stream. However, it can also be defined as a sequential data set or as a member of a partitioned data set. It must contain 80-byte, fixed-length records. Block size, if coded, must be a multiple of 80.
You can change the default values of utility control statement keywords by setting the values in the site default module. For more information, see Setting site default values for the Online Structure Change utility.
Subsections:
GLOBAL command keywords
The GLOBAL command is a required command. Use the GLOBAL command to establish implicit job step keyword values.
For the GLOBAL command, you can specify the keywords that are listed in the following table. For the format of the GLOBAL command, see GLOBAL command keywords.
| Keyword | Required or optional | Description | Topic |
|---|---|---|---|
| IMSCATHLQ |
Optional |
Specifies the high-level qualifier of the bootstrap data set of the IMS directory. | IMSCATHLQ keyword |
| IMSID |
Required |
Specifies the production IMS system ID. | IMSID keyword |
| ITKBSRVR |
Optional |
Specifies the name of the IMS Tools KB server XCF group. | ITKBSRVR keyword |
| MSTIMESTAMP |
Optional |
Specifies whether to include a timestamp in the messages. | MSTIMESTAMP keyword |
| SCAN |
Optional |
Specifies whether to verify the syntax of command, keywords, and parameters without running OSC functions. | SCAN keyword |
| TOIXCFGRP |
Required |
Specifies the XCF group that IMS Tools Online System Interface uses to interface with the Online Structure Change utility. | TOIXCFGRP keyword |
RESTRUCTURE command keywords
The RESTRUCTURE command is a required command. Use the RESTRUCTURE command to specify how you want to change the structure of DEDB areas.
For the RESTRUCTURE command, you can specify the keywords that are listed in the following table. For the format of the RESTRUCTURE command, see RESTRUCTURE command keywords.
| Keyword | Required or optional | Description | Topic |
|---|---|---|---|
| ANALYZE |
Optional |
Specifies to analyze ADSs. | ANALYZE keyword |
| ATASKCTL |
Optional |
Specifies the maximum number of restructured areas to be analyzed concurrently. | ATASKCTL keyword |
| COPYJOB |
Optional |
Specifies the number of jobs to divide the DEDB ADS Create utility internal job into. | COPYJOB keyword |
| DBD |
Required |
Specifies the database description (DBD) that contains the areas to restructure. | DBD keyword |
| ERRORACT |
Optional |
Specifies the action for the utility to take at certain error conditions. | ERRORACT keyword |
| IAREA |
Optional |
Specifies one or more input areas to restructure. | IAREA keyword |
| ITASKCTL |
Optional |
Specifies the maximum number of input areas to process concurrently. | ITASKCTL keyword |
| OAREA |
Optional |
Specifies one or more output areas for the process. | OAREA keyword |
| ORIGADS_PROC |
Optional |
Specifies whether to delete or retain the original ADSs. | ORIGADS_PROC keyword |
| OTASKCTL |
Optional |
Specifies the maximum number of output areas to process concurrently. | OTASKCTL keyword |
| PAD |
Optional |
Specifies the padding character to be used when the segment minimum length is increased due to DBD description change. | PAD keyword |
| PAUSE_INTERVAL |
Optional |
Specifies the interval for issuing the DBRTEST command, which checks whether the DEDB that you want to make changes is not being accessed by other applications. This keyword is effective when IMS Tools Common Pauser is enabled. | PAUSE_INTERVAL keyword |
| PAUSE_WAIT |
Optional |
Specifies the maximum wait time for the active BMP, CICS, and ODBA applications that are accessing the DEDB to stop. This keyword is effective when IMS Tools Common Pauser is enabled. | PAUSE_WAIT keyword |
| PRESTOP |
Optional |
Specifies whether to stop and start the DEDB and areas to prevent losing online updates made by FLD calls. | PRESTOP keyword |
| REPLRAND_AREALVL |
Optional |
Issues the REPLRAND command by using IMS Tools Online System Interface (TOSI) to replace the randomizer. Only certain areas are stopped while the randomizer is replaced. | REPLRAND_AREALVL keyword |
| RUNTYPE |
Optional |
Specifies the operating mode. | RUNTYPE keyword |
| SKIP_OLC |
Optional |
Specifies to skip online change. | SKIP_OLC keyword |
| TAKEOVER_TIME |
Optional |
Specifies when the takeover phase should start. | TAKEOVER_TIME keyword |
| UPDATE_NUMBER |
Optional |
Specifies the threshold for the number of online updates. | UPDATE_NUMBER keyword |
| USR_MAX |
Optional |
Specifies the maximum number of USR (unloaded segment records) data sets that the Online Structure Change utility generates during the unload phase. | USR_MAX keyword |
ALLOCATE subcommand keywords
The ALLOCATE subcommand is a required subcommand. Use the ALLOCATE subcommand to provide the Online Structure Change utility the information that is required to allocate restructured ADSs.
For the ALLOCATE subcommand, you can specify the keywords that are listed in the following table. For the format of the ALLOCATE subcommand, see ALLOCATE subcommand keywords. Also see Example: Specifying the ALLOCATE subcommand.
| Keyword | Required or optional | Description | Topic |
|---|---|---|---|
| ATTRIBUTE |
Required |
Specifies the data set to pass on to Access Method Services for allocating new VSAM clusters. | ATTRIBUTE keyword |
| OAREA |
Required |
Specifies one or more output areas. | OAREA keyword |
JCLPARM subcommand keywords
The JCLPARM subcommand is a required subcommand. Use the JCLPARM subcommand to specify the options to be applied to OSC internal jobs.
For the JCLPARM subcommand, you can specify the keywords that are listed in the following table. For the format of the JCLPARM command, see JCLPARM subcommand keywords.
| Keyword | Required or optional | Description | Topic |
|---|---|---|---|
| COMPRESS |
Optional |
Specifies that the output records in the unloaded files contain compressed segments. | COMPRESS keyword |
| CONFIGLIB_DSN |
Optional |
Specifies the name of the library that contains configuration module HFP#imsid or HFPSETOP. | CONFIGLIB_DSN keyword |
| DATACOMP_SUFFIX |
Optional |
Specifies the suffix portion of the VSAM data component name. | DATACOMP_SUFFIX keyword |
| DBDLIB_DSN |
Required |
Specifies the name of the active DBDLIB library. | DBDLIB_DSN keyword |
| DBRCGRP |
Required |
Specifies the identifier that is assigned to a group of DBRC instances (DBRC sharing group) that access the same RECON data set in the IMSplex. This keyword is for the production IMS systems. | DBRCGRP keyword |
| DBRCGRP_APPLY |
Optional |
Specifies the identifier that is assigned to a group of DBRC instances (DBRC sharing group) that access the same RECON data set in the IMSplex. This keywords is for the IMS DBCTL system. | DBRCGRP_APPLY keyword |
| DBR_NOFEOV |
Optional |
Adds the NOFEOV keyword to the /DBRECOVERY command that is issued to stop the DEDB or DEDB areas in the production IMS systems. | DBR_NOFEOV keyword |
| DBR_NOFEOV_APPLY |
Optional |
Adds the NOFEOV keyword to the TOSI DBRSYNC command that is issued to stop the DEDB or DEDB areas in the IMS DBCTL system. | DBR_NOFEOV_APPLY keyword |
| DCLASS_TEMP |
Optional |
Specifies the SMS data class for the temporary data sets that the Online Structure Change utility dynamically allocates. | DCLASS_TEMP keyword |
| DDNPREFIX_NEW |
Optional |
Specifies the DD name prefix for the new area data sets that the Online Structure Change utility adds to the production environment. This keyword is required when adding new areas. |
DDNPREFIX_NEW keyword |
| DDNPREFIX_SHADOW |
Required |
Specifies the DD name prefix for the shadow area data sets and restructured area data sets that the Online Structure Change utility allocates. | DDNPREFIX_SHADOW keyword |
| DDNPREFIX_UIC |
Required |
Specifies the DD name prefix for the user image copy data sets that the Online Structure Change utility allocates. | DDNPREFIX_UIC keyword |
| DSNMASK_NEW |
Optional |
Specifies the data set name or the mask for the new area data sets that the
Online Structure Change utility adds to the production environment. This keyword is required when adding new areas. |
DSNMASK_NEW keyword |
| DSNMASK_SHADOW |
Required |
Specifies the data set name or the mask for the shadow area data sets and restructured area data sets that the Online Structure Change utility dynamically allocates. | DSNMASK_SHADOW keyword |
| DSNMASK_UIC |
Required |
Specifies the data set name or the mask for the user image copy data sets that the Online Structure Change utility dynamically allocates. | DSNMASK_UIC keyword |
| ENQDSN |
Optional |
Specifies the name of the ENQ data set in which the utility generates internal SYSIN files. | ENQDSN keyword |
| FPLIB_DSN |
Required |
Specifies the name of the IMS Fast Path Solution Pack SHFPLMD0 library. | FPLIB_DSN keyword |
| IMSID_APPLY |
Required |
Specifies the IMS DBCTL system ID that the Online Structure Change utility uses for the apply job. | IMSID_APPLY keyword |
| IMSLIB_DSN |
Required |
Specifies the name of the production IMS SDFSRESL library. | IMSLIB_DSN keyword |
| IMSLIB_DSN_APPLY |
Required |
Specifies the name of the IMS DBCTL SDFSRESL library that is used for the apply job. | IMSLIB_DSN_APPLY keyword |
| IMSPLEX |
Required |
Specifies the name of the IMSplex group that share databases and message queues for the production IMS systems. | IMSPLEX keyword |
| IMSPLEX_APPLY |
Optional |
Specifies the name of the IMSplex group that share databases and message queues for the IMS DBCTL system. | IMSPLEX_APPLY keyword |
| IMSRESLB_EDC_DSN |
Optional |
Specifies the name of the library that contains the segment edit/compression routines that the active ACB member specifies. | IMSRESLB_EDC_DSN keyword |
| IMSRESLB_RND_DSN |
Required |
Specifies the name of the library that contains the randomizing routine that the active ACB member specifies. | IMSRESLB_RND_DSN keyword |
| INTRDR |
Required |
Specifies the member name of the internal reader program in the PROCLIB library. | INTRDR keyword |
| JCLDSN |
Required |
Specifies the name of the OSC internal job data set in which the utility generates OSC internal jobs. | JCLDSN keyword |
| JOBCARDx |
Optional |
Specifies JOB statements for the OSC internal jobs. | JOBCARDx keyword |
| JOBN_PREFIX |
Optional |
Specifies the prefix for OSC internal job names. | JOBN_PREFIX keyword |
| LOGDSN |
Required |
Specifies the name prefix for the OSC internal job log data set. | LOGDSN keyword |
| MCLASS_TEMP |
Optional |
Specifies the SMS management class for the temporary data sets that the Online Structure Change utility dynamically allocates. | MCLASS_TEMP keyword |
| NBA_APPLY |
Optional |
Specifies the IMS DBCTL Fast Path database buffers to be made available for the apply job. | NBA_APPLY keyword |
| NEWDBDLIB_DSN |
Required |
Specifies the name of the new DBDLIB library that contains the database description for the restructured DEDB. | NEWDBDLIB_DSN keyword |
| NEWRESLB_EDC_DSN |
Optional |
Specifies the name of the library that contains the segment edit/compression routines that the new ACB member specifies. | NEWRESLB_EDC_DSN keyword |
| NEWRESLB_RND_DSN |
Required |
Specifies the name of the library that contains the randomizer that the new ACB member specifies. | NEWRESLB_RND_DSN keyword |
| OBA_APPLY |
Optional |
Specifies, for the apply job, additional IMS DBCTL page-fixed buffers to be made available when the normal allotment is used up. | OBA_APPLY keyword |
| PROCLIB_DSN |
Required |
Specifies the name of the PROCLIB library that the production IMS systems use. | PROCLIB_DSN keyword |
| PROCLIB_DSN_APPLY |
Required |
Specifies the name of the IMS DBCTL PROCLIB library. This library is used during the apply job. | PROCLIB_DSN_APPLY keyword |
| PSBNAME_APPLY |
Required |
Specifies the name of the PSB that is used for the apply job. | PSBNAME_APPLY keyword |
| RECONx_DSN |
Required |
Specifies the names of RECON data sets that the production IMS systems use. | RECONx_DSN keyword |
| RECONx_DSN_APPLY |
Required |
Specifies the names of IMS DBCTL RECONx data sets for the apply job. | RECONx_DSN_APPLY keyword |
| SCLASS_TEMP |
Optional |
Specifies the SMS storage class for the temporary data sets that the Online Structure Change utility dynamically allocates. | SCLASS_TEMP keyword |
| SGLXLOAD |
Optional |
Specifies the name of the IMS Tools Base load module library. | SGLXLOAD keyword |
 SORTOPT_FILSZ_PCT |
Optional |
Specifies a percentage value to adjust the FILSZ
parameter value of the SORT control statement. |
SORTOPT_FILSZ_PCT keyword |
| SPACE |
Optional |
Specifies the space requirements for the output data sets that the Online Structure Change utility dynamically allocates to hold unloaded segment data records. | SPACE keyword |
| SPOC_WAITTIME |
Optional |
Specifies the wait time that applies to each of the commands in the batch SPOC utility SYSIN file. | SPOC_WAITTIME keyword |
| SYSAFF |
Required |
Specifies the JES2 member that is eligible to process the job (representing system affinity). | SYSAFF keyword |
| SYSAFF_APPLY |
Optional |
Species the JES2 member that is eligible to process the apply job (representing system affinity). | SYSAFF_APPLY keyword |
| TOIXCFGRP_APPLY |
Required |
Specifies the XCF group that IMS Tools Online System Interface uses to interface with the apply job. | TOIXCFGRP_APPLY keyword |
| TOSILOAD |
Required |
Specifies the name of the load module library for IMS Tools Online System Interface (TOSI). | TOSILOAD keyword |
| UNIT_TEMP |
Optional |
Specifies the physical device type for the temporary data sets that the Online Structure Change utility dynamically allocates. | UNIT_TEMP keyword |
| USRHLQ |
Required |
Specifies the high-level qualifier for the output data sets in which the Online Structure Change utility generates unloaded segment data records. | USRHLQ keyword |
| WKDS_SIZE_PCT |
Optional |
Specifies a percentage value to adjust the
allocation size of intermediate work data sets. |
WKDS_SIZE_PCT keyword |
LOADCTL subcommand keywords
The LOADCTL subcommand is an optional subcommand. The LOAD subcommand specifies the options for loading segments into the restructured ADSs.
For the LOADCTL subcommand, you can specify the keywords that are listed in the following table. For the format of the LOADCTL command, see LOADCTL subcommand keywords.
| Keyword | Required or optional | Description | Topic |
|---|---|---|---|
| INSERT_LIMIT_COUNT |
Optional |
Specifies the maximum number of segments that can be inserted close to their root segment. | INSERT_LIMIT_COUNT keyword |
| LOCATION |
Optional |
Specifies the location to insert dependent segments, either DOVF or IOVF. | LOCATION keyword |
| SEGMENT |
Required |
Specifies the name of the segment that should be loaded to a specific location. | SEGMENT keyword |