USERREAD command
The USERREAD command specifies the PCBs that the API will service.
The USERREAD command can also provide some debugging information. The following keywords are valid with USERREAD:
Table 1. USERREAD command keywords
Keyword | Description |
|---|---|
PCB | The PCB keyword allows you to specify one or more PCBs within the PSB that the API processes. You can specify the PCB by number or DBD name. When you specify a HALDB DBD name, all PCBs referencing that HALDB database are under API control. When you specify a non-HALDB DBD name, the first PCB that refers to that DBD is under API control. When you specify a PCB number for a non-HALDB database that is in the PCB, only that PCB is under API control. A maximum of 40 values are allowed for this keyword. |
PCBNAME | The PCBNAME keyword provides an alternate method of specifying one or more PCBs within the PSB that the API processes. You can specify the PCB by the PCB name assigned to it in the label field or the PCBNAME keyword of the PCB statement. If the referenced database is a non-HALDB database, only the selected PCB is under API control. A maximum of 40 values are allowed for this keyword. |
IMSFIRST | The IMSFIRST keyword is a debugging tool that allows you to see the results of the call as made by DL/I first and the same call as made by the Unload function. Specify Y or N. The default value is N. If you use this keyword, the PCBs must specify a G-type PROCOPT. |
The PRINT keyword prints the DL/I call, the PCB information, and the contents of the user I/O area. If you want all information (CALL, PCB, and IOAREA), specify PRINT(ALL); the information prints to the PLUSLIST DD statement. If you omit the PRINT keyword, the default value is NO for the USERREAD command. | |
SNAPDBD | The SNAPDBD keyword is valid only if you have EXTENDED BUFFER MANAGER for IMS (XBM for IMS) or the SNAPSHOT UPGRADE FEATURE (SUF for IMS) installed. XBM Snapshot allows you to take a Snapshot Copy of a database. Although the Snapshot process copies all related databases, the API is an extension of the Unload process (DFSURGU0) and can only process a physical DBDs. For more information, see PSB-conditions. |
XBMSSID | When you specify the SNAPDBD keyword, you must specify the name of the XBM subsystem with the XBMSSID keyword. The XBM subsystem intercepts any updates made to an XBM-registered database, and it preserves the pre-image of the database. The API includes the pre-image in the Snapshot Copy instead of the corresponding block read from the database. |
IRLMGRP | Specify the IRLMGRP keyword to activate sysplex support. The name is passed to the Snapshot Copy function with the data set registration call. Snapshot technology uses this name to ensure that each active IRLM in a sysplex has an active subsystem. The registration call fails if the snapshot technology discovers an active IRLM without supporting the subsystem. |
SNAPERR | Specify the SNAPERR keyword to instruct the API about how to react to errors when XBM is being used. Specify BYPASS or ABEND. If you specify BYPASS, the API bypasses errors as it does when XBM is not being used. If you specify ABEND, the job step will end with a 4094 abend. The default value is ABEND. |