TOIAUTO keyword

The TOIAUTO keyword specifies whether IMS Tools Online System Interface issues IMS commands to stop and start the database before and after the batch image copy process.

Functions that support this keyword
Image Copy function
Statements that support this keyword
  • GLOBAL statement
  • GROUP statement
  • IC/AIC statement
Site default option
Supported
Related keywords
Format
Read syntax diagramSkip visual syntax diagramTOIAUTO=NYO(YO,EVERYLASTNO,DBRDBD,FIRSTSECOND,LOCALGLOBAL,NOPFAPFA)
Y
Stops the database before the batch image copy process, then starts the database after the batch image copy process.
N
Does not stop or start the database.
O
Stops the database before the batch image copy process, but does not start the database after the batch image copy process.

The following optional parameters are applicable only when the first parameter is Y or O. These optional parameters can be specified only on the GLOBAL statement.

EVERY
Switches the log to the next OLDS and takes a checkpoint every time the database is stopped. EVERY is the default.
LAST
Switches the log to the next OLDS and takes a checkpoint only when the last IMS command is issued to stop the database. If the GLOBAL parameter is specified, LAST is ignored.
NO
Indicates that the log is not to be switched to the next OLDS and that a checkpoint is not to be taken when the database is stopped.
Note: EVERY, LAST, and NO are mutually exclusive.
DBR
Issues the /DBRECOVERY command to stop the full-function database, HALDB, and DEDB. DBR is the default.
DBD
Issues the /DBDUMP command to stop the full-function database and HALDB. When specified for a DEDB, this option is ignored.
Note: DBR and DBD are mutually exclusive.
FIRST
Starts the database after the primary image copy process ends. FIRST is the default.
SECOND
Starts the database after the secondary image copy process ends.
Note: FIRST and SECOND are mutually exclusive. They are effective when the secondary image copy data set is requested with Fast Recovery image copy format of the Advanced Image Copy Services.
LOCAL
Issues the /DBRECOVERY, /DBDUMP, and /START commands to each subsystem independently.
  • A /DBRECOVERY or /DBDUMP command is issued only to each subsystem that allocates the database, the area, or the HALDB partition in exclusive mode or update mode.
  • A /START command is issued to each subsystem to which IMS HP Image Copy issued the /DBRECOVERY or the /DBDUMP command.
LOCAL is the default.
Note: If LOCAL is applied, IMS HP Image Copy identifies all the subsystems that allocate the database, the area, or the HALDB partition in exclusive mode or update mode and issues the IMS commands to those subsystems that were identified. If no subsystems match these criteria, IMS commands are not issued to any of the subsystems. If you want IMS HP Image Copy to always issue the /DBRECOVERY or the /DBDUMP command regardless of the condition, specify the GLOBAL parameter.
GLOBAL
Issues the /DBRECOVERY, /DBDUMP, and /START commands with the GLOBAL keyword for the database or the area, which means that these IMS commands apply to all online subsystems that share the database, the area, or the HALDB partition.
Note: LOCAL and GLOBAL are mutually exclusive.
NOPFA
Issues the /DBR GLOBAL and /DBD GLOBAL commands with the NOPFA keyword when both GLOBAL and NOPFA are specified. If the GLOBAL parameter is not specified, NOPFA is ignored.
PFA
Issues the /DBR GLOBAL and /DBD GLOBAL commands without the NOPFA keyword when both GLOBAL and PFA are specified. If the GLOBAL parameter is not specified, PFA is ignored.
Default value
  • If TOIAUTO is not specified, the default is TOIAUTO=N.
  • If TOIAUTO=Y is specified, the default is TOIAUTO=(Y, EVERY, DBR, FIRST).
  • If TOIAUTO=O is specified, the default is TOIAUTO=(O, EVERY, DBR, FIRST).
Usage notes
  • To specify TOIAUTO=Y, DBRC=Y is required. Also, all the load libraries of IMS HP Image Copy, the IMS Tools Online System Interface, and IMS HP Image Copy site default module must be APF-authorized.
  • If this keyword is specified on the GROUP or GLOBAL statement, it applies to IC/AIC control statements, only. If this keyword is specified in multiple IC/AIC statements for each database data set of the same database, the first setting is effective for the entire database. TOIAUTO works for full-function, HALDB, and Fast Path databases.
  • IMS command process run by IMS Tools Online System Interface must meet the following conditions:
    • DBRC=Y is required.
    • Database data set or area must be registered to DBRC.
  • If TOIAUTO=Y or O is specified but the target IMS is not online, IMS HP Image Copy continues processing as TOIAUTO=N.
  • The following considerations apply to the GLOBAL parameter:
    • IRLM must be active. If IRLM is not active, the command is rejected. For more information, see IMS Commands.
    • Even if the database data set or the area is not registered to DBRC, the /DBR GLOBAL, /DBD GLOBAL, and /STA GLOBAL commands are issued.
    • Even if the /DBR GLOBAL or the /DBD GLOBAL command fails, the image copy processing continues.
    • If both the GLOBAL and the LAST parameters are specified, LAST is replaced with EVERY.
  • If TOIAUTO=O is specified without the NOPFA parameter, the database or the area is stopped and authorization processing for data sharing is prohibited. To permit authorization processing for data sharing for the database or the area, use the /STA DB GLOBAL command to start the database or the area.