CA IDMS/DB Utilities

The CA IDMS/DB utilities assist the database administrator in performing database maintenance and backup and recovery functions.
idmscu19
The CA IDMS/DB utilities assist the database administrator in performing database maintenance and backup and recovery functions.
Utilities are executed as follows:
  • You execute most utilities by submitting utility statements through the CA IDMS/DB Command Facility (either in batch through program IDMSBCF or online using the task code OCF).
  • The remaining utilities are executed as separate programs.
This article describes the following information:
2
2
Utility Statements
The following utilities can be submitted as statements to the CA IDMS/DB Batch Command Facility (IDMSBCF).
  • ARCHIVE JOURNAL
  • ARCHIVE LOG
  • ARCHIVE TRACE
  • BACKUP
  • BUILD
  • CLEANUP
  • CONVERT CATALOG
  • CONVERT PAGE
  • CREATE DSMODEL
  • EXPAND PAGE
  • EXTRACT JOURNAL
  • FASTLOAD
  • FIX ARCHIVE
  • FIX PAGE
  • FORMAT
  • INSTALL STAMPS
  • LOAD
  • LOCK
  • MAINTAIN INDEX
  • MERGE ARCHIVE
  • PRINT INDEX
  • PRINT JOURNAL
  • PRINT LOG
  • PRINT PAGE
  • PRINT SPACE
  • PUNCH
  • RELOAD
  • REORG
  • RESTORE
  • RESTRUCTURE CONNECT
  • RESTRUCTURE
  • ROLLBACK
  • ROLLFORWARD
  • SYNCHRONIZE STAMPS
  • TUNE INDEX
  • UNLOAD
  • UNLOCK
  • UPDATE STATISTICS
  • VALIDATE
The following utility statements can be submitted through the online command facility and through the batch command facility while operating in local mode or under the central version.
  • CLEANUP
  • CONVERT CATALOG
  • FIX PAGE
  • FORMAT AREA
  • FORMAT SEGMENT
  • INSTALL STAMPS
  • LOCK AREA
  • PRINT INDEX
  • PRINT PAGE
  • PRINT SPACE FOR AREA
  • PRINT SPACE FOR SEGMENT
  • SYNCHRONIZE STAMPS
  • TUNE INDEX
  • UPDATE STATISTICS
For considerations when executing a utility statement under central version, see Central Version Considerations.
Utility Programs
You submit the following utilities to CA IDMS/DB as separate programs.
  • IDMSCALC (called as a subroutine from user programs)
  • IDMSDBAN
  • IDMSDIRL
  • IDMSLOOK
  • IDMSRPTS
  • IDMSRSTC
The following utility programs can be run while operating in local mode or under the central version:
  • IDMSDIRL
  • IDMSRPTS
  • IDMSRSTC
Securing Utility Commands
Individual utility commands can be secured whether they run in batch or online. For more information, see Administrating Security for IDMS.
JCL Considerations
In the discussion of each utility, the files that are required to run a utility are identified under the heading "JCL Considerations."
The z/OS JCL, z/VSE JCL, and CMS Commands sections present sample JCL for each utility by operating system.
Batch Command Facility JCL
In each JCL section, the basic JCL to execute the CA IDMS batch command facility (IDMSBCF) is presented first. IDMSBCF JCL must include definitions of the input, and output files CA IDMS/DB must perform the requested operations. For each operating system, sample file assignments for these input and output files are presented in alphabetical order by utility.
For more information about using the CA IDMS Batch Command Facility, see Using Common Facilities.
 
Operating System-specific JCL
Sample JCL for submitting utility statements and programs is presented in the following sections:
SYSIDMS Parameter File:
The SYSIDMS parameter file is added to the JCL stream of batch jobs running in local mode or under the central version. You can use SYSIDMS parameters to specify:
  • Physical requirements of the environment, such as the DMCL and the database or dictionary to use at runtime
  • Runtime directives that help application execution, such as activating the IDMSQSAM facility
  • Operating system-dependent file information, such as overriding a block size for a file in a z/VSE environment
When executing utility statements through the batch command facility, you use SYSIDMS parameters, as appropriate, to specify database name, dictionary name, DMCL name, and other required information.
You should be familiar with SYSIDMS parameters and the function of the SYSIDMS parameter file before running CA IDMS utilities.
For more information about SYSIDMS parameters, see Using Common Facilities.
 
IDMSLBLS Procedure for z/VSE JCL
A procedure containing file assignments for CA IDMS dictionary and database files, disk journals, and the SYSIDMS parameter file for use in the CA IDMS/DB z/VSE environment is provided during the CA IDMS installation. A copy of this procedure appears in the z/VSE JCL section.
Only the file definitions for work files, SYSCTL files, and tape and archive journal files appear in the sample JCL in the z/VSE JCL section.
For more information about executing a utility statement under central version, see Central Version Considerations.